CSDL 规范CSDL Specification

概念架构定义语言 (CSDL) 是一种基于 XML 的语言，它描述构成数据驱动应用程序的概念模型的实体、关系和函数。 此概念模型可由实体框架或 WCF 数据服务使用。 实体框架使用 CSDL 描述的元数据将概念模型中定义的实体和关系映射到数据源。 有关详细信息，请参阅SSDL 规范和MSL 规范。

CSDL 是实体数据模型的实体框架实现。

在实体框架应用程序中，概念模型元数据从 csdl 文件（用 CSDL 编写）加载到 EdmItemCollection 的实例中，可以使用中的方法进行访问。”System.object” 类。 实体框架使用概念模型元数据将针对概念模型的查询转换为特定于数据源的命令。

EF 设计器会在设计时将概念模型信息存储在 .edmx 文件中。 在生成时，EF 设计器使用 .edmx 文件中的信息来创建运行时实体框架所需的 csdl 文件。

CSDL 的版本按 XML 命名空间进行区分。

Association 元素 (CSDL)Association Element (CSDL)

Association元素定义了两个实体类型之间的关系。 关联必须指定关系中涉及的实体类型和关系的每一端可能的实体类型数量（也称为重数）。 关联端的多重性值可以为一（1）、零或一（0 ..1）或多（*）。 此信息在两个 End 子元素中指定。

通过导航属性或外键（如果在实体类型上公开了外键）可以访问关联一端的实体类型实例。

在应用程序中，关联的实例表示实体类型的实例之间的特定关联。 关联实例按逻辑分组在关联集中。

Association元素可以具有以下子元素（按所列顺序）：

• 文档（零个或一个元素）
• End （正好2个元素）
• ReferentialConstraint （零个或一个元素）
• 批注元素（零个或多个元素）

适用的属性Applicable Attributes

下表描述了可应用于Association元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于Association元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示一个association元素，该元素定义在Customer和Order实体类型上没有公开外键时的CustomerOrders关联。 关联的每个端点的多重性值指示可以将多个订单与一个客户关联，但只能有一个客户与一个订单相关联。 此外， OnDelete元素指示在删除客户时，将删除与特定客户相关且已加载到 ObjectContext 的所有订单。

 <Association Name="CustomerOrders">
   <End Type="ExampleModel.Customer" Role="Customer" Multiplicity="1" >
         <OnDelete Action="Cascade" />
   </End>
   <End Type="ExampleModel.Order" Role="Order" Multiplicity="*" />
 </Association>

下面的示例演示一个association元素，该元素定义在Customer和Order实体类型上公开外键时的CustomerOrders关联。 公开外键后，实体之间的关系将通过ReferentialConstraint元素进行管理。 将此关联映射到数据源并不需要 AssociationSetMapping 元素。

 <Association Name="CustomerOrders">
   <End Type="ExampleModel.Customer" Role="Customer" Multiplicity="1" >
         <OnDelete Action="Cascade" />
   </End>
   <End Type="ExampleModel.Order" Role="Order" Multiplicity="*" />
   <ReferentialConstraint>
        <Principal Role="Customer">
            <PropertyRef Name="Id" />
        </Principal>
        <Dependent Role="Order">
             <PropertyRef Name="CustomerId" />
         </Dependent>
   </ReferentialConstraint>
 </Association>

AssociationSet 元素 (CSDL)AssociationSet Element (CSDL)

概念架构定义语言（CSDL）中的AssociationSet元素是同一类型的关联实例的逻辑容器。 关联集为对关联实例进行分组提供了定义，以便能够将它们映射到数据源。

AssociationSet元素可以具有以下子元素（按所列顺序）：

• 文档（允许零个或一个元素）
• End （只需要两个元素）
• Annotation 元素（允许零个或多个元素）

Association特性指定关联集包含的关联类型。 构成关联集末尾的实体集是通过恰好两个子End元素指定的。

适用的属性Applicable Attributes

下表介绍可应用于AssociationSet元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于AssociationSet元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示具有两个AssociationSet元素的EntityContainer元素：

 <EntityContainer Name="BooksContainer" >
   <EntitySet Name="Books" EntityType="BooksModel.Book" />
   <EntitySet Name="Publishers" EntityType="BooksModel.Publisher" />
   <EntitySet Name="Authors" EntityType="BooksModel.Author" />
   <AssociationSet Name="PublishedBy" Association="BooksModel.PublishedBy">
     <End Role="Book" EntitySet="Books" />
     <End Role="Publisher" EntitySet="Publishers" />
   </AssociationSet>
   <AssociationSet Name="WrittenBy" Association="BooksModel.WrittenBy">
     <End Role="Book" EntitySet="Books" />
     <End Role="Author" EntitySet="Authors" />
   </AssociationSet>
 </EntityContainer>

CollectionType 元素 (CSDL)CollectionType Element (CSDL)

概念架构定义语言（CSDL）中的CollectionType元素指定函数参数或函数返回类型是集合。 CollectionType元素可以是参数元素的子元素，也可以是 ReturnType （函数）元素的子元素。 可以使用type特性或以下子元素之一指定集合类型：

• CollectionType
• ReferenceType
• RowType
• TypeRef

备注

如果集合类型是使用type特性和子元素指定的，则模型不会进行验证。

适用的属性Applicable Attributes

下表介绍可应用于CollectionType元素的特性。 请注意， DefaultValue、 MaxLength、 FixedLength、精度、小数位数、 Unicode和排序规则特性仅适用于edmsimpletype的集合。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于CollectionType元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示一个模型定义函数，该函数使用CollectionType元素来指定该函数返回Person实体类型的集合（使用ElementType特性指定）。

 <Function Name="LastNamesAfter">
        <Parameter Name="someString" Type="Edm.String"/>
        <ReturnType>
             <CollectionType  ElementType="SchoolModel.Person"/>
        </ReturnType>
        <DefiningExpression>
             SELECT VALUE p
             FROM SchoolEntities.People AS p
             WHERE p.LastName >= someString
        </DefiningExpression>
 </Function>

下面的示例演示一个模型定义函数，该函数使用CollectionType元素来指定该函数返回行的集合（在RowType元素中指定）。

 <Function Name="LastNamesAfter">
   <Parameter Name="someString" Type="Edm.String" />
   <ReturnType>
    <CollectionType>
      <RowType>
        <Property Name="FirstName" Type="Edm.String" Nullable="false" />
        <Property Name="LastName" Type="Edm.String" Nullable="false" />
      </RowType>
    </CollectionType>
   </ReturnType>
   <DefiningExpression>
             SELECT VALUE ROW(p.FirstName, p.LastName)
             FROM SchoolEntities.People AS p
             WHERE p.LastName &gt;= somestring
   </DefiningExpression>
 </Function>

下面的示例演示一个模型定义的函数，该函数使用CollectionType元素来指定该函数接受作为参数的部门实体类型的集合。

 <Function Name="GetAvgBudget">
      <Parameter Name="Departments">
          <CollectionType>
             <TypeRef Type="SchoolModel.Department"/>
          </CollectionType>
           </Parameter>
       <ReturnType Type="Collection(Edm.Decimal)"/>
       <DefiningExpression>
             SELECT VALUE AVG(d.Budget) FROM Departments AS d
       </DefiningExpression>
 </Function>

ComplexType 元素 (CSDL)ComplexType Element (CSDL)

ComplexType元素定义由EdmSimpleType属性或其他复杂类型组成的数据结构。 复杂类型可以是实体类型或其他复杂类型的属性。 复杂类型类似于复杂类型定义数据中的实体类型。 但是，在复杂类型与实体类型之间仍存在着一些重要区别：

