chore(deps): update dependency drizzle-kit to v0.28.0

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
drizzle-kit (source)	0.21.4 -> 0.28.0

---

Release Notes

drizzle-team/drizzle-orm (drizzle-kit)

v0.28.0

Compare Source

Improvements

• Added an OHM static imports checker to identify unexpected imports within a chain of imports in the drizzle-kit repo. For example, it checks if drizzle-orm is imported before drizzle-kit and verifies if the drizzle-orm import is available in your project.
• Adding more columns to Supabase auth.users table schema - thanks @​nicholasdly

Bug Fixes

• [BUG]: [drizzle-kit]: Fix breakpoints option cannot be disabled - thanks @​klotztech
• [BUG]: drizzle-kit introspect: SMALLINT import missing and incorrect DECIMAL UNSIGNED handling - thanks @​L-Mario564
• Unsigned tinyints preventing migrations - thanks @​L-Mario564
• [BUG]: Can't parse float(8,2) from database (precision and scale and/or unsigned breaks float types) - thanks @​L-Mario564
• [BUG]: PgEnum generated migration doesn't escape single quotes - thanks @​L-Mario564
• [BUG]: single quote not escaped correctly in migration file - thanks @​L-Mario564
• [BUG]: Migrations does not escape single quotes - thanks @​L-Mario564
• [BUG]: Issue with quoted default string values - thanks @​L-Mario564
• [BUG]: SQl commands in wrong roder - thanks @​L-Mario564
• [BUG]: Time with precision in drizzle-orm/pg-core adds double-quotes around type - thanks @​L-Mario564
• [BUG]: Postgres push fails due to lack of quotes - thanks @​L-Mario564
• [BUG]: TypeError: Cannot read properties of undefined (reading 'compositePrimaryKeys') - thanks @​L-Mario564
• [BUG]: drizzle-kit introspect generates CURRENT_TIMESTAMP without sql operator on date column - thanks @​L-Mario564
• [BUG]: Drizzle-kit introspect doesn't pull correct defautl statement - thanks @​L-Mario564
• [BUG]: Problem on MacBook - This statement does not return data. Use run() instead - thanks @​L-Mario564
• [BUG]: Enum column names that are used as arrays are not quoted - thanks @​L-Mario564
• [BUG]: drizzle-kit generate ignores index operators - thanks @​L-Mario564
• dialect param config error message is wrong - thanks @​L-Mario564
• [BUG]: Error setting default enum field values - thanks @​L-Mario564
• [BUG]: drizzle-kit does not respect the order of columns configured in primaryKey() - thanks @​L-Mario564
• [BUG]: Cannot drop Unique Constraint MySQL - thanks @​L-Mario564

v0.27.2

Compare Source

• Fix [BUG]: Undefined properties when using drizzle-kit push
• Fix TypeError: Cannot read properties of undefined (reading 'isRLSEnabled')
• Fix push bugs, when pushing a schema with linked policy to a table from drizzle-orm/supabase

v0.27.1

Compare Source

• 🎉 Added support for Neon HTTP driver

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

Compare Source

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.

import { is, Column } from 'drizzle-orm'

if (is(value, Column)) {
  // value's type is narrowed to Column
}

distinct clause support

await db.selectDistinct().from(usersDistinctTable).orderBy(
  usersDistinctTable.id,
  usersDistinctTable.name,
);

Also, distinct on clause is available for PostgreSQL:

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 (#​558), @​raducristianpopa (#​411) and @​meech-ward (#​725)

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) by @​arjunyel
• Add Supabase guide to readme (#​690) by @​saltcod
• Make the column type in sqlite clearer (#​717) by @​shairez

v0.26.2

Compare Source

• 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

Compare Source

• Fix data is malformed for views

v0.26.0

Compare Source

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:

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

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:

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

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

Compare Source

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:

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

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

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:

      '/*\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:

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

LIMITATIONS

• Dropping foreign key will cause table recreation.

This is because LibSQL/Turso does not support dropping this type of foreign key.

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.

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:

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

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

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

Compare Source

New Features

🎉 Support for pglite driver

You can now use pglite with all drizzle-kit commands, including Drizzle Studio!

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

v0.24.1

Compare Source

Bug fixes

Big thanks to @​L-Mario564 for his PR. 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 ::<type> 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
• [BUG][mysql introspection]: TS error when introspect column including colon
• [BUG]: Unhandled defaults when introspecting postgres db
• [BUG]: PostgreSQL Enum Naming and Schema Typing Issue
• [BUG]: drizzle-kit instrospect command generates syntax error on varchar column types
• [BUG]: Introspecting varchar[] type produces syntactically invalid schema.ts
• [BUG]: introspect:pg column not using generated enum name
• [BUG]: drizzle-kit introspect casing "preserve" config not working
• [BUG]: drizzle-kit introspect fails on required param that is defined
• [BUG]: Error when running npx drizzle-kit introspect: "Expected object, received string"
• [BUG]: Missing index names when running introspect command [MYSQL]
• [BUG]: drizzle-kit introspect TypeError: Cannot read properties of undefined (reading 'toLowerCase')
• [BUG]: Wrong column name when using PgEnum.array()
• [BUG]: Incorrect Schema Generated when introspecting extisting pg database
• [⚠️🐞BUG]: index() missing argument after introspection, causes tsc error that fails the build
• [BUG]: drizzle-kit introspect small errors
• [BUG]: Missing bigint import in drizzle-kit introspect

v0.24.0

Compare Source

• 🎉 Added iterator support to mysql2 (sponsored by @​rizen ❤). Read more in the docs
• ❗ .prepare() in MySQL no longer requires a name argument

v0.23.2

Compare Source

• 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

Compare Source

• 🐛 Re-export InferModel from drizzle-orm

v0.23.0

Compare Source

• 🎉 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
  • Kysely adapter

• 🎉 Added "type maps" to all entities. You can access them via the special _ property. For example:

  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.

  // Before
  const test = mysqlTable('test', {
    jsonField: json<Data>('json_field'),
  });
  
  // After
  const test = mysqlTable('test', {
    jsonField: json('json_field').$type<Data>(),
  });

• ❗ Changed syntax for text-based enum columns:

  // 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:

  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:

  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:

  // 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 #​301 #​276 #​269 #​253 #​311 #​312

v0.22.8

Compare Source

v0.22.7

Compare Source

v0.22.6

Compare Source

v0.22.5

Compare Source

v0.22.4

Compare Source

v0.22.3

Compare Source

v0.22.2

Compare Source

v0.22.1

Compare Source

v0.22.0

Compare Source

• 🎉 Introduced a standalone query builder that can be used without a DB connection:

  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:

  const regionalSales = db
    .select({
      region: orders.region,
      totalSales: sql`sum(${orders.amount})`.as<number>('total_sales'),
  })
  .from(orders)
  .groupBy(orders.region)
  .prepareWithSubquery('regional_sales');
  
  await db.with(regionalSales).select(...).from(...);

  After:

  const regionalSales = db
    .$with('regional_sales')
    .as(
      db
        .select({
          region: orders.region,
          totalSales: sql<number>`sum(${orders.amount})`.as('total_sales'),
        })
        .from(orders)
        .groupBy(orders.region),
    );
  
  await db.with(regionalSales).select(...).from(...);

---

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 these updates again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
ani	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 6, 2024 10:01pm