Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add readme for sql server #30466

Merged
merged 4 commits into from
Sep 6, 2023
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions src/EFCore.SqlServer/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
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.

## Getting started

Explain how to use your package, provide clear and concise getting started instructions, including any necessary steps.
ajcvickers marked this conversation as resolved.
Show resolved Hide resolved
ajcvickers marked this conversation as resolved.
Show resolved Hide resolved

### Prerequisites

- Supported database Engines: Microsoft SQL Server (2012 onwards)
- 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.
ajcvickers marked this conversation as resolved.
Show resolved Hide resolved

## Usage

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:

```csharp
protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
optionsBuilder.UseSqlServer("Server=(localdb)\\mssqllocaldb;Database=MyDatabase;Trusted_Connection=True;");
}
```

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.
ajcvickers marked this conversation as resolved.
Show resolved Hide resolved

## Features

The SQL Server provider for Entity Framework Core supports a variety of features, including:

- Basic CRUD operations
- Transactions
- Stored procedures
- Views
- Table-valued functions
- Identity columns
- In-memory tables
ajcvickers marked this conversation as resolved.
Show resolved Hide resolved

## Additional documentation

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).

## Feedback

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).