• 复杂类型没有标识（或键），因此不能独立存在。 复杂类型只能作为实体类型或其他复杂类型的属性而存在。
• 复杂类型不能参与关联。 关联的任一端都不能是复杂类型，因此不能为复杂类型定义导航属性。
• 复杂类型属性不能具有 null 值，但可以将复杂类型的每个标量属性设置为 null。

ComplexType元素可以具有以下子元素（按所列顺序）：

• 文档（零个或一个元素）
• Property（零个或多个元素）
• 批注元素（零个或多个元素）

下表介绍可应用于ComplexType元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于ComplexType元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例显示了一个复杂类型Address，其中包含EdmSimpleType属性StreetAddress、 City、 StateOrProvince、国家/地区和邮政编码。

 <ComplexType Name="Address" >
   <Property Type="String" Name="StreetAddress" Nullable="false" />
   <Property Type="String" Name="City" Nullable="false" />
   <Property Type="String" Name="StateOrProvince" Nullable="false" />
   <Property Type="String" Name="Country" Nullable="false" />
   <Property Type="String" Name="PostalCode" Nullable="false" />
 </ComplexType>

若要将复杂类型地址（如上所示）定义为某个实体类型的属性，必须在实体类型定义中声明该属性类型。 下面的示例显示了在实体类型（发布者）上作为复杂类型的地址属性：

 <EntityType Name="Publisher">
       <Key>
         <PropertyRef Name="Id" />
       </Key>
       <Property Type="Int32" Name="Id" Nullable="false" />
       <Property Type="String" Name="Name" Nullable="false" />
       <Property Type="BooksModel.Address" Name="Address" Nullable="false" />
       <NavigationProperty Name="Books" Relationship="BooksModel.PublishedBy"
                           FromRole="Publisher" ToRole="Book" />
     </EntityType>

DefiningExpression 元素 (CSDL)DefiningExpression Element (CSDL)

概念架构定义语言（CSDL）中的DefiningExpression元素包含一个定义概念模型中的函数的实体 SQL 表达式。

备注

出于验证目的， DefiningExpression元素可以包含任意内容。 但是，如果DefiningExpression元素不包含有效的实体 SQL，则实体框架在运行时将引发异常。

适用的属性Applicable Attributes

可以将任意数量的批注特性（自定义 XML 特性）应用于DefiningExpression元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例使用DefiningExpression元素来定义一个函数，该函数返回发布书籍之后的年数。 DefiningExpression元素的内容是以实体 SQL 编写的。

 <Function Name="GetYearsInPrint" ReturnType="Edm.Int32" >
       <Parameter Name="book" Type="BooksModel.Book" />
       <DefiningExpression>
         Year(CurrentDateTime()) - Year(cast(book.PublishedDate as DateTime))
       </DefiningExpression>
     </Function>

Dependent 元素 (CSDL)Dependent Element (CSDL)

概念架构定义语言（CSDL）中的依赖元素是 ReferentialConstraint 元素的子元素，用于定义引用约束的依赖端。 ReferentialConstraint元素定义的功能与关系数据库中的引用完整性约束类似。 与数据库表中的一个（或多个）列可以引用另一个表的主键相同，实体类型的一个（或多个）属性可以引用另一个实体类型的实体键。 引用的实体类型称为约束的主体端。 引用主体端的实体类型称为约束的依赖端。 PropertyRef元素用于指定哪些键引用主体端。

依赖元素可以具有以下子元素（按所列顺序）：

• PropertyRef （一个或多个元素）
• 批注元素（零个或多个元素）

适用的属性Applicable Attributes

下表描述了可应用于依赖元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于依赖元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示了在PublishedBy关联的定义中使用的ReferentialConstraint元素。 Book实体类型的PublisherId属性构成了引用约束的依赖端。

 <Association Name="PublishedBy">
   <End Type="BooksModel.Book" Role="Book" Multiplicity="*" >
   </End>
   <End Type="BooksModel.Publisher" Role="Publisher" Multiplicity="1" />
   <ReferentialConstraint>
     <Principal Role="Publisher">
       <PropertyRef Name="Id" />
     </Principal>
     <Dependent Role="Book">
       <PropertyRef Name="PublisherId" />
     </Dependent>
   </ReferentialConstraint>
 </Association>

Documentation 元素 (CSDL)Documentation Element (CSDL)

概念架构定义语言（CSDL）中的文档元素可用于提供有关在父元素中定义的对象的信息。 在 .edmx 文件中，当文档元素是元素的子元素，而该元素显示为 EF 设计器设计图面上的对象（如实体、关联或属性）时，文档元素的内容将显示在对象的 Visual Studio 属性窗口中。

文档元素可以具有以下子元素（按所列顺序）：

• 摘要：父元素的简要说明。 （零个或一个元素）
• LongDescription：父元素的详细说明。 （零个或一个元素）
• 批注元素. （零个或多个元素）

适用的属性Applicable Attributes

可以将任意数量的批注特性（自定义 XML 特性）应用于文档元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例将文档元素显示为 EntityType 元素的子元素。 如果下面的代码片段在 .edmx 文件的 CSDL 内容中，则当你单击 Customer 实体类型时， Summary和LongDescription元素的内容将显示在 Visual Studio 的 “ 属性“ 窗口中。

 <EntityType Name="Customer">
    <Documentation>
      <Summary>Summary here.</Summary>
      <LongDescription>Long description here.</LongDescription>
    </Documentation>
    <Key>
      <PropertyRef Name="CustomerId" />
    </Key>
    <Property Type="Int32" Name="CustomerId" Nullable="false" />
    <Property Type="String" Name="Name" Nullable="false" />
 </EntityType>

End 元素 (CSDL)End Element (CSDL)

概念架构定义语言（CSDL）中的End元素可以是 Association 元素或 AssociationSet 元素的子元素。 在每种情况下， End元素的角色不同，适用的属性也不同。

End 元素作为 Association 元素的子元素End Element as a Child of the Association Element

结束元素（作为association元素的子元素）标识了关联一端的实体类型以及该关联端可以存在的实体类型实例的数量。 关联端定义为关联的一部分；关联必须正好有两个关联端。 通过导航属性或外键（如果实体类型上有）可以访问关联某一端的实体类型实例。

结束元素可以具有以下子元素（按所列顺序）：

• 文档（零个或一个元素）
• OnDelete （零个或一个元素）
• 批注元素（零个或多个元素）

适用的属性Applicable Attributes

下表描述了当结束元素是Association元素的子元素时，可应用于该元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于结束元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示了一个定义CustomerOrders关联的association元素。 关联的每个端点的多重性值指示可以将多个订单与一个客户关联，但只能有一个客户与一个订单相关联。 此外， OnDelete元素指示在删除客户时，将删除与特定客户相关且已加载到 ObjectContext 的所有订单。

 <Association Name="CustomerOrders">
   <End Type="ExampleModel.Customer" Role="Customer" Multiplicity="1" />
   <End Type="ExampleModel.Order" Role="Order" Multiplicity="*">
         <OnDelete Action="Cascade" />
   </End>
 </Association>

End 元素作为 AssociationSet 元素的子元素End Element as a Child of the AssociationSet Element

End元素指定关联集的一端。 AssociationSet元素必须包含两个结束元素。 End元素中包含的信息用于将关联集映射到数据源。

结束元素可以具有以下子元素（按所列顺序）：

• 文档（零个或一个元素）
• 批注元素（零个或多个元素）

备注

Annotation 元素必须出现在所有其他子元素之后。 仅在 CSDL v2 和更高版本中允许使用批注元素。

适用的属性Applicable Attributes

