drizzle-team/drizzle-orm (drizzle-kit)
### [`v0.27.1`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/0.27.1)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/drizzle-kit@0.27.0...drizzle-kit@0.27.1)
- 🎉 Added support for [Neon HTTP driver](https://neon.tech/docs/serverless/serverless-driver)
```typescript
import { neon, neonConfig } from '@neondatabase/serverless';
import { drizzle } from 'drizzle-orm/neon-http';
neonConfig.fetchConnectionCache = true;
const sql = neon(process.env.DRIZZLE_DATABASE_URL!);
const db = drizzle(sql);
db.select(...)
```
### [`v0.27.0`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/0.27.0)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/drizzle-kit@0.26.2...drizzle-kit@0.27.0)
#### Correct behavior when installed in a monorepo (multiple Drizzle instances)
Replacing all `instanceof` statements with a custom `is()` function allowed us to handle multiple Drizzle packages interacting properly.
**It also fixes one of our biggest Discord tickets: `maximum call stack exceeded` 🎉**
You should now use `is()` instead of `instanceof` to check if specific objects are instances of specific Drizzle types. It might be useful if you are building something on top of the Drizzle API.
```ts
import { is, Column } from 'drizzle-orm'
if (is(value, Column)) {
// value's type is narrowed to Column
}
```
#### `distinct` clause support
```ts
await db.selectDistinct().from(usersDistinctTable).orderBy(
usersDistinctTable.id,
usersDistinctTable.name,
);
```
Also, `distinct on` clause is available for PostgreSQL:
```ts
await db.selectDistinctOn([usersDistinctTable.id]).from(usersDistinctTable).orderBy(
usersDistinctTable.id,
);
await db.selectDistinctOn([usersDistinctTable.name], { name: usersDistinctTable.name }).from(
usersDistinctTable,
).orderBy(usersDistinctTable.name);
```
#### `bigint` and `boolean` support for SQLite
Contributed by [@MrRahulRamkumar](https://redirect.github.com/MrRahulRamkumar) ([#558](https://redirect.github.com/drizzle-team/drizzle-orm/issues/558)), [@raducristianpopa](https://redirect.github.com/raducristianpopa) ([#411](https://redirect.github.com/drizzle-team/drizzle-orm/issues/411)) and [@meech-ward](https://redirect.github.com/meech-ward) ([#725](https://redirect.github.com/drizzle-team/drizzle-orm/issues/725))
```ts
const users = sqliteTable('users', {
bigintCol: blob('bigint', { mode: 'bigint' }).notNull(),
boolCol: integer('bool', { mode: 'boolean' }).notNull(),
});
```
#### DX improvements
- Added verbose type error when relational queries are used on a database type without a schema generic
- Fix `where` callback in RQB for tables without relations
#### Various docs improvements
- Fix joins docs typo ([#522](https://redirect.github.com/drizzle-team/drizzle-orm/issues/522)) by [@arjunyel](https://redirect.github.com/arjunyel)
- Add Supabase guide to readme ([#690](https://redirect.github.com/drizzle-team/drizzle-orm/issues/690)) by [@saltcod](https://redirect.github.com/saltcod)
- Make the column type in sqlite clearer ([#717](https://redirect.github.com/drizzle-team/drizzle-orm/issues/717)) by [@shairez](https://redirect.github.com/shairez)
### [`v0.26.2`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/drizzle-kit%400.26.2)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/drizzle-kit@0.26.1...drizzle-kit@0.26.2)
- Updated internal versions for the drizzle-kit and drizzle-orm packages. Changes were introduced in the last minor release, and you are required to upgrade both packages to ensure they work as expected
### [`v0.26.1`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/drizzle-kit%400.26.1)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/drizzle-kit@0.26.0...drizzle-kit@0.26.1)
- Fix `data is malformed` for views
### [`v0.26.0`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/drizzle-kit%400.26.0)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/drizzle-kit@0.25.0...drizzle-kit@0.26.0)
> While writing this update, we found one bug that may occur with views in MySQL and SQLite, so please use the `drizzle-kit@0.26.1` release
### New Features
#### Checks support in `drizzle-kit`
You can use drizzle-kit to manage your `check` constraint defined in drizzle-orm schema definition
For example current drizzle table:
```ts
import { sql } from "drizzle-orm";
import { check, pgTable } from "drizzle-orm/pg-core";
export const users = pgTable(
"users",
(c) => ({
id: c.uuid().defaultRandom().primaryKey(),
username: c.text().notNull(),
age: c.integer(),
}),
(table) => ({
checkConstraint: check("age_check", sql`${table.age} > 21`),
})
);
```
will be generated into
```sql
CREATE TABLE IF NOT EXISTS "users" (
"id" uuid PRIMARY KEY DEFAULT gen_random_uuid() NOT NULL,
"username" text NOT NULL,
"age" integer,
CONSTRAINT "age_check" CHECK ("users"."age" > 21)
);
```
The same is supported in all dialects
##### Limitations
- `generate` will work as expected for all check constraint changes.
- `push` will detect only check renames and will recreate the constraint. All other changes to SQL won't be detected and will be ignored.
So, if you want to change the constraint's SQL definition using only `push`, you would need to manually comment out the constraint, `push`, then put it back with the new SQL definition and `push` one more time.
#### Views support in `drizzle-kit`
You can use drizzle-kit to manage your `views` defined in drizzle-orm schema definition. It will work with all existing dialects and view options
##### PostgreSQL
For example current drizzle table:
```ts
import { sql } from "drizzle-orm";
import {
check,
pgMaterializedView,
pgTable,
pgView,
} from "drizzle-orm/pg-core";
export const users = pgTable(
"users",
(c) => ({
id: c.uuid().defaultRandom().primaryKey(),
username: c.text().notNull(),
age: c.integer(),
}),
(table) => ({
checkConstraint: check("age_check", sql`${table.age} > 21`),
})
);
export const simpleView = pgView("simple_users_view").as((qb) =>
qb.select().from(users)
);
export const materializedView = pgMaterializedView(
"materialized_users_view"
).as((qb) => qb.select().from(users));
```
will be generated into
```sql
CREATE TABLE IF NOT EXISTS "users" (
"id" uuid PRIMARY KEY DEFAULT gen_random_uuid() NOT NULL,
"username" text NOT NULL,
"age" integer,
CONSTRAINT "age_check" CHECK ("users"."age" > 21)
);
CREATE VIEW "public"."simple_users_view" AS (select "id", "username", "age" from "users");
CREATE MATERIALIZED VIEW "public"."materialized_users_view" AS (select "id", "username", "age" from "users");
```
Views supported in all dialects, but materialized views are supported only in PostgreSQL
##### Limitations
- `generate` will work as expected for all view changes
- `push` limitations:
1. If you want to change the view's SQL definition using only `push`, you would need to manually comment out the view, `push`, then put it back with the new SQL definition and `push` one more time.
#### Updates for PostgreSQL enums behavior
We've updated enum behavior in Drizzle with PostgreSQL:
- Add value after or before in enum: With this change, Drizzle will now respect the order of values in the enum and allow adding new values after or before a specific one.
- Support for dropping a value from an enum: In this case, Drizzle will attempt to alter all columns using the enum to text, then drop the existing enum and create a new one with the updated set of values. After that, all columns previously using the enum will be altered back to the new enum.
> If the deleted enum value was used by a column, this process will result in a database error.
- Support for dropping an enum
- Support for moving enums between schemas
- Support for renaming enums
### [`v0.25.0`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/drizzle-kit%400.25.0)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/drizzle-kit@0.24.2...drizzle-kit@0.25.0)
#### Breaking changes and migrate guide for Turso users
If you are using Turso and libsql, you will need to upgrade your `drizzle.config` and `@libsql/client` package.
1. This version of drizzle-orm will only work with `@libsql/client@0.10.0` or higher if you are using the `migrate` function. For other use cases, you can continue using previous versions(But the suggestion is to upgrade)
To install the latest version, use the command:
```bash
npm i @libsql/client@latest
```
2. Previously, we had a common `drizzle.config` for SQLite and Turso users, which allowed a shared strategy for both dialects. Starting with this release, we are introducing the turso dialect in drizzle-kit. We will evolve and improve Turso as a separate dialect with its own migration strategies.
**Before**
```ts
import { defineConfig } from "drizzle-kit";
export default defineConfig({
dialect: "sqlite",
schema: "./schema.ts",
out: "./drizzle",
dbCredentials: {
url: "database.db",
},
breakpoints: true,
verbose: true,
strict: true,
});
```
**After**
```ts
import { defineConfig } from "drizzle-kit";
export default defineConfig({
dialect: "turso",
schema: "./schema.ts",
out: "./drizzle",
dbCredentials: {
url: "database.db",
},
breakpoints: true,
verbose: true,
strict: true,
});
```
If you are using only SQLite, you can use `dialect: "sqlite"`
#### LibSQL/Turso and Sqlite migration updates
##### SQLite "generate" and "push" statements updates
Starting from this release, we will no longer generate comments like this:
```sql
'/*\n SQLite does not support "Changing existing column type" out of the box, we do not generate automatic migration for that, so it has to be done manually'
+ '\n Please refer to: https://www.techonthenet.com/sqlite/tables/alter_table.php'
+ '\n https://www.sqlite.org/lang_altertable.html'
+ '\n https://stackoverflow.com/questions/2083543/modify-a-columns-type-in-sqlite3'
+ "\n\n Due to that we don't generate migration automatically and it has to be done manually"
+ '\n*/'
```
We will generate a set of statements, and you can decide if it's appropriate to create data-moving statements instead. Here is an example of the SQL file you'll receive now:
```sql
PRAGMA foreign_keys=OFF;
--> statement-breakpoint
CREATE TABLE `__new_worker` (
`id` integer PRIMARY KEY NOT NULL,
`name` text NOT NULL,
`salary` text NOT NULL,
`job_id` integer,
FOREIGN KEY (`job_id`) REFERENCES `job`(`id`) ON UPDATE no action ON DELETE no action
);
--> statement-breakpoint
INSERT INTO `__new_worker`("id", "name", "salary", "job_id") SELECT "id", "name", "salary", "job_id" FROM `worker`;
--> statement-breakpoint
DROP TABLE `worker`;
--> statement-breakpoint
ALTER TABLE `__new_worker` RENAME TO `worker`;
--> statement-breakpoint
PRAGMA foreign_keys=ON;
```
##### LibSQL/Turso "generate" and "push" statements updates
Since LibSQL supports more ALTER statements than SQLite, we can generate more statements without recreating your schema and moving all the data, which can be potentially dangerous for production environments.
LibSQL and Turso will now have a separate dialect in the Drizzle config file, meaning that we will evolve Turso and LibSQL independently from SQLite and will aim to support as many features as Turso/LibSQL offer.
With the updated LibSQL migration strategy, you will have the ability to:
- **Change Data Type**: Set a new data type for existing columns.
- **Set and Drop Default Values**: Add or remove default values for existing columns.
- **Set and Drop NOT NULL**: Add or remove the NOT NULL constraint on existing columns.
- **Add References to Existing Columns**: Add foreign key references to existing columns
You can find more information in the [LibSQL documentation](https://redirect.github.com/tursodatabase/libsql/blob/main/libsql-sqlite3/doc/libsql_extensions.md#altering-columns)
##### LIMITATIONS
- Dropping foreign key will cause table recreation.
This is because LibSQL/Turso does not support dropping this type of foreign key.
```sql
CREATE TABLE `users` (
`id` integer NOT NULL,
`name` integer,
`age` integer PRIMARY KEY NOT NULL
FOREIGN KEY (`name`) REFERENCES `users1`("id") ON UPDATE no action ON DELETE no action
);
```
- If the table has indexes, altering columns will cause index recreation:
Drizzle-Kit will drop the indexes, modify the columns, and then create the indexes.
- Adding or dropping composite foreign keys is not supported and will cause table recreation.
- Primary key columns can not be altered and will cause table recreation.
- Altering columns that are part of foreign key will cause table recreation.
##### NOTES
- You can create a reference on any column type, but if you want to insert values, the referenced column must have a unique index or primary key.
```sql
CREATE TABLE parent(a PRIMARY KEY, b UNIQUE, c, d, e, f);
CREATE UNIQUE INDEX i1 ON parent(c, d);
CREATE INDEX i2 ON parent(e);
CREATE UNIQUE INDEX i3 ON parent(f COLLATE nocase);
CREATE TABLE child1(f, g REFERENCES parent(a)); -- Ok
CREATE TABLE child2(h, i REFERENCES parent(b)); -- Ok
CREATE TABLE child3(j, k, FOREIGN KEY(j, k) REFERENCES parent(c, d)); -- Ok
CREATE TABLE child4(l, m REFERENCES parent(e)); -- Error!
CREATE TABLE child5(n, o REFERENCES parent(f)); -- Error!
CREATE TABLE child6(p, q, FOREIGN KEY(p, q) REFERENCES parent(b, c)); -- Error!
CREATE TABLE child7(r REFERENCES parent(c)); -- Error!
```
> **NOTE**: The foreign key for the table child5 is an error because, although the parent key column has a unique index, the index uses a different collating sequence.
See more: https://www.sqlite.org/foreignkeys.html
#### New `casing` param in `drizzle-orm` and `drizzle-kit`
There are more improvements you can make to your schema definition. The most common way to name your variables in a database and in TypeScript code is usually `snake_case` in the database and `camelCase` in the code. For this case, in Drizzle, you can now define a naming strategy in your database to help Drizzle map column keys automatically. Let's take a table from the previous example and make it work with the new casing API in Drizzle
Table can now become:
```ts
import { pgTable } from "drizzle-orm/pg-core";
export const ingredients = pgTable("ingredients", (t) => ({
id: t.uuid().defaultRandom().primaryKey(),
name: t.text().notNull(),
description: t.text(),
inStock: t.boolean().default(true),
}));
```
As you can see, `inStock` doesn't have a database name alias, but by defining the casing configuration at the connection level, all queries will automatically map it to `snake_case`
```ts
const db = await drizzle('node-postgres', { connection: '', casing: 'snake_case' })
```
For `drizzle-kit` migrations generation you should also specify `casing` param in drizzle config, so you can be sure you casing strategy will be applied to drizzle-kit as well
```ts
import { defineConfig } from "drizzle-kit";
export default defineConfig({
dialect: "postgresql",
schema: "./schema.ts",
dbCredentials: {
url: "postgresql://postgres:password@localhost:5432/db",
},
casing: "snake_case",
});
```
### [`v0.24.2`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/drizzle-kit%400.24.2)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/drizzle-kit@0.24.1...drizzle-kit@0.24.2)
#### New Features
##### 🎉 Support for `pglite` driver
You can now use pglite with all drizzle-kit commands, including Drizzle Studio!
```ts
import { defineConfig } from "drizzle-kit";
export default defineConfig({
dialect: "postgresql",
driver: "pglite",
schema: "./schema.ts",
dbCredentials: {
url: "local-pg.db",
},
verbose: true,
strict: true,
});
```
#### Bug fixes
- mysql-kit: fix GENERATED ALWAYS AS ... NOT NULL - [#2824](https://redirect.github.com/drizzle-team/drizzle-orm/pull/2824)
### [`v0.24.1`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/drizzle-kit%400.24.1)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/drizzle-kit@0.24.0...drizzle-kit@0.24.1)
#### Bug fixes
> Big thanks to [@L-Mario564](https://redirect.github.com/L-Mario564) for his [PR](https://redirect.github.com/drizzle-team/drizzle-orm/pull/2804). It conflicted in most cases with a PR that was merged, but we incorporated some of his logic. Merging it would have caused more problems and taken more time to resolve, so we just took a few things from his PR, like removing "::" mappings in introspect and some array type default handlers
##### What was fixed
1. The Drizzle Kit CLI was not working properly for the `introspect` command.
2. Added the ability to use column names with special characters for all dialects.
3. Included PostgreSQL sequences in the introspection process.
4. Reworked array type introspection and added all test cases.
5. Fixed all (we hope) default issues in PostgreSQL, where `::` was included in the introspected output.
6. `preserve` casing option was broken
##### Tickets that were closed
- [\[BUG\]: invalid schema generation with drizzle-kit introspect:pg](https://redirect.github.com/drizzle-team/drizzle-orm/issues/1210)
- [\[BUG\]\[mysql introspection\]: TS error when introspect column including colon](https://redirect.github.com/drizzle-team/drizzle-orm/issues/1928)
- [\[BUG\]: Unhandled defaults when introspecting postgres db](https://redirect.github.com/drizzle-team/drizzle-orm/issues/1625)
- [\[BUG\]: PostgreSQL Enum Naming and Schema Typing Issue](https://redirect.github.com/drizzle-team/drizzle-orm/issues/2315)
- [\[BUG\]: drizzle-kit instrospect command generates syntax error on varchar column types](https://redirect.github.com/drizzle-team/drizzle-orm/issues/2714)
- [\[BUG\]: Introspecting varchar\[\] type produces syntactically invalid schema.ts](https://redirect.github.com/drizzle-team/drizzle-orm/issues/1633)
- [\[BUG\]: introspect:pg column not using generated enum name](https://redirect.github.com/drizzle-team/drizzle-orm/issues/1648)
- [\[BUG\]: drizzle-kit introspect casing "preserve" config not working](https://redirect.github.com/drizzle-team/drizzle-orm/issues/2773)
- [\[BUG\]: drizzle-kit introspect fails on required param that is defined](https://redirect.github.com/drizzle-team/drizzle-orm/issues/2719)
- [\[BUG\]: Error when running npx drizzle-kit introspect: "Expected object, received string"](https://redirect.github.com/drizzle-team/drizzle-orm/issues/2657)
- [\[BUG\]: Missing index names when running introspect command \[MYSQL\]](https://redirect.github.com/drizzle-team/drizzle-orm/issues/2525)
- [\[BUG\]: drizzle-kit introspect TypeError: Cannot read properties of undefined (reading 'toLowerCase')](https://redirect.github.com/drizzle-team/drizzle-orm/issues/2338)
- [\[BUG\]: Wrong column name when using PgEnum.array()](https://redirect.github.com/drizzle-team/drizzle-orm/issues/2100)
- [\[BUG\]: Incorrect Schema Generated when introspecting extisting pg database](https://redirect.github.com/drizzle-team/drizzle-orm/issues/1985)
- [\[⚠️🐞BUG\]: index() missing argument after introspection, causes tsc error that fails the build](https://redirect.github.com/drizzle-team/drizzle-orm/issues/1870)
- [\[BUG\]: drizzle-kit introspect small errors](https://redirect.github.com/drizzle-team/drizzle-orm/issues/1738)
- [\[BUG\]: Missing bigint import in drizzle-kit introspect](https://redirect.github.com/drizzle-team/drizzle-orm/issues/1020)
### [`v0.24.0`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/0.24.0)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/drizzle-kit@0.23.2...drizzle-kit@0.24.0)
- 🎉 Added iterator support to `mysql2` (sponsored by [@rizen](https://redirect.github.com/rizen) ❤). Read more in the [docs](https://redirect.github.com/drizzle-team/drizzle-orm/blob/main/drizzle-orm/src/mysql-core/README.md#querying-large-datasets)
- ❗ `.prepare()` in MySQL no longer requires a name argument
### [`v0.23.2`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/drizzle-kit%400.23.2)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/0.23.1...drizzle-kit@0.23.2)
- Fixed a bug in PostgreSQL with push and introspect where the `schemaFilter` object was passed. It was detecting enums even in schemas that were not defined in the schemaFilter.
- Fixed the `drizzle-kit up` command to work as expected, starting from the sequences release.
### [`v0.23.1`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/0.23.1)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/0.23.0...0.23.1)
- 🐛 Re-export `InferModel` from `drizzle-orm`
### [`v0.23.0`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/0.23.0)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/50f22b0282a6c7a115da4240fd63d9a3fa596526...0.23.0)
- 🎉 Added Knex and Kysely adapters! They allow you to manage the schemas and migrations with Drizzle and query the data with your favorite query builder. See documentation for more details:
- [Knex adapter](https://redirect.github.com/drizzle-team/drizzle-knex)
- [Kysely adapter](https://redirect.github.com/drizzle-team/drizzle-kysely)
- 🎉 Added "type maps" to all entities. You can access them via the special `_` property. For example:
```ts
const users = mysqlTable('users', {
id: int('id').primaryKey(),
name: text('name').notNull(),
});
type UserFields = typeof users['_']['columns'];
type InsertUser = typeof users['_']['model']['insert'];
```
Full documentation on the type maps is coming soon.
- 🎉 Added `.$type()` method to all column builders to allow overriding the data type. It also replaces the optional generics on columns.
```ts
// Before
const test = mysqlTable('test', {
jsonField: json('json_field'),
});
// After
const test = mysqlTable('test', {
jsonField: json('json_field').$type(),
});
```
- ❗ Changed syntax for text-based enum columns:
```ts
// Before
const test = mysqlTable('test', {
role: text<'admin' | 'user'>('role'),
});
// After
const test = mysqlTable('test', {
role: text('role', { enum: ['admin', 'user'] }),
});
```
- 🎉 Allowed passing an array of values into `.insert().values()` directly without spreading:
```ts
const users = mysqlTable('users', {
id: int('id').primaryKey(),
name: text('name').notNull(),
});
await users.insert().values([
{ name: 'John' },
{ name: 'Jane' },
]);
```
The spread syntax is now deprecated and will be removed in one of the next releases.
- 🎉 Added "table creators" to allow for table name customization:
```ts
import { mysqlTableCreator } from 'drizzle-orm/mysql-core';
const mysqlTable = mysqlTableCreator((name) => `myprefix_${name}`);
const users = mysqlTable('users', {
id: int('id').primaryKey(),
name: text('name').notNull(),
});
// Users table is a normal table, but its name is `myprefix_users` in runtime
```
- 🎉 Implemented support for selecting/joining raw SQL expressions:
```ts
// select current_date + s.a as dates from generate_series(0,14,7) as s(a);
const result = await db
.select({
dates: sql`current_date + s.a`,
})
.from(sql`generate_series(0,14,7) as s(a)`);
```
- 🐛 Fixed a lot of bugs from user feedback on GitHub and Discord (thank you! ❤). Fixes [#293](https://redirect.github.com/drizzle-team/drizzle-orm/issues/293) [#301](https://redirect.github.com/drizzle-team/drizzle-orm/issues/301) [#276](https://redirect.github.com/drizzle-team/drizzle-orm/issues/276) [#269](https://redirect.github.com/drizzle-team/drizzle-orm/issues/269) [#253](https://redirect.github.com/drizzle-team/drizzle-orm/issues/253) [#311](https://redirect.github.com/drizzle-team/drizzle-orm/issues/311) [#312](https://redirect.github.com/drizzle-team/drizzle-orm/issues/312)
### [`v0.22.8`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/db013f5eb7bfb7098bb443493640c79ad0eb8259...50f22b0282a6c7a115da4240fd63d9a3fa596526)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/db013f5eb7bfb7098bb443493640c79ad0eb8259...50f22b0282a6c7a115da4240fd63d9a3fa596526)
### [`v0.22.7`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/c44b9dc66f8e5cf2851067a5266aea6d3325ffef...db013f5eb7bfb7098bb443493640c79ad0eb8259)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/c44b9dc66f8e5cf2851067a5266aea6d3325ffef...db013f5eb7bfb7098bb443493640c79ad0eb8259)
### [`v0.22.6`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/f389ebdf7d98d7379991601bc3c9e28f83fd0c85...c44b9dc66f8e5cf2851067a5266aea6d3325ffef)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/f389ebdf7d98d7379991601bc3c9e28f83fd0c85...c44b9dc66f8e5cf2851067a5266aea6d3325ffef)
### [`v0.22.5`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/c312bb7a11c21171d51f94539260130211d57792...f389ebdf7d98d7379991601bc3c9e28f83fd0c85)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/c312bb7a11c21171d51f94539260130211d57792...f389ebdf7d98d7379991601bc3c9e28f83fd0c85)
### [`v0.22.4`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/0f433ae97e28d862b12d0a7daba7c0b0eb58f8d7...c312bb7a11c21171d51f94539260130211d57792)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/0f433ae97e28d862b12d0a7daba7c0b0eb58f8d7...c312bb7a11c21171d51f94539260130211d57792)
### [`v0.22.3`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/c0b07b840f515eac92f5aaeecf744824fd35348c...0f433ae97e28d862b12d0a7daba7c0b0eb58f8d7)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/c0b07b840f515eac92f5aaeecf744824fd35348c...0f433ae97e28d862b12d0a7daba7c0b0eb58f8d7)
### [`v0.22.2`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/3ba7ffdb3be897bbc325bfa9ae1b2a6cbf4a51ee...c0b07b840f515eac92f5aaeecf744824fd35348c)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/3ba7ffdb3be897bbc325bfa9ae1b2a6cbf4a51ee...c0b07b840f515eac92f5aaeecf744824fd35348c)
### [`v0.22.1`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/0.22.0...3ba7ffdb3be897bbc325bfa9ae1b2a6cbf4a51ee)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/0.22.0...3ba7ffdb3be897bbc325bfa9ae1b2a6cbf4a51ee)
### [`v0.22.0`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/0.22.0)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/0d156e4abc51d7cb65d2087496f3cf9a08f08682...0.22.0)
- 🎉 Introduced a standalone query builder that can be used without a DB connection:
```ts
import { queryBuilder as qb } from 'drizzle-orm/pg-core';
const query = qb.select().from(users).where(eq(users.name, 'Dan'));
const { sql, params } = query.toSQL();
```
- 🎉 Improved `WITH ... SELECT` subquery creation syntax to more resemble SQL:
**Before**:
```ts
const regionalSales = db
.select({
region: orders.region,
totalSales: sql`sum(${orders.amount})`.as('total_sales'),
})
.from(orders)
.groupBy(orders.region)
.prepareWithSubquery('regional_sales');
await db.with(regionalSales).select(...).from(...);
```
**After**:
```ts
const regionalSales = db
.$with('regional_sales')
.as(
db
.select({
region: orders.region,
totalSales: sql`sum(${orders.amount})`.as('total_sales'),
})
.from(orders)
.groupBy(orders.region),
);
await db.with(regionalSales).select(...).from(...);
```
### [`v0.21.4`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/99d3d12d06ebee9a64e9383471acb7905adb8b45...0d156e4abc51d7cb65d2087496f3cf9a08f08682)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/99d3d12d06ebee9a64e9383471acb7905adb8b45...0d156e4abc51d7cb65d2087496f3cf9a08f08682)
### [`v0.21.3`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/28cb4dfda10b15d73230f04ffae2803c86fe6b1e...99d3d12d06ebee9a64e9383471acb7905adb8b45)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/28cb4dfda10b15d73230f04ffae2803c86fe6b1e...99d3d12d06ebee9a64e9383471acb7905adb8b45)
### [`v0.21.2`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/0.21.1...28cb4dfda10b15d73230f04ffae2803c86fe6b1e)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/0.21.1...28cb4dfda10b15d73230f04ffae2803c86fe6b1e)
### [`v0.21.1`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/0.21.1)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/0.21.0...0.21.1)
- 🎉 Added support for `HAVING` clause
- 🎉 Added support for referencing selected fields in `.where()`, `.having()`, `.groupBy()` and `.orderBy()` using an optional callback:
```ts
await db
.select({
id: citiesTable.id,
name: sql`upper(${citiesTable.name})`.as('upper_name'),
usersCount: sql`count(${users2Table.id})::int`.as('users_count'),
})
.from(citiesTable)
.leftJoin(users2Table, eq(users2Table.cityId, citiesTable.id))
.where(({ name }) => sql`length(${name}) >= 3`)
.groupBy(citiesTable.id)
.having(({ usersCount }) => sql`${usersCount} > 0`)
.orderBy(({ name }) => name);
```
### [`v0.21.0`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/0.21.0)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/bbea26653ed37d1cfb391fdb041d584f94b401be...0.21.0)
#### Drizzle ORM 0.21.0 was released 🎉
- Added support for new migration folder structure and breakpoints feature, described in drizzle-kit release section
- Fix `onUpdateNow()` expression generation for default migration statement
##### Support for PostgreSQL array types
***
```ts
export const salEmp = pgTable('sal_emp', {
name: text('name').notNull(),
payByQuarter: integer('pay_by_quarter').array(),
schedule: text('schedule').array().array(),
});
export const tictactoe = pgTable('tictactoe', {
squares: integer('squares').array(3).array(3),
});
```
drizzle kit will generate
```sql
CREATE TABLE sal_emp (
name text,
pay_by_quarter integer[],
schedule text[][]
);
CREATE TABLE tictactoe (
squares integer[3][3]
);
```
##### Added composite primary key support to PostgreSQL and MySQL
***
PostgreSQL
```ts
import { primaryKey } from 'drizzle-orm/pg-core';
export const cpkTable = pgTable('table', {
column1: integer('column1').default(10).notNull(),
column2: integer('column2'),
column3: integer('column3'),
}, (table) => ({
cpk: primaryKey(table.column1, table.column2),
}));
```
MySQL
```ts
import { primaryKey } from 'drizzle-orm/mysql-core';
export const cpkTable = mysqlTable('table', {
simple: int('simple'),
columnNotNull: int('column_not_null').notNull(),
columnDefault: int('column_default').default(100),
}, (table) => ({
cpk: primaryKey(table.simple, table.columnDefault),
}));
```
***
#### Drizzle Kit 0.17.0 was released 🎉
#### Breaking changes
##### Folder structure was migrated to newer version
Before running any new migrations `drizzle-kit` will ask you to upgrade in a first place
Migration file structure < 0.17.0
```plaintext
📦
└ 📂 migrations
└ 📂 20221207174503
├ 📜 migration.sql
├ 📜 snapshot.json
└ 📂 20230101104503
├ 📜 migration.sql
├ 📜 snapshot.json
```
Migration file structure >= 0.17.0
```plaintext
📦
└ 📂 migrations
└ 📂 meta
├ 📜 _journal.json
├ 📜 0000_snapshot.json
├ 📜 0001_snapshot.json
└ 📜 0000_icy_stranger.sql
└ 📜 0001_strange_avengers.sql
```
#### Upgrading to 0.17.0
***
To easily migrate from previous folder structure to new you need to run `up` command in drizzle kit. It's a great helper to upgrade your migrations to new format on each drizzle kit major update
```bash
drizzle-kit up: # dialects: `pg`, `mysql`, `sqlite`
### example for pg
drizzle-kit up:pg
```
#### New Features
##### New `drizzle-kit` command called `drop`
In a case you think some of migrations were generated in a wrong way or you have made migration simultaneously with other developers you can easily rollback it by running simple command
> **Warning**:
> Make sure you are dropping migrations that were not applied to your database
```bash
drizzle-kit drop
```
This command will show you a list of all migrations you have and you'll need just to choose migration you want to drop. After that `drizzle-kit` will do all the hard work on deleting migration files
##### New `drizzle-kit` option `--breakpoints` for `generate` and `introspect` commands
If particular driver doesn't support running multiple quries in 1 execution you can use `--breakpoints`.
`drizzle-kit` will generate current sql
```sql
CREATE TABLE `users` (
`id` int PRIMARY KEY NOT NULL,
`full_name` text NOT NULL,
);
--> statement-breakpoint
CREATE TABLE `table` (
`id` int PRIMARY KEY NOT NULL,
`phone` int,
);
```
Using it `drizzle-orm` will split all sql files by statements and execute them separately
##### Add `drizzle-kit introspect` for MySQL dialect
You can introspect your mysql database using `introspect:mysql` command
```bash
drizzle-kit introspect:mysql --out ./migrations --connectionString mysql://user:password@127.0.0.1:3306/database
```
##### Support for glob patterns for schema path
Usage example in `cli`
```bash
drizzle-kit generate:pg --out ./migrations --schema ./core/**/*.ts ./database/schema.ts
```
Usage example in `drizzle.config`
```text
{
"out: "./migrations",
"schema": ["./core/**/*.ts", "./database/schema.ts"]
}
```
#### Bug Fixes and improvements
##### Postgres dialect
***
**GitHub issue fixes**
- \[pg] char is undefined during introspection [#9](https://redirect.github.com/drizzle-team/drizzle-kit-mirror/issues/9)
- when unknown type is detected, would be nice to emit a TODO comment instead of undefined [#8](https://redirect.github.com/drizzle-team/drizzle-kit-mirror/issues/8)
- "post_id" integer DEFAULT currval('posts_id_seq'::regclass) generates invalid TS [#7](https://redirect.github.com/drizzle-team/drizzle-kit-mirror/issues/7)
- "ip" INET NOT NULL is not supported [#6](https://redirect.github.com/drizzle-team/drizzle-kit-mirror/issues/6)
- "id" UUID NOT NULL DEFAULT uuid_generate_v4() type is not supported [#5](https://redirect.github.com/drizzle-team/drizzle-kit-mirror/issues/5)
- array fields end up as "undefined" in the schema [#4](https://redirect.github.com/drizzle-team/drizzle-kit-mirror/issues/4)
- timestamp is not in the import statement in schema.ts [#3](https://redirect.github.com/drizzle-team/drizzle-kit-mirror/issues/3)
- generated enums are not camel cased [#2](https://redirect.github.com/drizzle-team/drizzle-kit-mirror/issues/2)
**Introspect improvements**
- Add support for composite PK's generation;
- Add support for `cidr`, `inet`, `macaddr`, `macaddr8`, `smallserial`
- Add interval fields generation in schema, such as `minute to second`, `day to hour`, etc.
- Add default values for `numerics`
- Add default values for `enums`
##### MySQL dialect
***
**Migration generation improvements**
- Add `autoincrement` create, delete and update handling
- Add `on update current_timestamp` handling for timestamps
- Add data type changing, using `modify`
- Add `not null` changing, using `modify`
- Add `default` drop and create statements
- Fix `defaults` generation bugs, such as escaping, date strings, expressions, etc
**Introspect improvements**
- Add `autoincrement` to all supported types
- Add `fsp` for time based data types
- Add precision and scale for `double`
- Make time `{ mode: "string" }` by default
- Add defaults to `json`, `decimal` and `binary` datatypes
- Add `enum` data type generation
### [`v0.20.18`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/cdf98626ec33436a6d9bf92aa9f00167b29a07c9...bbea26653ed37d1cfb391fdb041d584f94b401be)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/cdf98626ec33436a6d9bf92aa9f00167b29a07c9...bbea26653ed37d1cfb391fdb041d584f94b401be)
### [`v0.20.17`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/fada231990001b2ab6a4962777aa2e8dbe51681c...cdf98626ec33436a6d9bf92aa9f00167b29a07c9)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/fada231990001b2ab6a4962777aa2e8dbe51681c...cdf98626ec33436a6d9bf92aa9f00167b29a07c9)
### [`v0.20.16`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/efc074b8a39a2994ab97cbb8690dc5d613443b71...fada231990001b2ab6a4962777aa2e8dbe51681c)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/efc074b8a39a2994ab97cbb8690dc5d613443b71...fada231990001b2ab6a4962777aa2e8dbe51681c)
### [`v0.20.15`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/18e6af455c614e7a51d270eea56302bf26ac2da6...efc074b8a39a2994ab97cbb8690dc5d613443b71)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/18e6af455c614e7a51d270eea56302bf26ac2da6...efc074b8a39a2994ab97cbb8690dc5d613443b71)
### [`v0.20.14`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/659c0ec3d419ca1b656b59ae5e428acc32299369...18e6af455c614e7a51d270eea56302bf26ac2da6)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/659c0ec3d419ca1b656b59ae5e428acc32299369...18e6af455c614e7a51d270eea56302bf26ac2da6)
### [`v0.20.13`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/a3bdefdbfdd1f1e33e04af3ab86095c9f59851ec...659c0ec3d419ca1b656b59ae5e428acc32299369)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/a3bdefdbfdd1f1e33e04af3ab86095c9f59851ec...659c0ec3d419ca1b656b59ae5e428acc32299369)
### [`v0.20.12`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/43fa23d7c55a10d9556a9da02ecb05b134663350...a3bdefdbfdd1f1e33e04af3ab86095c9f59851ec)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/43fa23d7c55a10d9556a9da02ecb05b134663350...a3bdefdbfdd1f1e33e04af3ab86095c9f59851ec)
### [`v0.20.11`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/127b973f260930db4b38c266e6e153c946be9f90...43fa23d7c55a10d9556a9da02ecb05b134663350)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/127b973f260930db4b38c266e6e153c946be9f90...43fa23d7c55a10d9556a9da02ecb05b134663350)
### [`v0.20.10`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/e334b245b67b66248979eb5b7c5beae78821061c...127b973f260930db4b38c266e6e153c946be9f90)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/e334b245b67b66248979eb5b7c5beae78821061c...127b973f260930db4b38c266e6e153c946be9f90)
### [`v0.20.9`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/8c21043a25503943c5f004fe76455ba94b32f345...e334b245b67b66248979eb5b7c5beae78821061c)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/8c21043a25503943c5f004fe76455ba94b32f345...e334b245b67b66248979eb5b7c5beae78821061c)
### [`v0.20.8`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/bbf358d421b123430c209c100875d3f2ce27384f...8c21043a25503943c5f004fe76455ba94b32f345)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/bbf358d421b123430c209c100875d3f2ce27384f...8c21043a25503943c5f004fe76455ba94b32f345)
### [`v0.20.7`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/45489ee351ce4a451f522b91e64d7d47606b8bcb...bbf358d421b123430c209c100875d3f2ce27384f)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/45489ee351ce4a451f522b91e64d7d47606b8bcb...bbf358d421b123430c209c100875d3f2ce27384f)
### [`v0.20.6`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/02424c0a522eb3fc431f282acfa5c36e11684393...45489ee351ce4a451f522b91e64d7d47606b8bcb)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/02424c0a522eb3fc431f282acfa5c36e11684393...45489ee351ce4a451f522b91e64d7d47606b8bcb)
### [`v0.20.5`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/b5c47818931f884d1402c16b99ed2bb26fa405a7...02424c0a522eb3fc431f282acfa5c36e11684393)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/b5c47818931f884d1402c16b99ed2bb26fa405a7...02424c0a522eb3fc431f282acfa5c36e11684393)
### [`v0.20.4`](https://redirect.github.com/drizzle-team/drizzle-orm/compare/0.20.3...b5c47818931f884d1402c16b99ed2bb26fa405a7)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/0.20.3...b5c47818931f884d1402c16b99ed2bb26fa405a7)
### [`v0.20.3`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/0.20.3)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/0.20.2...0.20.3)
- 🎉 Added support for locking clauses in SELECT (`SELECT ... FOR UPDATE`):
PostgreSQL
```ts
await db
.select()
.from(users)
.for('update')
.for('no key update', { of: users })
.for('no key update', { of: users, skipLocked: true })
.for('share', { of: users, noWait: true });
```
MySQL
```ts
await db.select().from(users).for('update');
await db.select().from(users).for('share', { skipLocked: true });
await db.select().from(users).for('update', { noWait: true });
```
- 🎉🐛 Custom column types now support returning `SQL` from `toDriver()` method in addition to the `driverData` type from generic.
### [`v0.20.2`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/0.20.2)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/0.20.1...0.20.2)
- 🎉 Added PostgreSQL network data types:
- `inet`
- `cidr`
- `macaddr`
- `macaddr8`
### [`v0.20.1`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/0.20.1)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/0.20.0...0.20.1)
- 🎉 Added `{ logger: true }` shorthand to `drizzle()` to enable query logging. See [logging docs](/drizzle-orm/src/pg-core/README.md#logging) for detailed logging configuration.
### [`v0.20.0`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/0.20.0)
[Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/fd8ba7537f32f614494b48832e4aa7dda891bef6...0.20.0)
- 🎉 **Implemented support for WITH clause ([docs](/drizzle-orm/src/pg-core/README.md#with-clause)). Example usage:**
```ts
const sq = db
.select()
.from(users)
.prepareWithSubquery('sq');
const result = await db
.with(sq)
.select({
id: sq.id,
name: sq.name,
total: sql`count(${sq.id})::int`(),
})
.from(sq)
.groupBy(sq.id, sq.name);
```
- 🐛 Fixed various bugs with selecting/joining of subqueries.
- ❗ Renamed `.subquery('alias')` to `.as('alias')`.
- ❗ ``sql`query`.as()`` is now ``sql`query`()``. Old syntax is still supported, but is deprecated and will be removed in one of the next releases.
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR contains the following updates:
^0.19.13->^0.27.0Release Notes
drizzle-team/drizzle-orm (drizzle-kit)
### [`v0.27.1`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/0.27.1) [Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/drizzle-kit@0.27.0...drizzle-kit@0.27.1) - 🎉 Added support for [Neon HTTP driver](https://neon.tech/docs/serverless/serverless-driver) ```typescript import { neon, neonConfig } from '@neondatabase/serverless'; import { drizzle } from 'drizzle-orm/neon-http'; neonConfig.fetchConnectionCache = true; const sql = neon(process.env.DRIZZLE_DATABASE_URL!); const db = drizzle(sql); db.select(...) ``` ### [`v0.27.0`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/0.27.0) [Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/drizzle-kit@0.26.2...drizzle-kit@0.27.0) #### Correct behavior when installed in a monorepo (multiple Drizzle instances) Replacing all `instanceof` statements with a custom `is()` function allowed us to handle multiple Drizzle packages interacting properly. **It also fixes one of our biggest Discord tickets: `maximum call stack exceeded` 🎉** You should now use `is()` instead of `instanceof` to check if specific objects are instances of specific Drizzle types. It might be useful if you are building something on top of the Drizzle API. ```ts import { is, Column } from 'drizzle-orm' if (is(value, Column)) { // value's type is narrowed to Column } ``` #### `distinct` clause support ```ts await db.selectDistinct().from(usersDistinctTable).orderBy( usersDistinctTable.id, usersDistinctTable.name, ); ``` Also, `distinct on` clause is available for PostgreSQL: ```ts await db.selectDistinctOn([usersDistinctTable.id]).from(usersDistinctTable).orderBy( usersDistinctTable.id, ); await db.selectDistinctOn([usersDistinctTable.name], { name: usersDistinctTable.name }).from( usersDistinctTable, ).orderBy(usersDistinctTable.name); ``` #### `bigint` and `boolean` support for SQLite Contributed by [@MrRahulRamkumar](https://redirect.github.com/MrRahulRamkumar) ([#558](https://redirect.github.com/drizzle-team/drizzle-orm/issues/558)), [@raducristianpopa](https://redirect.github.com/raducristianpopa) ([#411](https://redirect.github.com/drizzle-team/drizzle-orm/issues/411)) and [@meech-ward](https://redirect.github.com/meech-ward) ([#725](https://redirect.github.com/drizzle-team/drizzle-orm/issues/725)) ```ts const users = sqliteTable('users', { bigintCol: blob('bigint', { mode: 'bigint' }).notNull(), boolCol: integer('bool', { mode: 'boolean' }).notNull(), }); ``` #### DX improvements - Added verbose type error when relational queries are used on a database type without a schema generic - Fix `where` callback in RQB for tables without relations #### Various docs improvements - Fix joins docs typo ([#522](https://redirect.github.com/drizzle-team/drizzle-orm/issues/522)) by [@arjunyel](https://redirect.github.com/arjunyel) - Add Supabase guide to readme ([#690](https://redirect.github.com/drizzle-team/drizzle-orm/issues/690)) by [@saltcod](https://redirect.github.com/saltcod) - Make the column type in sqlite clearer ([#717](https://redirect.github.com/drizzle-team/drizzle-orm/issues/717)) by [@shairez](https://redirect.github.com/shairez) ### [`v0.26.2`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/drizzle-kit%400.26.2) [Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/drizzle-kit@0.26.1...drizzle-kit@0.26.2) - Updated internal versions for the drizzle-kit and drizzle-orm packages. Changes were introduced in the last minor release, and you are required to upgrade both packages to ensure they work as expected ### [`v0.26.1`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/drizzle-kit%400.26.1) [Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/drizzle-kit@0.26.0...drizzle-kit@0.26.1) - Fix `data is malformed` for views ### [`v0.26.0`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/drizzle-kit%400.26.0) [Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/drizzle-kit@0.25.0...drizzle-kit@0.26.0) > While writing this update, we found one bug that may occur with views in MySQL and SQLite, so please use the `drizzle-kit@0.26.1` release ### New Features #### Checks support in `drizzle-kit` You can use drizzle-kit to manage your `check` constraint defined in drizzle-orm schema definition For example current drizzle table: ```ts import { sql } from "drizzle-orm"; import { check, pgTable } from "drizzle-orm/pg-core"; export const users = pgTable( "users", (c) => ({ id: c.uuid().defaultRandom().primaryKey(), username: c.text().notNull(), age: c.integer(), }), (table) => ({ checkConstraint: check("age_check", sql`${table.age} > 21`), }) ); ``` will be generated into ```sql CREATE TABLE IF NOT EXISTS "users" ( "id" uuid PRIMARY KEY DEFAULT gen_random_uuid() NOT NULL, "username" text NOT NULL, "age" integer, CONSTRAINT "age_check" CHECK ("users"."age" > 21) ); ``` The same is supported in all dialects ##### Limitations - `generate` will work as expected for all check constraint changes. - `push` will detect only check renames and will recreate the constraint. All other changes to SQL won't be detected and will be ignored. So, if you want to change the constraint's SQL definition using only `push`, you would need to manually comment out the constraint, `push`, then put it back with the new SQL definition and `push` one more time. #### Views support in `drizzle-kit` You can use drizzle-kit to manage your `views` defined in drizzle-orm schema definition. It will work with all existing dialects and view options ##### PostgreSQL For example current drizzle table: ```ts import { sql } from "drizzle-orm"; import { check, pgMaterializedView, pgTable, pgView, } from "drizzle-orm/pg-core"; export const users = pgTable( "users", (c) => ({ id: c.uuid().defaultRandom().primaryKey(), username: c.text().notNull(), age: c.integer(), }), (table) => ({ checkConstraint: check("age_check", sql`${table.age} > 21`), }) ); export const simpleView = pgView("simple_users_view").as((qb) => qb.select().from(users) ); export const materializedView = pgMaterializedView( "materialized_users_view" ).as((qb) => qb.select().from(users)); ``` will be generated into ```sql CREATE TABLE IF NOT EXISTS "users" ( "id" uuid PRIMARY KEY DEFAULT gen_random_uuid() NOT NULL, "username" text NOT NULL, "age" integer, CONSTRAINT "age_check" CHECK ("users"."age" > 21) ); CREATE VIEW "public"."simple_users_view" AS (select "id", "username", "age" from "users"); CREATE MATERIALIZED VIEW "public"."materialized_users_view" AS (select "id", "username", "age" from "users"); ``` Views supported in all dialects, but materialized views are supported only in PostgreSQL ##### Limitations - `generate` will work as expected for all view changes - `push` limitations: 1. If you want to change the view's SQL definition using only `push`, you would need to manually comment out the view, `push`, then put it back with the new SQL definition and `push` one more time. #### Updates for PostgreSQL enums behavior We've updated enum behavior in Drizzle with PostgreSQL: - Add value after or before in enum: With this change, Drizzle will now respect the order of values in the enum and allow adding new values after or before a specific one. - Support for dropping a value from an enum: In this case, Drizzle will attempt to alter all columns using the enum to text, then drop the existing enum and create a new one with the updated set of values. After that, all columns previously using the enum will be altered back to the new enum. > If the deleted enum value was used by a column, this process will result in a database error. - Support for dropping an enum - Support for moving enums between schemas - Support for renaming enums ### [`v0.25.0`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/drizzle-kit%400.25.0) [Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/drizzle-kit@0.24.2...drizzle-kit@0.25.0) #### Breaking changes and migrate guide for Turso users If you are using Turso and libsql, you will need to upgrade your `drizzle.config` and `@libsql/client` package. 1. This version of drizzle-orm will only work with `@libsql/client@0.10.0` or higher if you are using the `migrate` function. For other use cases, you can continue using previous versions(But the suggestion is to upgrade) To install the latest version, use the command: ```bash npm i @libsql/client@latest ``` 2. Previously, we had a common `drizzle.config` for SQLite and Turso users, which allowed a shared strategy for both dialects. Starting with this release, we are introducing the turso dialect in drizzle-kit. We will evolve and improve Turso as a separate dialect with its own migration strategies. **Before** ```ts import { defineConfig } from "drizzle-kit"; export default defineConfig({ dialect: "sqlite", schema: "./schema.ts", out: "./drizzle", dbCredentials: { url: "database.db", }, breakpoints: true, verbose: true, strict: true, }); ``` **After** ```ts import { defineConfig } from "drizzle-kit"; export default defineConfig({ dialect: "turso", schema: "./schema.ts", out: "./drizzle", dbCredentials: { url: "database.db", }, breakpoints: true, verbose: true, strict: true, }); ``` If you are using only SQLite, you can use `dialect: "sqlite"` #### LibSQL/Turso and Sqlite migration updates ##### SQLite "generate" and "push" statements updates Starting from this release, we will no longer generate comments like this: ```sql '/*\n SQLite does not support "Changing existing column type" out of the box, we do not generate automatic migration for that, so it has to be done manually' + '\n Please refer to: https://www.techonthenet.com/sqlite/tables/alter_table.php' + '\n https://www.sqlite.org/lang_altertable.html' + '\n https://stackoverflow.com/questions/2083543/modify-a-columns-type-in-sqlite3' + "\n\n Due to that we don't generate migration automatically and it has to be done manually" + '\n*/' ``` We will generate a set of statements, and you can decide if it's appropriate to create data-moving statements instead. Here is an example of the SQL file you'll receive now: ```sql PRAGMA foreign_keys=OFF; --> statement-breakpoint CREATE TABLE `__new_worker` ( `id` integer PRIMARY KEY NOT NULL, `name` text NOT NULL, `salary` text NOT NULL, `job_id` integer, FOREIGN KEY (`job_id`) REFERENCES `job`(`id`) ON UPDATE no action ON DELETE no action ); --> statement-breakpoint INSERT INTO `__new_worker`("id", "name", "salary", "job_id") SELECT "id", "name", "salary", "job_id" FROM `worker`; --> statement-breakpoint DROP TABLE `worker`; --> statement-breakpoint ALTER TABLE `__new_worker` RENAME TO `worker`; --> statement-breakpoint PRAGMA foreign_keys=ON; ``` ##### LibSQL/Turso "generate" and "push" statements updates Since LibSQL supports more ALTER statements than SQLite, we can generate more statements without recreating your schema and moving all the data, which can be potentially dangerous for production environments. LibSQL and Turso will now have a separate dialect in the Drizzle config file, meaning that we will evolve Turso and LibSQL independently from SQLite and will aim to support as many features as Turso/LibSQL offer. With the updated LibSQL migration strategy, you will have the ability to: - **Change Data Type**: Set a new data type for existing columns. - **Set and Drop Default Values**: Add or remove default values for existing columns. - **Set and Drop NOT NULL**: Add or remove the NOT NULL constraint on existing columns. - **Add References to Existing Columns**: Add foreign key references to existing columns You can find more information in the [LibSQL documentation](https://redirect.github.com/tursodatabase/libsql/blob/main/libsql-sqlite3/doc/libsql_extensions.md#altering-columns) ##### LIMITATIONS - Dropping foreign key will cause table recreation. This is because LibSQL/Turso does not support dropping this type of foreign key. ```sql CREATE TABLE `users` ( `id` integer NOT NULL, `name` integer, `age` integer PRIMARY KEY NOT NULL FOREIGN KEY (`name`) REFERENCES `users1`("id") ON UPDATE no action ON DELETE no action ); ``` - If the table has indexes, altering columns will cause index recreation: Drizzle-Kit will drop the indexes, modify the columns, and then create the indexes. - Adding or dropping composite foreign keys is not supported and will cause table recreation. - Primary key columns can not be altered and will cause table recreation. - Altering columns that are part of foreign key will cause table recreation. ##### NOTES - You can create a reference on any column type, but if you want to insert values, the referenced column must have a unique index or primary key. ```sql CREATE TABLE parent(a PRIMARY KEY, b UNIQUE, c, d, e, f); CREATE UNIQUE INDEX i1 ON parent(c, d); CREATE INDEX i2 ON parent(e); CREATE UNIQUE INDEX i3 ON parent(f COLLATE nocase); CREATE TABLE child1(f, g REFERENCES parent(a)); -- Ok CREATE TABLE child2(h, i REFERENCES parent(b)); -- Ok CREATE TABLE child3(j, k, FOREIGN KEY(j, k) REFERENCES parent(c, d)); -- Ok CREATE TABLE child4(l, m REFERENCES parent(e)); -- Error! CREATE TABLE child5(n, o REFERENCES parent(f)); -- Error! CREATE TABLE child6(p, q, FOREIGN KEY(p, q) REFERENCES parent(b, c)); -- Error! CREATE TABLE child7(r REFERENCES parent(c)); -- Error! ``` > **NOTE**: The foreign key for the table child5 is an error because, although the parent key column has a unique index, the index uses a different collating sequence. See more: https://www.sqlite.org/foreignkeys.html #### New `casing` param in `drizzle-orm` and `drizzle-kit` There are more improvements you can make to your schema definition. The most common way to name your variables in a database and in TypeScript code is usually `snake_case` in the database and `camelCase` in the code. For this case, in Drizzle, you can now define a naming strategy in your database to help Drizzle map column keys automatically. Let's take a table from the previous example and make it work with the new casing API in Drizzle Table can now become: ```ts import { pgTable } from "drizzle-orm/pg-core"; export const ingredients = pgTable("ingredients", (t) => ({ id: t.uuid().defaultRandom().primaryKey(), name: t.text().notNull(), description: t.text(), inStock: t.boolean().default(true), })); ``` As you can see, `inStock` doesn't have a database name alias, but by defining the casing configuration at the connection level, all queries will automatically map it to `snake_case` ```ts const db = await drizzle('node-postgres', { connection: '', casing: 'snake_case' }) ``` For `drizzle-kit` migrations generation you should also specify `casing` param in drizzle config, so you can be sure you casing strategy will be applied to drizzle-kit as well ```ts import { defineConfig } from "drizzle-kit"; export default defineConfig({ dialect: "postgresql", schema: "./schema.ts", dbCredentials: { url: "postgresql://postgres:password@localhost:5432/db", }, casing: "snake_case", }); ``` ### [`v0.24.2`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/drizzle-kit%400.24.2) [Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/drizzle-kit@0.24.1...drizzle-kit@0.24.2) #### New Features ##### 🎉 Support for `pglite` driver You can now use pglite with all drizzle-kit commands, including Drizzle Studio! ```ts import { defineConfig } from "drizzle-kit"; export default defineConfig({ dialect: "postgresql", driver: "pglite", schema: "./schema.ts", dbCredentials: { url: "local-pg.db", }, verbose: true, strict: true, }); ``` #### Bug fixes - mysql-kit: fix GENERATED ALWAYS AS ... NOT NULL - [#2824](https://redirect.github.com/drizzle-team/drizzle-orm/pull/2824) ### [`v0.24.1`](https://redirect.github.com/drizzle-team/drizzle-orm/releases/tag/drizzle-kit%400.24.1) [Compare Source](https://redirect.github.com/drizzle-team/drizzle-orm/compare/drizzle-kit@0.24.0...drizzle-kit@0.24.1) #### Bug fixes > Big thanks to [@L-Mario564](https://redirect.github.com/L-Mario564) for his [PR](https://redirect.github.com/drizzle-team/drizzle-orm/pull/2804). It conflicted in most cases with a PR that was merged, but we incorporated some of his logic. Merging it would have caused more problems and taken more time to resolve, so we just took a few things from his PR, like removing "::Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.