-
Notifications
You must be signed in to change notification settings - Fork 40
/
IDatabaseCreator.xml
286 lines (286 loc) · 16.9 KB
/
IDatabaseCreator.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
<Type Name="IDatabaseCreator" FullName="Microsoft.EntityFrameworkCore.Storage.IDatabaseCreator">
<TypeSignature Language="C#" Value="public interface IDatabaseCreator" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IDatabaseCreator" 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.IDatabaseCreator" />
<TypeSignature Language="VB.NET" Value="Public Interface IDatabaseCreator" />
<TypeSignature Language="F#" Value="type IDatabaseCreator = interface" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IDatabaseCreator" 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>
Creates and deletes databases for a given 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="CanConnect">
<MemberSignature Language="C#" Value="public bool CanConnect ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool CanConnect() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Storage.IDatabaseCreator.CanConnect" />
<MemberSignature Language="VB.NET" Value="Public Function CanConnect () As Boolean" />
<MemberSignature Language="F#" Value="abstract member CanConnect : unit -> bool" Usage="iDatabaseCreator.CanConnect " />
<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 />
<Docs>
<summary>
Determines whether or not the database is available and can be connected to.
</summary>
<returns>
<see langword="true" /> if the database is available; <see langword="false" /> otherwise.</returns>
<remarks>
Note that being able to connect to the database does not mean that it is
up-to-date with regard to schema creation, etc.
</remarks>
</Docs>
</Member>
<Member MemberName="CanConnectAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<bool> CanConnectAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<bool> CanConnectAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Storage.IDatabaseCreator.CanConnectAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function CanConnectAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)" />
<MemberSignature Language="F#" Value="abstract member CanConnectAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>" Usage="iDatabaseCreator.CanConnectAsync 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.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" 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="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> to observe while waiting for the task to complete.</param>
<summary>
Determines whether or not the database is available and can be connected to.
</summary>
<returns>
<see langword="true" /> if the database is available; <see langword="false" /> otherwise.</returns>
<remarks>
Note that being able to connect to the database does not mean that it is
up-to-date with regard to schema creation, etc.
</remarks>
<exception cref="T:System.OperationCanceledException">If the <see cref="T:System.Threading.CancellationToken" /> is canceled.</exception>
</Docs>
</Member>
<Member MemberName="EnsureCreated">
<MemberSignature Language="C#" Value="public bool EnsureCreated ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool EnsureCreated() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Storage.IDatabaseCreator.EnsureCreated" />
<MemberSignature Language="VB.NET" Value="Public Function EnsureCreated () As Boolean" />
<MemberSignature Language="F#" Value="abstract member EnsureCreated : unit -> bool" Usage="iDatabaseCreator.EnsureCreated " />
<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>
<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 />
<Docs>
<summary>
Ensures that the database for the context exists. If it exists, no action is taken. If it does not
exist then the database and all its schema are created. If the database exists, then no effort is made
to ensure it is compatible with the model for this context.
</summary>
<returns>
<see langword="true" /> if the database is created, <see langword="false" /> if it already existed.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnsureCreatedAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<bool> EnsureCreatedAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<bool> EnsureCreatedAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Storage.IDatabaseCreator.EnsureCreatedAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function EnsureCreatedAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)" />
<MemberSignature Language="F#" Value="abstract member EnsureCreatedAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>" Usage="iDatabaseCreator.EnsureCreatedAsync 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>
<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.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> to observe while waiting for the task to complete.</param>
<summary>
Asynchronously ensures that the database for the context exists. If it exists, no action is taken. If it does not
exist then the database and all its schema are created. If the database exists, then no effort is made
to ensure it is compatible with the model for this context.
</summary>
<returns>
A task that represents the asynchronous save operation. The task result contains <see langword="true" /> if the database is created,
<see langword="false" /> if it already existed.
</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="EnsureDeleted">
<MemberSignature Language="C#" Value="public bool EnsureDeleted ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool EnsureDeleted() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Storage.IDatabaseCreator.EnsureDeleted" />
<MemberSignature Language="VB.NET" Value="Public Function EnsureDeleted () As Boolean" />
<MemberSignature Language="F#" Value="abstract member EnsureDeleted : unit -> bool" Usage="iDatabaseCreator.EnsureDeleted " />
<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>
<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 />
<Docs>
<summary>
<para>
Ensures that the database for the context does not exist. If it does not exist, no action is taken. If it does
exist then the database is deleted.
</para>
<para>
Warning: The entire database is deleted an no effort is made to remove just the database objects that are used by
the model for this context.
</para>
</summary>
<returns>
<see langword="true" /> if the database is deleted, <see langword="false" /> if it did not exist.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnsureDeletedAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<bool> EnsureDeletedAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<bool> EnsureDeletedAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Storage.IDatabaseCreator.EnsureDeletedAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function EnsureDeletedAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)" />
<MemberSignature Language="F#" Value="abstract member EnsureDeletedAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>" Usage="iDatabaseCreator.EnsureDeletedAsync 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>
<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.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> to observe while waiting for the task to complete.</param>
<summary>
<para>
Asynchronously ensures that the database for the context does not exist. If it does not exist, no action is taken. If it does
exist then the database is deleted.
</para>
<para>
Warning: The entire database is deleted an no effort is made to remove just the database objects that are used by
the model for this context.
</para>
</summary>
<returns>
A task that represents the asynchronous save operation. The task result contains <see langword="true" /> if the database is deleted,
<see langword="false" /> if it did not exist.
</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>