Entity Framework - Suporte para múltiplas BD

Uma das limitações que o EF ainda tem é o seu suporte para múltiplas bases de dados. A opção simplesmente não é suportada à partida, apesar de atrair muitos votos no UserVoice.

Antes de mais, quero dar crédito aos autores da ideia original. Esta ideia não foi minha. Eu fiz download do script original, utilizei-o e depois reescrevi-o quase completamente para lidar com alguns casos adicionais. Eu adoro Linq, por isso aproveitei para utilizar bastante na nova versão. O script original pode ser encontrado aqui.

O truque é fazer o EF acreditar que todas as tabelas/objectos mapeados estão na mesma base de dados utilizando sinónimos. Eu não sei se todas as BD's suportadas pelo EF têm alguma feature semalhante a sinónimos, mas isto é certamente possível no SQL Server (que eu estou actualmente a usar).

O meu script acrescenta a possibilidade de primeiro fazer backup dos ficheiros edmx (algo que eu acho útil para evitar que o meu modelo fique corrompido), substitui os prefixos no modelo resultante (que eu tinha que fazer à mão com o script anterior) e finalmente ordena as navigation properties por ordem alfabética. Esta última opção é muito importante para mim, porque eu uso o LINQPad bastante e as propriedades aparecem como links na ordem em que estão declaradas no modelo. Outra mudança inclui a possibilidade de importar os Function Imports declarados (se não estou enganado, o script original dava um erro pela falta de um atributo no elemento FunctionImport).

Os seguintes procedimentos devem ser executados para que esta abordagem funcione. Eu sei que parece muito, mas o fim justifica o meio:

• Deve ser definida uma base de dados que terá todos os sinónimos para objectos de outras bases de dados. Este é o nosso ponto de entrada no EF, e pode ser qualquer base de dados dentro da mesma instância.

• Devem ser criados sinónimos para cada tabela/view/função das bases de dados secundárias que serão mapeados para o modelo. Eu costumo gerar um script que cria código para gerar sinónimos por todas as tabelas e funções. Algo deste género:

	USE databasename
	select 'CREATE SYNONYM dbo.' + t.name + ' FOR ' + 'databasename.dbo.' + t.name
	FROM sys.tables t

view raw synonyms.cs hosted with ❤ by GitHub

• Deve ser criado um modelo por cada base de dados que queremos utilizar.


• Configuramos as variáveis no script. É necessário configurar o caminho para os modelos, o destino dos backups e o caminho do modelo resultante do merge. Ainda existem semelhanças com o script original na minha versão. Não esquecer de alterar o XNamespace no início do script. Estes podem variar dependendo da versão do EF. 

• Ir ao método ReplacePrefixes e configurar a variável "CorrectPrefix". Esta variável deve conter o nome do Conceptual Model (Modelo Conceptual) do nosso modelo principal, isto é, aquele que criámos para a nossa base de dados principal. Finalmente, configurar as substituições mais abaixo, na linha onde o método Replace(string, string) é chamado.


• Fazer backup manual de tudo primeiro. Podem ocorrer problemas


• Correr o script. Abrir e validar o modelo resultante para verificar se tudo correu bem. Daqui em diante, cada vez que houver actualizações em algum dos modelos periféricos basta repetir este passo e as alterações serão reflectidas no modelo principal.

Limitações

• O script é uma alternativa para quando precisamos deste tipo de feature. É uma pena o EF não suportar isto, porque muitas vezes não é possível começar com uma BD desenhada para este efeito. Dito isto, as Entities não serão removidas do edmx principal forem apagadas de um edmx secundário. Na altura não precisava desta feature, por isso não a implementei.

• Não é possível garantir que este script funcione em todos os casos. O modelo que uso não é extremamente complexo e não dá cobertura a todos os casos de mapping possíveis, por isso podem faltar algumas features. 


• Navigation properties entre entidades de modelos diferentes são suportadas. Certifiquem-se que as nomeiam com o prefixo "LNK_". Isto permite-me manter as relações enquanto faço o merge em vez de as apagar. Esta abordagem é exactamente a mesma que a do script original. Caso prefiram, é possível alterar o prefixo no método MergeEDMX.


• Cuidado com objectos com o mesmo nome entre modelos diferentes. Se existir um conflito, o modelo ficará corrompido e terá de ser alterado manualmente, ou repôr-se os backups. 


