| title | Object-Relational Mapping Integrations with GitHub Copilot | ||
|---|---|---|---|
| titleSuffix | MSSQL Extension for Visual Studio Code | ||
| description | Reference guide for using GitHub Copilot with the MSSQL extension across Entity Framework, Prisma, Sequelize, SQLAlchemy, Django ORM, TypeORM, Drizzle, and Dapper. | ||
| author | rwestMSFT | ||
| ms.author | randolphwest | ||
| ms.reviewer | roblescarlos | ||
| ms.date | 06/01/2026 | ||
| ms.service | sql | ||
| ms.subservice | vs-code-sql-extensions | ||
| ms.topic | reference | ||
| ms.collection |
|
||
| ai-usage | ai-assisted |
GitHub Copilot and the MSSQL extension work with every major object-relational mapping (ORM) framework for SQL Server and Azure SQL Database. This reference covers the supported ORMs, what each can do, and an end-to-end example that takes you from a SQL Server table to a typed model, migration, and data access method.
- GitHub Copilot generates models, migrations, and data access code tailored to your chosen ORM.
- The
@mssqlchat participant reads your database schema and uses it as context when generating ORM code. - Custom instructions can enforce conventions across both Transact-SQL (T-SQL) and ORM layers.
| ORM | Stack | Models | Migrations | Schema-first | Code-first |
|---|---|---|---|---|---|
| Entity Framework Core | .NET / C# | Yes | Yes | Yes | Yes |
| Prisma | Node.js / TypeScript | Yes | Yes | Yes | Yes |
| Sequelize | Node.js | Yes | Yes | Yes | Yes |
| SQLAlchemy | Python | Yes | Yes (via Alembic) | Yes | Yes |
| Django ORM | Python | Yes | Yes | Yes | Limited |
| TypeORM | Node.js / TypeScript | Yes | Yes | Yes | Yes |
| Drizzle | Node.js / TypeScript | Yes | Yes | Yes | Yes |
| Dapper | .NET / C# | Micro-ORM | Manual | No | Yes |
Each section uses the same scenario: you have SalesLT.Customer in SQL Server and want to add an email column, generate a typed model, and produce a data access method.
@mssql Generate an Entity Framework Core entity class for
SalesLT.Customer. Use C# records where appropriate. Target
Entity Framework Core 9 with SQL Server provider.
@mssql Generate an Entity Framework Core migration to add an
`Email` column (nvarchar(256), nullable) to the Customer entity.
Use the EF Core Add-Migration conventions and include both the
Up and Down methods.
@mssql Write a CustomerRepository method that returns all active
customers ordered by LastName. Use the DbContext pattern, async/await,
and return IReadOnlyList<Customer>.
@mssql Generate a Prisma model for SalesLT.Customer using the
sqlserver provider. Use @map annotations to match the existing
column names. Set the primary key and unique constraints explicitly.
@mssql Generate a Prisma migration SQL file to add an `email`
column (NVARCHAR(256), nullable) to the SalesLT.Customer table,
compatible with the sqlserver provider.
@mssql Write a TypeScript function that uses the Prisma client to
return all active customers ordered by last name, including strict
TypeScript types.
@mssql Generate a Sequelize model class for SalesLT.Customer using
the sequelize-typescript decorators pattern. Include data type
mappings for DATETIME2 and NVARCHAR columns.
@mssql Generate a Sequelize migration in JavaScript to add an
`email` column (STRING(256), nullable) to the `Customer` table in
the `SalesLT` schema.
@mssql Write a Sequelize repository method using async/await that
returns all active customers ordered by LastName. Use model scopes
for the `active` filter.
@mssql Generate a SQLAlchemy 2.0 model for SalesLT.Customer using
the declarative Mapped[] syntax. Use the pyodbc driver connection
string format for SQL Server.
@mssql Generate an Alembic migration script to add an `email`
column (NVARCHAR(256), nullable) to the SalesLT.Customer table.
Include both upgrade and downgrade functions.
@mssql Write a SQLAlchemy 2.0 async repository method using
select() and scalars() that returns all active customers ordered
by last name.
@mssql Generate a Django model for SalesLT.Customer using
django-mssql-backend. Include Meta.db_table to map to the
existing table name with the SalesLT schema.
@mssql Generate a Django migration to add an `email` field
(CharField, max_length=256, null=True) to the Customer model.
Use the AddField operation.
@mssql Write a Django queryset manager method that returns all
active customers ordered by last_name, using select_related for
any foreign key fields.
@mssql Generate a TypeORM entity class for SalesLT.Customer.
Use decorators for @Entity, @Column, @PrimaryGeneratedColumn.
Include DATETIME2 and NVARCHAR mappings for SQL Server.
@mssql Generate a TypeORM migration class to add an `email`
column (nvarchar 256, nullable) to the SalesLT.Customer table.
Include both up and down methods.
@mssql Write a TypeORM repository method that uses the query
builder to return all active customers ordered by last name.
Include strict TypeScript types.
@mssql Generate a Drizzle schema definition for SalesLT.Customer
using the mssql dialect. Include type-safe column mappings for
nvarchar, datetime2, and bit types.
@mssql Generate a Drizzle migration SQL file to add an `email`
column (nvarchar 256, nullable) to the SalesLT.Customer table.
@mssql Write a Drizzle query using the query builder that returns
all active customers ordered by last name. Use type-safe column
references.
Dapper is a micro-ORM with no schema generation or migration support, but GitHub Copilot can generate data access methods that use Dapper's extension methods against an existing schema.
@mssql Write a Dapper-based repository method in C# that returns
all active customers ordered by LastName. Use parameterized
queries and a typed Customer record.
- Entity Framework Core + SQL Server collation. For case-sensitive comparisons, explicitly set
EF.Functions.Collatein queries. Don't assume default collation matches SQL Server's server-level setting. - Prisma + MSSQL connection string quoting. Azure SQL Database connection strings need careful URL encoding of special characters in passwords. See the Prisma SQL Server provider docs.
- SQLAlchemy + pyodbc driver. Install and reference the correct driver version (
ODBC Driver 18 for SQL Serveras of 2026). Pin versions inrequirements.txtto avoid surprises. - Django ORM + primary key mapping.
IDENTITYcolumns require thedjango-mssql-backendpackage andIDENTITY_INSERThandling for data loads. - TypeORM + camelCase. Set
entityPrefixand use naming strategies to align with your custom instructions if your team uses a specific convention.
[!INCLUDE copilot-feedback]