efcore README

The project's README from github.com/dotnet/efcore. As one markdown file: README.md.

Repository

This repository is home to the following .NET Foundation projects. These projects are maintained by Microsoft and licensed under the MIT License.

Entity Framework Core
Microsoft.Data.Sqlite

Entity Framework Core

EF Core is a modern object-database mapper for .NET. It supports LINQ queries, change tracking, updates, and schema migrations. EF Core works with SQL Server, Azure SQL Database, SQLite, Azure Cosmos DB, MariaDB, MySQL, PostgreSQL, and other databases through a provider plugin API.

Installation

EF Core is available on NuGet. Install the provider package corresponding to your target database. See the list of providers in the docs for additional databases.

dotnet add package Microsoft.EntityFrameworkCore.SqlServer
dotnet add package Microsoft.EntityFrameworkCore.Sqlite
dotnet add package Microsoft.EntityFrameworkCore.Cosmos

Use the --version option to specify a preview version to install.

Daily builds

We recommend using the daily builds to get the latest code and provide feedback on EF Core. These builds contain latest features and bug fixes; previews and official releases lag significantly behind.

Basic usage

The following code demonstrates basic usage of EF Core. For a full tutorial configuring the DbContext, defining the model, and creating the database, see getting started in the docs.

using var db = new BloggingContext();

// Inserting data into the database
db.Add(new Blog { Url = "http://blogs.msdn.com/adonet" });
db.SaveChanges();

// Querying
var blog = db.Blogs
    .OrderBy(b => b.BlogId)
    .First();

// Updating
blog.Url = "https://devblogs.microsoft.com/dotnet";
blog.Posts.Add(
    new Post
    {
        Title = "Hello World",
        Content = "I wrote an app using EF Core!"
    });
db.SaveChanges();

// Deleting
db.Remove(blog);
db.SaveChanges();

Build from source

Most people use EF Core by installing pre-built NuGet packages, as shown above. Alternatively, the code can be built and packages can be created directly on your development machine.

Contributing

We welcome community pull requests for bug fixes, enhancements, and documentation. See How to contribute for more information.

Getting support

If you have a specific question about using these projects, we encourage you to ask it on Stack Overflow. If you encounter a bug or would like to request a feature, submit an issue. For more details, see getting support.

Microsoft.Data.Sqlite

Microsoft.Data.Sqlite is a lightweight ADO.NET provider for SQLite. The EF Core provider for SQLite is built on top of this library. However, it can also be used independently or with other data access libraries.

Installation

The latest stable version is available on NuGet.

dotnet add package Microsoft.Data.Sqlite

Use the --version option to specify a preview version to install.

Daily builds

We recommend using the daily builds to get the latest code and provide feedback on Microsoft.Data.Sqlite. These builds contain the latest features and bug fixes; previews and official releases lag significantly behind.

Basic usage

This library implements the common ADO.NET abstractions for connections, commands, data readers, and so on. For more information, see Microsoft.Data.Sqlite on Microsoft Docs.

using var connection = new SqliteConnection("Data Source=Blogs.db");
connection.Open();

using var command = connection.CreateCommand();
command.CommandText = "SELECT Url FROM Blogs";

using var reader = command.ExecuteReader();
while (reader.Read())
{
    var url = reader.GetString(0);
}

Build from source

Most people use Microsoft.Data.Sqlite by installing pre-built NuGet packages, as shown above. Alternatively, the code can be built and packages can be created directly on your development machine.

Contributing

We welcome community pull requests for bug fixes, enhancements, and documentation. See How to contribute for more information.

Getting support

If you have a specific question about using these projects, we encourage you to ask it on Stack Overflow. If you encounter a bug or would like to request a feature, submit an issue. For more details, see getting support.

See also

Searching Database…

14.8K ·GitHub

What is this?

EF Core is a modern object-database mapper for .NET: you query and update data as regular objects, and it handles LINQ queries, change tracking, updates, and schema migrations.

Is it a library I add to my .NET project, or a separate tool I run?

It is a library: you reference EF Core NuGet packages from your .NET code. Most people install the pre-built packages rather than building from source.

How do I get it into my project?

EF Core ships on NuGet - install the provider package that matches your target database, and use the --version option if you want a preview build.

Which databases can I use it with?

SQL Server, Azure SQL Database, SQLite, Azure Cosmos DB, MariaDB, MySQL, PostgreSQL, and other databases - less common ones are supported through a provider plugin API.

Is the latest stable release enough, or should I look elsewhere for new features?

The README recommends the daily builds for the latest code: previews and official releases lag significantly behind the newest features and bug fixes.

What else lives in this repository besides EF Core?

Microsoft.Data.Sqlite - a lightweight ADO.NET provider for SQLite. EF Core's SQLite provider is built on top of it, but the library can also be used independently or with other data access libraries.

Is there a tutorial for my first EF Core app?

Yes - the docs include a getting-started tutorial that walks through configuring the DbContext, defining the model, and creating the database.

What are similar projects?

server, typeorm, nopCommerce, sequelize, Smartstore, aspnetboilerplate, sql-server-samples, orm

Which topics is it in?

entity-framework, mssql, sql-server, dotnet-core, c-sharp, nosql, azure, orm, microsoft, dotnet, c#, csharp

Creator: dotnet
Size: 238.3 MB
Stars: 14.8K
Updated: CommitOct 16 Releasev10.0.13Oct 13
Age: 12y
Commits · 90 Days