• Quando tem que se actualizar o modelo da base de dados, façam-no sempre nos modelos secundários, ou no modelo que representa cada base de dados em separado, e não no modelo construído pelo script.


• Sempre que ocorrer uma mudança num dos modelos secundários, teremos que fazer o merge com o principal. Não é necessário fazer merge de todos os modelos secundários ao mesmo tempo.

Chega de conversa, aqui está o script. Façam bom uso dele!

	//Some change may be needed here, depending on your version
	public static XNamespace edmx = "http://schemas.microsoft.com/ado/2009/11/edmx";
	public static XNamespace xmlnsssdl = "http://schemas.microsoft.com/ado/2009/11/edm/ssdl";
	public static XNamespace xmlnsedm = "http://schemas.microsoft.com/ado/2009/11/edm";
	public static XNamespace xmlnscs = "http://schemas.microsoft.com/ado/2009/11/mapping/cs";
	void Main()
	{
	string rootDir = @"C:\Users\Admin\Documents\visual studio 2013\Projects\ConsoleApplication2\ConsoleApplication2";
	string BackupDestination = @"C:\Users\Admin\Documents\visual studio 2013\Projects\ConsoleApplication2\ConsoleApplication2\Backup";
	string resultFilePath = rootDir + @"\ReportServer.edmx";
	string[] files = new string[]
	{
	rootDir + @"\SimpleAccount.edmx",
	};
	Backup(rootDir, BackupDestination);
	MergeEDMX(files, resultFilePath);
	ReplacePrefixes(resultFilePath);
	ReorderNavigationProperties(resultFilePath);
	}
	private static void MergeEDMX(string[] files, string ResultFile)
	{
	Console.WriteLine ("Merging EDMX");
	foreach (string file in files)
	{
	XDocument doc = XDocument.Load(file);
	XDocument docresult = XDocument.Load(ResultFile);
	//SSDL
	Console.WriteLine ("Merging SSDL");
	MergeNodes(docresult.Root.Descendants(xmlnsssdl + "EntityContainer").First(),
	doc.Root.Descendants(xmlnsssdl + "EntityContainer").Elements(),
	docresult.Root.Descendants(xmlnsssdl + "EntityContainer").Elements(),
	(x,y) => x.Attribute("Name").Value == y.Attribute("Name").Value);
	MergeNodes(docresult.Root.Descendants(xmlnsssdl + "Schema").First(),
	doc.Root.Descendants(xmlnsssdl + "Schema").Elements().Where(x=> x.Name != xmlnsssdl + "EntityContainer"),
	docresult.Root.Descendants(xmlnsssdl + "Schema").Elements().Where(x=> x.Name != xmlnsssdl + "EntityContainer"),
	(x,y) => x.Attribute("Name").Value == y.Attribute("Name").Value);
	Console.WriteLine ("Done SSDL");
	//CSDL
	Console.WriteLine ("Merging CSDL");
	MergeNodes(docresult.Root.Descendants(xmlnsedm + "EntityContainer").First(),
	doc.Root.Descendants(xmlnsedm + "EntityContainer").Elements(),
	docresult.Root.Descendants(xmlnsedm + "EntityContainer").Elements(),
	(x,y) => x.Attribute("Name").Value == y.Attribute("Name").Value);
	//Import NavigationProperties. First we go to already existant entities (OldEntities) to read existing NavProp
	//Then we import those Elements to the new entity (NewEntity) in the loop
	var OldEntities = docresult.Root.Descendants(xmlnsedm + "EntityType");
	var NewEntities = doc.Root.Descendants(xmlnsedm + "EntityType");
	foreach (var NewEntity in NewEntities)
	{
	var OldEntity = OldEntities.FirstOrDefault(x=> x.Attribute("Name").Value == NewEntity.Attribute("Name").Value);
	if (OldEntity == null)
	continue;
	NewEntity.Add(OldEntity
	.Elements(xmlnsedm + "NavigationProperty")
	.Where(x=> x.Attribute("Relationship").Value.Contains(".LNK_")));
	}
	NewEntities = NewEntities.Union(doc.Root.Descendants(xmlnsedm + "Schema").Elements().Where(x=> x.Name != xmlnsedm + "EntityContainer"));
	//
	//Merge the itens inside the Schema (except EntityContainer)
	MergeNodes(docresult.Root.Descendants(xmlnsedm + "Schema").First(),
	NewEntities.ToList(),
	docresult.Root.Descendants(xmlnsedm + "Schema").Elements().Where(x=> x.Name != xmlnsedm + "EntityContainer"),
	(x,y) => x.Attribute("Name").Value == y.Attribute("Name").Value);
	Console.WriteLine ("Done CSDL");
	//C-S
	Console.WriteLine ("Merging C-S");
	//Merge the itens inside EntityContainer in the C-S layer
	MergeNodes(docresult.Root.Descendants(xmlnscs + "EntityContainerMapping").First(),
	doc.Root.Descendants(xmlnscs + "EntitySetMapping"),
	docresult.Root.Descendants(xmlnscs + "EntitySetMapping"),
	(x,y) => x.Attribute("Name").Value == y.Attribute("Name").Value);
	//Merge the functions (requires different attribute comparing)
	MergeNodes(docresult.Root.Descendants(xmlnscs + "EntityContainerMapping").First(),
	doc.Root.Descendants(xmlnscs + "FunctionImportMapping"),
	docresult.Root.Descendants(xmlnscs + "FunctionImportMapping"),
	(x,y) => x.Attribute("FunctionImportName").Value == y.Attribute("FunctionImportName").Value);
	Console.WriteLine ("Done C-S");
	docresult.Save(ResultFile);
	}
	Console.WriteLine("Done Merging");
	}
	//Deletes old nodes that exist in a ParentTarget and in the NewChilds when the comparer returns true
	private static void MergeNodes(XElement ParentTarget, IEnumerable<XElement> NewChilds, IEnumerable<XElement> OldChilds, Func<XElement, XElement, bool> ChildComparer)
	{
	(from OldFunc in OldChilds
	from NewFunc in NewChilds
	where ChildComparer(OldFunc, NewFunc)
	select OldFunc).Remove();
	//Add new functions
	ParentTarget.Add(NewChilds);
	}
	//Reorders the navigation properties of an EDMX
	private void ReorderNavigationProperties(string EDMXFilePath)
	{
	Console.WriteLine ("Reordering navigation properties");
	XDocument doc = XDocument.Load(EDMXFilePath);
	foreach (var Entity in doc.Root.Descendants(edmx + "Runtime")
	.Descendants(edmx + "ConceptualModels")
	.Descendants(xmlnsedm + "Schema")
	.Descendants(xmlnsedm + "EntityType"))
	{
	Entity.ReplaceNodes(
	Entity.Descendants()
	.Where (x => x.Parent == Entity) //Descendentes directos
	.OrderBy (x => x.Name == xmlnsedm + "NavigationProperty" ? x.Attribute("Name").Value : "a" ));
	}
	doc.Save(EDMXFilePath);
	Console.WriteLine("Done");
	}
	//Replace the prefixes of the other models.
	private void ReplacePrefixes(string FilePath)
	{
	Console.WriteLine ("Replacing database prefixes");
	string CorrectPrefix = "Model";
	var text = File.ReadAllText(FilePath);
	text = text.Replace("SimpleAccountModel", CorrectPrefix);
	File.WriteAllText(FilePath, text);
	Console.WriteLine ("Done");
	}
	public void Backup(string source, string destination)
	{
	string DoBackups;
	Console.WriteLine ("Do backups first? y/n");
	do
	{
	DoBackups = Console.ReadLine();
	} while (DoBackups != "y" && DoBackups != "n");
	if (DoBackups == "y")
	{
	Console.WriteLine ("Performing backups");
	DoBackup(source, destination);
	Console.WriteLine ("Done");
	}
	else
	Console.WriteLine ("Ignoring backups...");
	}
	//Backs up all .edmx and .Designer.cs in the Source directory.
	public void DoBackup(string Source, string Destination)
	{
	DirectoryInfo srcDir = new DirectoryInfo(Source);
	DirectoryInfo dstDir = new DirectoryInfo(Destination);
	var files = from file in srcDir.GetFiles()
	where file.Extension == ".edmx"
	|| file.Name.Contains(".Designer.cs")
	select file;
	foreach (FileInfo FileName in files)
	{
	if (!dstDir.Exists)
	dstDir.Create();
	System.IO.File.Copy(FileName.FullName, dstDir.FullName + "\\" + FileName.Name, true);
	}
	}

view raw EF.cs hosted with ❤ by GitHub

Nota: Lembrem-se de testar o script antes de o utilizarem. Isto é um workaround e portanto não é perfeito, podendo conter bugs ou comportamento inesperado.