下表描述了当结束元素为AssociationSet元素的子元素时，可应用于该元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于结束元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示具有两个AssociationSet元素的EntityContainer元素，每个元素都有两个End元素：

 <EntityContainer Name="BooksContainer" >
   <EntitySet Name="Books" EntityType="BooksModel.Book" />
   <EntitySet Name="Publishers" EntityType="BooksModel.Publisher" />
   <EntitySet Name="Authors" EntityType="BooksModel.Author" />
   <AssociationSet Name="PublishedBy" Association="BooksModel.PublishedBy">
     <End Role="Book" EntitySet="Books" />
     <End Role="Publisher" EntitySet="Publishers" />
   </AssociationSet>
   <AssociationSet Name="WrittenBy" Association="BooksModel.WrittenBy">
     <End Role="Book" EntitySet="Books" />
     <End Role="Author" EntitySet="Authors" />
   </AssociationSet>
 </EntityContainer>

EntityContainer 元素 (CSDL)EntityContainer Element (CSDL)

概念架构定义语言（CSDL）中的EntityContainer元素是实体集、关联集和函数导入的逻辑容器。 概念模型实体容器通过 EntityContainerMapping 元素映射到存储模型实体容器。 存储模型实体容器描述数据库的结构：实体集描述表、关联集描述外键约束、函数导入描述数据库中的存储过程。

EntityContainer元素可以有零个或一个文档元素。 如果存在文档元素，则它必须位于所有EntitySet、 AssociationSet和FunctionImport元素之前。

EntityContainer元素可包含零个或多个下列子元素（按所列顺序）：

• EntitySet
• AssociationSet
• FunctionImport
• 批注元素

可以扩展EntityContainer元素，使其包含同一命名空间中的另一个entitycontainer的内容。 若要包含另一个entitycontainer的内容，请在引用entitycontainer元素中，将 “扩展“ 属性的值设置为要包括的EntityContainer元素的名称。 包含的entitycontainer元素的所有子元素将被视为引用entitycontainer元素的子元素。

适用的属性Applicable Attributes

下表描述了可应用于Using元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于EntityContainer元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示一个EntityContainer元素，该元素定义三个实体集和两个关联集。

 <EntityContainer Name="BooksContainer" >
   <EntitySet Name="Books" EntityType="BooksModel.Book" />
   <EntitySet Name="Publishers" EntityType="BooksModel.Publisher" />
   <EntitySet Name="Authors" EntityType="BooksModel.Author" />
   <AssociationSet Name="PublishedBy" Association="BooksModel.PublishedBy">
     <End Role="Book" EntitySet="Books" />
     <End Role="Publisher" EntitySet="Publishers" />
   </AssociationSet>
   <AssociationSet Name="WrittenBy" Association="BooksModel.WrittenBy">
     <End Role="Book" EntitySet="Books" />
     <End Role="Author" EntitySet="Authors" />
   </AssociationSet>
 </EntityContainer>

EntitySet 元素 (CSDL)EntitySet Element (CSDL)

概念架构定义语言中的EntitySet元素是某个实体类型的实例和从该实体类型派生的任何类型的实例的逻辑容器。 实体类型与实体集之间的关系类似于关系数据库中行与表之间的关系。 实体类型与行类似，它定义一组相关数据；而实体集与表类似，它包含该定义的实例。 实体集为对实体类型实例分组提供了一个构造，以便能够将它们映射到数据源中的相关数据结构。

可以为特定实体类型定义多个实体集。

备注

EF 设计器不支持每个类型包含多个实体集的概念模型。

EntitySet元素可以具有以下子元素（按所列顺序）：

• 文档元素（允许零个或一个元素）
• Annotation 元素（允许零个或多个元素）

适用的属性Applicable Attributes

下表描述了可应用于EntitySet元素的特性。

备注

可以向EntitySet元素应用任意数量的批注特性（自定义 XML 特性）。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示具有三个EntitySet元素的EntityContainer元素：

 <EntityContainer Name="BooksContainer" >
   <EntitySet Name="Books" EntityType="BooksModel.Book" />
   <EntitySet Name="Publishers" EntityType="BooksModel.Publisher" />
   <EntitySet Name="Authors" EntityType="BooksModel.Author" />
   <AssociationSet Name="PublishedBy" Association="BooksModel.PublishedBy">
     <End Role="Book" EntitySet="Books" />
     <End Role="Publisher" EntitySet="Publishers" />
   </AssociationSet>
   <AssociationSet Name="WrittenBy" Association="BooksModel.WrittenBy">
     <End Role="Book" EntitySet="Books" />
     <End Role="Author" EntitySet="Authors" />
   </AssociationSet>
 </EntityContainer>

每个类型可以定义多个实体集 (MEST)。 下面的示例定义了一个实体容器，其中包含书籍实体类型的两个实体集：

 <EntityContainer Name="BooksContainer" >
   <EntitySet Name="Books" EntityType="BooksModel.Book" />
   <EntitySet Name="FictionBooks" EntityType="BooksModel.Book" />
   <EntitySet Name="Publishers" EntityType="BooksModel.Publisher" />
   <EntitySet Name="Authors" EntityType="BooksModel.Author" />
   <AssociationSet Name="PublishedBy" Association="BooksModel.PublishedBy">
     <End Role="Book" EntitySet="Books" />
     <End Role="Publisher" EntitySet="Publishers" />
   </AssociationSet>
   <AssociationSet Name="BookAuthor" Association="BooksModel.BookAuthor">
     <End Role="Book" EntitySet="Books" />
     <End Role="Author" EntitySet="Authors" />
   </AssociationSet>
 </EntityContainer>

EntityType 元素 (CSDL)EntityType Element (CSDL)

EntityType元素表示概念模型中的顶级概念（例如客户或订单）的结构。 实体类型是应用程序中实体类型实例的模板。 每个模板都包含以下信息：

• 唯一名称。 （必选。）
• 由一个或多个属性定义的实体键。 （必选。）
• 用于包含数据的属性。 （可选。）
• 导航属性，用于从关联的一端导航至另一端。 （可选。）

在应用程序中，实体类型的实例表示一个特定对象（例如特定客户或订单）。 实体类型的每个实例在某个实体集中都必须具有一个唯一的实体键。

只有两个实体类型实例的类型相同且其实体键的值也相同时，才认为它们是相等的。

EntityType元素可以具有以下子元素（按所列顺序）：

• 文档（零个或一个元素）
• Key（零个或一个元素）
• Property（零个或多个元素）
• NavigationProperty（零个或多个元素）
• 批注元素（零个或多个元素）

适用的属性Applicable Attributes

下表介绍可应用于EntityType元素的特性。

备注

可以向EntityType元素应用任意数量的批注特性（自定义 XML 特性）。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示一个具有三个属性元素和两个NavigationProperty元素的EntityType元素：

 <EntityType Name="Book">
   <Key>
     <PropertyRef Name="ISBN" />
   </Key>
   <Property Type="String" Name="ISBN" Nullable="false" />
   <Property Type="String" Name="Title" Nullable="false" />
   <Property Type="Decimal" Name="Revision" Nullable="false" Precision="29" Scale="29" />
   <NavigationProperty Name="Publisher" Relationship="BooksModel.PublishedBy"
                       FromRole="Book" ToRole="Publisher" />
   <NavigationProperty Name="Authors" Relationship="BooksModel.WrittenBy"
                       FromRole="Book" ToRole="Author" />
 </EntityType>

EnumType 元素（CSDL）EnumType Element (CSDL)

EnumType元素表示一个枚举类型。

EnumType元素可以具有以下子元素（按所列顺序）：

• 文档（零个或一个元素）
• 成员（零个或多个元素）
• 批注元素（零个或多个元素）

适用的属性Applicable Attributes

