-
Notifications
You must be signed in to change notification settings - Fork 40
/
IDatabase.xml
290 lines (290 loc) · 20.9 KB
/
IDatabase.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
<Type Name="IDatabase" FullName="Microsoft.EntityFrameworkCore.Storage.IDatabase">
<TypeSignature Language="C#" Value="public interface IDatabase" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IDatabase" 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;efcore-6.0;efcore-7.0" />
<TypeSignature Language="DocId" Value="T:Microsoft.EntityFrameworkCore.Storage.IDatabase" />
<TypeSignature Language="VB.NET" Value="Public Interface IDatabase" />
<TypeSignature Language="F#" Value="type IDatabase = interface" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IDatabase" FrameworkAlternate="efcore-8.0" />
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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>
<Interfaces />
<Docs>
<summary>
<para>
The main interaction point between a context and the database provider.
</para>
<para>
This interface is typically used by database providers (and other extensions). It is generally
not used in application code.
</para>
</summary>
<remarks>
<para>
The service lifetime is <see cref="F:Microsoft.Extensions.DependencyInjection.ServiceLifetime.Scoped" />. This means that each
<see cref="T:Microsoft.EntityFrameworkCore.DbContext" /> instance will use its own instance of this service.
The implementation may depend on other services registered with any lifetime.
The implementation does not need to be thread-safe.
</para>
<para>
See <see href="https://aka.ms/efcore-docs-providers">Implementation of database providers and extensions</see>
for more information and examples.
</para>
</remarks>
</Docs>
<Members>
<Member MemberName="CompileAsyncQuery<TResult>">
<MemberSignature Language="C#" Value="public Func<Microsoft.EntityFrameworkCore.Query.QueryContext,System.Collections.Generic.IAsyncEnumerable<TResult>> CompileAsyncQuery<TResult> (Remotion.Linq.QueryModel queryModel);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Func`2<class Microsoft.EntityFrameworkCore.Query.QueryContext, class System.Collections.Generic.IAsyncEnumerable`1<!!TResult>> CompileAsyncQuery<TResult>(class Remotion.Linq.QueryModel queryModel) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Storage.IDatabase.CompileAsyncQuery``1(Remotion.Linq.QueryModel)" />
<MemberSignature Language="VB.NET" Value="Public Function CompileAsyncQuery(Of TResult) (queryModel As QueryModel) As Func(Of QueryContext, IAsyncEnumerable(Of TResult))" />
<MemberSignature Language="F#" Value="abstract member CompileAsyncQuery : Remotion.Linq.QueryModel -> Func<Microsoft.EntityFrameworkCore.Query.QueryContext, System.Collections.Generic.IAsyncEnumerable<'Result>>" Usage="iDatabase.CompileAsyncQuery queryModel" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Func<Microsoft.EntityFrameworkCore.Query.QueryContext,System.Collections.Generic.IAsyncEnumerable<TResult>></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TResult" />
</TypeParameters>
<Parameters>
<Parameter Name="queryModel" Type="Remotion.Linq.QueryModel" Index="0" FrameworkAlternate="efcore-1.0;efcore-1.1;efcore-2.0;efcore-2.1;efcore-2.2" />
</Parameters>
<Docs>
<typeparam name="TResult"> The type of results returned by the query. </typeparam>
<param name="queryModel"> An object model representing the query to be executed. </param>
<summary>
Translates a query model into a function that can be executed to asynchronously get query results from the database.
</summary>
<returns> A function that will asynchronously execute the query. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CompileQuery<TResult>">
<MemberSignature Language="C#" Value="public Func<Microsoft.EntityFrameworkCore.Query.QueryContext,System.Collections.Generic.IEnumerable<TResult>> CompileQuery<TResult> (Remotion.Linq.QueryModel queryModel);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Func`2<class Microsoft.EntityFrameworkCore.Query.QueryContext, class System.Collections.Generic.IEnumerable`1<!!TResult>> CompileQuery<TResult>(class Remotion.Linq.QueryModel queryModel) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Storage.IDatabase.CompileQuery``1(Remotion.Linq.QueryModel)" />
<MemberSignature Language="VB.NET" Value="Public Function CompileQuery(Of TResult) (queryModel As QueryModel) As Func(Of QueryContext, IEnumerable(Of TResult))" />
<MemberSignature Language="F#" Value="abstract member CompileQuery : Remotion.Linq.QueryModel -> Func<Microsoft.EntityFrameworkCore.Query.QueryContext, seq<'Result>>" Usage="iDatabase.CompileQuery queryModel" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Func<Microsoft.EntityFrameworkCore.Query.QueryContext,System.Collections.Generic.IEnumerable<TResult>></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TResult" />
</TypeParameters>
<Parameters>
<Parameter Name="queryModel" Type="Remotion.Linq.QueryModel" Index="0" FrameworkAlternate="efcore-1.0;efcore-1.1;efcore-2.0;efcore-2.1;efcore-2.2" />
</Parameters>
<Docs>
<typeparam name="TResult"> The type of results returned by the query. </typeparam>
<param name="queryModel"> An object model representing the query to be executed. </param>
<summary>
Translates a query model into a function that can be executed to get query results from the database.
</summary>
<returns> A function that will execute the query. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CompileQuery<TResult>">
<MemberSignature Language="C#" Value="public Func<Microsoft.EntityFrameworkCore.Query.QueryContext,TResult> CompileQuery<TResult> (System.Linq.Expressions.Expression query, bool async);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Func`2<class Microsoft.EntityFrameworkCore.Query.QueryContext, !!TResult> CompileQuery<TResult>(class System.Linq.Expressions.Expression query, bool async) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Storage.IDatabase.CompileQuery``1(System.Linq.Expressions.Expression,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Function CompileQuery(Of TResult) (query As Expression, async As Boolean) As Func(Of QueryContext, TResult)" />
<MemberSignature Language="F#" Value="abstract member CompileQuery : System.Linq.Expressions.Expression * bool -> Func<Microsoft.EntityFrameworkCore.Query.QueryContext, 'Result>" Usage="iDatabase.CompileQuery (query, async)" />
<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.Func<Microsoft.EntityFrameworkCore.Query.QueryContext,TResult></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TResult" />
</TypeParameters>
<Parameters>
<Parameter Name="query" Type="System.Linq.Expressions.Expression" Index="0" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<Parameter Name="async" Type="System.Boolean" Index="1" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
</Parameters>
<Docs>
<typeparam name="TResult">The type of query result.</typeparam>
<param name="query">The query to compile.</param>
<param name="async">A value indicating whether this is an async query.</param>
<summary>
Compiles the given query to generate a <see cref="T:System.Func`2" />.
</summary>
<returns>A <see cref="T:System.Func`2" /> which can be invoked to get results of the query.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SaveChanges">
<MemberSignature Language="C#" Value="public int SaveChanges (System.Collections.Generic.IList<Microsoft.EntityFrameworkCore.Update.IUpdateEntry> entries);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 SaveChanges(class System.Collections.Generic.IList`1<class Microsoft.EntityFrameworkCore.Update.IUpdateEntry> entries) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Storage.IDatabase.SaveChanges(System.Collections.Generic.IList{Microsoft.EntityFrameworkCore.Update.IUpdateEntry})" />
<MemberSignature Language="VB.NET" Value="Public Function SaveChanges (entries As IList(Of IUpdateEntry)) As Integer" />
<MemberSignature Language="F#" Value="abstract member SaveChanges : System.Collections.Generic.IList<Microsoft.EntityFrameworkCore.Update.IUpdateEntry> -> int" Usage="iDatabase.SaveChanges entries" />
<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>
<Parameter Name="entries" Type="System.Collections.Generic.IList<Microsoft.EntityFrameworkCore.Update.IUpdateEntry>" Index="0" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
</Parameters>
<Docs>
<param name="entries">Entries representing the changes to be persisted.</param>
<summary>
Persists changes from the supplied entries to the database.
</summary>
<returns>The number of state entries persisted to the database.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SaveChanges">
<MemberSignature Language="C#" Value="public int SaveChanges (System.Collections.Generic.IReadOnlyList<Microsoft.EntityFrameworkCore.Update.IUpdateEntry> entries);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 SaveChanges(class System.Collections.Generic.IReadOnlyList`1<class Microsoft.EntityFrameworkCore.Update.IUpdateEntry> entries) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Storage.IDatabase.SaveChanges(System.Collections.Generic.IReadOnlyList{Microsoft.EntityFrameworkCore.Update.IUpdateEntry})" />
<MemberSignature Language="VB.NET" Value="Public Function SaveChanges (entries As IReadOnlyList(Of IUpdateEntry)) As Integer" />
<MemberSignature Language="F#" Value="abstract member SaveChanges : System.Collections.Generic.IReadOnlyList<Microsoft.EntityFrameworkCore.Update.IUpdateEntry> -> int" Usage="iDatabase.SaveChanges entries" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="entries" Type="System.Collections.Generic.IReadOnlyList<Microsoft.EntityFrameworkCore.Update.IUpdateEntry>" Index="0" FrameworkAlternate="efcore-1.0;efcore-1.1;efcore-2.0;efcore-2.1;efcore-2.2" />
</Parameters>
<Docs>
<param name="entries"> Entries representing the changes to be persisted. </param>
<summary>
Persists changes from the supplied entries to the database.
</summary>
<returns> The number of state entries persisted to the database. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SaveChangesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<int> SaveChangesAsync (System.Collections.Generic.IList<Microsoft.EntityFrameworkCore.Update.IUpdateEntry> entries, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<int32> SaveChangesAsync(class System.Collections.Generic.IList`1<class Microsoft.EntityFrameworkCore.Update.IUpdateEntry> entries, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Storage.IDatabase.SaveChangesAsync(System.Collections.Generic.IList{Microsoft.EntityFrameworkCore.Update.IUpdateEntry},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function SaveChangesAsync (entries As IList(Of IUpdateEntry), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Integer)" />
<MemberSignature Language="F#" Value="abstract member SaveChangesAsync : System.Collections.Generic.IList<Microsoft.EntityFrameworkCore.Update.IUpdateEntry> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>" Usage="iDatabase.SaveChangesAsync (entries, cancellationToken)" />
<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.Threading.Tasks.Task<System.Int32></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="entries" Type="System.Collections.Generic.IList<Microsoft.EntityFrameworkCore.Update.IUpdateEntry>" Index="0" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
</Parameters>
<Docs>
<param name="entries">Entries representing the changes to be persisted.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> to observe while waiting for the task to complete.</param>
<summary>
Asynchronously persists changes from the supplied entries to the database.
</summary>
<returns>
A task that represents the asynchronous save operation. The task result contains the
number of entries persisted to the database.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">If the <see cref="T:System.Threading.CancellationToken" /> is canceled.</exception>
</Docs>
</Member>
<Member MemberName="SaveChangesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<int> SaveChangesAsync (System.Collections.Generic.IReadOnlyList<Microsoft.EntityFrameworkCore.Update.IUpdateEntry> entries, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<int32> SaveChangesAsync(class System.Collections.Generic.IReadOnlyList`1<class Microsoft.EntityFrameworkCore.Update.IUpdateEntry> entries, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Storage.IDatabase.SaveChangesAsync(System.Collections.Generic.IReadOnlyList{Microsoft.EntityFrameworkCore.Update.IUpdateEntry},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function SaveChangesAsync (entries As IReadOnlyList(Of IUpdateEntry), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Integer)" />
<MemberSignature Language="F#" Value="abstract member SaveChangesAsync : System.Collections.Generic.IReadOnlyList<Microsoft.EntityFrameworkCore.Update.IUpdateEntry> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>" Usage="iDatabase.SaveChangesAsync (entries, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Int32></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="entries" Type="System.Collections.Generic.IReadOnlyList<Microsoft.EntityFrameworkCore.Update.IUpdateEntry>" Index="0" FrameworkAlternate="efcore-1.0;efcore-1.1;efcore-2.0;efcore-2.1;efcore-2.2" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="efcore-1.0;efcore-1.1;efcore-2.0;efcore-2.1;efcore-2.2" />
</Parameters>
<Docs>
<param name="entries"> Entries representing the changes to be persisted. </param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> to observe while waiting for the task to complete.</param>
<summary>
Asynchronously persists changes from the supplied entries to the database.
</summary>
<returns>
A task that represents the asynchronous save operation. The task result contains the
number of entries persisted to the database.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>