-
Notifications
You must be signed in to change notification settings - Fork 40
/
IReadOnlySequence.xml
335 lines (335 loc) · 18.3 KB
/
IReadOnlySequence.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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
<Type Name="IReadOnlySequence" FullName="Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence">
<TypeSignature Language="C#" Value="public interface IReadOnlySequence : Microsoft.EntityFrameworkCore.Infrastructure.IReadOnlyAnnotatable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IReadOnlySequence implements class Microsoft.EntityFrameworkCore.Infrastructure.IReadOnlyAnnotatable" FrameworkAlternate="efcore-6.0;efcore-7.0" />
<TypeSignature Language="DocId" Value="T:Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence" />
<TypeSignature Language="VB.NET" Value="Public Interface IReadOnlySequence
Implements IReadOnlyAnnotatable" />
<TypeSignature Language="F#" Value="type IReadOnlySequence = interface
 interface IReadOnlyAnnotatable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IReadOnlySequence implements class Microsoft.EntityFrameworkCore.Infrastructure.IReadOnlyAnnotatable" FrameworkAlternate="efcore-8.0" />
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Relational</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.EntityFrameworkCore.Infrastructure.IReadOnlyAnnotatable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Represents a database sequence in the model.
</summary>
<remarks>
See <see href="https://aka.ms/efcore-docs-sequences">Database sequences</see> for more information and examples.
</remarks>
</Docs>
<Members>
<Member MemberName="ClrType">
<MemberSignature Language="C#" Value="public Type ClrType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Type ClrType" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.ClrType" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ClrType As Type" />
<MemberSignature Language="F#" Value="member this.ClrType : Type" Usage="Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.ClrType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Relational</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="efcore-6.0">
<AttributeName Language="C#">[System.Obsolete("Use Type")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use Type")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.Type" /> of values returned by the sequence.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IncrementBy">
<MemberSignature Language="C#" Value="public int IncrementBy { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 IncrementBy" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.IncrementBy" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IncrementBy As Integer" />
<MemberSignature Language="F#" Value="member this.IncrementBy : int" Usage="Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.IncrementBy" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Relational</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the amount incremented to obtain each new value in the sequence.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsCyclic">
<MemberSignature Language="C#" Value="public bool IsCyclic { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsCyclic" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.IsCyclic" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsCyclic As Boolean" />
<MemberSignature Language="F#" Value="member this.IsCyclic : bool" Usage="Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.IsCyclic" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Relational</AssemblyName>
<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>
<Docs>
<summary>
Gets the value indicating whether the sequence will start again from the beginning when the max value
is reached.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxValue">
<MemberSignature Language="C#" Value="public long? MaxValue { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int64> MaxValue" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.MaxValue" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MaxValue As Nullable(Of Long)" />
<MemberSignature Language="F#" Value="member this.MaxValue : Nullable<int64>" Usage="Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.MaxValue" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Relational</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.Int64></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the maximum value supported by the sequence, or <see langword="null" /> if none has been set.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MinValue">
<MemberSignature Language="C#" Value="public long? MinValue { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int64> MinValue" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.MinValue" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MinValue As Nullable(Of Long)" />
<MemberSignature Language="F#" Value="member this.MinValue : Nullable<int64>" Usage="Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.MinValue" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Relational</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.Int64></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the minimum value supported by the sequence, or <see langword="null" /> if none has been set.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Model">
<MemberSignature Language="C#" Value="public Microsoft.EntityFrameworkCore.Metadata.IReadOnlyModel Model { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.EntityFrameworkCore.Metadata.IReadOnlyModel Model" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.Model" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Model As IReadOnlyModel" />
<MemberSignature Language="F#" Value="member this.Model : Microsoft.EntityFrameworkCore.Metadata.IReadOnlyModel" Usage="Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.Model" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Relational</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.Metadata.IReadOnlyModel</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the model in which this sequence is defined.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ModelSchema">
<MemberSignature Language="C#" Value="public string? ModelSchema { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ModelSchema" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.ModelSchema" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ModelSchema As String" />
<MemberSignature Language="F#" Value="member this.ModelSchema : string" Usage="Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.ModelSchema" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Relational</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the model schema of the sequence. This is the one specified in
<see cref="M:Microsoft.EntityFrameworkCore.RelationalModelBuilderExtensions.HasSequence(Microsoft.EntityFrameworkCore.ModelBuilder,System.String,System.String)" /> and the one to use
with <see cref="M:Microsoft.EntityFrameworkCore.RelationalModelExtensions.FindSequence(Microsoft.EntityFrameworkCore.Metadata.IConventionModel,System.String,System.String)" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.Name" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string" Usage="Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Relational</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the name of the sequence in the database.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Schema">
<MemberSignature Language="C#" Value="public string? Schema { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Schema" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.Schema" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Schema As String" />
<MemberSignature Language="F#" Value="member this.Schema : string" Usage="Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.Schema" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Relational</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the database schema that contains the sequence.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartValue">
<MemberSignature Language="C#" Value="public long StartValue { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 StartValue" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.StartValue" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StartValue As Long" />
<MemberSignature Language="F#" Value="member this.StartValue : int64" Usage="Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.StartValue" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Relational</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the value at which the sequence will start.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToDebugString">
<MemberSignature Language="C#" Value="public virtual string ToDebugString (Microsoft.EntityFrameworkCore.Infrastructure.MetadataDebugStringOptions options = Microsoft.EntityFrameworkCore.Infrastructure.MetadataDebugStringOptions.ShortDefault, int indent = 0);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string ToDebugString(valuetype Microsoft.EntityFrameworkCore.Infrastructure.MetadataDebugStringOptions options, int32 indent) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.ToDebugString(Microsoft.EntityFrameworkCore.Infrastructure.MetadataDebugStringOptions,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ToDebugString (Optional options As MetadataDebugStringOptions = Microsoft.EntityFrameworkCore.Infrastructure.MetadataDebugStringOptions.ShortDefault, Optional indent As Integer = 0) As String" />
<MemberSignature Language="F#" Value="abstract member ToDebugString : Microsoft.EntityFrameworkCore.Infrastructure.MetadataDebugStringOptions * int -> string
override this.ToDebugString : Microsoft.EntityFrameworkCore.Infrastructure.MetadataDebugStringOptions * int -> string" Usage="iReadOnlySequence.ToDebugString (options, indent)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Relational</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="options" Type="Microsoft.EntityFrameworkCore.Infrastructure.MetadataDebugStringOptions" />
<Parameter Name="indent" Type="System.Int32" />
</Parameters>
<Docs>
<param name="options">Options for generating the string.</param>
<param name="indent">The number of indent spaces to use before each new line.</param>
<summary>
<para>
Creates a human-readable representation of the given metadata.
</para>
<para>
Warning: Do not rely on the format of the returned string.
It is designed for debugging only and may change arbitrarily between releases.
</para>
</summary>
<returns>A human-readable representation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public Type Type { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Type Type" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.Type" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Type As Type" />
<MemberSignature Language="F#" Value="member this.Type : Type" Usage="Microsoft.EntityFrameworkCore.Metadata.IReadOnlySequence.Type" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore.Relational</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the type of values returned by the sequence.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>