-
Notifications
You must be signed in to change notification settings - Fork 40
/
IBatchExecutor.xml
133 lines (133 loc) · 9.34 KB
/
IBatchExecutor.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
<Type Name="IBatchExecutor" FullName="Microsoft.EntityFrameworkCore.Update.IBatchExecutor">
<TypeSignature Language="C#" Value="public interface IBatchExecutor" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IBatchExecutor" 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.Update.IBatchExecutor" />
<TypeSignature Language="VB.NET" Value="Public Interface IBatchExecutor" />
<TypeSignature Language="F#" Value="type IBatchExecutor = interface" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IBatchExecutor" FrameworkAlternate="efcore-8.0" />
<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>
<Interfaces />
<Docs>
<summary>
<para>
A service for executing one or more batches of insert/update/delete commands against a database.
</para>
<para>
This type is typically used by database providers; 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="Execute">
<MemberSignature Language="C#" Value="public int Execute (System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Update.ModificationCommandBatch> commandBatches, Microsoft.EntityFrameworkCore.Storage.IRelationalConnection connection);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 Execute(class System.Collections.Generic.IEnumerable`1<class Microsoft.EntityFrameworkCore.Update.ModificationCommandBatch> commandBatches, class Microsoft.EntityFrameworkCore.Storage.IRelationalConnection connection) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Update.IBatchExecutor.Execute(System.Collections.Generic.IEnumerable{Microsoft.EntityFrameworkCore.Update.ModificationCommandBatch},Microsoft.EntityFrameworkCore.Storage.IRelationalConnection)" />
<MemberSignature Language="VB.NET" Value="Public Function Execute (commandBatches As IEnumerable(Of ModificationCommandBatch), connection As IRelationalConnection) As Integer" />
<MemberSignature Language="F#" Value="abstract member Execute : seq<Microsoft.EntityFrameworkCore.Update.ModificationCommandBatch> * Microsoft.EntityFrameworkCore.Storage.IRelationalConnection -> int" Usage="iBatchExecutor.Execute (commandBatches, connection)" />
<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>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="commandBatches" Type="System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Update.ModificationCommandBatch>" />
<Parameter Name="connection" Type="Microsoft.EntityFrameworkCore.Storage.IRelationalConnection" />
</Parameters>
<Docs>
<param name="commandBatches">The batches to execute.</param>
<param name="connection">The database connection to use.</param>
<summary>
Executes the commands in the batches against the given database connection.
</summary>
<returns>The total number of rows affected.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExecuteAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<int> ExecuteAsync (System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Update.ModificationCommandBatch> commandBatches, Microsoft.EntityFrameworkCore.Storage.IRelationalConnection connection, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<int32> ExecuteAsync(class System.Collections.Generic.IEnumerable`1<class Microsoft.EntityFrameworkCore.Update.ModificationCommandBatch> commandBatches, class Microsoft.EntityFrameworkCore.Storage.IRelationalConnection connection, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Update.IBatchExecutor.ExecuteAsync(System.Collections.Generic.IEnumerable{Microsoft.EntityFrameworkCore.Update.ModificationCommandBatch},Microsoft.EntityFrameworkCore.Storage.IRelationalConnection,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function ExecuteAsync (commandBatches As IEnumerable(Of ModificationCommandBatch), connection As IRelationalConnection, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Integer)" />
<MemberSignature Language="F#" Value="abstract member ExecuteAsync : seq<Microsoft.EntityFrameworkCore.Update.ModificationCommandBatch> * Microsoft.EntityFrameworkCore.Storage.IRelationalConnection * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>" Usage="iBatchExecutor.ExecuteAsync (commandBatches, connection, cancellationToken)" />
<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>System.Threading.Tasks.Task<System.Int32></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="commandBatches" Type="System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Update.ModificationCommandBatch>" />
<Parameter Name="connection" Type="Microsoft.EntityFrameworkCore.Storage.IRelationalConnection" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="commandBatches">The batches to execute.</param>
<param name="connection">The database connection to use.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> to observe while waiting for the task to complete.</param>
<summary>
Executes the commands in the batches against the given database connection.
</summary>
<returns>
A task that represents the asynchronous save operation. The task result contains the
total number of rows affected.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">If the <see cref="T:System.Threading.CancellationToken" /> is canceled.</exception>
</Docs>
</Member>
</Members>
</Type>