-
Notifications
You must be signed in to change notification settings - Fork 40
/
EntityFrameworkServiceCollectionExtensions.xml
97 lines (96 loc) · 6.58 KB
/
EntityFrameworkServiceCollectionExtensions.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
<Type Name="EntityFrameworkServiceCollectionExtensions" FullName="Microsoft.EntityFrameworkCore.Infrastructure.EntityFrameworkServiceCollectionExtensions">
<TypeSignature Language="C#" Value="public static class EntityFrameworkServiceCollectionExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit EntityFrameworkServiceCollectionExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.EntityFrameworkCore.Infrastructure.EntityFrameworkServiceCollectionExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module EntityFrameworkServiceCollectionExtensions" />
<TypeSignature Language="F#" Value="type EntityFrameworkServiceCollectionExtensions = class" />
<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>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Extension methods for setting up Entity Framework related services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AddEntityFramework">
<MemberSignature Language="C#" Value="public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddEntityFramework (this Microsoft.Extensions.DependencyInjection.IServiceCollection serviceCollection);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Extensions.DependencyInjection.IServiceCollection AddEntityFramework(class Microsoft.Extensions.DependencyInjection.IServiceCollection serviceCollection) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Infrastructure.EntityFrameworkServiceCollectionExtensions.AddEntityFramework(Microsoft.Extensions.DependencyInjection.IServiceCollection)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AddEntityFramework (serviceCollection As IServiceCollection) As IServiceCollection" />
<MemberSignature Language="F#" Value="static member AddEntityFramework : Microsoft.Extensions.DependencyInjection.IServiceCollection -> Microsoft.Extensions.DependencyInjection.IServiceCollection" Usage="Microsoft.EntityFrameworkCore.Infrastructure.EntityFrameworkServiceCollectionExtensions.AddEntityFramework serviceCollection" />
<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>
<Attributes>
<Attribute FrameworkAlternate="efcore-2.0;efcore-2.1;efcore-2.2">
<AttributeName Language="C#">[System.Obsolete("AddEntityFramework is no longer functional. Use AddEntityFrameworkSqlServer, AddEntityFrameworkSqlite, etc. instead.", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("AddEntityFramework is no longer functional. Use AddEntityFrameworkSqlServer, AddEntityFrameworkSqlite, etc. instead.", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Extensions.DependencyInjection.IServiceCollection</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="serviceCollection" Type="Microsoft.Extensions.DependencyInjection.IServiceCollection" RefType="this" />
</Parameters>
<Docs>
<param name="serviceCollection"> The service collection. </param>
<summary>
This method is no longer functional. Call a provider-specific method such as
AddEntityFrameworkSqlServer, AddEntityFrameworkSqlite, etc. instead.
</summary>
<returns> Always throws NotSupportedException. </returns>
<remarks>
<para>
You only need to use this functionality when you want Entity Framework to resolve the services it uses
from an external <see cref="T:System.IServiceProvider" />. If you are not using an external
<see cref="T:System.IServiceProvider" /> Entity Framework will take care of creating the services it requires.
</para>
<para>
The database you are using will also define extension methods that can be called on the returned
<see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to register the services required by the database.
For example, when using Microsoft.EntityFrameworkCore.SqlServer you would call
<c>collection.AddEntityFrameworkSqlServer()</c>.
</para>
<para>
For derived contexts to be registered in the <see cref="T:System.IServiceProvider" /> and resolve their services
from the <see cref="T:System.IServiceProvider" /> you must chain a call to the
<see cref="M:Microsoft.Extensions.DependencyInjection.EntityFrameworkServiceCollectionExtensions.AddDbContext``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.EntityFrameworkCore.DbContextOptionsBuilder},Microsoft.Extensions.DependencyInjection.ServiceLifetime)" />
method on the returned <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
</para>
</remarks>
<exception cref="T:System.NotSupportedException"> Always throws NotSupportedException. </exception>
<example>
<code>
public void ConfigureServices(IServiceCollection services)
{
var connectionString = "connection string to database";
services.AddDbContext<MyContext>(options => options.UseSqlServer(connectionString));
}
</code>
</example>
</Docs>
</Member>
</Members>
</Type>