From 6faf65ce47caea96ee88d9e44e62da3d3ca73fe0 Mon Sep 17 00:00:00 2001 From: Lynn Dai Date: Mon, 13 Mar 2023 12:19:22 -0700 Subject: [PATCH 1/4] add readme for sql server --- src/EFCore.SqlServer/README.md | 43 ++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 src/EFCore.SqlServer/README.md diff --git a/src/EFCore.SqlServer/README.md b/src/EFCore.SqlServer/README.md new file mode 100644 index 00000000000..c5695090c8e --- /dev/null +++ b/src/EFCore.SqlServer/README.md @@ -0,0 +1,43 @@ +Microsoft.EntityFrameworkCore.SqlServer is Microsoft SQL Server EF Core Database Provider, which enables you to use Entity Framework Core with Microsoft SQL Server (including Azure SQL Database). + +## Getting started + +Explain how to use your package, provide clear and concise getting started instructions, including any necessary steps. + +### 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. + +## 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. + +## 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 + +## 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). \ No newline at end of file From 7a12a4035ae9f87cbc90ea817486f3c56b19eb2b Mon Sep 17 00:00:00 2001 From: Arthur Vickers Date: Wed, 6 Sep 2023 16:04:51 +0100 Subject: [PATCH 2/4] Update src/EFCore.SqlServer/README.md --- src/EFCore.SqlServer/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/EFCore.SqlServer/README.md b/src/EFCore.SqlServer/README.md index c5695090c8e..3a965809532 100644 --- a/src/EFCore.SqlServer/README.md +++ b/src/EFCore.SqlServer/README.md @@ -1,4 +1,4 @@ -Microsoft.EntityFrameworkCore.SqlServer is Microsoft SQL Server EF Core Database Provider, which enables you to use Entity Framework Core with Microsoft SQL Server (including Azure SQL Database). +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 From 672fbce80ec4f908ce517b59a3f5ce434a47b17e Mon Sep 17 00:00:00 2001 From: Arthur Vickers Date: Wed, 6 Sep 2023 16:06:21 +0100 Subject: [PATCH 3/4] Update src/EFCore.SqlServer/README.md --- src/EFCore.SqlServer/README.md | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/src/EFCore.SqlServer/README.md b/src/EFCore.SqlServer/README.md index 3a965809532..1789d25bac6 100644 --- a/src/EFCore.SqlServer/README.md +++ b/src/EFCore.SqlServer/README.md @@ -24,15 +24,7 @@ In this example, we're using the (localdb)\mssqllocaldb server with the MyDataba ## 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 +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. ## Additional documentation From 8bb4f7616fad3a7509d7a17d83e33d0ce7ef80cf Mon Sep 17 00:00:00 2001 From: Arthur Vickers Date: Wed, 6 Sep 2023 16:06:36 +0100 Subject: [PATCH 4/4] Update src/EFCore.SqlServer/README.md --- src/EFCore.SqlServer/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/EFCore.SqlServer/README.md b/src/EFCore.SqlServer/README.md index 1789d25bac6..a6e3b378044 100644 --- a/src/EFCore.SqlServer/README.md +++ b/src/EFCore.SqlServer/README.md @@ -2,7 +2,11 @@ Microsoft.EntityFrameworkCore.SqlServer is the database provider for Microsoft S ## Getting started -Explain how to use your package, provide clear and concise getting started instructions, including any necessary steps. +`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. + +If you don't use Migrations or Reverse Engineering, you don't need it. + +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. ### Prerequisites