下表介绍可应用于EnumType元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于EnumType元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示具有三个成员元素的EnumType元素：

 <EnumType Name="Color" IsFlags=”false” UnderlyingTyp=”Edm.Byte”>
   <Member Name="Red" />
   <Member Name="Green" />
   <Member Name="Blue" />
 </EntityType>

Function 元素 (CSDL)Function Element (CSDL)

概念架构定义语言（CSDL）中的函数元素用于在概念模型中定义或声明函数。 函数通过使用 DefiningExpression 元素来定义。

函数元素可以具有以下子元素（按所列顺序）：

• 文档（零个或一个元素）
• Parameter（零个或多个元素）
• DefiningExpression（零个或一个元素）
• ReturnType （函数）（零个或一个元素）
• 批注元素（零个或多个元素）

函数的返回类型必须与returntype （function）元素或returntype属性（见下文）一起指定，但不能同时指定两者。 可能的返回类型为任何 EdmSimpleType、实体类型、复杂类型、行类型或引用类型（或这些类型之一的集合）。

适用的属性Applicable Attributes

下表描述了可应用于Function元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于Function元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例使用function元素来定义一个函数，该函数返回一个指导员后的年数。

 <Function Name="YearsSince" ReturnType="Edm.Int32">
   <Parameter Name="date" Type="Edm.DateTime" />
   <DefiningExpression>
     Year(CurrentDateTime()) - Year(date)
   </DefiningExpression>
 </Function>

FunctionImport 元素 (CSDL)FunctionImport Element (CSDL)

概念性架构定义语言（CSDL）中的FunctionImport元素表示在数据源中定义但可通过概念模型用于对象的函数。 例如，存储模型中的 Function 元素可用于表示数据库中的存储过程。 概念模型中的FunctionImport元素表示实体框架应用程序中的相应函数并通过使用 FunctionImportMapping 元素映射到存储模型函数。 在应用程序中调用函数时，会在数据库中执行相应的存储过程。

FunctionImport元素可以具有以下子元素（按所列顺序）：

• 文档（允许零个或一个元素）
• Parameter（允许零个或多个元素）
• Annotation 元素（允许零个或多个元素）
• ReturnType （FunctionImport）（允许零个或多个元素）

应为函数接受的每个参数定义一个参数元素。

函数的返回类型必须与returntype （FunctionImport）元素或returntype属性（见下文）一起指定，但不能同时指定两者。 返回类型值必须是 EdmSimpleType、EntityType 或 ComplexType 的集合。

适用的属性Applicable Attributes

下表介绍可应用于FunctionImport元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于FunctionImport元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示一个FunctionImport元素，该元素接受一个参数并返回实体类型的集合：

 <FunctionImport Name="GetStudentGrades"
                 EntitySet="StudentGrade"
                 ReturnType="Collection(SchoolModel.StudentGrade)">
        <Parameter Name="StudentID" Mode="In" Type="Int32" />
 </FunctionImport>

Key 元素 (CSDL)Key Element (CSDL)

Key元素是 EntityType 元素的子元素，用于定义实体键（用于确定标识的实体类型的一个或一组属性）。 构成实体键的属性是在设计时选择的。 实体键属性的值必须在运行时唯一标识实体集中的实体类型实例。 在选择构成实体键的属性时应确保实例在实体集中的唯一性。 Key元素通过引用实体类型的一个或多个属性来定义实体键。

Key元素可以具有以下子元素：

• PropertyRef （一个或多个元素）
• 批注元素（零个或多个元素）

适用的属性Applicable Attributes

可以将任意数量的批注特性（自定义 XML 特性）应用于该键元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例定义了一个名为Book的实体类型。 实体键通过引用实体类型的ISBN属性来定义。

 <EntityType Name="Book">
   <Key>
     <PropertyRef Name="ISBN" />
   </Key>
   <Property Type="String" Name="ISBN" Nullable="false" />
   <Property Type="String" Name="Title" Nullable="false" />
   <Property Type="Decimal" Name="Revision" Nullable="false" Precision="29" Scale="29" />
   <NavigationProperty Name="Publisher" Relationship="BooksModel.PublishedBy"
                       FromRole="Book" ToRole="Publisher" />
   <NavigationProperty Name="Authors" Relationship="BooksModel.WrittenBy"
                       FromRole="Book" ToRole="Author" />
 </EntityType>

由于国际标准图书编号（ISBN）唯一标识书籍，因此ISBN属性是实体键的一个不错选择。

下面的示例演示一个实体类型（作者），其中包含一个由两个属性、名称和地址组成的实体键。

 <EntityType Name="Author">
   <Key>
     <PropertyRef Name="Name" />
     <PropertyRef Name="Address" />
   </Key>
   <Property Type="String" Name="Name" Nullable="false" />
   <Property Type="String" Name="Address" Nullable="false" />
   <NavigationProperty Name="Books" Relationship="BooksModel.WrittenBy"
                       FromRole="Author" ToRole="Book" />
 </EntityType>

使用实体键的名称和地址是合理的选择，因为同一名称的两个作者不会居住在同一地址。 但是，针对实体键的这种选择并不能绝对确保实体键在实体集中的唯一性。 在这种情况下，建议添加可用于唯一标识作者的属性，例如AuthorId：。

Member 元素（CSDL）Member Element (CSDL)

Member元素是 EnumType 元素的子元素，用于定义枚举类型的成员。

适用的属性Applicable Attributes

下表介绍可应用于FunctionImport元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于FunctionImport元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示具有三个成员元素的EnumType元素：

 <EnumType Name="Color">
   <Member Name="Red" Value=”1”/>
   <Member Name="Green" Value=”3” />
   <Member Name="Blue" Value=”5”/>
 </EntityType>

NavigationProperty 元素 (CSDL)NavigationProperty Element (CSDL)

NavigationProperty元素定义导航属性，该属性提供对关联的另一端的引用。 与使用 Property 元素定义的属性不同，导航属性不定义数据的形状和特征。 它们提供了一种在两个实体类型之间导航关联的方法。

注意，对于关联两端的两种实体类型，导航属性都是可选的。 如果您对于位于关联一端的实体类型定义一个导航属性，则不需要对于位于关联另一端的实体类型定义导航属性。

导航属性返回的数据类型是由其远程关联端的重数确定的。 例如，假设有一个导航属性OrdersNavProp，该属性存在于客户实体类型上，并在customer和Order之间导航一对多关联。 因为导航属性的远程关联端的重数为 many （*），所以其数据类型为集合（顺序）。 同样，如果 “订单“ 实体类型上存在导航属性CustomerNavProp，则其数据类型为Customer ，因为远程端的重数为一（1）。

NavigationProperty元素可以具有以下子元素（按所列顺序）：

• 文档（零个或一个元素）
• 批注元素（零个或多个元素）

适用的属性Applicable Attributes

下表介绍可应用于NavigationProperty元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于NavigationProperty元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例定义了一个具有两个导航属性（PublishedBy和WrittenBy）的实体类型（Book）：

 <EntityType Name="Book">
   <Key>
     <PropertyRef Name="ISBN" />
   </Key>
   <Property Type="String" Name="ISBN" Nullable="false" />
   <Property Type="String" Name="Title" Nullable="false" />
   <Property Type="Decimal" Name="Revision" Nullable="false" Precision="29" Scale="29" />
   <NavigationProperty Name="Publisher" Relationship="BooksModel.PublishedBy"
                       FromRole="Book" ToRole="Publisher" />
   <NavigationProperty Name="Authors" Relationship="BooksModel.WrittenBy"
                       FromRole="Book" ToRole="Author" />
 </EntityType>

OnDelete 元素 (CSDL)OnDelete Element (CSDL)

