-
Notifications
You must be signed in to change notification settings - Fork 40
/
RelationalKeyBuilderExtensions.xml
198 lines (198 loc) · 15.2 KB
/
RelationalKeyBuilderExtensions.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
<Type Name="RelationalKeyBuilderExtensions" FullName="Microsoft.EntityFrameworkCore.RelationalKeyBuilderExtensions">
<TypeSignature Language="C#" Value="public static class RelationalKeyBuilderExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit RelationalKeyBuilderExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.EntityFrameworkCore.RelationalKeyBuilderExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module RelationalKeyBuilderExtensions" />
<TypeSignature Language="F#" Value="type RelationalKeyBuilderExtensions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Relational</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.0.6.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.1.6.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.1.11.0</AssemblyVersion>
<AssemblyVersion>2.2.6.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Relational database specific extension methods for <see cref="T:Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder" />.
</summary>
<remarks>
See <see href="https://aka.ms/efcore-docs-keys">Keys</see> for more information and examples.
</remarks>
</Docs>
<Members>
<Member MemberName="CanSetName">
<MemberSignature Language="C#" Value="public static bool CanSetName (this Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder keyBuilder, string name, bool fromDataAnnotation = false);" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool CanSetName(class Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder keyBuilder, string name, bool fromDataAnnotation) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.RelationalKeyBuilderExtensions.CanSetName(Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder,System.String,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function CanSetName (keyBuilder As IConventionKeyBuilder, name As String, Optional fromDataAnnotation As Boolean = false) As Boolean" />
<MemberSignature Language="F#" Value="static member CanSetName : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder * string * bool -> bool" Usage="Microsoft.EntityFrameworkCore.RelationalKeyBuilderExtensions.CanSetName (keyBuilder, name, fromDataAnnotation)" />
<MemberSignature Language="C#" Value="public static bool CanSetName (this Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder keyBuilder, string? name, bool fromDataAnnotation = false);" FrameworkAlternate="efcore-6.0;efcore-7.0;efcore-8.0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Relational</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="keyBuilder" Type="Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder" RefType="this" Index="0" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<Parameter Name="name" Type="System.String" Index="1" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<Parameter Name="fromDataAnnotation" Type="System.Boolean" Index="2" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
</Parameters>
<Docs>
<param name="keyBuilder">The builder for the key being configured.</param>
<param name="name">The name of the index.</param>
<param name="fromDataAnnotation">Indicates whether the configuration was specified using a data annotation.</param>
<summary>
Returns a value indicating whether the given name can be set for the key constraint.
</summary>
<returns>
<see langword="true" /> if the given name can be set for the key constraint.</returns>
<remarks>
See <see href="https://aka.ms/efcore-docs-keys">Keys</see> for more information and examples.
</remarks>
</Docs>
</Member>
<Member MemberName="HasName">
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder HasName (this Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder keyBuilder, string name);" FrameworkAlternate="efcore-1.0;efcore-1.1;efcore-2.0;efcore-2.1;efcore-2.2;efcore-3.0;efcore-3.1;efcore-5.0" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder HasName(class Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder keyBuilder, string name) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.RelationalKeyBuilderExtensions.HasName(Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder,System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function HasName (keyBuilder As KeyBuilder, name As String) As KeyBuilder" />
<MemberSignature Language="F#" Value="static member HasName : Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder * string -> Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder" Usage="Microsoft.EntityFrameworkCore.RelationalKeyBuilderExtensions.HasName (keyBuilder, name)" />
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder HasName (this Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder keyBuilder, string? name);" FrameworkAlternate="efcore-6.0;efcore-7.0;efcore-8.0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Relational</AssemblyName>
<AssemblyVersion>1.0.6.0</AssemblyVersion>
<AssemblyVersion>1.1.6.0</AssemblyVersion>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
<AssemblyVersion>2.1.11.0</AssemblyVersion>
<AssemblyVersion>2.2.6.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="keyBuilder" Type="Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder" RefType="this" />
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="keyBuilder">The builder for the key being configured.</param>
<param name="name">The name of the key.</param>
<summary>
Configures the name of the key constraint in the database when targeting a relational database.
</summary>
<returns>The same builder instance so that multiple calls can be chained.</returns>
<remarks>
See <see href="https://aka.ms/efcore-docs-keys">Keys</see> for more information and examples.
</remarks>
</Docs>
</Member>
<Member MemberName="HasName">
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder HasName (this Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder keyBuilder, string name, bool fromDataAnnotation = false);" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder HasName(class Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder keyBuilder, string name, bool fromDataAnnotation) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.RelationalKeyBuilderExtensions.HasName(Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder,System.String,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function HasName (keyBuilder As IConventionKeyBuilder, name As String, Optional fromDataAnnotation As Boolean = false) As IConventionKeyBuilder" />
<MemberSignature Language="F#" Value="static member HasName : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder * string * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder" Usage="Microsoft.EntityFrameworkCore.RelationalKeyBuilderExtensions.HasName (keyBuilder, name, fromDataAnnotation)" />
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder? HasName (this Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder keyBuilder, string? name, bool fromDataAnnotation = false);" FrameworkAlternate="efcore-6.0;efcore-7.0;efcore-8.0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Relational</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="keyBuilder" Type="Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionKeyBuilder" RefType="this" Index="0" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<Parameter Name="name" Type="System.String" Index="1" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<Parameter Name="fromDataAnnotation" Type="System.Boolean" Index="2" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
</Parameters>
<Docs>
<param name="keyBuilder">The builder for the key being configured.</param>
<param name="name">The name of the key.</param>
<param name="fromDataAnnotation">Indicates whether the configuration was specified using a data annotation.</param>
<summary>
Configures the name of the key constraint in the database when targeting a relational database.
</summary>
<returns>
The same builder instance if the configuration was applied,
<see langword="null" /> otherwise.
</returns>
<remarks>
See <see href="https://aka.ms/efcore-docs-keys">Keys</see> for more information and examples.
</remarks>
</Docs>
</Member>
<Member MemberName="HasName<TEntity>">
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder<TEntity> HasName<TEntity> (this Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder<TEntity> keyBuilder, string name);" FrameworkAlternate="efcore-5.0" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder`1<!!TEntity> HasName<TEntity>(class Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder`1<!!TEntity> keyBuilder, string name) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.RelationalKeyBuilderExtensions.HasName``1(Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder{``0},System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function HasName(Of TEntity) (keyBuilder As KeyBuilder(Of TEntity), name As String) As KeyBuilder(Of TEntity)" />
<MemberSignature Language="F#" Value="static member HasName : Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder<'Entity> * string -> Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder<'Entity>" Usage="Microsoft.EntityFrameworkCore.RelationalKeyBuilderExtensions.HasName (keyBuilder, name)" />
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder<TEntity> HasName<TEntity> (this Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder<TEntity> keyBuilder, string? name);" FrameworkAlternate="efcore-6.0;efcore-7.0;efcore-8.0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Relational</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder<TEntity></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TEntity" />
</TypeParameters>
<Parameters>
<Parameter Name="keyBuilder" Type="Microsoft.EntityFrameworkCore.Metadata.Builders.KeyBuilder<TEntity>" RefType="this" Index="0" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<Parameter Name="name" Type="System.String" Index="1" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
</Parameters>
<Docs>
<typeparam name="TEntity">To be added.</typeparam>
<param name="keyBuilder">The builder for the key being configured.</param>
<param name="name">The name of the key.</param>
<summary>
Configures the name of the key constraint in the database when targeting a relational database.
</summary>
<returns>The same builder instance so that multiple calls can be chained.</returns>
<remarks>
See <see href="https://aka.ms/efcore-docs-keys">Keys</see> for more information and examples.
</remarks>
</Docs>
</Member>
</Members>
</Type>