-
Notifications
You must be signed in to change notification settings - Fork 40
/
DbContextId.xml
321 lines (321 loc) · 17.4 KB
/
DbContextId.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
<Type Name="DbContextId" FullName="Microsoft.EntityFrameworkCore.DbContextId">
<TypeSignature Language="C#" Value="public readonly struct DbContextId" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit DbContextId extends System.ValueType" />
<TypeSignature Language="DocId" Value="T:Microsoft.EntityFrameworkCore.DbContextId" />
<TypeSignature Language="VB.NET" Value="Public Structure DbContextId" />
<TypeSignature Language="F#" Value="type DbContextId = struct" />
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="efcore-3.0;efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.IsReadOnly>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
A unique identifier for the context instance and pool lease, if any.
</summary>
<remarks>
<para>
This identifier is primarily intended as a correlation ID for logging and debugging such
that it is easy to identify that multiple events are using the same or different context instances.
</para>
<para>
See <see href="https://aka.ms/efcore-docs-dbcontext">DbContext lifetime, configuration, and initialization</see>
for more information and examples.
</para>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DbContextId (Guid id, int lease);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Guid id, int32 lease) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.DbContextId.#ctor(System.Guid,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (id As Guid, lease As Integer)" />
<MemberSignature Language="F#" Value="new Microsoft.EntityFrameworkCore.DbContextId : Guid * int -> Microsoft.EntityFrameworkCore.DbContextId" Usage="new Microsoft.EntityFrameworkCore.DbContextId (id, lease)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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>
<Parameters>
<Parameter Name="id" Type="System.Guid" />
<Parameter Name="lease" Type="System.Int32" />
</Parameters>
<Docs>
<param name="id">A unique identifier for the <see cref="T:Microsoft.EntityFrameworkCore.DbContext" /> being used.</param>
<param name="lease">A number indicating whether this is the first, second, third, etc. lease of this instance.</param>
<summary>
Creates a new <see cref="T:Microsoft.EntityFrameworkCore.DbContextId" /> with the given <see cref="P:Microsoft.EntityFrameworkCore.DbContextId.InstanceId" /> and lease number.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public bool Equals (Microsoft.EntityFrameworkCore.DbContextId other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Equals(valuetype Microsoft.EntityFrameworkCore.DbContextId other) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.DbContextId.Equals(Microsoft.EntityFrameworkCore.DbContextId)" />
<MemberSignature Language="VB.NET" Value="Public Function Equals (other As DbContextId) As Boolean" />
<MemberSignature Language="F#" Value="override this.Equals : Microsoft.EntityFrameworkCore.DbContextId -> bool" Usage="dbContextId.Equals other" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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="other" Type="Microsoft.EntityFrameworkCore.DbContextId" />
</Parameters>
<Docs>
<param name="other">The other ID.</param>
<summary>
Compares this ID to another ID to see if they represent the same leased context.
</summary>
<returns>
<see langword="true" /> if they represent the same leased context; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object obj);" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.DbContextId.Equals(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />
<MemberSignature Language="F#" Value="override this.Equals : obj -> bool" Usage="dbContextId.Equals obj" />
<MemberSignature Language="C#" Value="public override bool Equals (object? obj);" FrameworkAlternate="efcore-6.0;efcore-7.0;efcore-8.0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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="obj" Type="System.Object" />
</Parameters>
<Docs>
<param name="obj">The other ID.</param>
<summary>
Compares this ID to another ID to see if they represent the same leased context.
</summary>
<returns>
<see langword="true" /> if they represent the same leased context; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.DbContextId.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="dbContextId.GetHashCode " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
A hash code for this ID.
</summary>
<returns>The hash code.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="InstanceId">
<MemberSignature Language="C#" Value="public Guid InstanceId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Guid InstanceId" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.DbContextId.InstanceId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property InstanceId As Guid" />
<MemberSignature Language="F#" Value="member this.InstanceId : Guid" Usage="Microsoft.EntityFrameworkCore.DbContextId.InstanceId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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.Guid</ReturnType>
</ReturnValue>
<Docs>
<summary>
A unique identifier for the <see cref="T:Microsoft.EntityFrameworkCore.DbContext" /> being used.
</summary>
<value>To be added.</value>
<remarks>
When context pooling is being used, then this ID must be combined with
the <see cref="P:Microsoft.EntityFrameworkCore.DbContextId.Lease" /> in order to get a unique ID for the effective instance being used.
</remarks>
</Docs>
</Member>
<Member MemberName="Lease">
<MemberSignature Language="C#" Value="public int Lease { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Lease" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.DbContextId.Lease" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Lease As Integer" />
<MemberSignature Language="F#" Value="member this.Lease : int" Usage="Microsoft.EntityFrameworkCore.DbContextId.Lease" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
A number that is incremented each time this particular <see cref="T:Microsoft.EntityFrameworkCore.DbContext" /> instance is leased
from the context pool.
</summary>
<value>To be added.</value>
<remarks>
Will be zero if context pooling is not being used.
</remarks>
</Docs>
</Member>
<Member MemberName="op_Equality">
<MemberSignature Language="C#" Value="public static bool operator == (Microsoft.EntityFrameworkCore.DbContextId left, Microsoft.EntityFrameworkCore.DbContextId right);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(valuetype Microsoft.EntityFrameworkCore.DbContextId left, valuetype Microsoft.EntityFrameworkCore.DbContextId right) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.DbContextId.op_Equality(Microsoft.EntityFrameworkCore.DbContextId,Microsoft.EntityFrameworkCore.DbContextId)" />
<MemberSignature Language="VB.NET" Value="Public Shared Operator == (left As DbContextId, right As DbContextId) As Boolean" />
<MemberSignature Language="F#" Value="static member ( = ) : Microsoft.EntityFrameworkCore.DbContextId * Microsoft.EntityFrameworkCore.DbContextId -> bool" Usage="left = right" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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="left" Type="Microsoft.EntityFrameworkCore.DbContextId" />
<Parameter Name="right" Type="Microsoft.EntityFrameworkCore.DbContextId" />
</Parameters>
<Docs>
<param name="left">The first ID.</param>
<param name="right">The second ID.</param>
<summary>
Compares one ID to another ID to see if they represent the same leased context.
</summary>
<returns>
<see langword="true" /> if they represent the same leased context; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="op_Inequality">
<MemberSignature Language="C#" Value="public static bool operator != (Microsoft.EntityFrameworkCore.DbContextId left, Microsoft.EntityFrameworkCore.DbContextId right);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(valuetype Microsoft.EntityFrameworkCore.DbContextId left, valuetype Microsoft.EntityFrameworkCore.DbContextId right) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.DbContextId.op_Inequality(Microsoft.EntityFrameworkCore.DbContextId,Microsoft.EntityFrameworkCore.DbContextId)" />
<MemberSignature Language="VB.NET" Value="Public Shared Operator != (left As DbContextId, right As DbContextId) As Boolean" />
<MemberSignature Language="F#" Value="static member op_Inequality : Microsoft.EntityFrameworkCore.DbContextId * Microsoft.EntityFrameworkCore.DbContextId -> bool" Usage="Microsoft.EntityFrameworkCore.DbContextId.op_Inequality (left, right)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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="left" Type="Microsoft.EntityFrameworkCore.DbContextId" />
<Parameter Name="right" Type="Microsoft.EntityFrameworkCore.DbContextId" />
</Parameters>
<Docs>
<param name="left">The first ID.</param>
<param name="right">The second ID.</param>
<summary>
Compares one ID to another ID to see if they represent different leased contexts.
</summary>
<returns>
<see langword="true" /> if they represent different leased contexts; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.DbContextId.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="dbContextId.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns the instance ID and lease number.
</summary>
<returns>The instance ID and lease number.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>