概念架构定义语言（CSDL）中的OnDelete元素定义与关联关联的行为。 如果在关联的一端将Action特性设置为Cascade ，则在删除第一条上的实体类型时，将删除关联的另一端上的相关实体类型。 如果两个实体类型之间的关联是主键到主键关系，则当删除关联的另一端上的主体对象时，将删除加载的依赖对象，而不考虑OnDelete规范。

备注

OnDelete元素只影响应用程序的运行时行为;它不会影响数据源中的行为。 在数据源中定义的行为应与在应用程序中定义的行为相同。

OnDelete元素可以具有以下子元素（按所列顺序）：

• 文档（零个或一个元素）
• 批注元素（零个或多个元素）

适用的属性Applicable Attributes

下表介绍可应用于OnDelete元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于Association元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示了一个定义CustomerOrders关联的association元素。 OnDelete元素指示在删除客户时，将删除与特定客户相关且已加载到 ObjectContext 的所有订单。

 <Association Name="CustomerOrders">
   <End Type="ExampleModel.Customer" Role="Customer" Multiplicity="1">
         <OnDelete Action="Cascade" />
   </End>
   <End Type="ExampleModel.Order" Role="Order" Multiplicity="*" />
 </Association>

Parameter 元素 (CSDL)Parameter Element (CSDL)

概念架构定义语言（CSDL）中的Parameter元素可以是 FunctionImport 元素或 Function 元素的子元素。

FunctionImport 元素应用程序FunctionImport Element Application

Parameter元素（作为FunctionImport元素的子元素）用于定义在 CSDL 中声明的函数导入的输入和输出参数。

Parameter元素可以具有以下子元素（按所列顺序）：

• 文档（允许零个或一个元素）
• Annotation 元素（允许零个或多个元素）

适用的属性Applicable Attributes

下表介绍可应用于参数元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于参数元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示一个具有一个参数子元素的FunctionImport元素。 函数接受一个输入参数并返回实体类型的集合。

 <FunctionImport Name="GetStudentGrades"
                 EntitySet="StudentGrade"
                 ReturnType="Collection(SchoolModel.StudentGrade)">
        <Parameter Name="StudentID" Mode="In" Type="Int32" />
 </FunctionImport>

Function 元素应用程序Function Element Application

Parameter元素（作为Function元素的子元素）为在概念模型中定义或声明的函数定义参数。

Parameter元素可以具有以下子元素（按所列顺序）：

• 文档（零个或一个元素）
• CollectionType （零个或一个元素）
• ReferenceType （零个或一个元素）
• RowType （零个或一个元素）

备注

只有一个CollectionType、 ReferenceType或RowType元素可以是属性元素的子元素。

• Annotation 元素（允许零个或多个元素）

备注

Annotation 元素必须出现在所有其他子元素之后。 仅在 CSDL v2 和更高版本中允许使用批注元素。

适用的属性Applicable Attributes

下表介绍可应用于参数元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于参数元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示一个使用一个参数子元素定义函数参数的函数元素。

 <Function Name="GetYearsEmployed" ReturnType="Edm.Int32">
 <Parameter Name="Instructor" Type="SchoolModel.Person" />
   <DefiningExpression>
   Year(CurrentDateTime()) - Year(cast(Instructor.HireDate as DateTime))
   </DefiningExpression>
 </Function>

Principal 元素 (CSDL)Principal Element (CSDL)

概念架构定义语言（CSDL）中的主体元素是 ReferentialConstraint 元素的子元素，用于定义引用约束的主体端。 ReferentialConstraint元素定义的功能与关系数据库中的引用完整性约束类似。 与数据库表中的一个（或多个）列可以引用另一个表的主键相同，实体类型的一个（或多个）属性可以引用另一个实体类型的实体键。 引用的实体类型称为约束的主体端。 引用主体端的实体类型称为约束的依赖端。 PropertyRef元素用于指定依赖端引用的键。

主体元素可以具有以下子元素（按所列顺序）：

• PropertyRef （一个或多个元素）
• 批注元素（零个或多个元素）

适用的属性Applicable Attributes

下表描述了可应用于主体元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于主体元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例显示了ReferentialConstraint元素，它是PublishedBy关联定义的一部分。 发行者实体类型的Id属性构成了引用约束的主体端。

 <Association Name="PublishedBy">
   <End Type="BooksModel.Book" Role="Book" Multiplicity="*" >
   </End>
   <End Type="BooksModel.Publisher" Role="Publisher" Multiplicity="1" />
   <ReferentialConstraint>
     <Principal Role="Publisher">
       <PropertyRef Name="Id" />
     </Principal>
     <Dependent Role="Book">
       <PropertyRef Name="PublisherId" />
     </Dependent>
   </ReferentialConstraint>
 </Association>

Property 元素 (CSDL)Property Element (CSDL)

概念架构定义语言（CSDL）中的属性元素可以是 EntityType 元素、ComplexType 元素或 RowType 元素的子元素。

EntityType 和 ComplexType 元素应用程序EntityType and ComplexType Element Applications

属性元素（作为EntityType或ComplexType元素的子元素）定义实体类型实例或复杂类型实例将包含的数据的形状和特征。 概念模型中的属性类似于为类定义的属性。 正如类的属性定义类的形状和携带有关对象的信息一样，概念模型中的属性也定义实体类型的形状和携带有关实体类型实例的信息。

Property元素可以具有以下子元素（按所列顺序）：

• 文档元素（允许零个或一个元素）
• Annotation 元素（允许零个或多个元素）

以下方面可应用于属性元素：可以为 null、默认值、 MaxLength、 FixedLength、精度、小数位数、 Unicode、排序规则、 ConcurrencyMode。 方面是一些 XML 特性，它们提供有关如何在数据存储区中存储属性值的信息。

备注

Facet 只能应用于EDMSimpleType类型的属性。

适用的属性Applicable Attributes

下表介绍可应用于属性元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于Property元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示一个具有三个属性元素的EntityType元素：

 <EntityType Name="Book">
   <Key>
     <PropertyRef Name="ISBN" />
   </Key>
   <Property Type="String" Name="ISBN" Nullable="false" />
   <Property Type="String" Name="Title" Nullable="false" />
   <Property Type="Decimal" Name="Revision" Nullable="false" Precision="29" Scale="29" />
   <NavigationProperty Name="Publisher" Relationship="BooksModel.PublishedBy"
                       FromRole="Book" ToRole="Publisher" />
   <NavigationProperty Name="Authors" Relationship="BooksModel.WrittenBy"
                       FromRole="Book" ToRole="Author" />
 </EntityType>

下面的示例演示一个包含五个属性元素的ComplexType元素：

 <ComplexType Name="Address" >
   <Property Type="String" Name="StreetAddress" Nullable="false" />
   <Property Type="String" Name="City" Nullable="false" />
   <Property Type="String" Name="StateOrProvince" Nullable="false" />
   <Property Type="String" Name="Country" Nullable="false" />
   <Property Type="String" Name="PostalCode" Nullable="false" />
 </ComplexType>

RowType 元素应用RowType Element Application

Property元素（作为RowType元素的子元素）定义可传递到模型定义函数或从模型定义函数返回的数据的形状和特征。

Property元素可以具有以下子元素之一：

• CollectionType
• ReferenceType
• RowType

Property元素可以有任意数量的子批注元素。

备注

仅在 CSDL v2 和更高版本中允许使用批注元素。

适用的属性Applicable Attributes

下表介绍可应用于属性元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于Property元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示了用于定义模型定义函数的返回类型的形状的属性元素。

 <Function Name="LastNamesAfter">
   <Parameter Name="someString" Type="Edm.String" />
   <ReturnType>
    <CollectionType>
      <RowType>
        <Property Name="FirstName" Type="Edm.String" Nullable="false" />
        <Property Name="LastName" Type="Edm.String" Nullable="false" />
      </RowType>
    </CollectionType>
   </ReturnType>
   <DefiningExpression>
             SELECT VALUE ROW(p.FirstName, p.LastName)
             FROM SchoolEntities.People AS p
             WHERE p.LastName &gt;= somestring
   </DefiningExpression>
 </Function>

PropertyRef 元素 (CSDL)PropertyRef Element (CSDL)

概念架构定义语言（CSDL）中的PropertyRef元素引用实体类型的属性，以指示该属性将执行以下角色之一：

• 实体键的一部分（实体类型的用于确定标识的一个或一组属性）。 一个或多个PropertyRef元素可用于定义实体键。
• 引用约束的依赖端或主体端。

PropertyRef元素只能将批注元素（零个或多个）作为子元素。

备注

仅在 CSDL v2 和更高版本中允许使用批注元素。

适用的属性Applicable Attributes

下表介绍可应用于PropertyRef元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于PropertyRef元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例定义了一个实体类型（Book）。 实体键通过引用实体类型的ISBN属性来定义。

 <EntityType Name="Book">
   <Key>
     <PropertyRef Name="ISBN" />
   </Key>
   <Property Type="String" Name="ISBN" Nullable="false" />
   <Property Type="String" Name="Title" Nullable="false" />
   <Property Type="Decimal" Name="Revision" Nullable="false" Precision="29" Scale="29" />
   <NavigationProperty Name="Publisher" Relationship="BooksModel.PublishedBy"
                       FromRole="Book" ToRole="Publisher" />
   <NavigationProperty Name="Authors" Relationship="BooksModel.WrittenBy"
                       FromRole="Book" ToRole="Author" />
 </EntityType>

在下一个示例中，两个PropertyRef元素用于指示两个属性（Id和PublisherId）是引用约束的主体端和依赖端。

 <Association Name="PublishedBy">
   <End Type="BooksModel.Book" Role="Book" Multiplicity="*" >
   </End>
   <End Type="BooksModel.Publisher" Role="Publisher" Multiplicity="1" />
   <ReferentialConstraint>
     <Principal Role="Publisher">
       <PropertyRef Name="Id" />
     </Principal>
     <Dependent Role="Book">
       <PropertyRef Name="PublisherId" />
     </Dependent>
   </ReferentialConstraint>
 </Association>

ReferenceType 元素 (CSDL)ReferenceType Element (CSDL)

概念架构定义语言（CSDL）中的ReferenceType元素指定对实体类型的引用。 ReferenceType元素可以是以下元素的子元素：

• ReturnType （函数）
• 参数
• CollectionType

在定义函数的参数或返回类型时，将使用ReferenceType元素。

ReferenceType元素可以具有以下子元素（按所列顺序）：

• 文档（零个或一个元素）
• 批注元素（零个或多个元素）

适用的属性Applicable Attributes

下表介绍可应用于ReferenceType元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于ReferenceType元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例显示了ReferenceType元素，该元素在接受对Person实体类型的引用的模型定义函数中用作Parameter元素的子元素：

 <Function Name="GetYearsEmployed" ReturnType="Edm.Int32">
   <Parameter Name="instructor">
     <ReferenceType Type="SchoolModel.Person" />
   </Parameter>
   <DefiningExpression>
   Year(CurrentDateTime()) - Year(cast(instructor.HireDate as DateTime))
   </DefiningExpression>
 </Function>

下面的示例显示了ReferenceType元素，该元素用作模型定义的函数中的ReturnType （函数）元素的子元素，该函数返回对Person实体类型的引用：

 <Function Name="GetPersonReference">
     <Parameter Name="p" Type="SchoolModel.Person" />
     <ReturnType>
         <ReferenceType Type="SchoolModel.Person" />
     </ReturnType>
     <DefiningExpression>
           REF(p)
     </DefiningExpression>
 </Function>

ReferentialConstraint 元素 (CSDL)ReferentialConstraint Element (CSDL)

概念架构定义语言（CSDL）中的ReferentialConstraint元素定义的功能与关系数据库中的引用完整性约束类似。 与数据库表中的一个（或多个）列可以引用另一个表的主键相同，实体类型的一个（或多个）属性可以引用另一个实体类型的实体键。 引用的实体类型称为约束的主体端。 引用主体端的实体类型称为约束的依赖端。

如果一个实体类型上公开的外键引用另一个实体类型上的属性，则ReferentialConstraint元素将定义这两个实体类型之间的关联。 由于ReferentialConstraint元素提供有关两个实体类型之间的关系的信息，因此，在映射规范语言（MSL）中不需要对应的 AssociationSetMapping 元素。 没有公开外键的两个实体类型之间的关联必须具有相应的AssociationSetMapping元素，才能将关联信息映射到数据源。

如果在实体类型上没有公开外键，则ReferentialConstraint元素只能定义实体类型和其他实体类型之间的主键到主键约束。

ReferentialConstraint元素可以具有以下子元素（按所列顺序）：

• 文档（零个或一个元素）
• Principal （恰好一个元素）
• Dependent（恰好一个元素）
• 批注元素（零个或多个元素）

适用的属性Applicable Attributes

ReferentialConstraint元素可以具有任意数量的批注特性（自定义 XML 特性）。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示了在PublishedBy关联的定义中使用的ReferentialConstraint元素。

 <Association Name="PublishedBy">
   <End Type="BooksModel.Book" Role="Book" Multiplicity="*" >
   </End>
   <End Type="BooksModel.Publisher" Role="Publisher" Multiplicity="1" />
   <ReferentialConstraint>
     <Principal Role="Publisher">
       <PropertyRef Name="Id" />
     </Principal>
     <Dependent Role="Book">
       <PropertyRef Name="PublisherId" />
     </Dependent>
   </ReferentialConstraint>
 </Association>

ReturnType （Function）元素（CSDL）ReturnType (Function) Element (CSDL)

概念架构定义语言（CSDL）中的ReturnType （函数）元素指定在 function 元素中定义的函数的返回类型。 还可以使用ReturnType特性指定函数返回类型。

返回类型可以是任何EdmSimpleType、实体类型、复杂类型、行类型、引用类型或这些类型之一的集合。

函数的返回类型可以使用ReturnType （function）元素的type属性指定，也可以使用以下子元素之一指定：

• CollectionType
• ReferenceType
• RowType

备注

如果指定的函数返回类型同时具有ReturnType （函数）元素的type属性和一个子元素，模型将不会验证。

适用的属性Applicable Attributes

下表介绍可应用于ReturnType （函数）元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于ReturnType （Function）元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例使用function元素来定义一个函数，该函数返回书籍已打印的年数。 请注意，返回类型由ReturnType （函数）元素的type属性指定。

 <Function Name="GetYearsInPrint">
   <ReturnType Type=="Edm.Int32">
   <Parameter Name="book" Type="BooksModel.Book" />
   <DefiningExpression>
    Year(CurrentDateTime()) - Year(cast(book.PublishedDate as DateTime))
   </DefiningExpression>
 </Function>

ReturnType （FunctionImport）元素（CSDL）ReturnType (FunctionImport) Element (CSDL)

概念架构定义语言（CSDL）中的ReturnType （FunctionImport）元素指定在 FunctionImport 元素中定义的函数的返回类型。 还可以使用ReturnType特性指定函数返回类型。

返回类型可以是实体类型、复杂类型或EdmSimpleType的任何集合，

函数的返回类型是使用ReturnType （FunctionImport）元素的type属性指定的。

适用的属性Applicable Attributes

