Entity Framework Schema Translations
You should have different setup environments, right. Normally something like dev, test (or staging) and production. This implies to have different DBs as well. At work we have Oracle databases and there we don't really have different DB "instances" but different schemas, depending on the environment we deploy to. This post presents an approach of allowing to dynamically "rewrite" the schema defined in the EF mappings in an easy to use way.
The ProblemWhen you define a mapping in Entity Framework (I'm talking about database first, don't know whether this applies to code first as well) you'll get an EntitySet section which looks something like this:
<EntitySet Name="ADDRESSES" EntityType="Siag.IAM.Transversal.Entities.Store.ADDRESSES" store:Type="Tables" Schema="MYSCHEMA" Table="ADDRESSES" />Note that this is the xml file generated by the DevArt Entity Developer as we use that one since it has some nice features. The problem here is the hard-coded schema definition in line 4. Why? Because in the connection string you have to specify the schema name as the User Id like
<connectionStrings> <add name="Entities" connectionString="metadata=res...connection string='User Id=MYSCHEMA;Password=...'" providerName="System.Data.EntityClient" /> <connectionStrings>So normally, when we deploy to a different environment, a web.config transformation adapts the User Id for that specific environment like changing MYSCHEMA to MYSCHEMA_TEST. Unfortunately that doesn't work because - remember - the EF configuration file has still MYSCHEMA hardcoded in the configuration file.
Option 1: Alter sessionOne option is to execute a command on each connection opening, altering the used session. In Oracle
ALTER SESSION SET CURRENT_SCHEMA=MYSCHEMA_TEST;The drawback: you execute one additional command on each connection opening. Not probably a big overhead, but still. DevArt supports this starting from version 7 of their dotConnect driver. In there, they added anInitialization Command property defined on the connection string and which lets you specify exactly this alter session command. We currently have v 6.something ... Although we're planning to upgrade probably, I continued to search.
Option 2: Dynamically adapt the EF MetadataThe idea: Before establishing the connection, load the Entity Framework metadata and exchange the schema name.
Browsing around, I found the Entity Framework Runtime Model Adapter project on Codeplex. That sounds promising. I inspected the code, and it even had a SchemaAdapter which did the job I was looking for. But not exactly. First of all, the project seemed abandoned, with the latest update back in 2010. As a result, it only had support for the (now considered obsolete) ObjectContext rather than DbContext and finally, it adapted an approach of substituting all schema definitions which is not necessarily always desired.
Resulting Solution: Schema TranslationsSo I decided to adapt the code from codeplex s.t. one could define a Schema Translations property in the connection string that looked like
Schema Translations=MYSCHEMA->MYSCHEMA_TEST,ANOTHERSCHEMA->ANOTHERSCHEMA_STAGINGAdvantages of this approach:
- Only those schema definitions that have been explicitly specified get substituted while others remain unchanged
- No scary if conditions in the source code to map schema definitions
- Fully configuration based, wherefore web.config transformations work just great
(Note: Opinions expressed in this article and its replies are the opinions of their respective authors and not those of DZone, Inc.)