-
Notifications
You must be signed in to change notification settings - Fork 40
/
SqlServerKeyExtensions.xml
267 lines (267 loc) · 19.1 KB
/
SqlServerKeyExtensions.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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
<Type Name="SqlServerKeyExtensions" FullName="Microsoft.EntityFrameworkCore.SqlServerKeyExtensions">
<TypeSignature Language="C#" Value="public static class SqlServerKeyExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit SqlServerKeyExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.EntityFrameworkCore.SqlServerKeyExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module SqlServerKeyExtensions" />
<TypeSignature Language="F#" Value="type SqlServerKeyExtensions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.SqlServer</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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Key extension methods for SQL Server-specific metadata.
</summary>
<remarks>
See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see>, and
<see href="https://aka.ms/efcore-docs-sqlserver">Accessing SQL Server and Azure SQL databases with EF Core</see>
for more information and examples.
</remarks>
</Docs>
<Members>
<Member MemberName="GetIsClusteredConfigurationSource">
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource? GetIsClusteredConfigurationSource (this Microsoft.EntityFrameworkCore.Metadata.IConventionKey key);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.Nullable`1<valuetype Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource> GetIsClusteredConfigurationSource(class Microsoft.EntityFrameworkCore.Metadata.IConventionKey key) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.SqlServerKeyExtensions.GetIsClusteredConfigurationSource(Microsoft.EntityFrameworkCore.Metadata.IConventionKey)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetIsClusteredConfigurationSource (key As IConventionKey) As Nullable(Of ConfigurationSource)" />
<MemberSignature Language="F#" Value="static member GetIsClusteredConfigurationSource : Microsoft.EntityFrameworkCore.Metadata.IConventionKey -> Nullable<Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource>" Usage="Microsoft.EntityFrameworkCore.SqlServerKeyExtensions.GetIsClusteredConfigurationSource key" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.SqlServer</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.Nullable<Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="Microsoft.EntityFrameworkCore.Metadata.IConventionKey" RefType="this" />
</Parameters>
<Docs>
<param name="key">The key.</param>
<summary>
Gets the <see cref="T:Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource" /> for whether the key is clustered.
</summary>
<returns>The <see cref="T:Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource" /> for whether the key is clustered.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsClustered">
<MemberSignature Language="C#" Value="public static bool? IsClustered (this Microsoft.EntityFrameworkCore.Metadata.IKey key);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.Nullable`1<bool> IsClustered(class Microsoft.EntityFrameworkCore.Metadata.IKey key) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.SqlServerKeyExtensions.IsClustered(Microsoft.EntityFrameworkCore.Metadata.IKey)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function IsClustered (key As IKey) As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="static member IsClustered : Microsoft.EntityFrameworkCore.Metadata.IKey -> Nullable<bool>" Usage="Microsoft.EntityFrameworkCore.SqlServerKeyExtensions.IsClustered key" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.SqlServer</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="Microsoft.EntityFrameworkCore.Metadata.IKey" RefType="this" Index="0" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0" />
</Parameters>
<Docs>
<param name="key"> The key. </param>
<summary>
Returns a value indicating whether the key is clustered.
</summary>
<returns>
<see langword="true" /> if the key is clustered. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsClustered">
<MemberSignature Language="C#" Value="public static bool? IsClustered (this Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey key);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.Nullable`1<bool> IsClustered(class Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey key) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.SqlServerKeyExtensions.IsClustered(Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function IsClustered (key As IReadOnlyKey) As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="static member IsClustered : Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey -> Nullable<bool>" Usage="Microsoft.EntityFrameworkCore.SqlServerKeyExtensions.IsClustered key" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.SqlServer</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey" RefType="this" Index="0" FrameworkAlternate="efcore-6.0;efcore-7.0;efcore-8.0" />
</Parameters>
<Docs>
<param name="key">The key.</param>
<summary>
Returns a value indicating whether the key is clustered.
</summary>
<returns>
<see langword="true" /> if the key is clustered.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsClustered">
<MemberSignature Language="C#" Value="public static bool? IsClustered (this Microsoft.EntityFrameworkCore.Metadata.IKey key, in Microsoft.EntityFrameworkCore.Metadata.StoreObjectIdentifier storeObject);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.Nullable`1<bool> IsClustered(class Microsoft.EntityFrameworkCore.Metadata.IKey key, [in]valuetype Microsoft.EntityFrameworkCore.Metadata.StoreObjectIdentifier& storeObject) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.SqlServerKeyExtensions.IsClustered(Microsoft.EntityFrameworkCore.Metadata.IKey,Microsoft.EntityFrameworkCore.Metadata.StoreObjectIdentifier@)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function IsClustered (key As IKey, ByRef storeObject As StoreObjectIdentifier) As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="static member IsClustered : Microsoft.EntityFrameworkCore.Metadata.IKey * StoreObjectIdentifier -> Nullable<bool>" Usage="Microsoft.EntityFrameworkCore.SqlServerKeyExtensions.IsClustered (key, storeObject)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.SqlServer</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="Microsoft.EntityFrameworkCore.Metadata.IKey" RefType="this" Index="0" FrameworkAlternate="efcore-5.0" />
<Parameter Name="storeObject" Type="Microsoft.EntityFrameworkCore.Metadata.StoreObjectIdentifier" RefType="ref" Index="1" FrameworkAlternate="efcore-5.0">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.IsReadOnly>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="key"> The key. </param>
<param name="storeObject"> The identifier of the store object. </param>
<summary>
Returns a value indicating whether the key is clustered.
</summary>
<returns>
<see langword="true" /> if the key is clustered. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsClustered">
<MemberSignature Language="C#" Value="public static bool? IsClustered (this Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey key, in Microsoft.EntityFrameworkCore.Metadata.StoreObjectIdentifier storeObject);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.Nullable`1<bool> IsClustered(class Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey key, [in]valuetype Microsoft.EntityFrameworkCore.Metadata.StoreObjectIdentifier& storeObject) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.SqlServerKeyExtensions.IsClustered(Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey,Microsoft.EntityFrameworkCore.Metadata.StoreObjectIdentifier@)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function IsClustered (key As IReadOnlyKey, ByRef storeObject As StoreObjectIdentifier) As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="static member IsClustered : Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey * StoreObjectIdentifier -> Nullable<bool>" Usage="Microsoft.EntityFrameworkCore.SqlServerKeyExtensions.IsClustered (key, storeObject)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.SqlServer</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey" RefType="this" Index="0" FrameworkAlternate="efcore-6.0;efcore-7.0;efcore-8.0" />
<Parameter Name="storeObject" Type="Microsoft.EntityFrameworkCore.Metadata.StoreObjectIdentifier" RefType="ref" Index="1" FrameworkAlternate="efcore-6.0;efcore-7.0;efcore-8.0">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.IsReadOnly>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="key">The key.</param>
<param name="storeObject">The identifier of the store object.</param>
<summary>
Returns a value indicating whether the key is clustered.
</summary>
<returns>
<see langword="true" /> if the key is clustered.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetIsClustered">
<MemberSignature Language="C#" Value="public static void SetIsClustered (this Microsoft.EntityFrameworkCore.Metadata.IMutableKey key, bool? clustered);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void SetIsClustered(class Microsoft.EntityFrameworkCore.Metadata.IMutableKey key, valuetype System.Nullable`1<bool> clustered) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.SqlServerKeyExtensions.SetIsClustered(Microsoft.EntityFrameworkCore.Metadata.IMutableKey,System.Nullable{System.Boolean})" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Sub SetIsClustered (key As IMutableKey, clustered As Nullable(Of Boolean))" />
<MemberSignature Language="F#" Value="static member SetIsClustered : Microsoft.EntityFrameworkCore.Metadata.IMutableKey * Nullable<bool> -> unit" Usage="Microsoft.EntityFrameworkCore.SqlServerKeyExtensions.SetIsClustered (key, clustered)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.SqlServer</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.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="Microsoft.EntityFrameworkCore.Metadata.IMutableKey" RefType="this" />
<Parameter Name="clustered" Type="System.Nullable<System.Boolean>" />
</Parameters>
<Docs>
<param name="key">The key.</param>
<param name="clustered">The value to set.</param>
<summary>
Sets a value indicating whether the key is clustered.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetIsClustered">
<MemberSignature Language="C#" Value="public static void SetIsClustered (this Microsoft.EntityFrameworkCore.Metadata.IConventionKey key, bool? clustered, bool fromDataAnnotation = false);" FrameworkAlternate="efcore-3.0;efcore-3.1" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void SetIsClustered(class Microsoft.EntityFrameworkCore.Metadata.IConventionKey key, valuetype System.Nullable`1<bool> clustered, bool fromDataAnnotation) cil managed" FrameworkAlternate="efcore-3.0;efcore-3.1" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.SqlServerKeyExtensions.SetIsClustered(Microsoft.EntityFrameworkCore.Metadata.IConventionKey,System.Nullable{System.Boolean},System.Boolean)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Sub SetIsClustered (key As IConventionKey, clustered As Nullable(Of Boolean), Optional fromDataAnnotation As Boolean = false)" FrameworkAlternate="efcore-3.0;efcore-3.1" />
<MemberSignature Language="F#" Value="static member SetIsClustered : Microsoft.EntityFrameworkCore.Metadata.IConventionKey * Nullable<bool> * bool -> unit" Usage="Microsoft.EntityFrameworkCore.SqlServerKeyExtensions.SetIsClustered (key, clustered, fromDataAnnotation)" FrameworkAlternate="efcore-3.0;efcore-3.1" />
<MemberSignature Language="C#" Value="public static bool? SetIsClustered (this Microsoft.EntityFrameworkCore.Metadata.IConventionKey key, bool? clustered, bool fromDataAnnotation = false);" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.Nullable`1<bool> SetIsClustered(class Microsoft.EntityFrameworkCore.Metadata.IConventionKey key, valuetype System.Nullable`1<bool> clustered, bool fromDataAnnotation) cil managed" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function SetIsClustered (key As IConventionKey, clustered As Nullable(Of Boolean), Optional fromDataAnnotation As Boolean = false) As Nullable(Of Boolean)" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<MemberSignature Language="F#" Value="static member SetIsClustered : Microsoft.EntityFrameworkCore.Metadata.IConventionKey * Nullable<bool> * bool -> Nullable<bool>" Usage="Microsoft.EntityFrameworkCore.SqlServerKeyExtensions.SetIsClustered (key, clustered, fromDataAnnotation)" FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.SqlServer</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 FrameworkAlternate="efcore-3.0;efcore-3.1">System.Void</ReturnType>
<ReturnType FrameworkAlternate="efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0">System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="Microsoft.EntityFrameworkCore.Metadata.IConventionKey" RefType="this" />
<Parameter Name="clustered" Type="System.Nullable<System.Boolean>" />
<Parameter Name="fromDataAnnotation" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="key">The key.</param>
<param name="clustered">The value to set.</param>
<param name="fromDataAnnotation">Indicates whether the configuration was specified using a data annotation.</param>
<summary>
Sets a value indicating whether the key is clustered.
</summary>
<returns>The configured value.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>