drizzle-kit 0.28.0 → 0.28.1-14e59f4

package/README.md

@@ -1,21 +1,21 @@
 ## Drizzle Kit
 
-DrizzleKit - is a CLI migrator tool for DrizzleORM. It is probably one and only tool that lets you completely automatically generate SQL migrations and covers ~95% of the common cases like deletions and renames by prompting user input.
+Drizzle Kit is a CLI migrator tool for Drizzle ORM. It is probably the one and only tool that lets you completely automatically generate SQL migrations and covers ~95% of the common cases like deletions and renames by prompting user input.
 <https://github.com/drizzle-team/drizzle-kit-mirror> - is a mirror repository for issues.
 
 ## Documentation
 
-Check the full documenation on [the website](https://orm.drizzle.team/kit-docs/overview)
+Check the full documentation on [the website](https://orm.drizzle.team/kit-docs/overview).
 
 ### How it works
 
-`drizzle-kit` will traverse `schema folder` or `schema file`, generate schema snapshot and compare it to the previous version, if there's one.
- Based on the difference it will generate all needed SQL migrations and if there are any `automatically unresolvable` cases like `renames` it will prompt user for input.
+Drizzle Kit traverses a schema module and generates a snapshot to compare with the previous version, if there is one.
+Based on the difference, it will generate all needed SQL migrations. If there are any cases that can't be resolved automatically, such as renames, it will prompt the user for input.
 
-For schema file:
+For example, for this schema module:
 
 ```typescript
-// ./src/db/schema.ts
+// src/db/schema.ts
 
 import { integer, pgTable, serial, text, varchar } from "drizzle-orm/pg-core";
 
@@ -63,7 +63,7 @@ CREATE INDEX IF NOT EXISTS users_full_name_index ON users (full_name);
 npm install -D drizzle-kit
 ```
 
-Running with CLI options
+Running with CLI options:
 
 ```jsonc
 // package.json

package/api.d.mts

@@ -1,12 +1,13 @@
 import { LibSQLDatabase } from 'drizzle-orm/libsql';
 import { MySql2Database } from 'drizzle-orm/mysql2';
 import { PgDatabase } from 'drizzle-orm/pg-core';
-import { C as CasingType, a as Config } from './index-BfiZoTqG.mjs';
+import { SingleStoreDriverDatabase } from 'drizzle-orm/singlestore';
+import { C as CasingType, a as Config } from './index-Z-1TKnbX.mjs';
 import * as zod from 'zod';
 import { TypeOf } from 'zod';
 import 'tls';
 
-declare const schema$1: zod.ZodObject<zod.objectUtil.extendShape<{
+declare const schema$2: zod.ZodObject<zod.objectUtil.extendShape<{
     version: zod.ZodLiteral<"5">;
     dialect: zod.ZodLiteral<"mysql">;
     tables: zod.ZodRecord<zod.ZodString, zod.ZodObject<{
@@ -558,7 +559,7 @@ declare const schema$1: zod.ZodObject<zod.objectUtil.extendShape<{
         definition?: string | undefined;
     }> | undefined;
 }>;
-type MySqlSchema = TypeOf<typeof schema$1>;
+type MySqlSchema = TypeOf<typeof schema$2>;
 
 declare const pgSchema: zod.ZodObject<zod.objectUtil.extendShape<{
     version: zod.ZodLiteral<"7">;
@@ -1805,6 +1806,339 @@ declare const pgSchema: zod.ZodObject<zod.objectUtil.extendShape<{
 }>;
 type PgSchema = TypeOf<typeof pgSchema>;
 
+declare const schema$1: zod.ZodObject<zod.objectUtil.extendShape<{
+    version: zod.ZodLiteral<"1">;
+    dialect: zod.ZodLiteral<"singlestore">;
+    tables: zod.ZodRecord<zod.ZodString, zod.ZodObject<{
+        name: zod.ZodString;
+        columns: zod.ZodRecord<zod.ZodString, zod.ZodObject<{
+            name: zod.ZodString;
+            type: zod.ZodString;
+            primaryKey: zod.ZodBoolean;
+            notNull: zod.ZodBoolean;
+            autoincrement: zod.ZodOptional<zod.ZodBoolean>;
+            default: zod.ZodOptional<zod.ZodAny>;
+            onUpdate: zod.ZodOptional<zod.ZodAny>;
+            generated: zod.ZodOptional<zod.ZodObject<{
+                type: zod.ZodEnum<["stored", "virtual"]>;
+                as: zod.ZodString;
+            }, "strip", zod.ZodTypeAny, {
+                type: "stored" | "virtual";
+                as: string;
+            }, {
+                type: "stored" | "virtual";
+                as: string;
+            }>>;
+        }, "strict", zod.ZodTypeAny, {
+            name: string;
+            type: string;
+            primaryKey: boolean;
+            notNull: boolean;
+            default?: any;
+            onUpdate?: any;
+            autoincrement?: boolean | undefined;
+            generated?: {
+                type: "stored" | "virtual";
+                as: string;
+            } | undefined;
+        }, {
+            name: string;
+            type: string;
+            primaryKey: boolean;
+            notNull: boolean;
+            default?: any;
+            onUpdate?: any;
+            autoincrement?: boolean | undefined;
+            generated?: {
+                type: "stored" | "virtual";
+                as: string;
+            } | undefined;
+        }>>;
+        indexes: zod.ZodRecord<zod.ZodString, zod.ZodObject<{
+            name: zod.ZodString;
+            columns: zod.ZodArray<zod.ZodString, "many">;
+            isUnique: zod.ZodBoolean;
+            using: zod.ZodOptional<zod.ZodEnum<["btree", "hash"]>>;
+            algorithm: zod.ZodOptional<zod.ZodEnum<["default", "inplace", "copy"]>>;
+            lock: zod.ZodOptional<zod.ZodEnum<["default", "none", "shared", "exclusive"]>>;
+        }, "strict", zod.ZodTypeAny, {
+            name: string;
+            columns: string[];
+            isUnique: boolean;
+            using?: "btree" | "hash" | undefined;
+            algorithm?: "default" | "inplace" | "copy" | undefined;
+            lock?: "none" | "default" | "shared" | "exclusive" | undefined;
+        }, {
+            name: string;
+            columns: string[];
+            isUnique: boolean;
+            using?: "btree" | "hash" | undefined;
+            algorithm?: "default" | "inplace" | "copy" | undefined;
+            lock?: "none" | "default" | "shared" | "exclusive" | undefined;
+        }>>;
+        compositePrimaryKeys: zod.ZodRecord<zod.ZodString, zod.ZodObject<{
+            name: zod.ZodString;
+            columns: zod.ZodArray<zod.ZodString, "many">;
+        }, "strict", zod.ZodTypeAny, {
+            name: string;
+            columns: string[];
+        }, {
+            name: string;
+            columns: string[];
+        }>>;
+        uniqueConstraints: zod.ZodDefault<zod.ZodRecord<zod.ZodString, zod.ZodObject<{
+            name: zod.ZodString;
+            columns: zod.ZodArray<zod.ZodString, "many">;
+        }, "strict", zod.ZodTypeAny, {
+            name: string;
+            columns: string[];
+        }, {
+            name: string;
+            columns: string[];
+        }>>>;
+    }, "strict", zod.ZodTypeAny, {
+        name: string;
+        columns: Record<string, {
+            name: string;
+            type: string;
+            primaryKey: boolean;
+            notNull: boolean;
+            default?: any;
+            onUpdate?: any;
+            autoincrement?: boolean | undefined;
+            generated?: {
+                type: "stored" | "virtual";
+                as: string;
+            } | undefined;
+        }>;
+        indexes: Record<string, {
+            name: string;
+            columns: string[];
+            isUnique: boolean;
+            using?: "btree" | "hash" | undefined;
+            algorithm?: "default" | "inplace" | "copy" | undefined;
+            lock?: "none" | "default" | "shared" | "exclusive" | undefined;
+        }>;
+        compositePrimaryKeys: Record<string, {
+            name: string;
+            columns: string[];
+        }>;
+        uniqueConstraints: Record<string, {
+            name: string;
+            columns: string[];
+        }>;
+    }, {
+        name: string;
+        columns: Record<string, {
+            name: string;
+            type: string;
+            primaryKey: boolean;
+            notNull: boolean;
+            default?: any;
+            onUpdate?: any;
+            autoincrement?: boolean | undefined;
+            generated?: {
+                type: "stored" | "virtual";
+                as: string;
+            } | undefined;
+        }>;
+        indexes: Record<string, {
+            name: string;
+            columns: string[];
+            isUnique: boolean;
+            using?: "btree" | "hash" | undefined;
+            algorithm?: "default" | "inplace" | "copy" | undefined;
+            lock?: "none" | "default" | "shared" | "exclusive" | undefined;
+        }>;
+        compositePrimaryKeys: Record<string, {
+            name: string;
+            columns: string[];
+        }>;
+        uniqueConstraints?: Record<string, {
+            name: string;
+            columns: string[];
+        }> | undefined;
+    }>>;
+    _meta: zod.ZodObject<{
+        tables: zod.ZodRecord<zod.ZodString, zod.ZodString>;
+        columns: zod.ZodRecord<zod.ZodString, zod.ZodString>;
+    }, "strip", zod.ZodTypeAny, {
+        columns: Record<string, string>;
+        tables: Record<string, string>;
+    }, {
+        columns: Record<string, string>;
+        tables: Record<string, string>;
+    }>;
+    internal: zod.ZodOptional<zod.ZodObject<{
+        tables: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodOptional<zod.ZodObject<{
+            columns: zod.ZodRecord<zod.ZodString, zod.ZodOptional<zod.ZodObject<{
+                isDefaultAnExpression: zod.ZodOptional<zod.ZodBoolean>;
+            }, "strip", zod.ZodTypeAny, {
+                isDefaultAnExpression?: boolean | undefined;
+            }, {
+                isDefaultAnExpression?: boolean | undefined;
+            }>>>;
+        }, "strip", zod.ZodTypeAny, {
+            columns: Record<string, {
+                isDefaultAnExpression?: boolean | undefined;
+            } | undefined>;
+        }, {
+            columns: Record<string, {
+                isDefaultAnExpression?: boolean | undefined;
+            } | undefined>;
+        }>>>>;
+        indexes: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodOptional<zod.ZodObject<{
+            columns: zod.ZodRecord<zod.ZodString, zod.ZodOptional<zod.ZodObject<{
+                isExpression: zod.ZodOptional<zod.ZodBoolean>;
+            }, "strip", zod.ZodTypeAny, {
+                isExpression?: boolean | undefined;
+            }, {
+                isExpression?: boolean | undefined;
+            }>>>;
+        }, "strip", zod.ZodTypeAny, {
+            columns: Record<string, {
+                isExpression?: boolean | undefined;
+            } | undefined>;
+        }, {
+            columns: Record<string, {
+                isExpression?: boolean | undefined;
+            } | undefined>;
+        }>>>>;
+    }, "strip", zod.ZodTypeAny, {
+        indexes?: Record<string, {
+            columns: Record<string, {
+                isExpression?: boolean | undefined;
+            } | undefined>;
+        } | undefined> | undefined;
+        tables?: Record<string, {
+            columns: Record<string, {
+                isDefaultAnExpression?: boolean | undefined;
+            } | undefined>;
+        } | undefined> | undefined;
+    }, {
+        indexes?: Record<string, {
+            columns: Record<string, {
+                isExpression?: boolean | undefined;
+            } | undefined>;
+        } | undefined> | undefined;
+        tables?: Record<string, {
+            columns: Record<string, {
+                isDefaultAnExpression?: boolean | undefined;
+            } | undefined>;
+        } | undefined> | undefined;
+    }>>;
+}, {
+    id: zod.ZodString;
+    prevId: zod.ZodString;
+}>, "strip", zod.ZodTypeAny, {
+    tables: Record<string, {
+        name: string;
+        columns: Record<string, {
+            name: string;
+            type: string;
+            primaryKey: boolean;
+            notNull: boolean;
+            default?: any;
+            onUpdate?: any;
+            autoincrement?: boolean | undefined;
+            generated?: {
+                type: "stored" | "virtual";
+                as: string;
+            } | undefined;
+        }>;
+        indexes: Record<string, {
+            name: string;
+            columns: string[];
+            isUnique: boolean;
+            using?: "btree" | "hash" | undefined;
+            algorithm?: "default" | "inplace" | "copy" | undefined;
+            lock?: "none" | "default" | "shared" | "exclusive" | undefined;
+        }>;
+        compositePrimaryKeys: Record<string, {
+            name: string;
+            columns: string[];
+        }>;
+        uniqueConstraints: Record<string, {
+            name: string;
+            columns: string[];
+        }>;
+    }>;
+    id: string;
+    prevId: string;
+    version: "1";
+    dialect: "singlestore";
+    _meta: {
+        columns: Record<string, string>;
+        tables: Record<string, string>;
+    };
+    internal?: {
+        indexes?: Record<string, {
+            columns: Record<string, {
+                isExpression?: boolean | undefined;
+            } | undefined>;
+        } | undefined> | undefined;
+        tables?: Record<string, {
+            columns: Record<string, {
+                isDefaultAnExpression?: boolean | undefined;
+            } | undefined>;
+        } | undefined> | undefined;
+    } | undefined;
+}, {
+    tables: Record<string, {
+        name: string;
+        columns: Record<string, {
+            name: string;
+            type: string;
+            primaryKey: boolean;
+            notNull: boolean;
+            default?: any;
+            onUpdate?: any;
+            autoincrement?: boolean | undefined;
+            generated?: {
+                type: "stored" | "virtual";
+                as: string;
+            } | undefined;
+        }>;
+        indexes: Record<string, {
+            name: string;
+            columns: string[];
+            isUnique: boolean;
+            using?: "btree" | "hash" | undefined;
+            algorithm?: "default" | "inplace" | "copy" | undefined;
+            lock?: "none" | "default" | "shared" | "exclusive" | undefined;
+        }>;
+        compositePrimaryKeys: Record<string, {
+            name: string;
+            columns: string[];
+        }>;
+        uniqueConstraints?: Record<string, {
+            name: string;
+            columns: string[];
+        }> | undefined;
+    }>;
+    id: string;
+    prevId: string;
+    version: "1";
+    dialect: "singlestore";
+    _meta: {
+        columns: Record<string, string>;
+        tables: Record<string, string>;
+    };
+    internal?: {
+        indexes?: Record<string, {
+            columns: Record<string, {
+                isExpression?: boolean | undefined;
+            } | undefined>;
+        } | undefined> | undefined;
+        tables?: Record<string, {
+            columns: Record<string, {
+                isDefaultAnExpression?: boolean | undefined;
+            } | undefined>;
+        } | undefined> | undefined;
+    } | undefined;
+}>;
+type SingleStoreSchema = TypeOf<typeof schema$1>;
+
 declare const schema: zod.ZodObject<zod.objectUtil.extendShape<{
     version: zod.ZodLiteral<"6">;
     dialect: zod.ZodEnum<["sqlite"]>;
@@ -2284,6 +2618,7 @@ type SQLiteSchema = TypeOf<typeof schema>;
 type DrizzleSnapshotJSON = PgSchema;
 type DrizzleSQLiteSnapshotJSON = SQLiteSchema;
 type DrizzleMySQLSnapshotJSON = MySqlSchema;
+type DrizzleSingleStoreSnapshotJSON = SingleStoreSchema;
 declare const generateDrizzleJson: (imports: Record<string, unknown>, prevId?: string, schemaFilters?: string[], casing?: CasingType) => PgSchema;
 declare const generateMigration: (prev: DrizzleSnapshotJSON, cur: DrizzleSnapshotJSON) => Promise<string[]>;
 declare const pushSchema: (imports: Record<string, unknown>, drizzleInstance: PgDatabase<any>, schemaFilters?: string[], tablesFilter?: string[], extensionsFilters?: Config["extensionsFilters"]) => Promise<{
@@ -2308,6 +2643,14 @@ declare const pushMySQLSchema: (imports: Record<string, unknown>, drizzleInstanc
     statementsToExecute: string[];
     apply: () => Promise<void>;
 }>;
+declare const generateSingleStoreDrizzleJson: (imports: Record<string, unknown>, prevId?: string, casing?: CasingType) => Promise<SingleStoreSchema>;
+declare const generateSingleStoreMigration: (prev: DrizzleSingleStoreSnapshotJSON, cur: DrizzleSingleStoreSnapshotJSON) => Promise<string[]>;
+declare const pushSingleStoreSchema: (imports: Record<string, unknown>, drizzleInstance: SingleStoreDriverDatabase<any>, databaseName: string) => Promise<{
+    hasDataLoss: boolean;
+    warnings: string[];
+    statementsToExecute: string[];
+    apply: () => Promise<void>;
+}>;
 declare const upPgSnapshot: (snapshot: Record<string, unknown>) => {
     version: "7";
     dialect: "postgresql";
@@ -2500,4 +2843,4 @@ declare const upPgSnapshot: (snapshot: Record<string, unknown>) => {
     } | undefined;
 } | Record<string, unknown>;
 
-export { type DrizzleMySQLSnapshotJSON, type DrizzleSQLiteSnapshotJSON, type DrizzleSnapshotJSON, generateDrizzleJson, generateMigration, generateMySQLDrizzleJson, generateMySQLMigration, generateSQLiteDrizzleJson, generateSQLiteMigration, pushMySQLSchema, pushSQLiteSchema, pushSchema, upPgSnapshot };
+export { type DrizzleMySQLSnapshotJSON, type DrizzleSQLiteSnapshotJSON, type DrizzleSingleStoreSnapshotJSON, type DrizzleSnapshotJSON, generateDrizzleJson, generateMigration, generateMySQLDrizzleJson, generateMySQLMigration, generateSQLiteDrizzleJson, generateSQLiteMigration, generateSingleStoreDrizzleJson, generateSingleStoreMigration, pushMySQLSchema, pushSQLiteSchema, pushSchema, pushSingleStoreSchema, upPgSnapshot };