下表介绍可应用于ReturnType （FunctionImport）元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于ReturnType （FunctionImport）元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例使用返回书籍和出版商的FunctionImport 。 请注意，函数将返回两个结果集，因而指定了两个ReturnType （FunctionImport）元素。

 <FunctionImport Name="GetBooksAndPublishers">
   <ReturnType Type=="Collection(BooksModel.Book )" EntitySet=”Books”>
   <ReturnType Type=="Collection(BooksModel.Publisher)" EntitySet=”Publishers”>
 </FunctionImport>

RowType 元素 (CSDL)RowType Element (CSDL)

概念架构定义语言（CSDL）中的RowType元素将未命名的结构定义为概念模型中定义的函数的参数或返回类型。

RowType元素可以是以下元素的子元素：

• CollectionType
• 参数
• ReturnType （函数）

RowType元素可以具有以下子元素（按所列顺序）：

• Property（一个或多个）
• 批注元素（零个或多个）

适用的属性Applicable Attributes

可以将任意数量的批注特性（自定义 XML 特性）应用于RowType元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示一个模型定义函数，该函数使用CollectionType元素来指定该函数返回行的集合（在RowType元素中指定）。

 <Function Name="LastNamesAfter">
   <Parameter Name="someString" Type="Edm.String" />
   <ReturnType>
    <CollectionType>
      <RowType>
        <Property Name="FirstName" Type="Edm.String" Nullable="false" />
        <Property Name="LastName" Type="Edm.String" Nullable="false" />
      </RowType>
    </CollectionType>
   </ReturnType>
   <DefiningExpression>
             SELECT VALUE ROW(p.FirstName, p.LastName)
             FROM SchoolEntities.People AS p
             WHERE p.LastName &gt;= somestring
   </DefiningExpression>
 </Function>

Schema 元素 (CSDL)Schema Element (CSDL)

Schema元素是概念模型定义的根元素。 它包括构成概念模型的对象、函数和容器的定义。

Schema元素可包含零个或多个下列子元素：

• 使用
• EntityContainer
• EntityType
• EnumType
• 关联
• ComplexType
• 函数

一个Schema元素可包含零个或一个批注元素。

备注

仅在 CSDL v2 和更高版本中允许Function元素和 annotation 元素。

Schema元素使用namespace特性为概念模型中的实体类型、复杂类型和关联对象定义命名空间。 在命名空间内，任何两个对象都不能同名。 命名空间可以跨多个架构元素和多个 csdl 文件。

概念模型命名空间与Schema元素的 XML 命名空间不同。 概念模型命名空间（由命名空间特性定义）是实体类型、复杂类型和关联类型的逻辑容器。 Schema元素的 XML 命名空间（由xmlns特性指示）是schema元素的子元素和属性的默认命名空间。 格式为 https://schemas.microsoft.com/ado/YYYY/MM/edm 的 XML 命名空间（其中，YYYY 和 MM 分别表示年份和月份）是为 CSDL 保留的。 自定义元素和特性不能位于具有此格式的命名空间中。

适用的属性Applicable Attributes

下表描述了可对Schema元素应用的属性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于Schema元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示一个架构元素，该元素包含一个EntityContainer元素、两个EntityType元素和一个Association元素。

 <Schema xmlns="https://schemas.microsoft.com/ado/2009/11/edm"
      xmlns:cg="https://schemas.microsoft.com/ado/2009/11/codegeneration"
      xmlns:store="https://schemas.microsoft.com/ado/2009/11/edm/EntityStoreSchemaGenerator"
       Namespace="ExampleModel" Alias="Self">
         <EntityContainer Name="ExampleModelContainer">
           <EntitySet Name="Customers"
                      EntityType="ExampleModel.Customer" />
           <EntitySet Name="Orders" EntityType="ExampleModel.Order" />
           <AssociationSet
                       Name="CustomerOrder"
                       Association="ExampleModel.CustomerOrders">
             <End Role="Customer" EntitySet="Customers" />
             <End Role="Order" EntitySet="Orders" />
           </AssociationSet>
         </EntityContainer>
         <EntityType Name="Customer">
           <Key>
             <PropertyRef Name="CustomerId" />
           </Key>
           <Property Type="Int32" Name="CustomerId" Nullable="false" />
           <Property Type="String" Name="Name" Nullable="false" />
           <NavigationProperty
                    Name="Orders"
                    Relationship="ExampleModel.CustomerOrders"
                    FromRole="Customer" ToRole="Order" />
         </EntityType>
         <EntityType Name="Order">
           <Key>
             <PropertyRef Name="OrderId" />
           </Key>
           <Property Type="Int32" Name="OrderId" Nullable="false" />
           <Property Type="Int32" Name="ProductId" Nullable="false" />
           <Property Type="Int32" Name="Quantity" Nullable="false" />
           <NavigationProperty
                    Name="Customer"
                    Relationship="ExampleModel.CustomerOrders"
                    FromRole="Order" ToRole="Customer" />
           <Property Type="Int32" Name="CustomerId" Nullable="false" />
         </EntityType>
         <Association Name="CustomerOrders">
           <End Type="ExampleModel.Customer"
                Role="Customer" Multiplicity="1" />
           <End Type="ExampleModel.Order"
                Role="Order" Multiplicity="*" />
           <ReferentialConstraint>
             <Principal Role="Customer">
               <PropertyRef Name="CustomerId" />
             </Principal>
             <Dependent Role="Order">
               <PropertyRef Name="CustomerId" />
             </Dependent>
           </ReferentialConstraint>
         </Association>
       </Schema>

TypeRef 元素 (CSDL)TypeRef Element (CSDL)

概念架构定义语言（CSDL）中的TypeRef元素提供对现有命名类型的引用。 TypeRef元素可以是 CollectionType 元素的子元素，用于指定函数具有集合作为参数或返回类型。

TypeRef元素可以具有以下子元素（按所列顺序）：

• 文档（零个或一个元素）
• 批注元素（零个或多个元素）

适用的属性Applicable Attributes

下表介绍可应用于TypeRef元素的特性。 请注意， DefaultValue、 MaxLength、 FixedLength、精度、小数位数、 Unicode和排序规则特性仅适用于edmsimpletype。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于CollectionType元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示一个模型定义函数，该函数使用TypeRef元素（作为CollectionType元素的子元素）来指定该函数接受部门实体类型的集合。

 <Function Name="GetAvgBudget">
      <Parameter Name="Departments">
          <CollectionType>
             <TypeRef Type="SchoolModel.Department"/>
          </CollectionType>
           </Parameter>
       <ReturnType Type="Collection(Edm.Decimal)"/>
       <DefiningExpression>
             SELECT VALUE AVG(d.Budget) FROM Departments AS d
       </DefiningExpression>
 </Function>

Using 元素 (CSDL)Using Element (CSDL)

概念性架构定义语言（CSDL）中的Using元素导入存在于其他命名空间中的概念模型的内容。 通过设置Namespace属性的值，您可以引用在其他概念模型中定义的实体类型、复杂类型和关联类型。 多个Using元素可以是Schema元素的子元素。

备注

CSDL 中的using元素的作用与编程语言中的using语句完全相同。 通过使用编程语言中的using语句导入命名空间，不会影响原始命名空间中的对象。 在 CSDL 中，导入的命名空间可以包含从原始命名空间中的实体类型导出的实体类型。 这可能影响在原始命名空间中声明的实体集。

Using元素可以具有以下子元素：

• 文档（允许零个或一个元素）
• Annotation 元素（允许零个或多个元素）

适用的属性Applicable Attributes

下表描述了可应用于Using元素的特性。

备注

