Skip to content

Commit bb8a309

Browse files
lyndaidaiiLynn Daiajcvickers
authored
Add readme for sql server (#30466)
Co-authored-by: Lynn Dai <[email protected]> Co-authored-by: Arthur Vickers <[email protected]>
1 parent 65d6102 commit bb8a309

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

src/EFCore.SqlServer/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Microsoft.EntityFrameworkCore.SqlServer is the database provider for Microsoft SQL Server and Azure SQL. This providers allows you to use Entity Framework Core with Microsoft SQL Server and Azure SQL databases.
2+
3+
## Getting started
4+
5+
`Microsoft.EntityFrameworkCore.Design` contains all the design-time logic for Entity Framework Core. It's the code that all of the various tools (PMC cmdlets like `Add-Migration`, `dotnet ef` & `ef.exe`) call into.
6+
7+
If you don't use Migrations or Reverse Engineering, you don't need it.
8+
9+
And when you do need it, we encourage `PrivateAssets="All" `so it doesn't get published to the server where you almost certainly won't need it.
10+
11+
### Prerequisites
12+
13+
- Supported database Engines: Microsoft SQL Server (2012 onwards)
14+
- The provider references Microsoft.Data.SqlClient (not System.Data.SqlClient). If your project takes a direct dependency on SqlClient, make sure it references the Microsoft.Data.SqlClient package.
15+
16+
## Usage
17+
18+
Once you've installed the package, you can use it in your Entity Framework Core application by specifying the SQL Server provider in your DbContext's OnConfiguring method:
19+
20+
```csharp
21+
protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
22+
{
23+
optionsBuilder.UseSqlServer("Server=(localdb)\\mssqllocaldb;Database=MyDatabase;Trusted_Connection=True;");
24+
}
25+
```
26+
27+
In this example, we're using the (localdb)\mssqllocaldb server with the MyDatabase database. You'll need to adjust the connection string to match your own SQL Server instance and database.
28+
29+
## Features
30+
31+
The SQL Server provider supports all common features of [Entity Framework Core](https://learn.microsoft.com/ef/core/) as well as some [SQL Server-specific features](https://learn.microsoft.com/ef/core/providers/sql-server/?tabs=dotnet-core-cli) including temporal tables and memory-optimized tables.
32+
33+
## Additional documentation
34+
35+
For more information on using the SQL Server provider for Entity Framework Core, you can refer to the official [documentation](https://learn.microsoft.com/en-us/ef/core/providers/sql-server/?tabs=dotnet-core-cli).
36+
37+
## Feedback
38+
39+
If you encounter a bug or would like to request a feature, [submit an Github issue](https://github.com/dotnet/efcore/issues/new/choose). For more details, see [getting support](https://github.com/dotnet/efcore/blob/main/.github/SUPPORT.md).

0 commit comments

Comments
 (0)