Especificação de MSL
A linguagem de especificação de mapeamento (MSL) é uma linguagem baseada em XML que descreve o mapeamento entre o modelo conceitual e o modelo de armazenamento de um aplicativo do Entity Framework.
Em um aplicativo do Entity Framework, os metadados de mapeamento são carregados de um arquivo .msl (gravado em MSL) em tempo de compilação. O Entity Framework usa metadados de mapeamento em tempo de execução para converter consultas no modelo conceitual em comandos específicos de armazenamento.
O Entity Framework Designer (EF Designer) armazena informações de mapeamento em um arquivo .edmx em tempo de design. Em tempo de compilação, o Entity Designer usa informações em um arquivo .edmx para criar o arquivo .msl necessário para o Entity Framework em tempo de execução
Os nomes de todos os tipos conceituais ou de modelo de armazenamento referenciados no MSL devem ser qualificados por seus respectivos nomes de namespace. Para obter informações sobre o nome do namespace do modelo conceitual, consulte Especificação CSDL. Para obter informações sobre o nome do namespace do modelo de armazenamento, consulte Especificação SSDL.
As versões do MSL são diferenciadas por namespaces XML.
| Versão MSL | XML Namespace |
|---|---|
| MSL v1 | urn:schemas-microsoft-com:windows:storage:mapping:CS |
| MSL v2 | https://schemas.microsoft.com/ado/2008/09/mapping/cs |
| MSL v3 | https://schemas.microsoft.com/ado/2009/11/mapping/cs |
Elemento de alias (MSL)
O elemento Alias na linguagem de especificação de mapeamento (MSL) é um filho do elemento Mapping que é usado para definir aliases para namespaces de modelo conceitual e modelo de armazenamento. Os nomes de todos os tipos conceituais ou de modelo de armazenamento referenciados no MSL devem ser qualificados por seus respectivos nomes de namespace. Para obter informações sobre o nome do namespace do modelo conceitual, consulte Elemento de esquema (CSDL). Para obter informações sobre o nome do namespace do modelo de armazenamento, consulte Elemento de esquema (SSDL).
O elemento Alias não pode ter elementos filho.
Atributos aplicáveis
A tabela abaixo descreve os atributos que podem ser aplicados ao elemento Alias.
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| Chave | Sim | O alias para o namespace especificado pelo atributo Value. |
| Valor | Sim | O namespace para o qual o valor do elemento Key é um alias. |
Exemplo
O exemplo a seguir mostra um elemento Alias que define um alias, c, para tipos definidos no modelo conceitual.
<Mapping Space="C-S"
xmlns="https://schemas.microsoft.com/ado/2009/11/mapping/cs">
<Alias Key="c" Value="SchoolModel"/>
<EntityContainerMapping StorageEntityContainer="SchoolModelStoreContainer"
CdmEntityContainer="SchoolModelEntities">
<EntitySetMapping Name="Courses">
<EntityTypeMapping TypeName="c.Course">
<MappingFragment StoreEntitySet="Course">
<ScalarProperty Name="CourseID" ColumnName="CourseID" />
<ScalarProperty Name="Title" ColumnName="Title" />
<ScalarProperty Name="Credits" ColumnName="Credits" />
<ScalarProperty Name="DepartmentID" ColumnName="DepartmentID" />
</MappingFragment>
</EntityTypeMapping>
</EntitySetMapping>
<EntitySetMapping Name="Departments">
<EntityTypeMapping TypeName="c.Department">
<MappingFragment StoreEntitySet="Department">
<ScalarProperty Name="DepartmentID" ColumnName="DepartmentID" />
<ScalarProperty Name="Name" ColumnName="Name" />
<ScalarProperty Name="Budget" ColumnName="Budget" />
<ScalarProperty Name="StartDate" ColumnName="StartDate" />
<ScalarProperty Name="Administrator" ColumnName="Administrator" />
</MappingFragment>
</EntityTypeMapping>
</EntitySetMapping>
</EntityContainerMapping>
</Mapping>
Elemento AssociationEnd (MSL)
O elemento AssociationEnd na linguagem de especificação de mapeamento (MSL) é usado quando as funções de modificação de um tipo de entidade no modelo conceitual são mapeadas para procedimentos armazenados no banco de dados subjacente. Se um procedimento armazenado de modificação usar um parâmetro cujo valor é mantido em uma propriedade de associação, o elemento AssociationEnd mapeia o valor da propriedade para o parâmetro. Para obter mais informações, consulte o exemplo a seguir.
Para obter mais informações sobre como mapear funções de modificação de tipos de entidade para procedimentos armazenados, consulte ModificationFunctionMapping Element (MSL) e Demonstra Passo a passo: mapeando uma entidade para procedimentos armazenados.
O elemento AssociationEnd pode ter os seguintes elementos filho:
- ScalarProperty
Atributos aplicáveis
A tabela a seguir descreve os atributos aplicáveis ao elemento AssociationEnd.
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| AssociationSet | Sim | O nome da associação que está sendo mapeada. |
| De | Sim | O valor do atributo FromRole da propriedade de navegação que corresponde à associação que está sendo mapeada. Para obter mais informações, consulte NavigationProperty Element (CSDL). |
| Para | Sim | O valor do atributo ToRole da propriedade de navegação que corresponde à associação que está sendo mapeada. Para obter mais informações, consulte NavigationProperty Element (CSDL). |
Exemplo
Considere o seguinte tipo de entidade de modelo conceitual:
<EntityType Name="Course">
<Key>
<PropertyRef Name="CourseID" />
</Key>
<Property Type="Int32" Name="CourseID" Nullable="false" />
<Property Type="String" Name="Title" Nullable="false" MaxLength="100"
FixedLength="false" Unicode="true" />
<Property Type="Int32" Name="Credits" Nullable="false" />
<NavigationProperty Name="Department"
Relationship="SchoolModel.FK_Course_Department"
FromRole="Course" ToRole="Department" />
</EntityType>
Considere também o seguinte procedimento armazenado:
CREATE PROCEDURE [dbo].[UpdateCourse]
@CourseID int,
@Title nvarchar(50),
@Credits int,
@DepartmentID int
AS
UPDATE Course SET Title=@Title,
Credits=@Credits,
DepartmentID=@DepartmentID
WHERE CourseID=@CourseID;
Para mapear a função de atualização da entidade Course para esse procedimento armazenado, você deve fornecer um valor para o parâmetro DepartmentID. O valor para DepartmentID não corresponde a uma propriedade no tipo de entidade; ele está contido em uma associação independente cujo mapeamento é mostrado aqui:
<AssociationSetMapping Name="FK_Course_Department"
TypeName="SchoolModel.FK_Course_Department"
StoreEntitySet="Course">
<EndProperty Name="Course">
<ScalarProperty Name="CourseID" ColumnName="CourseID" />
</EndProperty>
<EndProperty Name="Department">
<ScalarProperty Name="DepartmentID" ColumnName="DepartmentID" />
</EndProperty>
</AssociationSetMapping>
O código a seguir mostra o elemento AssociationEnd usado para mapear a propriedade DepartmentID da associação FK_Course_Department para o procedimento armazenado UpdateCourse (para o qual a função de atualização do tipo de entidade Course é mapeada):
<EntitySetMapping Name="Courses">
<EntityTypeMapping TypeName="SchoolModel.Course">
<MappingFragment StoreEntitySet="Course">
<ScalarProperty Name="Credits" ColumnName="Credits" />
<ScalarProperty Name="Title" ColumnName="Title" />
<ScalarProperty Name="CourseID" ColumnName="CourseID" />
</MappingFragment>
</EntityTypeMapping>
<EntityTypeMapping TypeName="SchoolModel.Course">
<ModificationFunctionMapping>
<UpdateFunction FunctionName="SchoolModel.Store.UpdateCourse">
<AssociationEnd AssociationSet="FK_Course_Department"
From="Course" To="Department">
<ScalarProperty Name="DepartmentID"
ParameterName="DepartmentID"
Version="Current" />
</AssociationEnd>
<ScalarProperty Name="Credits" ParameterName="Credits"
Version="Current" />
<ScalarProperty Name="Title" ParameterName="Title"
Version="Current" />
<ScalarProperty Name="CourseID" ParameterName="CourseID"
Version="Current" />
</UpdateFunction>
</ModificationFunctionMapping>
</EntityTypeMapping>
</EntitySetMapping>
Elemento AssociationSetMapping (MSL)
O elemento AssociationSetMapping na linguagem de especificação de mapeamento (MSL) define o mapeamento entre uma associação no modelo conceitual e colunas de tabela no banco de dados subjacente.
As associações no modelo conceitual são tipos cujas propriedades representam colunas de chave primária e estrangeira no banco de dados subjacente. O elemento AssociationSetMapping usa dois elementos EndProperty para definir os mapeamentos entre propriedades de tipo de associação e colunas no banco de dados. Você pode colocar condições nesses mapeamentos com o elemento Condition. Mapeie as funções de inserção, atualização e exclusão para associações a procedimentos armazenados no banco de dados com o elemento ModificationFunctionMapping. Defina mapeamentos somente leitura entre associações e colunas de tabela usando uma cadeia de caracteres Entity SQL em um elemento QueryView.
Observação
Se uma restrição referencial for definida para uma associação no modelo conceitual, a associação não precisará ser mapeada com um elemento AssociationSetMapping. Se um elemento AssociationSetMapping estiver presente para uma associação que tenha uma restrição referencial, os mapeamentos definidos no elemento AssociationSetMapping serão ignorados. Para obter mais informações, consulte Elemento ReferentialConstraint (CSDL).
O elemento AssociationSetMapping pode ter os seguintes elementos filho
- QueryView (zero ou um)
- EndProperty (zero ou dois)
- Condição (zero ou mais)
- ModificationFunctionMapping (zero ou um)
Atributos aplicáveis
A tabela a seguir descreve os atributos que podem ser aplicados ao elemento AssociationSetMapping.
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| Nome | Sim | O nome do conjunto de associação de modelo conceitual que está sendo mapeado. |
| TypeName | Não | O nome qualificado para namespace do tipo de associação de modelo conceitual que está sendo mapeado. |
| StoreEntitySet | Não | O nome da tabela que está sendo mapeada. |
Exemplo
O exemplo a seguir mostra um elemento AssociationSetMapping no qual o conjunto de associação FK_Course_Department no modelo conceitual é mapeado para a tabela Course no banco de dados. Os mapeamentos entre propriedades de tipo de associação e colunas de tabela são especificados em elementos filho EndProperty.
<AssociationSetMapping Name="FK_Course_Department"
TypeName="SchoolModel.FK_Course_Department"
StoreEntitySet="Course">
<EndProperty Name="Department">
<ScalarProperty Name="DepartmentID" ColumnName="DepartmentID" />
</EndProperty>
<EndProperty Name="Course">
<ScalarProperty Name="CourseID" ColumnName="CourseID" />
</EndProperty>
</AssociationSetMapping>
Elemento ComplexProperty (MSL)
Um elemento ComplexProperty na linguagem de especificação de mapeamento (MSL) define o mapeamento entre uma propriedade de tipo complexo em um tipo de entidade de modelo conceitual e colunas de tabela no banco de dados subjacente. Os mapeamentos de coluna de propriedade são especificados em elementos filho ScalarProperty.
O elemento de propriedade ComplexType pode ter os seguintes elementos filho:
- ScalarProperty (zero ou mais)
- ComplexProperty (zero ou mais)
- ComplexTypeMapping (zero ou mais)
- Condição (zero ou mais)
Atributos aplicáveis
A tabela a seguir descreve os atributos aplicáveis ao elemento ComplexProperty:
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| Nome | Sim | O nome da propriedade complexa de um tipo de entidade no modelo conceitual que está sendo mapeado. |
| TypeName | Não | O nome qualificado para namespace do tipo de propriedade de modelo conceitual. |
Exemplo
O exemplo a seguir é baseado no modelo Escola. O seguinte tipo complexo foi adicionado ao modelo conceitual:
<ComplexType Name="FullName">
<Property Type="String" Name="LastName"
Nullable="false" MaxLength="50"
FixedLength="false" Unicode="true" />
<Property Type="String" Name="FirstName"
Nullable="false" MaxLength="50"
FixedLength="false" Unicode="true" />
</ComplexType>
As propriedades LastName e FirstName do tipo de entidade Person foram substituídas por uma propriedade complexa, Name:
<EntityType Name="Person">
<Key>
<PropertyRef Name="PersonID" />
</Key>
<Property Name="PersonID" Type="Int32" Nullable="false"
annotation:StoreGeneratedPattern="Identity" />
<Property Name="HireDate" Type="DateTime" />
<Property Name="EnrollmentDate" Type="DateTime" />
<Property Name="Name" Type="SchoolModel.FullName" Nullable="false" />
</EntityType>
O MSL a seguir mostra o elemento ComplexProperty usado para mapear a propriedade Nome para colunas no banco de dados subjacente:
<EntitySetMapping Name="People">
<EntityTypeMapping TypeName="SchoolModel.Person">
<MappingFragment StoreEntitySet="Person">
<ScalarProperty Name="PersonID" ColumnName="PersonID" />
<ScalarProperty Name="HireDate" ColumnName="HireDate" />
<ScalarProperty Name="EnrollmentDate" ColumnName="EnrollmentDate" />
<ComplexProperty Name="Name" TypeName="SchoolModel.FullName">
<ScalarProperty Name="FirstName" ColumnName="FirstName" />
<ScalarProperty Name="LastName" ColumnName="LastName" />
</ComplexProperty>
</MappingFragment>
</EntityTypeMapping>
</EntitySetMapping>
Elemento ComplexTypeMapping (MSL)
O elemento ComplexTypeMapping na linguagem de especificação de mapeamento (MSL) é um filho do elemento ResultMapping e define o mapeamento entre uma importação de função no modelo conceitual e um procedimento armazenado no banco de dados subjacente quando o seguinte for verdadeiro:
- A importação de função retorna um tipo complexo conceitual.
- Os nomes das colunas retornadas pelo procedimento armazenado não correspondem exatamente aos nomes das propriedades no tipo complexo.
Por padrão, o mapeamento entre as colunas retornadas por um procedimento armazenado e um tipo complexo é baseado em nomes de colunas e propriedades. Se os nomes de coluna não corresponderem exatamente aos nomes de propriedade, você deverá usar o elemento ComplexTypeMapping para definir o mapeamento. Para obter um exemplo do mapeamento padrão, consulte Elemento FunctionImportMapping (MSL).
O elemento ComplexTypeMapping pode ter os seguintes elementos filho:
- ScalarProperty (zero ou mais)
Atributos aplicáveis
A tabela a seguir descreve os atributos aplicáveis ao elemento ComplexTypeMapping.
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| TypeName | Sim | O nome qualificado para namespace do tipo complexo que está sendo mapeado. |
Exemplo
Considere o seguinte procedimento armazenado:
CREATE PROCEDURE [dbo].[GetGrades]
@student_Id int
AS
SELECT EnrollmentID as enroll_id,
Grade as grade,
CourseID as course_id,
StudentID as student_id
FROM dbo.StudentGrade
WHERE StudentID = @student_Id
Considere também o seguinte tipo complexo de modelo conceitual:
<ComplexType Name="GradeInfo">
<Property Type="Int32" Name="EnrollmentID" Nullable="false" />
<Property Type="Decimal" Name="Grade" Nullable="true"
Precision="3" Scale="2" />
<Property Type="Int32" Name="CourseID" Nullable="false" />
<Property Type="Int32" Name="StudentID" Nullable="false" />
</ComplexType>
Para criar uma importação de função que retorna instâncias do tipo complexo anterior, o mapeamento entre as colunas retornadas pelo procedimento armazenado e o tipo de entidade deve ser definido em um elemento ComplexTypeMapping:
<FunctionImportMapping FunctionImportName="GetGrades"
FunctionName="SchoolModel.Store.GetGrades" >
<ResultMapping>
<ComplexTypeMapping TypeName="SchoolModel.GradeInfo">
<ScalarProperty Name="EnrollmentID" ColumnName="enroll_id"/>
<ScalarProperty Name="CourseID" ColumnName="course_id"/>
<ScalarProperty Name="StudentID" ColumnName="student_id"/>
<ScalarProperty Name="Grade" ColumnName="grade"/>
</ComplexTypeMapping>
</ResultMapping>
</FunctionImportMapping>
Elemento de condição (MSL)
O elemento Condition na linguagem de especificação de mapeamento (MSL) coloca condições em mapeamentos entre o modelo conceitual e o banco de dados subjacente. O mapeamento definido em um nó XML será válido se todas as condições, conforme especificado nos elementos filho Condition, forem atendidas. Caso contrário, o mapeamento não será válido. Por exemplo, se um elemento MappingFragment contiver um ou mais elementos filho Condition, o mapeamento definido no nó MappingFragment só será válido se todas as condições dos elementos filho Condition forem atendidas.
Cada condição pode se aplicar a um Name (o nome de uma propriedade de entidade de modelo conceitual, especificada pelo atributo Name) ou a um ColumnName (o nome de uma coluna no banco de dados, especificado pelo atributo ColumnName). Quando o atributo Name é definido, a condição é verificada em relação a um valor de propriedade de entidade. Quando o atributo ColumnName é definido, a condição é verificada em relação a um valor de coluna. Somente um dos atributos Name ou ColumnName pode ser especificado em um elemento Condition.
Observação
Quando o elemento Condition é usado em um elemento FunctionImportMapping, somente o atributo Name não é aplicável.
O elemento Condition pode ser filho dos seguintes elementos:
- AssociationSetMapping
- ComplexProperty
- EntitySetMapping
- MappingFragment
- EntityTypeMapping
O elemento Condition não pode ter elementos filho.
Atributos aplicáveis
A tabela a seguir descreve os atributos aplicáveis ao elemento Condition:
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| ColumnName | Não | O nome da coluna da tabela cujo valor é usado para avaliar a condição. |
| IsNull | Não | True ou False. Se o valor for True e o valor da coluna for null, ou se o valor for False e o valor da coluna não for null, a condição será true. Caso contrário, a condição é falsa. Os atributos IsNull e Value não podem ser usados ao mesmo tempo. |
| Valor | Não | O valor com o qual o valor da coluna é comparado. Se os valores forem os mesmos, a condição será true. Caso contrário, a condição é falsa. Os atributos IsNull e Value não podem ser usados ao mesmo tempo. |
| Nome | Não | O nome da propriedade de entidade de modelo conceitual cujo valor é usado para avaliar a condição. Esse atributo não será aplicável se o elemento Condition for usado em um elemento FunctionImportMapping. |
Exemplo
O exemplo a seguir mostra elementos Condition como filhos de elementos MappingFragment. Quando HireDate não é nulo e EnrollmentDate é nulo, os dados são mapeados entre o tipo SchoolModel.Instructor e as colunas PersonID e HireDate da tabela Person. Quando EnrollmentDate não é nulo e HireDate é nulo, os dados são mapeados entre o tipo SchoolModel.Student e as colunas PersonID e Enrollment da tabela Person.
<EntitySetMapping Name="People">
<EntityTypeMapping TypeName="IsTypeOf(SchoolModel.Person)">
<MappingFragment StoreEntitySet="Person">
<ScalarProperty Name="PersonID" ColumnName="PersonID" />
<ScalarProperty Name="FirstName" ColumnName="FirstName" />
<ScalarProperty Name="LastName" ColumnName="LastName" />
</MappingFragment>
</EntityTypeMapping>
<EntityTypeMapping TypeName="IsTypeOf(SchoolModel.Instructor)">
<MappingFragment StoreEntitySet="Person">
<ScalarProperty Name="PersonID" ColumnName="PersonID" />
<ScalarProperty Name="HireDate" ColumnName="HireDate" />
<Condition ColumnName="HireDate" IsNull="false" />
<Condition ColumnName="EnrollmentDate" IsNull="true" />
</MappingFragment>
</EntityTypeMapping>
<EntityTypeMapping TypeName="IsTypeOf(SchoolModel.Student)">
<MappingFragment StoreEntitySet="Person">
<ScalarProperty Name="PersonID" ColumnName="PersonID" />
<ScalarProperty Name="EnrollmentDate"
ColumnName="EnrollmentDate" />
<Condition ColumnName="EnrollmentDate" IsNull="false" />
<Condition ColumnName="HireDate" IsNull="true" />
</MappingFragment>
</EntityTypeMapping>
</EntitySetMapping>
Elemento DeleteFunction (MSL)
O elemento DeleteFunction na linguagem de especificação de mapeamento (MSL) mapeia a função de exclusão de um tipo de entidade ou associação no modelo conceitual para um procedimento armazenado no banco de dados subjacente. Os procedimentos armazenados para os quais as funções de modificação são mapeadas devem ser declarados no modelo de armazenamento. Para obter mais informações, consulte Elemento de função (SSDL).
Observação
Se você não mapear todas as três operações de inserção, atualização ou exclusão de um tipo de entidade para procedimentos armazenados, as operações não mapeadas falharão se executadas em tempo de execução e um UpdateException for lançado.
DeleteFunction aplicado a EntityTypeMapping
Quando aplicado ao elemento EntityTypeMapping, o elemento DeleteFunction mapeia a função de exclusão de um tipo de entidade no modelo conceitual para um procedimento armazenado.
O elemento DeleteFunction pode ter os seguintes elementos filho quando aplicado a um elemento EntityTypeMapping:
- AssociationEnd (zero ou mais)
- ComplexProperty (zero ou mais)
- ScalarProperty (zero ou mais)
Atributos aplicáveis
A tabela a seguir descreve os atributos que podem ser aplicados ao elemento DeleteFunction quando ele é aplicado a um elemento EntityTypeMapping.
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| FunctionName | Sim | O nome qualificado para namespace do procedimento armazenado para o qual a função de exclusão é mapeada. O procedimento armazenado deve ser declarado no modelo de armazenamento. |
| RowsAffectedParameter | Não | O nome do parâmetro de saída que retorna o número de linhas afetadas. |
Exemplo
O exemplo a seguir é baseado no modelo School e mostra o elemento DeleteFunction mapeando a função delete do tipo de entidade Person para o procedimento armazenado DeletePerson. O procedimento armazenado DeletePerson é declarado no modelo de armazenamento.
<EntitySetMapping Name="People">
<EntityTypeMapping TypeName="SchoolModel.Person">
<MappingFragment StoreEntitySet="Person">
<ScalarProperty Name="PersonID" ColumnName="PersonID" />
<ScalarProperty Name="LastName" ColumnName="LastName" />
<ScalarProperty Name="FirstName" ColumnName="FirstName" />
<ScalarProperty Name="HireDate" ColumnName="HireDate" />
<ScalarProperty Name="EnrollmentDate"
ColumnName="EnrollmentDate" />
</MappingFragment>
</EntityTypeMapping>
<EntityTypeMapping TypeName="SchoolModel.Person">
<ModificationFunctionMapping>
<InsertFunction FunctionName="SchoolModel.Store.InsertPerson">
<ScalarProperty Name="EnrollmentDate"
ParameterName="EnrollmentDate" />
<ScalarProperty Name="HireDate" ParameterName="HireDate" />
<ScalarProperty Name="FirstName" ParameterName="FirstName" />
<ScalarProperty Name="LastName" ParameterName="LastName" />
<ResultBinding Name="PersonID" ColumnName="NewPersonID" />
</InsertFunction>
<UpdateFunction FunctionName="SchoolModel.Store.UpdatePerson">
<ScalarProperty Name="EnrollmentDate"
ParameterName="EnrollmentDate"
Version="Current" />
<ScalarProperty Name="HireDate" ParameterName="HireDate"
Version="Current" />
<ScalarProperty Name="FirstName" ParameterName="FirstName"
Version="Current" />
<ScalarProperty Name="LastName" ParameterName="LastName"
Version="Current" />
<ScalarProperty Name="PersonID" ParameterName="PersonID"
Version="Current" />
</UpdateFunction>
<DeleteFunction FunctionName="SchoolModel.Store.DeletePerson">
<ScalarProperty Name="PersonID" ParameterName="PersonID" />
</DeleteFunction>
</ModificationFunctionMapping>
</EntityTypeMapping>
</EntitySetMapping>
DeleteFunction aplicado a AssociationSetMapping
Quando aplicado ao elemento AssociationSetMapping, o elemento DeleteFunction mapeia a função de exclusão de uma associação no modelo conceitual para um procedimento armazenado.
O elemento DeleteFunction pode ter os seguintes elementos filho quando aplicado ao elemento AssociationSetMapping:
- EndProperty
Atributos aplicáveis
A tabela a seguir descreve os atributos que podem ser aplicados ao elemento DeleteFunction quando ele é aplicado ao elemento AssociationSetMapping.
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| FunctionName | Sim | O nome qualificado para namespace do procedimento armazenado para o qual a função de exclusão é mapeada. O procedimento armazenado deve ser declarado no modelo de armazenamento. |
| RowsAffectedParameter | Não | O nome do parâmetro de saída que retorna o número de linhas afetadas. |
Exemplo
O exemplo a seguir é baseado no modelo Escola e mostra o elemento DeleteFunction usado para mapear a função de exclusão da associação CourseInstructor ao procedimento armazenado DeleteCourseInstructor. O procedimento armazenado DeleteCourseInstructor é declarado no modelo de armazenamento.
<AssociationSetMapping Name="CourseInstructor"
TypeName="SchoolModel.CourseInstructor"
StoreEntitySet="CourseInstructor">
<EndProperty Name="Person">
<ScalarProperty Name="PersonID" ColumnName="PersonID" />
</EndProperty>
<EndProperty Name="Course">
<ScalarProperty Name="CourseID" ColumnName="CourseID" />
</EndProperty>
<ModificationFunctionMapping>
<InsertFunction FunctionName="SchoolModel.Store.InsertCourseInstructor" >
<EndProperty Name="Course">
<ScalarProperty Name="CourseID" ParameterName="courseId"/>
</EndProperty>
<EndProperty Name="Person">
<ScalarProperty Name="PersonID" ParameterName="instructorId"/>
</EndProperty>
</InsertFunction>
<DeleteFunction FunctionName="SchoolModel.Store.DeleteCourseInstructor">
<EndProperty Name="Course">
<ScalarProperty Name="CourseID" ParameterName="courseId"/>
</EndProperty>
<EndProperty Name="Person">
<ScalarProperty Name="PersonID" ParameterName="instructorId"/>
</EndProperty>
</DeleteFunction>
</ModificationFunctionMapping>
</AssociationSetMapping>
Elemento EndProperty (MSL)
O elemento EndProperty na linguagem de especificação de mapeamento (MSL) define o mapeamento entre uma função final ou de modificação de uma associação de modelo conceitual e o banco de dados subjacente. O mapeamento de coluna de propriedade é especificado em um elemento filho ScalarProperty.
Quando um elemento EndProperty é usado para definir o mapeamento para o final de uma associação de modelo conceitual, ele é filho de um elemento AssociationSetMapping. Quando o elemento EndProperty é usado para definir o mapeamento para uma função de modificação de uma associação de modelo conceitual, ele é filho de um elemento InsertFunction ou elemento DeleteFunction.
O elemento EndProperty pode ter os seguintes elementos filho:
- ScalarProperty (zero ou mais)
Atributos aplicáveis
A tabela a seguir descreve os atributos aplicáveis ao elemento EndProperty:
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| Nome | Sim | O nome do fim da associação que está sendo mapeado. |
Exemplo
O exemplo a seguir mostra um elemento AssociationSetMapping no qual a associação FK_Course_Department no modelo conceitual é mapeada para a tabela Course no banco de dados. Os mapeamentos entre propriedades de tipo de associação e colunas de tabela são especificados em elementos filho EndProperty.
<AssociationSetMapping Name="FK_Course_Department"
TypeName="SchoolModel.FK_Course_Department"
StoreEntitySet="Course">
<EndProperty Name="Department">
<ScalarProperty Name="DepartmentID" ColumnName="DepartmentID" />
</EndProperty>
<EndProperty Name="Course">
<ScalarProperty Name="CourseID" ColumnName="CourseID" />
</EndProperty>
</AssociationSetMapping>
Exemplo
O exemplo a seguir mostra o elemento EndProperty mapeando as funções de inserção e exclusão de uma associação (CourseInstructor) para procedimentos armazenados no banco de dados subjacente. As funções mapeadas para são declaradas no modelo de armazenamento.
<AssociationSetMapping Name="CourseInstructor"
TypeName="SchoolModel.CourseInstructor"
StoreEntitySet="CourseInstructor">
<EndProperty Name="Person">
<ScalarProperty Name="PersonID" ColumnName="PersonID" />
</EndProperty>
<EndProperty Name="Course">
<ScalarProperty Name="CourseID" ColumnName="CourseID" />
</EndProperty>
<ModificationFunctionMapping>
<InsertFunction FunctionName="SchoolModel.Store.InsertCourseInstructor" >
<EndProperty Name="Course">
<ScalarProperty Name="CourseID" ParameterName="courseId"/>
</EndProperty>
<EndProperty Name="Person">
<ScalarProperty Name="PersonID" ParameterName="instructorId"/>
</EndProperty>
</InsertFunction>
<DeleteFunction FunctionName="SchoolModel.Store.DeleteCourseInstructor">
<EndProperty Name="Course">
<ScalarProperty Name="CourseID" ParameterName="courseId"/>
</EndProperty>
<EndProperty Name="Person">
<ScalarProperty Name="PersonID" ParameterName="instructorId"/>
</EndProperty>
</DeleteFunction>
</ModificationFunctionMapping>
</AssociationSetMapping>
Elemento EntityContainerMapping (MSL)
O elemento EntityContainerMapping na linguagem de especificação de mapeamento (MSL) mapeia o contêiner de entidade no modelo conceitual para o contêiner de entidade no modelo de armazenamento. O elemento EntityContainerMapping é filho do elemento de Mapeamento.
O elemento EntityContainerMapping pode ter os seguintes elementos filho (na ordem listada):
- EntitySetMapping (zero ou mais)
- AssociationSetMapping (zero ou mais)
- FunctionImportMapping (zero ou mais)
Atributos aplicáveis
A tabela a seguir descreve os atributos que podem ser aplicados ao elemento EntityContainerMapping.
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| StorageModelContainer | Sim | O nome do contêiner de entidade do modelo de armazenamento que está sendo mapeado. |
| CdmEntityContainer | Sim | O nome do contêiner de entidade de modelo conceitual que está sendo mapeado. |
| GenerateUpdateViews | Não | True ou False. Se False, nenhuma exibição de atualização será gerada. Esse atributo deve ser definido como False quando você tiver um mapeamento somente leitura que seria inválido porque os dados podem não ser bem-sucedidos. O valor padrão é True. |
Exemplo
O exemplo a seguir mostra um elemento EntityContainerMapping que mapeia o contêiner SchoolModelEntities (o contêiner de entidade de modelo conceitual) para o contêiner SchoolModelStoreContainer (o contêiner de entidade do modelo de armazenamento):
<EntityContainerMapping StorageEntityContainer="SchoolModelStoreContainer"
CdmEntityContainer="SchoolModelEntities">
<EntitySetMapping Name="Courses">
<EntityTypeMapping TypeName="c.Course">
<MappingFragment StoreEntitySet="Course">
<ScalarProperty Name="CourseID" ColumnName="CourseID" />
<ScalarProperty Name="Title" ColumnName="Title" />
<ScalarProperty Name="Credits" ColumnName="Credits" />
<ScalarProperty Name="DepartmentID" ColumnName="DepartmentID" />
</MappingFragment>
</EntityTypeMapping>
</EntitySetMapping>
<EntitySetMapping Name="Departments">
<EntityTypeMapping TypeName="c.Department">
<MappingFragment StoreEntitySet="Department">
<ScalarProperty Name="DepartmentID" ColumnName="DepartmentID" />
<ScalarProperty Name="Name" ColumnName="Name" />
<ScalarProperty Name="Budget" ColumnName="Budget" />
<ScalarProperty Name="StartDate" ColumnName="StartDate" />
<ScalarProperty Name="Administrator" ColumnName="Administrator" />
</MappingFragment>
</EntityTypeMapping>
</EntitySetMapping>
</EntityContainerMapping>
Elemento EntitySetMapping (MSL)
O elemento EntitySetMapping na linguagem de especificação de mapeamento (MSL) mapeia todos os tipos em um conjunto de entidades de modelo conceitual definido para conjuntos de entidades no modelo de armazenamento. Um conjunto de entidades no modelo conceitual é um contêiner lógico para instâncias de entidades do mesmo tipo (e tipos derivados). Um conjunto de entidades no modelo de armazenamento representa uma tabela ou exibição no banco de dados subjacente. O conjunto de entidades do modelo conceitual é especificado pelo valor do atributo Name do elemento EntitySetMapping. A tabela ou exibição mapeada para é especificada pelo atributo StoreEntitySet em cada elemento filho MappingFragment ou no próprio elemento EntitySetMapping.
O elemento EntitySetMapping pode ter os seguintes elementos filho:
- EntityTypeMapping (zero ou mais)
- QueryView (zero ou um)
- MappingFragment (zero ou mais)
Atributos aplicáveis
A tabela a seguir descreve os atributos que podem ser aplicados ao elemento EntitySetMapping.
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| Nome | Sim | O nome do conjunto de entidades do modelo conceitual que está sendo mapeado. |
| TypeName1 | Não | O nome do tipo de entidade de modelo conceitual que está sendo mapeado. |
| StoreEntitySet1 | Não | O nome do conjunto de entidades do modelo de armazenamento para o qual está sendo mapeado. |
| MakeColumnsDistinct | Não | True ou False dependendo se apenas linhas distintas são retornadas. Se esse atributo for definido como True, o atributo GenerateUpdateViews do elemento EntityContainerMapping deverá ser definido como False. |
1 Os atributos TypeName e StoreEntitySet podem ser usados no lugar dos elementos filho EntityTypeMapping e MappingFragment para mapear um único tipo de entidade para uma única tabela.
Exemplo
O exemplo a seguir mostra um elemento EntitySetMapping que mapeia três tipos (um tipo base e dois tipos derivados) no conjunto de entidades Courses do modelo conceitual para três tabelas diferentes no banco de dados subjacente. As tabelas são especificadas pelo atributo StoreEntitySet em cada elemento MappingFragment.
<EntitySetMapping Name="Courses">
<EntityTypeMapping TypeName="IsTypeOf(SchoolModel1.Course)">
<MappingFragment StoreEntitySet="Course">
<ScalarProperty Name="CourseID" ColumnName="CourseID" />
<ScalarProperty Name="DepartmentID" ColumnName="DepartmentID" />
<ScalarProperty Name="Credits" ColumnName="Credits" />
<ScalarProperty Name="Title" ColumnName="Title" />
</MappingFragment>
</EntityTypeMapping>
<EntityTypeMapping TypeName="IsTypeOf(SchoolModel1.OnlineCourse)">
<MappingFragment StoreEntitySet="OnlineCourse">
<ScalarProperty Name="CourseID" ColumnName="CourseID" />
<ScalarProperty Name="URL" ColumnName="URL" />
</MappingFragment>
</EntityTypeMapping>
<EntityTypeMapping TypeName="IsTypeOf(SchoolModel1.OnsiteCourse)">
<MappingFragment StoreEntitySet="OnsiteCourse">
<ScalarProperty Name="CourseID" ColumnName="CourseID" />
<ScalarProperty Name="Time" ColumnName="Time" />
<ScalarProperty Name="Days" ColumnName="Days" />
<ScalarProperty Name="Location" ColumnName="Location" />
</MappingFragment>
</EntityTypeMapping>
</EntitySetMapping>
Elemento EntityTypeMapping (MSL)
O elemento EntityTypeMapping na linguagem de especificação de mapeamento (MSL) define o mapeamento entre um tipo de entidade no modelo conceitual e tabelas ou exibições no banco de dados subjacente. Para obter informações sobre tipos de entidade de modelo conceitual e tabelas ou exibições de banco de dados subjacentes, consulte Elemento EntityType (CSDL) e Elemento EntitySet (SSDL). O tipo de entidade de modelo conceitual que está sendo mapeado é especificado pelo atributo TypeName do elemento EntityTypeMapping. A tabela ou exibição que está sendo mapeada é especificada pelo atributo StoreEntitySet do elemento filho MappingFragment.
O elemento filho ModificationFunctionMapping pode ser usado para mapear as funções de inserção, atualização ou exclusão de tipos de entidade para procedimentos armazenados no banco de dados.
O elemento EntityTypeMapping pode ter os seguintes elementos filho:
- MappingFragment (zero ou mais)
- ModificationFunctionMapping (zero ou um)
- ScalarProperty
- Condição
Observação
Os elementos MappingFragment e ModificationFunctionMapping não podem ser elementos filho do elemento EntityTypeMapping ao mesmo tempo.
Observação
Os elementos ScalarProperty e Condition só podem ser elementos filho do elemento EntityTypeMapping quando ele é usado em um elemento FunctionImportMapping.
Atributos aplicáveis
A tabela a seguir descreve os atributos que podem ser aplicados ao elemento EntityTypeMapping.
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| TypeName | Sim | O nome qualificado para namespace do tipo de entidade de modelo conceitual que está sendo mapeado. Se o tipo for abstrato ou derivado, o valor deverá ser IsOfType(Namespace-qualified_type_name). |
Exemplo
O exemplo a seguir mostra um elemento EntitySetMapping com dois elementos filho EntityTypeMapping. No primeiro elemento EntityTypeMapping, o tipo de entidade SchoolModel.Person é mapeado para a tabela Person. No segundo elemento EntityTypeMapping, a funcionalidade de atualização do tipo SchoolModel.Person é mapeada para um procedimento armazenado, UpdatePerson, no banco de dados.
<EntitySetMapping Name="People">
<EntityTypeMapping TypeName="SchoolModel.Person">
<MappingFragment StoreEntitySet="Person">
<ScalarProperty Name="PersonID" ColumnName="PersonID" />
<ScalarProperty Name="LastName" ColumnName="LastName" />
<ScalarProperty Name="FirstName" ColumnName="FirstName" />
<ScalarProperty Name="HireDate" ColumnName="HireDate" />
<ScalarProperty Name="EnrollmentDate" ColumnName="EnrollmentDate" />
</MappingFragment>
</EntityTypeMapping>
<EntityTypeMapping TypeName="SchoolModel.Person">
<ModificationFunctionMapping>
<UpdateFunction FunctionName="SchoolModel.Store.UpdatePerson">
<ScalarProperty Name="EnrollmentDate" ParameterName="EnrollmentDate"
Version="Current" />
<ScalarProperty Name="HireDate" ParameterName="HireDate"
Version="Current" />
<ScalarProperty Name="FirstName" ParameterName="FirstName"
Version="Current" />
<ScalarProperty Name="LastName" ParameterName="LastName"
Version="Current" />
<ScalarProperty Name="PersonID" ParameterName="PersonID"
Version="Current" />
</UpdateFunction>
</ModificationFunctionMapping>
</EntityTypeMapping>
</EntitySetMapping>
Exemplo
O próximo exemplo mostra o mapeamento de uma hierarquia de tipos na qual o tipo raiz é abstrato. Observe o uso da sintaxe IsOfType para os atributos TypeName.
<EntitySetMapping Name="People">
<EntityTypeMapping TypeName="IsTypeOf(SchoolModel.Person)">
<MappingFragment StoreEntitySet="Person">
<ScalarProperty Name="PersonID" ColumnName="PersonID" />
<ScalarProperty Name="FirstName" ColumnName="FirstName" />
<ScalarProperty Name="LastName" ColumnName="LastName" />
</MappingFragment>
</EntityTypeMapping>
<EntityTypeMapping TypeName="IsTypeOf(SchoolModel.Instructor)">
<MappingFragment StoreEntitySet="Person">
<ScalarProperty Name="PersonID" ColumnName="PersonID" />
<ScalarProperty Name="HireDate" ColumnName="HireDate" />
<Condition ColumnName="HireDate" IsNull="false" />
<Condition ColumnName="EnrollmentDate" IsNull="true" />
</MappingFragment>
</EntityTypeMapping>
<EntityTypeMapping TypeName="IsTypeOf(SchoolModel.Student)">
<MappingFragment StoreEntitySet="Person">
<ScalarProperty Name="PersonID" ColumnName="PersonID" />
<ScalarProperty Name="EnrollmentDate"
ColumnName="EnrollmentDate" />
<Condition ColumnName="EnrollmentDate" IsNull="false" />
<Condition ColumnName="HireDate" IsNull="true" />
</MappingFragment>
</EntityTypeMapping>
</EntitySetMapping>
Elemento FunctionImportMapping (MSL)
O elemento FunctionImportMapping na linguagem de especificação de mapeamento (MSL) define o mapeamento entre uma importação de função no modelo conceitual e um procedimento armazenado ou função no banco de dados subjacente. As importações de função devem ser declaradas no modelo conceitual e os procedimentos armazenados devem ser declarados no modelo de armazenamento. Para obter mais informações, consulte Elemento FunctionImport (CSDL) e Elemento de função (SSDL).
Observação
Por padrão, se uma importação de função retornar um tipo de entidade de modelo conceitual ou um tipo complexo, os nomes das colunas retornadas pelo procedimento armazenado subjacente deverão corresponder exatamente aos nomes das propriedades no tipo de modelo conceitual. Se os nomes das colunas não corresponderem exatamente aos nomes das propriedades, o mapeamento deverá ser definido em um elemento ResultMapping.
O elemento FunctionImportMapping pode ter os seguintes elementos filho:
- ResultMapping (zero ou mais)
Atributos aplicáveis
A tabela a seguir descreve os atributos aplicáveis ao elemento FunctionImportMapping:
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| FunctionImportName | Sim | O nome da importação de função no modelo conceitual que está sendo mapeado. |
| FunctionName | Sim | O nome qualificado do namespace da função no modelo de armazenamento que está sendo mapeado. |
Exemplo
O exemplo a seguir é baseado no modelo Escola. Considere a seguinte função no modelo de armazenamento:
<Function Name="GetStudentGrades" Aggregate="false"
BuiltIn="false" NiladicFunction="false"
IsComposable="false" ParameterTypeSemantics="AllowImplicitConversion"
Schema="dbo">
<Parameter Name="StudentID" Type="int" Mode="In" />
</Function>
Considere também essa função de importação no modelo conceitual:
<FunctionImport Name="GetStudentGrades" EntitySet="StudentGrades"
ReturnType="Collection(SchoolModel.StudentGrade)">
<Parameter Name="StudentID" Mode="In" Type="Int32" />
</FunctionImport>
O exemplo a seguir mostra um elemento FunctionImportMapping usado para mapear a função e a importação de função acima uma para a outra:
<FunctionImportMapping FunctionImportName="GetStudentGrades"
FunctionName="SchoolModel.Store.GetStudentGrades" />
Elemento InsertFunction (MSL)
O elemento InsertFunction na linguagem de especificação de mapeamento (MSL) mapeia a função de inserção de um tipo de entidade ou associação no modelo conceitual para um procedimento armazenado no banco de dados subjacente. Os procedimentos armazenados para os quais as funções de modificação são mapeadas devem ser declarados no modelo de armazenamento. Para obter mais informações, consulte Elemento de função (SSDL).
Observação
Se você não mapear todas as três operações de inserção, atualização ou exclusão de um tipo de entidade para procedimentos armazenados, as operações não mapeadas falharão se executadas em tempo de execução e um UpdateException for lançado.
O elemento InsertFunction pode ser um filho do elemento ModificationFunctionMapping e aplicado ao elemento EntityTypeMapping ou ao elemento AssociationSetMapping.
InsertFunction aplicado a EntityTypeMapping
Quando aplicado ao elemento EntityTypeMapping, o elemento InsertFunction mapeia a função de inserção de um tipo de entidade no modelo conceitual para um procedimento armazenado.
O elemento InsertFunction pode ter os seguintes elementos filho quando aplicado a um elemento EntityTypeMapping:
- AssociationEnd (zero ou mais)
- ComplexProperty (zero ou mais)
- ResultBinding (zero ou um)
- ScalarProperty (zero ou mais)
Atributos aplicáveis
A tabela a seguir descreve os atributos que podem ser aplicados ao elemento InsertFunction quando aplicados a um elemento EntityTypeMapping.
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| FunctionName | Sim | O nome qualificado para namespace do procedimento armazenado para o qual a função de inserção é mapeada. O procedimento armazenado deve ser declarado no modelo de armazenamento. |
| RowsAffectedParameter | Não | O nome do parâmetro de saída que retorna o número de linhas afetadas. |
Exemplo
O exemplo a seguir é baseado no modelo Escola e mostra o elemento InsertFunction usado para mapear a função de inserção do tipo de entidade Person para o procedimento armazenado InsertPerson. O procedimento armazenado InsertPerson é declarado no modelo de armazenamento.
<EntityTypeMapping TypeName="SchoolModel.Person">
<ModificationFunctionMapping>
<InsertFunction FunctionName="SchoolModel.Store.InsertPerson">
<ScalarProperty Name="EnrollmentDate"
ParameterName="EnrollmentDate" />
<ScalarProperty Name="HireDate" ParameterName="HireDate" />
<ScalarProperty Name="FirstName" ParameterName="FirstName" />
<ScalarProperty Name="LastName" ParameterName="LastName" />
<ResultBinding Name="PersonID" ColumnName="NewPersonID" />
</InsertFunction>
<UpdateFunction FunctionName="SchoolModel.Store.UpdatePerson">
<ScalarProperty Name="EnrollmentDate"
ParameterName="EnrollmentDate"
Version="Current" />
<ScalarProperty Name="HireDate" ParameterName="HireDate"
Version="Current" />
<ScalarProperty Name="FirstName" ParameterName="FirstName"
Version="Current" />
<ScalarProperty Name="LastName" ParameterName="LastName"
Version="Current" />
<ScalarProperty Name="PersonID" ParameterName="PersonID"
Version="Current" />
</UpdateFunction>
<DeleteFunction FunctionName="SchoolModel.Store.DeletePerson">
<ScalarProperty Name="PersonID" ParameterName="PersonID" />
</DeleteFunction>
</ModificationFunctionMapping>
</EntityTypeMapping>
InsertFunction aplicado a AssociationSetMapping
Quando aplicado ao elemento AssociationSetMapping, o elemento InsertFunction mapeia a função de inserção de uma associação no modelo conceitual para um procedimento armazenado.
O elemento InsertFunction pode ter os seguintes elementos filho quando aplicado ao elemento AssociationSetMapping:
- EndProperty
Atributos aplicáveis
A tabela a seguir descreve os atributos que podem ser aplicados ao elemento InsertFunction quando ele é aplicado ao elemento AssociationSetMapping.
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| FunctionName | Sim | O nome qualificado para namespace do procedimento armazenado para o qual a função de inserção é mapeada. O procedimento armazenado deve ser declarado no modelo de armazenamento. |
| RowsAffectedParameter | Não | O nome do parâmetro de saída que retorna o número de linhas afetadas. |
Exemplo
O exemplo a seguir é baseado no modelo School e mostra o elemento InsertFunction usado para mapear a função de inserção da associação CourseInstructor ao procedimento armazenado InsertCourseInstructor. O procedimento armazenado InsertCourseInstructor é declarado no modelo de armazenamento.
<AssociationSetMapping Name="CourseInstructor"
TypeName="SchoolModel.CourseInstructor"
StoreEntitySet="CourseInstructor">
<EndProperty Name="Person">
<ScalarProperty Name="PersonID" ColumnName="PersonID" />
</EndProperty>
<EndProperty Name="Course">
<ScalarProperty Name="CourseID" ColumnName="CourseID" />
</EndProperty>
<ModificationFunctionMapping>
<InsertFunction FunctionName="SchoolModel.Store.InsertCourseInstructor" >
<EndProperty Name="Course">
<ScalarProperty Name="CourseID" ParameterName="courseId"/>
</EndProperty>
<EndProperty Name="Person">
<ScalarProperty Name="PersonID" ParameterName="instructorId"/>
</EndProperty>
</InsertFunction>
<DeleteFunction FunctionName="SchoolModel.Store.DeleteCourseInstructor">
<EndProperty Name="Course">
<ScalarProperty Name="CourseID" ParameterName="courseId"/>
</EndProperty>
<EndProperty Name="Person">
<ScalarProperty Name="PersonID" ParameterName="instructorId"/>
</EndProperty>
</DeleteFunction>
</ModificationFunctionMapping>
</AssociationSetMapping>
Elemento de mapeamento (MSL)
O elemento Mapeamento na linguagem de especificação de mapeamento (MSL) contém informações para mapear objetos que são definidos em um modelo conceitual para um banco de dados (conforme descrito em um modelo de armazenamento). Para obter mais informações, consulte Especificação CSDL e Especificação SSDL.
O elemento Mapping é o elemento raiz de uma especificação de mapeamento. O namespace XML para especificações de mapeamento é https://schemas.microsoft.com/ado/2009/11/mapping/cs.
O elemento de mapeamento pode ter os seguintes elementos filho (na ordem listada):
- Alias (zero ou mais)
- EntityContainerMapping (exatamente um)
Os nomes dos tipos de modelo conceitual e de armazenamento referenciados no MSL devem ser qualificados por seus respectivos nomes de namespace. Para obter informações sobre o nome do namespace do modelo conceitual, consulte Elemento de esquema (CSDL). Para obter informações sobre o nome do namespace do modelo de armazenamento, consulte Elemento de esquema (SSDL). Os aliases para namespaces usados no MSL podem ser definidos com o elemento Alias.
Atributos aplicáveis
A tabela abaixo descreve os atributos que podem ser aplicados ao elemento Mapping.
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| Space | Sim | C-S. Este é um valor fixo e não pode ser alterado. |
Exemplo
O exemplo a seguir mostra um elemento Mapping baseado em parte do modelo Escola. Para obter mais informações sobre o modelo School, consulte o Guia de início rápido (Entity Framework):
<Mapping Space="C-S"
xmlns="https://schemas.microsoft.com/ado/2009/11/mapping/cs">
<Alias Key="c" Value="SchoolModel"/>
<EntityContainerMapping StorageEntityContainer="SchoolModelStoreContainer"
CdmEntityContainer="SchoolModelEntities">
<EntitySetMapping Name="Courses">
<EntityTypeMapping TypeName="c.Course">
<MappingFragment StoreEntitySet="Course">
<ScalarProperty Name="CourseID" ColumnName="CourseID" />
<ScalarProperty Name="Title" ColumnName="Title" />
<ScalarProperty Name="Credits" ColumnName="Credits" />
<ScalarProperty Name="DepartmentID" ColumnName="DepartmentID" />
</MappingFragment>
</EntityTypeMapping>
</EntitySetMapping>
<EntitySetMapping Name="Departments">
<EntityTypeMapping TypeName="c.Department">
<MappingFragment StoreEntitySet="Department">
<ScalarProperty Name="DepartmentID" ColumnName="DepartmentID" />
<ScalarProperty Name="Name" ColumnName="Name" />
<ScalarProperty Name="Budget" ColumnName="Budget" />
<ScalarProperty Name="StartDate" ColumnName="StartDate" />
<ScalarProperty Name="Administrator" ColumnName="Administrator" />
</MappingFragment>
</EntityTypeMapping>
</EntitySetMapping>
</EntityContainerMapping>
</Mapping>
Elemento MappingFragment (MSL)
O elemento MappingFragment na linguagem de especificação de mapeamento (MSL) define o mapeamento entre as propriedades de um tipo de entidade de modelo conceitual e uma tabela ou exibição no banco de dados. Para obter informações sobre tipos de entidade de modelo conceitual e tabelas ou exibições de banco de dados subjacentes, consulte Elemento EntityType (CSDL) e Elemento EntitySet (SSDL). O MappingFragment pode ser um elemento filho do elemento EntityTypeMapping ou do elemento EntitySetMapping.
O elemento MappingFragment pode ter os seguintes elementos filho:
- ComplexType (zero ou mais)
- ScalarProperty (zero ou mais)
- Condição (zero ou mais)
Atributos aplicáveis
A tabela a seguir descreve os atributos que podem ser aplicados ao elemento MappingFragment.
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| StoreEntitySet | Sim | O nome da tabela ou exibição que está sendo mapeada. |
| MakeColumnsDistinct | Não | True ou False dependendo se apenas linhas distintas são retornadas. Se esse atributo for definido como True, o atributo GenerateUpdateViews do elemento EntityContainerMapping deverá ser definido como False. |
Exemplo
O exemplo a seguir mostra um elemento MappingFragment como filho de um elemento EntityTypeMapping. Neste exemplo, as propriedades do tipo Course no modelo conceitual são mapeadas para colunas da tabela Course no banco de dados.
<EntitySetMapping Name="Courses">
<EntityTypeMapping TypeName="SchoolModel.Course">
<MappingFragment StoreEntitySet="Course">
<ScalarProperty Name="CourseID" ColumnName="CourseID" />
<ScalarProperty Name="Title" ColumnName="Title" />
<ScalarProperty Name="Credits" ColumnName="Credits" />
<ScalarProperty Name="DepartmentID" ColumnName="DepartmentID" />
</MappingFragment>
</EntityTypeMapping>
</EntitySetMapping>
Exemplo
O exemplo a seguir mostra um elemento MappingFragment como filho de um elemento EntitySetMapping. Como no exemplo acima, as propriedades do tipo Course no modelo conceitual são mapeadas para colunas da tabela Course no banco de dados.
<EntitySetMapping Name="Courses" TypeName="SchoolModel.Course">
<MappingFragment StoreEntitySet="Course">
<ScalarProperty Name="CourseID" ColumnName="CourseID" />
<ScalarProperty Name="Title" ColumnName="Title" />
<ScalarProperty Name="Credits" ColumnName="Credits" />
<ScalarProperty Name="DepartmentID" ColumnName="DepartmentID" />
</MappingFragment>
</EntitySetMapping>
Elemento ModificationFunctionMapping (MSL)
O elemento ModificationFunctionMapping na linguagem de especificação de mapeamento (MSL) mapeia as funções de inserção, atualização e exclusão de um tipo de entidade de modelo conceitual para procedimentos armazenados no banco de dados subjacente. O elemento ModificationFunctionMapping também pode mapear as funções de inserção e exclusão para associações muitos-para-muitos no modelo conceitual para procedimentos armazenados no banco de dados subjacente. Os procedimentos armazenados para os quais as funções de modificação são mapeadas devem ser declarados no modelo de armazenamento. Para obter mais informações, consulte Elemento de função (SSDL).
Observação
Se você não mapear todas as três operações de inserção, atualização ou exclusão de um tipo de entidade para procedimentos armazenados, as operações não mapeadas falharão se executadas em tempo de execução e um UpdateException for lançado.
Observação
Se as funções de modificação de uma entidade em uma hierarquia de herança forem mapeadas para procedimentos armazenados, as funções de modificação para todos os tipos na hierarquia deverão ser mapeadas para procedimentos armazenados.
O elemento ModificationFunctionMapping pode ser filho do elemento EntityTypeMapping ou do elemento AssociationSetMapping.
O elemento ModificationFunctionMapping pode ter os seguintes elementos filho:
- DeleteFunction (zero ou um)
- InsertFunction (zero ou um)
- UpdateFunction (zero ou um)
Nenhum atributo é aplicável ao elemento ModificationFunctionMapping.
Exemplo
O exemplo a seguir mostra o mapeamento do conjunto de entidades para o conjunto de entidades People no modelo Escola. Além do mapeamento de coluna para o tipo de entidade People, o mapeamento das funções de inserção, atualização e exclusão do tipo People é mostrado. As funções mapeadas para são declaradas no modelo de armazenamento.
<EntitySetMapping Name="People">
<EntityTypeMapping TypeName="SchoolModel.Person">
<MappingFragment StoreEntitySet="Person">
<ScalarProperty Name="PersonID" ColumnName="PersonID" />
<ScalarProperty Name="LastName" ColumnName="LastName" />
<ScalarProperty Name="FirstName" ColumnName="FirstName" />
<ScalarProperty Name="HireDate" ColumnName="HireDate" />
<ScalarProperty Name="EnrollmentDate"
ColumnName="EnrollmentDate" />
</MappingFragment>
</EntityTypeMapping>
<EntityTypeMapping TypeName="SchoolModel.Person">
<ModificationFunctionMapping>
<InsertFunction FunctionName="SchoolModel.Store.InsertPerson">
<ScalarProperty Name="EnrollmentDate"
ParameterName="EnrollmentDate" />
<ScalarProperty Name="HireDate" ParameterName="HireDate" />
<ScalarProperty Name="FirstName" ParameterName="FirstName" />
<ScalarProperty Name="LastName" ParameterName="LastName" />
<ResultBinding Name="PersonID" ColumnName="NewPersonID" />
</InsertFunction>
<UpdateFunction FunctionName="SchoolModel.Store.UpdatePerson">
<ScalarProperty Name="EnrollmentDate"
ParameterName="EnrollmentDate"
Version="Current" />
<ScalarProperty Name="HireDate" ParameterName="HireDate"
Version="Current" />
<ScalarProperty Name="FirstName" ParameterName="FirstName"
Version="Current" />
<ScalarProperty Name="LastName" ParameterName="LastName"
Version="Current" />
<ScalarProperty Name="PersonID" ParameterName="PersonID"
Version="Current" />
</UpdateFunction>
<DeleteFunction FunctionName="SchoolModel.Store.DeletePerson">
<ScalarProperty Name="PersonID" ParameterName="PersonID" />
</DeleteFunction>
</ModificationFunctionMapping>
</EntityTypeMapping>
</EntitySetMapping>
Exemplo
O exemplo a seguir mostra o mapeamento do conjunto de associações para o conjunto de associação CourseInstructor no modelo School. Além do mapeamento de coluna para a associação CourseInstructor o mapeamento das funções de inserção e exclusão da associação CourseInstructor são mostrados. As funções mapeadas para são declaradas no modelo de armazenamento.
<AssociationSetMapping Name="CourseInstructor"
TypeName="SchoolModel.CourseInstructor"
StoreEntitySet="CourseInstructor">
<EndProperty Name="Person">
<ScalarProperty Name="PersonID" ColumnName="PersonID" />
</EndProperty>
<EndProperty Name="Course">
<ScalarProperty Name="CourseID" ColumnName="CourseID" />
</EndProperty>
<ModificationFunctionMapping>
<InsertFunction FunctionName="SchoolModel.Store.InsertCourseInstructor" >
<EndProperty Name="Course">
<ScalarProperty Name="CourseID" ParameterName="courseId"/>
</EndProperty>
<EndProperty Name="Person">
<ScalarProperty Name="PersonID" ParameterName="instructorId"/>
</EndProperty>
</InsertFunction>
<DeleteFunction FunctionName="SchoolModel.Store.DeleteCourseInstructor">
<EndProperty Name="Course">
<ScalarProperty Name="CourseID" ParameterName="courseId"/>
</EndProperty>
<EndProperty Name="Person">
<ScalarProperty Name="PersonID" ParameterName="instructorId"/>
</EndProperty>
</DeleteFunction>
</ModificationFunctionMapping>
</AssociationSetMapping>
Elemento QueryView (MSL)
O elemento QueryView na linguagem de especificação de mapeamento (MSL) define um mapeamento somente leitura entre um tipo de entidade ou associação no modelo conceitual e uma tabela no banco de dados subjacente. O mapeamento é definido com uma consulta Entity SQL que é avaliada em relação ao modelo de armazenamento e você expressa o conjunto de resultados em termos de uma entidade ou associação no modelo conceitual. Como os modos de exibição de consulta são somente leitura, você não pode usar comandos de atualização padrão para atualizar tipos definidos por modos de exibição de consulta. Você pode fazer atualizações para esses tipos usando funções de modificação. Para obter mais informações, consulte Como: mapear funções de modificação para procedimentos armazenados.
Observação
No elemento QueryView não há suporte para expressões Entity SQL que contêm GroupBy, agregações de grupo ou propriedades de navegação.
O elemento QueryView pode ser um filho do elemento EntitySetMapping ou do elemento AssociationSetMapping. No primeiro caso, o modo de exibição de consulta define um mapeamento somente leitura para uma entidade no modelo conceitual. No último caso, o modo de exibição de consulta define um mapeamento somente leitura para uma associação no modelo conceitual.
Observação
Se o elemento AssociationSetMapping for para uma associação com uma restrição referencial, o elemento AssociationSetMapping será ignorado. Para obter mais informações, consulte Elemento ReferentialConstraint (CSDL).
O elemento QueryView não pode ter nenhum elemento filho.
Atributos aplicáveis
A tabela a seguir descreve os atributos que podem ser aplicados ao elemento QueryView.
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| TypeName | Não | O nome do tipo de modelo conceitual que está sendo mapeado pelo modo de exibição de consulta. |
Exemplo
O exemplo a seguir mostra o elemento QueryView como filho do elemento EntitySetMapping e define um mapeamento de exibição de consulta para o tipo de entidade Department no Modelo Escolar.
<EntitySetMapping Name="Departments" >
<QueryView>
SELECT VALUE SchoolModel.Department(d.DepartmentID,
d.Name,
d.Budget,
d.StartDate)
FROM SchoolModelStoreContainer.Department AS d
WHERE d.Budget > 150000
</QueryView>
</EntitySetMapping>
Como a consulta retorna apenas um subconjunto dos membros do tipo Departament no modelo de armazenamento, o tipo Departament no modelo Escola foi modificado com base nesse mapeamento da seguinte maneira:
<EntityType Name="Department">
<Key>
<PropertyRef Name="DepartmentID" />
</Key>
<Property Type="Int32" Name="DepartmentID" Nullable="false" />
<Property Type="String" Name="Name" Nullable="false"
MaxLength="50" FixedLength="false" Unicode="true" />
<Property Type="Decimal" Name="Budget" Nullable="false"
Precision="19" Scale="4" />
<Property Type="DateTime" Name="StartDate" Nullable="false" />
<NavigationProperty Name="Courses"
Relationship="SchoolModel.FK_Course_Department"
FromRole="Department" ToRole="Course" />
</EntityType>
Exemplo
O próximo exemplo mostra o elemento QueryView como filho de um elemento AssociationSetMapping e define um mapeamento somente leitura para a associação FK_Course_Department no modelo Escola.
<EntityContainerMapping StorageEntityContainer="SchoolModelStoreContainer"
CdmEntityContainer="SchoolEntities">
<EntitySetMapping Name="Courses" >
<QueryView>
SELECT VALUE SchoolModel.Course(c.CourseID,
c.Title,
c.Credits)
FROM SchoolModelStoreContainer.Course AS c
</QueryView>
</EntitySetMapping>
<EntitySetMapping Name="Departments" >
<QueryView>
SELECT VALUE SchoolModel.Department(d.DepartmentID,
d.Name,
d.Budget,
d.StartDate)
FROM SchoolModelStoreContainer.Department AS d
WHERE d.Budget > 150000
</QueryView>
</EntitySetMapping>
<AssociationSetMapping Name="FK_Course_Department" >
<QueryView>
SELECT VALUE SchoolModel.FK_Course_Department(
CREATEREF(SchoolEntities.Departments, row(c.DepartmentID), SchoolModel.Department),
CREATEREF(SchoolEntities.Courses, row(c.CourseID)) )
FROM SchoolModelStoreContainer.Course AS c
</QueryView>
</AssociationSetMapping>
</EntityContainerMapping>
Comentários
Você pode definir modos de exibição de consulta para habilitar os seguintes cenários:
- Defina uma entidade no modelo conceitual que não inclua todas as propriedades da entidade no modelo de armazenamento. Isso inclui propriedades que não têm valores padrão e não oferecem suporte a valores null.
- Mapeie colunas computadas no modelo de armazenamento para propriedades de tipos de entidade no modelo conceitual.
- Defina um mapeamento em que as condições usadas para particionar entidades no modelo conceitual não sejam baseadas em igualdade. Quando você especifica um mapeamento condicional usando o elemento Condition, a condição fornecida deve ser igual ao valor especificado. Para obter mais informações, consulte Elemento de condição (MSL).
- Mapeie a mesma coluna no modelo de armazenamento para vários tipos no modelo conceitual.
- Mapeie vários tipos para a mesma tabela.
- Defina associações no modelo conceitual que não sejam baseadas em chaves estrangeiras no esquema relacional.
- Use a lógica de negócios personalizada para definir o valor das propriedades no modelo conceitual. Por exemplo, você pode mapear o valor de cadeia de caracteres "T" na fonte de dados para um valor de true, um booleano, no modelo conceitual.
- Defina filtros condicionais para os resultados da consulta.
- Imponha menos restrições aos dados no modelo conceitual do que no modelo de armazenamento. Por exemplo, você pode tornar uma propriedade no modelo conceitual anulável mesmo se a coluna para a qual ela é mapeada não oferecer suporte a valores null.
As considerações a seguir se aplicam quando você define modos de exibição de consulta para entidades:
- Os modos de exibição de consulta são somente leitura. Você só pode fazer atualizações em entidades usando funções de modificação.
- Ao definir um tipo de entidade por um modo de exibição de consulta, você também deve definir todas as entidades relacionadas por modos de exibição de consulta.
- Ao mapear uma associação de muitos para muitos para uma entidade no modelo de armazenamento que representa uma tabela de link no esquema relacional, você deve definir um elemento QueryView no elemento AssociationSetMapping para essa tabela de vínculo.
- Os modos de exibição de consulta devem ser definidos para todos os tipos em uma hierarquia de tipos. É possível fazer isso das seguintes maneiras:
-
- Com um único elemento QueryView que especifica uma única consulta Entity SQL que retorna uma união de todos os tipos de entidade na hierarquia.
- Com um único elemento QueryView que especifica uma única consulta Entity SQL que usa o operador CASE para retornar um tipo de entidade específico na hierarquia com base em uma condição específica.
- Com um elemento QueryView adicional para um tipo específico na hierarquia. Nesse caso, use o atributo TypeName do elemento QueryView para especificar o tipo de entidade para cada modo de exibição.
- Quando uma exibição de consulta é definida, não é possível especificar o atributo StorageSetName no elemento EntitySetMapping.
- Quando um modo de exibição de consulta é definido, o elemento EntitySetMapping também não pode conter mapeamentos de Property.
Elemento ResultBinding (MSL)
O elemento ResultBinding na linguagem de especificação de mapeamento (MSL) mapeia valores de coluna que são retornados por procedimentos armazenados para propriedades de entidade no modelo conceitual quando funções de modificação de tipo de entidade são mapeadas para procedimentos armazenados no banco de dados subjacente. Por exemplo, quando o valor de uma coluna de identidade é retornado por um procedimento armazenado de inserção, o elemento ResultBinding mapeia o valor retornado para uma propriedade de tipo de entidade no modelo conceitual.
O elemento ResultBinding pode ser filho do elemento InsertFunction ou do elemento UpdateFunction.
O elemento ResultBinding não pode ter nenhum elemento filho.
Atributos aplicáveis
A tabela a seguir descreve os atributos aplicáveis ao elemento ResultBinding:
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| Nome | Sim | O nome da propriedade entity no modelo conceitual que está sendo mapeado. |
| ColumnName | Sim | O nome da coluna que está sendo mapeada. |
Exemplo
O exemplo a seguir é baseado no modelo School e mostra um elemento InsertFunction usado para mapear a função de inserção do tipo de entidade Person para o procedimento armazenado InsertPerson. (O procedimento armazenado InsertPerson é mostrado abaixo e é declarado no modelo de armazenamento.) Um elemento ResultBinding é usado para mapear um valor de coluna que é retornado pelo procedimento armazenado (NewPersonID) para uma propriedade de tipo de entidade (PersonID).
<EntityTypeMapping TypeName="SchoolModel.Person">
<ModificationFunctionMapping>
<InsertFunction FunctionName="SchoolModel.Store.InsertPerson">
<ScalarProperty Name="EnrollmentDate"
ParameterName="EnrollmentDate" />
<ScalarProperty Name="HireDate" ParameterName="HireDate" />
<ScalarProperty Name="FirstName" ParameterName="FirstName" />
<ScalarProperty Name="LastName" ParameterName="LastName" />
<ResultBinding Name="PersonID" ColumnName="NewPersonID" />
</InsertFunction>
<UpdateFunction FunctionName="SchoolModel.Store.UpdatePerson">
<ScalarProperty Name="EnrollmentDate"
ParameterName="EnrollmentDate"
Version="Current" />
<ScalarProperty Name="HireDate" ParameterName="HireDate"
Version="Current" />
<ScalarProperty Name="FirstName" ParameterName="FirstName"
Version="Current" />
<ScalarProperty Name="LastName" ParameterName="LastName"
Version="Current" />
<ScalarProperty Name="PersonID" ParameterName="PersonID"
Version="Current" />
</UpdateFunction>
<DeleteFunction FunctionName="SchoolModel.Store.DeletePerson">
<ScalarProperty Name="PersonID" ParameterName="PersonID" />
</DeleteFunction>
</ModificationFunctionMapping>
</EntityTypeMapping>
O Transact-SQL a seguir descreve o procedimento armazenado InsertPerson:
CREATE PROCEDURE [dbo].[InsertPerson]
@LastName nvarchar(50),
@FirstName nvarchar(50),
@HireDate datetime,
@EnrollmentDate datetime
AS
INSERT INTO dbo.Person (LastName,
FirstName,
HireDate,
EnrollmentDate)
VALUES (@LastName,
@FirstName,
@HireDate,
@EnrollmentDate);
SELECT SCOPE_IDENTITY() as NewPersonID;
Elemento ResultMapping (MSL)
O elemento ResultMapping na linguagem de especificação de mapeamento (MSL) define o mapeamento entre uma importação de função no modelo conceitual e um procedimento armazenado no banco de dados subjacente quando as seguintes opções forem verdadeiras:
- A importação de função retorna um tipo de entidade de modelo conceitual ou tipo complexo.
- Os nomes das colunas retornadas pelo procedimento armazenado não correspondem exatamente aos nomes das propriedades no tipo entidade ou tipo complexo.
Por padrão, o mapeamento entre as colunas retornadas por um procedimento armazenado e um tipo de entidade ou tipo complexo é baseado em nomes de coluna e propriedade. Se os nomes de coluna não corresponderem exatamente aos nomes de propriedade, você deverá usar o elemento ResultMapping para definir o mapeamento. Para obter um exemplo do mapeamento padrão, consulte Elemento FunctionImportMapping (MSL).
O elemento ResultMapping é um elemento filho do elemento FunctionImportMapping.
O elemento ResultMapping pode ter os seguintes elementos filho:
- EntityTypeMapping (zero ou mais)
- ComplexTypeMapping
Nenhum atributo é aplicável ao elemento ResultMapping.
Exemplo
Considere o seguinte procedimento armazenado:
CREATE PROCEDURE [dbo].[GetGrades]
@student_Id int
AS
SELECT EnrollmentID as enroll_id,
Grade as grade,
CourseID as course_id,
StudentID as student_id
FROM dbo.StudentGrade
WHERE StudentID = @student_Id
Considere também o seguinte tipo de entidade de modelo conceitual:
<EntityType Name="StudentGrade">
<Key>
<PropertyRef Name="EnrollmentID" />
</Key>
<Property Name="EnrollmentID" Type="Int32" Nullable="false"
annotation:StoreGeneratedPattern="Identity" />
<Property Name="CourseID" Type="Int32" Nullable="false" />
<Property Name="StudentID" Type="Int32" Nullable="false" />
<Property Name="Grade" Type="Decimal" Precision="3" Scale="2" />
</EntityType>
Para criar uma importação de função que retorna instâncias do tipo entidade anterior, o mapeamento entre as colunas retornadas pelo procedimento armazenado e o tipo de entidade deve ser definido em um elemento ResultMapping:
<FunctionImportMapping FunctionImportName="GetGrades"
FunctionName="SchoolModel.Store.GetGrades" >
<ResultMapping>
<EntityTypeMapping TypeName="SchoolModel.StudentGrade">
<ScalarProperty Name="EnrollmentID" ColumnName="enroll_id"/>
<ScalarProperty Name="CourseID" ColumnName="course_id"/>
<ScalarProperty Name="StudentID" ColumnName="student_id"/>
<ScalarProperty Name="Grade" ColumnName="grade"/>
</EntityTypeMapping>
</ResultMapping>
</FunctionImportMapping>
Elemento ScalarProperty (MSL)
O elemento ScalarProperty na linguagem de especificação de mapeamento (MSL) mapeia uma propriedade em um tipo de entidade de modelo conceitual, tipo complexo ou associação a uma coluna de tabela ou parâmetro de procedimento armazenado no banco de dados subjacente.
Observação
Os procedimentos armazenados para os quais as funções de modificação são mapeadas devem ser declarados no modelo de armazenamento. Para obter mais informações, consulte Elemento de função (SSDL).
O elemento ScalarProperty pode ser filho dos seguintes elementos:
- MappingFragment
- InsertFunction
- UpdateFunction
- DeleteFunction
- EndProperty
- ComplexProperty
- Mapeamento de resultados
Como filho do elemento MappingFragment, ComplexProperty ou EndProperty, o elemento ScalarProperty mapeia uma propriedade no modelo conceitual para uma coluna no banco de dados. Como filho do elemento InsertFunction, UpdateFunction ou DeleteFunction, o elemento ScalarProperty mapeia uma propriedade no modelo conceitual para um parâmetro de procedimento armazenado.
O elemento ScalarProperty não pode ter nenhum elemento filho.
Atributos aplicáveis
Os atributos que se aplicam ao elemento ScalarProperty diferem dependendo da função do elemento.
A tabela a seguir descreve os atributos que são aplicáveis quando o elemento ScalarProperty é usado para mapear uma propriedade de modelo conceitual para uma coluna no banco de dados:
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| Nome | Sim | O nome da propriedade de modelo conceitual que está sendo mapeada. |
| ColumnName | Sim | O nome da coluna da tabela que está sendo mapeada. |
A tabela a seguir descreve os atributos que são aplicáveis ao elemento ScalarProperty quando ele é usado para mapear uma propriedade de modelo conceitual para um parâmetro de procedimento armazenado:
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| Nome | Sim | O nome da propriedade de modelo conceitual que está sendo mapeada. |
| ParameterName | Sim | O nome do parâmetro que está sendo mapeado. |
| Versão | Não | Atual ou Original dependendo se o valor atual ou o valor original da propriedade devem ser usados para verificações de simultaneidade. |
Exemplo
O exemplo a seguir mostra o elemento ScalarProperty usado de duas maneiras:
- Para mapear as propriedades do tipo de entidade Person para as colunas da tabela Person.
- Para mapear as propriedades do tipo de entidade Person para os parâmetros do procedimento armazenado UpdatePerson. Os procedimentos armazenados são declarados no modelo de armazenamento.
<EntitySetMapping Name="People">
<EntityTypeMapping TypeName="SchoolModel.Person">
<MappingFragment StoreEntitySet="Person">
<ScalarProperty Name="PersonID" ColumnName="PersonID" />
<ScalarProperty Name="LastName" ColumnName="LastName" />
<ScalarProperty Name="FirstName" ColumnName="FirstName" />
<ScalarProperty Name="HireDate" ColumnName="HireDate" />
<ScalarProperty Name="EnrollmentDate"
ColumnName="EnrollmentDate" />
</MappingFragment>
</EntityTypeMapping>
<EntityTypeMapping TypeName="SchoolModel.Person">
<ModificationFunctionMapping>
<InsertFunction FunctionName="SchoolModel.Store.InsertPerson">
<ScalarProperty Name="EnrollmentDate"
ParameterName="EnrollmentDate" />
<ScalarProperty Name="HireDate" ParameterName="HireDate" />
<ScalarProperty Name="FirstName" ParameterName="FirstName" />
<ScalarProperty Name="LastName" ParameterName="LastName" />
<ResultBinding Name="PersonID" ColumnName="NewPersonID" />
</InsertFunction>
<UpdateFunction FunctionName="SchoolModel.Store.UpdatePerson">
<ScalarProperty Name="EnrollmentDate"
ParameterName="EnrollmentDate"
Version="Current" />
<ScalarProperty Name="HireDate" ParameterName="HireDate"
Version="Current" />
<ScalarProperty Name="FirstName" ParameterName="FirstName"
Version="Current" />
<ScalarProperty Name="LastName" ParameterName="LastName"
Version="Current" />
<ScalarProperty Name="PersonID" ParameterName="PersonID"
Version="Current" />
</UpdateFunction>
<DeleteFunction FunctionName="SchoolModel.Store.DeletePerson">
<ScalarProperty Name="PersonID" ParameterName="PersonID" />
</DeleteFunction>
</ModificationFunctionMapping>
</EntityTypeMapping>
</EntitySetMapping>
Exemplo
O próximo exemplo mostra o elemento ScalarProperty usado para mapear as funções de inserção e exclusão de uma associação de modelo conceitual para procedimentos armazenados no banco de dados. Os procedimentos armazenados são declarados no modelo de armazenamento.
<AssociationSetMapping Name="CourseInstructor"
TypeName="SchoolModel.CourseInstructor"
StoreEntitySet="CourseInstructor">
<EndProperty Name="Person">
<ScalarProperty Name="PersonID" ColumnName="PersonID" />
</EndProperty>
<EndProperty Name="Course">
<ScalarProperty Name="CourseID" ColumnName="CourseID" />
</EndProperty>
<ModificationFunctionMapping>
<InsertFunction FunctionName="SchoolModel.Store.InsertCourseInstructor" >
<EndProperty Name="Course">
<ScalarProperty Name="CourseID" ParameterName="courseId"/>
</EndProperty>
<EndProperty Name="Person">
<ScalarProperty Name="PersonID" ParameterName="instructorId"/>
</EndProperty>
</InsertFunction>
<DeleteFunction FunctionName="SchoolModel.Store.DeleteCourseInstructor">
<EndProperty Name="Course">
<ScalarProperty Name="CourseID" ParameterName="courseId"/>
</EndProperty>
<EndProperty Name="Person">
<ScalarProperty Name="PersonID" ParameterName="instructorId"/>
</EndProperty>
</DeleteFunction>
</ModificationFunctionMapping>
</AssociationSetMapping>
Elemento UpdateFunction (MSL)
O elemento UpdateFunction na linguagem de especificação de mapeamento (MSL) mapeia a função de atualização de um tipo de entidade no modelo conceitual para um procedimento armazenado no banco de dados subjacente. Os procedimentos armazenados para os quais as funções de modificação são mapeadas devem ser declarados no modelo de armazenamento. Para obter mais informações, consulte Elemento de função (SSDL).
Observação
Se você não mapear todas as três operações de inserção, atualização ou exclusão de um tipo de entidade para procedimentos armazenados, as operações não mapeadas falharão se executadas em tempo de execução e um UpdateException for lançado.
O elemento UpdateFunction pode ser um filho do elemento ModificationFunctionMapping e aplicado ao elemento EntityTypeMapping.
O elemento UpdateFunction pode ter os seguintes elementos filho:
- AssociationEnd (zero ou mais)
- ComplexProperty (zero ou mais)
- ResultBinding (zero ou um)
- ScalarProperty (zero ou mais)
Atributos aplicáveis
A tabela a seguir descreve os atributos que podem ser aplicados ao elemento UpdateFunction.
| Nome do atributo | É Obrigatório | Valor |
|---|---|---|
| FunctionName | Sim | O nome qualificado para namespace do procedimento armazenado para o qual a função de atualização é mapeada. O procedimento armazenado deve ser declarado no modelo de armazenamento. |
| RowsAffectedParameter | Não | O nome do parâmetro de saída que retorna o número de linhas afetadas. |
Exemplo
O exemplo a seguir é baseado no modelo School e mostra o elemento UpdateFunction usado para mapear a função de atualização do tipo de entidade Person para o procedimento armazenado UpdatePerson. O procedimento armazenado UpdatePerson é declarado no modelo de armazenamento.
<EntityTypeMapping TypeName="SchoolModel.Person">
<ModificationFunctionMapping>
<InsertFunction FunctionName="SchoolModel.Store.InsertPerson">
<ScalarProperty Name="EnrollmentDate"
ParameterName="EnrollmentDate" />
<ScalarProperty Name="HireDate" ParameterName="HireDate" />
<ScalarProperty Name="FirstName" ParameterName="FirstName" />
<ScalarProperty Name="LastName" ParameterName="LastName" />
<ResultBinding Name="PersonID" ColumnName="NewPersonID" />
</InsertFunction>
<UpdateFunction FunctionName="SchoolModel.Store.UpdatePerson">
<ScalarProperty Name="EnrollmentDate"
ParameterName="EnrollmentDate"
Version="Current" />
<ScalarProperty Name="HireDate" ParameterName="HireDate"
Version="Current" />
<ScalarProperty Name="FirstName" ParameterName="FirstName"
Version="Current" />
<ScalarProperty Name="LastName" ParameterName="LastName"
Version="Current" />
<ScalarProperty Name="PersonID" ParameterName="PersonID"
Version="Current" />
</UpdateFunction>
<DeleteFunction FunctionName="SchoolModel.Store.DeletePerson">
<ScalarProperty Name="PersonID" ParameterName="PersonID" />
</DeleteFunction>
</ModificationFunctionMapping>
</EntityTypeMapping>
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de