可以将任意数量的批注特性（自定义 XML 特性）应用于Using元素。 然而，自定义特性可能不属于为 CSDL 保留的任何 XML 命名空间。 任何两个自定义特性的完全限定名称都不能相同。

示例Example

下面的示例演示用于导入在其他位置定义的命名空间的Using元素。 请注意，显示的架构元素的命名空间是 BooksModel的。 PublisherEntityType上的 Address 属性是在 ExtendedBooksModel 命名空间中定义的复杂类型（使用Using元素导入）。

 <Schema xmlns="https://schemas.microsoft.com/ado/2009/11/edm"
           xmlns:cg="https://schemas.microsoft.com/ado/2009/11/codegeneration"
           xmlns:store="https://schemas.microsoft.com/ado/2009/11/edm/EntityStoreSchemaGenerator"
           Namespace="BooksModel" Alias="Self">
     <Using Namespace="BooksModel.Extended" Alias="BMExt" />
 <EntityContainer Name="BooksContainer" >
       <EntitySet Name="Publishers" EntityType="BooksModel.Publisher" />
     </EntityContainer>
 <EntityType Name="Publisher">
       <Key>
         <PropertyRef Name="Id" />
       </Key>
       <Property Type="Int32" Name="Id" Nullable="false" />
       <Property Type="String" Name="Name" Nullable="false" />
       <Property Type="BMExt.Address" Name="Address" Nullable="false" />
     </EntityType>
 </Schema>

Annotation 特性 (CSDL)Annotation Attributes (CSDL)

以概念架构定义语言 (CSDL) 表示的批注特性是概念模型中的自定义 XML 特性。 除了具有有效的 XML 结构之外，还必须满足批注特性的以下各项条件：

• 批注特性不能位于为 CSDL 保留的任何 XML 命名空间中。
• 可以将多个批注特性应用于给定的 CSDL 元素。
• 任何两个批注特性的完全限定名称都不能相同。

可以使用批注特性提供有关概念模型中元素的额外元数据。 可以在运行时通过使用 System.web 命名空间中的类访问批注元素中包含的元数据。

示例Example

下面的示例演示具有批注特性（CustomAttribute）的EntityType元素。 本示例还演示了一个应用于实体类型元素的批注元素。

 <Schema Namespace="SchoolModel" Alias="Self"
         xmlns:annotation="https://schemas.microsoft.com/ado/2009/02/edm/annotation"
         xmlns="https://schemas.microsoft.com/ado/2009/11/edm">
   <EntityContainer Name="SchoolEntities" annotation:LazyLoadingEnabled="true">
     <EntitySet Name="People" EntityType="SchoolModel.Person" />
   </EntityContainer>
   <EntityType Name="Person" xmlns:p="http://CustomNamespace.com"
               p:CustomAttribute="Data here.">
     <Key>
       <PropertyRef Name="PersonID" />
     </Key>
     <Property Name="PersonID" Type="Int32" Nullable="false"
               annotation:StoreGeneratedPattern="Identity" />
     <Property Name="LastName" Type="String" Nullable="false"
               MaxLength="50" Unicode="true" FixedLength="false" />
     <Property Name="FirstName" Type="String" Nullable="false"
               MaxLength="50" Unicode="true" FixedLength="false" />
     <Property Name="HireDate" Type="DateTime" />
     <Property Name="EnrollmentDate" Type="DateTime" />
     <p:CustomElement>
       Custom metadata.
     </p:CustomElement>
   </EntityType>
 </Schema>

下面的代码检索批注特性中的元数据并将其写入控制台：

 EdmItemCollection collection = new EdmItemCollection("School.csdl");
 MetadataWorkspace workspace = new MetadataWorkspace();
 workspace.RegisterItemCollection(collection);
 EdmType contentType;
 workspace.TryGetType("Person", "SchoolModel", DataSpace.CSpace, out contentType);
 if (contentType.MetadataProperties.Contains("http://CustomNamespace.com:CustomAttribute"))
 {
     MetadataProperty annotationProperty =
         contentType.MetadataProperties["http://CustomNamespace.com:CustomAttribute"];
     object annotationValue = annotationProperty.Value;
     Console.WriteLine(annotationValue.ToString());
 }

上面的代码假定 School.csdl 文件位于项目的输出目录中，且您已将下面的 Imports 和 Using 语句添加到项目中：

 using System.Data.Metadata.Edm;

Annotation 元素 (CSDL)Annotation Elements (CSDL)

以概念架构定义语言 (CSDL) 表示的批注元素是概念模型中的自定义 XML 元素。 除了具有有效的 XML 结构之外，还必须满足批注元素的以下各项条件：

• 批注元素不能位于为 CSDL 保留的任何 XML 命名空间中。
• 多个批注元素可能是某个给定 CSDL 元素的子元素。
• 任何两个批注元素的完全限定名称都不能相同。
• 批注元素必须出现在给定 CSDL 元素的所有其他子元素之后。

可以使用批注元素提供有关概念模型中元素的额外元数据。 从 .NET Framework 版本4开始，可以在运行时通过使用 System.web 命名空间中的类访问批注元素中包含的元数据。

示例Example

下面的示例显示具有 annotation 元素（CustomElement）的EntityType元素。 本示例还演示了一个应用于实体类型元素的批注特性。

 <Schema Namespace="SchoolModel" Alias="Self"
         xmlns:annotation="https://schemas.microsoft.com/ado/2009/02/edm/annotation"
         xmlns="https://schemas.microsoft.com/ado/2009/11/edm">
   <EntityContainer Name="SchoolEntities" annotation:LazyLoadingEnabled="true">
     <EntitySet Name="People" EntityType="SchoolModel.Person" />
   </EntityContainer>
   <EntityType Name="Person" xmlns:p="http://CustomNamespace.com"
               p:CustomAttribute="Data here.">
     <Key>
       <PropertyRef Name="PersonID" />
     </Key>
     <Property Name="PersonID" Type="Int32" Nullable="false"
               annotation:StoreGeneratedPattern="Identity" />
     <Property Name="LastName" Type="String" Nullable="false"
               MaxLength="50" Unicode="true" FixedLength="false" />
     <Property Name="FirstName" Type="String" Nullable="false"
               MaxLength="50" Unicode="true" FixedLength="false" />
     <Property Name="HireDate" Type="DateTime" />
     <Property Name="EnrollmentDate" Type="DateTime" />
     <p:CustomElement>
       Custom metadata.
     </p:CustomElement>
   </EntityType>
 </Schema>

下面的代码检索批注元素中的元数据并将其写入控制台：

 EdmItemCollection collection = new EdmItemCollection("School.csdl");
 MetadataWorkspace workspace = new MetadataWorkspace();
 workspace.RegisterItemCollection(collection);
 EdmType contentType;
 workspace.TryGetType("Person", "SchoolModel", DataSpace.CSpace, out contentType);
 if (contentType.MetadataProperties.Contains("http://CustomNamespace.com:CustomElement"))
 {
     MetadataProperty annotationProperty =
         contentType.MetadataProperties["http://CustomNamespace.com:CustomElement"];
     object annotationValue = annotationProperty.Value;
     Console.WriteLine(annotationValue.ToString());
 }

上面的代码假定 School.csdl 文件位于项目的输出目录中并且您已将下面的 Imports 和 Using 语句添加到项目中：

 using System.Data.Metadata.Edm;

概念模型类型 (CSDL)Conceptual Model Types (CSDL)

概念性架构定义语言（CSDL）支持一组抽象基元数据类型（称为edmsimpletype），用于定义概念模型中的属性。 Edmsimpletype是存储或承载环境中支持的基元数据类型的代理。

下表列出了 CSDL 支持的基元数据类型。 该表还列出了可应用于每个EDMSimpleType的分面。