[Snyk] Upgrade drizzle-orm from 0.31.2 to 0.32.0 #977
Conversation
Snyk has created this PR to upgrade drizzle-orm from 0.31.2 to 0.32.0. See this package in npm: drizzle-orm See this project in Snyk: https://app.snyk.io/org/nialljoemaher/project/8ac19f6c-c7f2-4720-acd1-09701979877c?utm_source=github&utm_medium=referral&page=upgrade-pr
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Important Review skippedIgnore keyword(s) in the title. Ignored keywords (1)
Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
|
Uh oh! @NiallJoeMaher, the image you shared is missing helpful alt text. Check your pull request body. Alt text is an invisible description that helps screen readers describe images to blind or low-vision users. If you are using markdown to display images, add your alt text inside the brackets of the markdown image. Learn more about alt text at Basic writing and formatting syntax: images on GitHub Docs. |
Snyk has created this PR to upgrade drizzle-orm from 0.31.2 to 0.32.0.
ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.
The recommended version is 19 versions ahead of your current version.
The recommended version was released on 22 days ago.
Release notes
Package name: drizzle-orm
-
0.32.0 - 2024-07-10
import { boolean, int, text, mysqlTable } from 'drizzle-orm/mysql-core';
import { varchar, text, mysqlTable } from 'drizzle-orm/mysql-core';
import { pgSchema, pgSequence } from "drizzle-orm/pg-core";
import { pgTable, integer, text } from 'drizzle-orm/pg-core'
import { SQL, sql } from "drizzle-orm";
-
-
-
-
-
-
import { defineConfig } from "drizzle-kit";
- Mark prisma clients package as optional - thanks @ Cherry
-
0.31.3 - 2024-07-08
- 🛠️ Fixed RQB behavior for tables with same names in different schemas
- 🛠️ Fixed [BUG]: Mismatched type hints when using RDS Data API - #2097
import { PrismaClient } from '@ prisma/client';
-
0.31.3-a90773c - 2024-07-08
-
0.31.2 - 2024-06-07
-
import { connect } from '@ tidbcloud/serverless';
from drizzle-orm GitHub release notesRelease notes for
drizzle-orm@0.32.0anddrizzle-kit@0.23.0New Features
🎉 MySQL
$returningId()functionMySQL itself doesn't have native support for
RETURNINGafter usingINSERT. There is only one way to do it forprimary keyswithautoincrement(orserial) types, where you can accessinsertIdandaffectedRowsfields. We've prepared an automatic way for you to handle such cases with Drizzle and automatically receive all inserted IDs as separate objectsconst usersTable = mysqlTable('users', {
id: int('id').primaryKey(),
name: text('name').notNull(),
verified: boolean('verified').notNull().default(false),
});
const result = await db.insert(usersTable).values([{ name: 'John' }, { name: 'John1' }]).$returningId();
// ^? { id: number }[]
Also with Drizzle, you can specify a
primary keywith$defaultfunction that will generate custom primary keys at runtime. We will also return those generated keys for you in the$returningId()callimport { createId } from '@ paralleldrive/cuid2';
const usersTableDefFn = mysqlTable('users_default_fn', {
customId: varchar('id', { length: 256 }).primaryKey().$defaultFn(createId),
name: text('name').notNull(),
});
const result = await db.insert(usersTableDefFn).values([{ name: 'John' }, { name: 'John1' }]).$returningId();
// ^? { customId: string }[]
🎉 PostgreSQL Sequences
You can now specify sequences in Postgres within any schema you need and define all the available properties
Example
// No params specified
export const customSequence = pgSequence("name");
// Sequence with params
export const customSequence = pgSequence("name", {
startWith: 100,
maxValue: 10000,
minValue: 100,
cycle: true,
cache: 10,
increment: 2
});
// Sequence in custom schema
export const customSchema = pgSchema('custom_schema');
export const customSequence = customSchema.sequence("name");
🎉 PostgreSQL Identity Columns
Source: As mentioned, the
serialtype in Postgres is outdated and should be deprecated. Ideally, you should not use it.Identity columnsare the recommended way to specify sequences in your schema, which is why we are introducing theidentity columnsfeatureExample
export const ingredients = pgTable("ingredients", {
id: integer("id").primaryKey().generatedAlwaysAsIdentity({ startWith: 1000 }),
name: text("name").notNull(),
description: text("description"),
});
You can specify all properties available for sequences in the
.generatedAlwaysAsIdentity()function. Additionally, you can specify custom names for these sequencesPostgreSQL docs reference.
🎉 PostgreSQL Generated Columns
You can now specify generated columns on any column supported by PostgreSQL to use with generated columns
Example with generated column for
tsvectorimport { customType, index, integer, pgTable, text } from "drizzle-orm/pg-core";
const tsVector = customType<{ data: string }>({
dataType() {
return "tsvector";
},
});
export const test = pgTable(
"test",
{
id: integer("id").primaryKey().generatedAlwaysAsIdentity(),
content: text("content"),
contentSearch: tsVector("content_search", {
dimensions: 3,
}).generatedAlwaysAs(
(): SQL => sql
to_tsvector('english', <span class="pl-s1"><span class="pl-kos">${</span><span class="pl-s1">test</span><span class="pl-kos">.</span><span class="pl-c1">content</span><span class="pl-kos">}</span></span>)),
},
(t) => ({
idx: index("idx_content_search").using("gin", t.contentSearch),
})
);
In case you don't need to reference any columns from your table, you can use just
sqltemplate or astring🎉 MySQL Generated Columns
You can now specify generated columns on any column supported by MySQL to use with generated columns
You can specify both
storedandvirtualoptions, for more info you can check MySQL docsAlso MySQL has a few limitation for such columns usage, which is described here
Drizzle Kit will also have limitations for
pushcommand:You can't change the generated constraint expression and type using
push. Drizzle-kit will ignore this change. To make it work, you would need todrop the column,push, and thenadd a column with a new expression. This was done due to the complex mapping from the database side, where the schema expression will be modified on the database side and, on introspection, we will get a different string. We can't be sure if you changed this expression or if it was changed and formatted by the database. As long as these are generated columns andpushis mostly used for prototyping on a local database, it should be fast todropandcreategenerated columns. Since these columns aregenerated, all the data will be restoredgenerateshould have no limitationsExample
In case you don't need to reference any columns from your table, you can use just
sqltemplate or astringin.generatedAlwaysAs()🎉 SQLite Generated Columns
You can now specify generated columns on any column supported by SQLite to use with generated columns
You can specify both
storedandvirtualoptions, for more info you can check SQLite docsAlso SQLite has a few limitation for such columns usage, which is described here
Drizzle Kit will also have limitations for
pushandgeneratecommand:You can't change the generated constraint expression with the stored type in an existing table. You would need to delete this table and create it again. This is due to SQLite limitations for such actions. We will handle this case in future releases (it will involve the creation of a new table with data migration).
You can't add a
storedgenerated expression to an existing column for the same reason as above. However, you can add avirtualexpression to an existing column.You can't change a
storedgenerated expression in an existing column for the same reason as above. However, you can change avirtualexpression.You can't change the generated constraint type from
virtualtostoredfor the same reason as above. However, you can change fromstoredtovirtual.New Drizzle Kit features
🎉 Migrations support for all the new orm features
PostgreSQL sequences, identity columns and generated columns for all dialects
🎉 New flag
--forcefordrizzle-kit pushYou can auto-accept all data-loss statements using the push command. It's only available in CLI parameters. Make sure you always use it if you are fine with running data-loss statements on your database
🎉 New
migrationsflagprefixYou can now customize migration file prefixes to make the format suitable for your migration tools:
indexis the default type and will result in0001_name.sqlfile names;supabaseandtimestampare equal and will result in20240627123900_name.sqlfile names;unixwill result in unix seconds prefixes1719481298_name.sqlfile names;nonewill omit the prefix completely;Example: Supabase migrations format
export default defineConfig({
dialect: "postgresql",
migrations: {
prefix: 'supabase'
}
});
0.32.0-e7cf338 - 2024-06-25
0.32.0-d0d6436 - 2024-06-27
0.32.0-af7ce99 - 2024-06-17
0.32.0-aaf764c - 2024-07-09
0.32.0-85c8008 - 2024-06-24
0.32.0-857ba54 - 2024-06-11
0.32.0-81cb794 - 2024-06-22
0.32.0-7721c7c - 2024-06-22
0.32.0-7612dda - 2024-07-09
0.32.0-5cc2ae0 - 2024-06-27
0.32.0-4ed01aa - 2024-06-12
0.32.0-0fdaa9e - 2024-06-25
0.32.0-0d48b64 - 2024-06-07
0.32.0-0a6885d - 2024-06-13
0.32.0-55471 - 2024-06-12
0.31.4 - 2024-07-08
Bug fixed
New Prisma-Drizzle extension
import { drizzle } from 'drizzle-orm/prisma/pg';
import { User } from './drizzle';
const prisma = new PrismaClient().$extends(drizzle());
const users = await prisma.$drizzle.select().from(User);
For more info, check docs: https://orm.drizzle.team/docs/prisma
🎉 Added support for TiDB Cloud Serverless driver:
import { drizzle } from 'drizzle-orm/tidb-serverless';
const client = connect({ url: '...' });
const db = drizzle(client);
await db.select().from(...);
Important
Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.
For more information: