drizzle-kit 0.31.4 → 0.31.5-7cb6516

package/api.d.ts

@@ -1,11 +1,478 @@
+import { PGlite } from '@electric-sql/pglite';
 import { LibSQLDatabase } from 'drizzle-orm/libsql';
 import { MySql2Database } from 'drizzle-orm/mysql2';
 import { PgDatabase } from 'drizzle-orm/pg-core';
 import { SingleStoreDriverDatabase } from 'drizzle-orm/singlestore';
-import { C as CasingType, a as Config } from './index-BAUrj6Ib.js';
 import * as zod from 'zod';
 import { TypeOf } from 'zod';
-import 'tls';
+import { ConnectionOptions } from 'tls';
+
+declare const prefixes: readonly ["index", "timestamp", "supabase", "unix", "none"];
+type Prefix = (typeof prefixes)[number];
+declare const casingTypes: readonly ["snake_case", "camelCase"];
+type CasingType = (typeof casingTypes)[number];
+declare const drivers: readonly ["d1-http", "expo", "aws-data-api", "pglite", "durable-sqlite"];
+type Driver = (typeof drivers)[number];
+
+declare const mysqlCredentials: zod.ZodUnion<[zod.ZodObject<{
+    host: zod.ZodString;
+    port: zod.ZodOptional<zod.ZodNumber>;
+    user: zod.ZodOptional<zod.ZodString>;
+    password: zod.ZodOptional<zod.ZodString>;
+    database: zod.ZodString;
+    ssl: zod.ZodOptional<zod.ZodUnion<[zod.ZodString, zod.ZodObject<{
+        pfx: zod.ZodOptional<zod.ZodString>;
+        key: zod.ZodOptional<zod.ZodString>;
+        passphrase: zod.ZodOptional<zod.ZodString>;
+        cert: zod.ZodOptional<zod.ZodString>;
+        ca: zod.ZodOptional<zod.ZodUnion<[zod.ZodString, zod.ZodArray<zod.ZodString, "many">]>>;
+        crl: zod.ZodOptional<zod.ZodUnion<[zod.ZodString, zod.ZodArray<zod.ZodString, "many">]>>;
+        ciphers: zod.ZodOptional<zod.ZodString>;
+        rejectUnauthorized: zod.ZodOptional<zod.ZodBoolean>;
+    }, "strip", zod.ZodTypeAny, {
+        pfx?: string | undefined;
+        key?: string | undefined;
+        passphrase?: string | undefined;
+        cert?: string | undefined;
+        ca?: string | string[] | undefined;
+        crl?: string | string[] | undefined;
+        ciphers?: string | undefined;
+        rejectUnauthorized?: boolean | undefined;
+    }, {
+        pfx?: string | undefined;
+        key?: string | undefined;
+        passphrase?: string | undefined;
+        cert?: string | undefined;
+        ca?: string | string[] | undefined;
+        crl?: string | string[] | undefined;
+        ciphers?: string | undefined;
+        rejectUnauthorized?: boolean | undefined;
+    }>]>>;
+}, "strip", zod.ZodTypeAny, {
+    host: string;
+    database: string;
+    port?: number | undefined;
+    user?: string | undefined;
+    password?: string | undefined;
+    ssl?: string | {
+        pfx?: string | undefined;
+        key?: string | undefined;
+        passphrase?: string | undefined;
+        cert?: string | undefined;
+        ca?: string | string[] | undefined;
+        crl?: string | string[] | undefined;
+        ciphers?: string | undefined;
+        rejectUnauthorized?: boolean | undefined;
+    } | undefined;
+}, {
+    host: string;
+    database: string;
+    port?: number | undefined;
+    user?: string | undefined;
+    password?: string | undefined;
+    ssl?: string | {
+        pfx?: string | undefined;
+        key?: string | undefined;
+        passphrase?: string | undefined;
+        cert?: string | undefined;
+        ca?: string | string[] | undefined;
+        crl?: string | string[] | undefined;
+        ciphers?: string | undefined;
+        rejectUnauthorized?: boolean | undefined;
+    } | undefined;
+}>, zod.ZodObject<{
+    url: zod.ZodString;
+}, "strip", zod.ZodTypeAny, {
+    url: string;
+}, {
+    url: string;
+}>]>;
+type MysqlCredentials = TypeOf<typeof mysqlCredentials>;
+
+declare const postgresCredentials: zod.ZodUnion<[zod.ZodEffects<zod.ZodObject<{
+    driver: zod.ZodUndefined;
+    host: zod.ZodString;
+    port: zod.ZodOptional<zod.ZodNumber>;
+    user: zod.ZodOptional<zod.ZodString>;
+    password: zod.ZodOptional<zod.ZodString>;
+    database: zod.ZodString;
+    ssl: zod.ZodOptional<zod.ZodUnion<[zod.ZodLiteral<"require">, zod.ZodLiteral<"allow">, zod.ZodLiteral<"prefer">, zod.ZodLiteral<"verify-full">, zod.ZodBoolean, zod.ZodObject<{}, "passthrough", zod.ZodTypeAny, zod.objectOutputType<{}, zod.ZodTypeAny, "passthrough">, zod.objectInputType<{}, zod.ZodTypeAny, "passthrough">>]>>;
+}, "strip", zod.ZodTypeAny, {
+    host: string;
+    database: string;
+    driver?: undefined;
+    port?: number | undefined;
+    user?: string | undefined;
+    password?: string | undefined;
+    ssl?: boolean | "require" | "allow" | "prefer" | "verify-full" | zod.objectOutputType<{}, zod.ZodTypeAny, "passthrough"> | undefined;
+}, {
+    host: string;
+    database: string;
+    driver?: undefined;
+    port?: number | undefined;
+    user?: string | undefined;
+    password?: string | undefined;
+    ssl?: boolean | "require" | "allow" | "prefer" | "verify-full" | zod.objectInputType<{}, zod.ZodTypeAny, "passthrough"> | undefined;
+}>, Omit<{
+    host: string;
+    database: string;
+    driver?: undefined;
+    port?: number | undefined;
+    user?: string | undefined;
+    password?: string | undefined;
+    ssl?: boolean | "require" | "allow" | "prefer" | "verify-full" | zod.objectOutputType<{}, zod.ZodTypeAny, "passthrough"> | undefined;
+}, "driver">, {
+    host: string;
+    database: string;
+    driver?: undefined;
+    port?: number | undefined;
+    user?: string | undefined;
+    password?: string | undefined;
+    ssl?: boolean | "require" | "allow" | "prefer" | "verify-full" | zod.objectInputType<{}, zod.ZodTypeAny, "passthrough"> | undefined;
+}>, zod.ZodEffects<zod.ZodObject<{
+    driver: zod.ZodUndefined;
+    url: zod.ZodString;
+}, "strip", zod.ZodTypeAny, {
+    url: string;
+    driver?: undefined;
+}, {
+    url: string;
+    driver?: undefined;
+}>, {
+    url: string;
+}, {
+    url: string;
+    driver?: undefined;
+}>, zod.ZodObject<{
+    driver: zod.ZodLiteral<"aws-data-api">;
+    database: zod.ZodString;
+    secretArn: zod.ZodString;
+    resourceArn: zod.ZodString;
+}, "strip", zod.ZodTypeAny, {
+    driver: "aws-data-api";
+    database: string;
+    secretArn: string;
+    resourceArn: string;
+}, {
+    driver: "aws-data-api";
+    database: string;
+    secretArn: string;
+    resourceArn: string;
+}>, zod.ZodObject<{
+    driver: zod.ZodLiteral<"pglite">;
+    url: zod.ZodString;
+}, "strip", zod.ZodTypeAny, {
+    url: string;
+    driver: "pglite";
+}, {
+    url: string;
+    driver: "pglite";
+}>]>;
+type PostgresCredentials = TypeOf<typeof postgresCredentials>;
+
+declare const singlestoreCredentials: zod.ZodUnion<[zod.ZodObject<{
+    host: zod.ZodString;
+    port: zod.ZodOptional<zod.ZodNumber>;
+    user: zod.ZodOptional<zod.ZodString>;
+    password: zod.ZodOptional<zod.ZodString>;
+    database: zod.ZodString;
+    ssl: zod.ZodOptional<zod.ZodUnion<[zod.ZodString, zod.ZodObject<{
+        pfx: zod.ZodOptional<zod.ZodString>;
+        key: zod.ZodOptional<zod.ZodString>;
+        passphrase: zod.ZodOptional<zod.ZodString>;
+        cert: zod.ZodOptional<zod.ZodString>;
+        ca: zod.ZodOptional<zod.ZodUnion<[zod.ZodString, zod.ZodArray<zod.ZodString, "many">]>>;
+        crl: zod.ZodOptional<zod.ZodUnion<[zod.ZodString, zod.ZodArray<zod.ZodString, "many">]>>;
+        ciphers: zod.ZodOptional<zod.ZodString>;
+        rejectUnauthorized: zod.ZodOptional<zod.ZodBoolean>;
+    }, "strip", zod.ZodTypeAny, {
+        pfx?: string | undefined;
+        key?: string | undefined;
+        passphrase?: string | undefined;
+        cert?: string | undefined;
+        ca?: string | string[] | undefined;
+        crl?: string | string[] | undefined;
+        ciphers?: string | undefined;
+        rejectUnauthorized?: boolean | undefined;
+    }, {
+        pfx?: string | undefined;
+        key?: string | undefined;
+        passphrase?: string | undefined;
+        cert?: string | undefined;
+        ca?: string | string[] | undefined;
+        crl?: string | string[] | undefined;
+        ciphers?: string | undefined;
+        rejectUnauthorized?: boolean | undefined;
+    }>]>>;
+}, "strip", zod.ZodTypeAny, {
+    host: string;
+    database: string;
+    port?: number | undefined;
+    user?: string | undefined;
+    password?: string | undefined;
+    ssl?: string | {
+        pfx?: string | undefined;
+        key?: string | undefined;
+        passphrase?: string | undefined;
+        cert?: string | undefined;
+        ca?: string | string[] | undefined;
+        crl?: string | string[] | undefined;
+        ciphers?: string | undefined;
+        rejectUnauthorized?: boolean | undefined;
+    } | undefined;
+}, {
+    host: string;
+    database: string;
+    port?: number | undefined;
+    user?: string | undefined;
+    password?: string | undefined;
+    ssl?: string | {
+        pfx?: string | undefined;
+        key?: string | undefined;
+        passphrase?: string | undefined;
+        cert?: string | undefined;
+        ca?: string | string[] | undefined;
+        crl?: string | string[] | undefined;
+        ciphers?: string | undefined;
+        rejectUnauthorized?: boolean | undefined;
+    } | undefined;
+}>, zod.ZodObject<{
+    url: zod.ZodString;
+}, "strip", zod.ZodTypeAny, {
+    url: string;
+}, {
+    url: string;
+}>]>;
+type SingleStoreCredentials = TypeOf<typeof singlestoreCredentials>;
+
+type SqliteCredentials = {
+    driver: 'd1-http';
+    accountId: string;
+    databaseId: string;
+    token: string;
+} | {
+    url: string;
+};
+
+declare const dialects: readonly ["postgresql", "mysql", "sqlite", "turso", "singlestore", "gel"];
+type Dialect = (typeof dialects)[number];
+
+type SslOptions = {
+    pfx?: string;
+    key?: string;
+    passphrase?: string;
+    cert?: string;
+    ca?: string | string[];
+    crl?: string | string[];
+    ciphers?: string;
+    rejectUnauthorized?: boolean;
+};
+type Verify<T, U extends T> = U;
+/**
+ * **You are currently using version 0.21.0+ of drizzle-kit. If you have just upgraded to this version, please make sure to read the changelog to understand what changes have been made and what
+ * adjustments may be necessary for you. See https://orm.drizzle.team/kit-docs/upgrade-21#how-to-migrate-to-0210**
+ *
+ * **Config** usage:
+ *
+ * `dialect` - mandatory and is responsible for explicitly providing a databse dialect you are using for all the commands
+ * *Possible values*: `postgresql`, `mysql`, `sqlite`, `singlestore
+ *
+ * See https://orm.drizzle.team/kit-docs/config-reference#dialect
+ *
+ * ---
+ * `schema` - param lets you define where your schema file/files live.
+ * You can have as many separate schema files as you want and define paths to them using glob or array of globs syntax.
+ *
+ * See https://orm.drizzle.team/kit-docs/config-reference#schema
+ *
+ * ---
+ * `out` - allows you to define the folder for your migrations and a folder, where drizzle will introspect the schema and relations
+ *
+ * See https://orm.drizzle.team/kit-docs/config-reference#out
+ *
+ * ---
+ * `driver` - optional param that is responsible for explicitly providing a driver to use when accessing a database
+ * *Possible values*: `aws-data-api`, `d1-http`, `expo`, `turso`, `pglite`
+ * If you don't use AWS Data API, D1, Turso or Expo - ypu don't need this driver. You can check a driver strategy choice here: https://orm.drizzle.team/kit-docs/upgrade-21
+ *
+ * See https://orm.drizzle.team/kit-docs/config-reference#driver
+ *
+ * ---
+ *
+ * `dbCredentials` - an object to define your connection to the database. For more info please check the docs
+ *
+ * See https://orm.drizzle.team/kit-docs/config-reference#dbcredentials
+ *
+ * ---
+ *
+ * `migrations` - param let’s use specify custom table and schema(PostgreSQL only) for migrations.
+ * By default, all information about executed migrations will be stored in the database inside
+ * the `__drizzle_migrations` table, and for PostgreSQL, inside the drizzle schema.
+ * However, you can configure where to store those records.
+ *
+ * See https://orm.drizzle.team/kit-docs/config-reference#migrations
+ *
+ * ---
+ *
+ * `breakpoints` - param lets you enable/disable SQL statement breakpoints in generated migrations.
+ * It’s optional and true by default, it’s necessary to properly apply migrations on databases,
+ * that do not support multiple DDL alternation statements in one transaction(MySQL, SQLite, SingleStore) and
+ * Drizzle ORM has to apply them sequentially one by one.
+ *
+ * See https://orm.drizzle.team/kit-docs/config-reference#breakpoints
+ *
+ * ---
+ *
+ * `tablesFilters` - param lets you filter tables with glob syntax for db push command.
+ * It’s useful when you have only one database avaialable for several separate projects with separate sql schemas.
+ *
+ * How to define multi-project tables with Drizzle ORM — see https://orm.drizzle.team/docs/goodies#multi-project-schema
+ *
+ * See https://orm.drizzle.team/kit-docs/config-reference#tablesfilters
+ *
+ * ---
+ *
+ * `schemaFilter` - parameter allows you to define which schema in PostgreSQL should be used for either introspect or push commands.
+ * This parameter accepts a single schema as a string or an array of schemas as strings.
+ * No glob pattern is supported here. By default, drizzle will use the public schema for both commands,
+ * but you can add any schema you need.
+ *
+ * For example, having schemaFilter: ["my_schema"] will only look for tables in both the database and
+ * drizzle schema that are a part of the my_schema schema.
+ *
+ * See https://orm.drizzle.team/kit-docs/config-reference#schemafilter
+ *
+ * ---
+ *
+ * `verbose` - command is used for drizzle-kit push commands and prints all statements that will be executed.
+ *
+ * > Note: This command will only print the statements that should be executed.
+ * To approve them before applying, please refer to the `strict` command.
+ *
+ * See https://orm.drizzle.team/kit-docs/config-reference#verbose
+ *
+ * ---
+ *
+ * `strict` - command is used for drizzle-kit push commands and will always ask for your confirmation,
+ * either to execute all statements needed to sync your schema with the database or not.
+ *
+ * See https://orm.drizzle.team/kit-docs/config-reference#strict
+ */
+type Config = {
+    dialect: Dialect;
+    out?: string;
+    breakpoints?: boolean;
+    tablesFilter?: string | string[];
+    extensionsFilters?: 'postgis'[];
+    schemaFilter?: string | string[];
+    schema?: string | string[];
+    verbose?: boolean;
+    strict?: boolean;
+    casing?: 'camelCase' | 'snake_case';
+    migrations?: {
+        table?: string;
+        schema?: string;
+        prefix?: Prefix;
+    };
+    introspect?: {
+        casing: 'camel' | 'preserve';
+    };
+    entities?: {
+        roles?: boolean | {
+            provider?: 'supabase' | 'neon' | string & {};
+            exclude?: string[];
+            include?: string[];
+        };
+    };
+} & ({
+    dialect: Verify<Dialect, 'turso'>;
+    dbCredentials: {
+        url: string;
+        authToken?: string;
+    };
+} | {
+    dialect: Verify<Dialect, 'sqlite'>;
+    dbCredentials: {
+        url: string;
+    };
+} | {
+    dialect: Verify<Dialect, 'postgresql'>;
+    dbCredentials: ({
+        host: string;
+        port?: number;
+        user?: string;
+        password?: string;
+        database: string;
+        ssl?: boolean | 'require' | 'allow' | 'prefer' | 'verify-full' | ConnectionOptions;
+    } & {}) | {
+        url: string;
+    };
+} | {
+    dialect: Verify<Dialect, 'postgresql'>;
+    driver: Verify<Driver, 'aws-data-api'>;
+    dbCredentials: {
+        database: string;
+        secretArn: string;
+        resourceArn: string;
+    };
+} | {
+    dialect: Verify<Dialect, 'postgresql'>;
+    driver: Verify<Driver, 'pglite'>;
+    dbCredentials: {
+        url: string;
+    };
+} | {
+    dialect: Verify<Dialect, 'mysql'>;
+    dbCredentials: {
+        host: string;
+        port?: number;
+        user?: string;
+        password?: string;
+        database: string;
+        ssl?: string | SslOptions;
+    } | {
+        url: string;
+    };
+} | {
+    dialect: Verify<Dialect, 'sqlite'>;
+    driver: Verify<Driver, 'd1-http'>;
+    dbCredentials: {
+        accountId: string;
+        databaseId: string;
+        token: string;
+    };
+} | {
+    dialect: Verify<Dialect, 'sqlite'>;
+    driver: Verify<Driver, 'expo'>;
+} | {
+    dialect: Verify<Dialect, 'sqlite'>;
+    driver: Verify<Driver, 'durable-sqlite'>;
+} | {} | {
+    dialect: Verify<Dialect, 'singlestore'>;
+    dbCredentials: {
+        host: string;
+        port?: number;
+        user?: string;
+        password?: string;
+        database: string;
+        ssl?: string | SslOptions;
+    } | {
+        url: string;
+    };
+} | {
+    dialect: Verify<Dialect, 'gel'>;
+    dbCredentials?: {
+        tlsSecurity?: 'insecure' | 'no_host_verification' | 'strict' | 'default';
+    } & ({
+        url: string;
+    } | ({
+        host: string;
+        port?: number;
+        user?: string;
+        password?: string;
+        database: string;
+    }));
+});
 
 declare const schema$2: zod.ZodObject<{
     version: zod.ZodLiteral<"5">;
@@ -2627,6 +3094,14 @@ declare const pushSchema: (imports: Record<string, unknown>, drizzleInstance: Pg
     statementsToExecute: string[];
     apply: () => Promise<void>;
 }>;
+declare const startStudioPostgresServer: (imports: Record<string, unknown>, credentials: PostgresCredentials | {
+    driver: "pglite";
+    client: PGlite;
+}, options?: {
+    host?: string;
+    port?: number;
+    casing?: CasingType;
+}) => Promise<void>;
 declare const generateSQLiteDrizzleJson: (imports: Record<string, unknown>, prevId?: string, casing?: CasingType) => Promise<SQLiteSchema>;
 declare const generateSQLiteMigration: (prev: DrizzleSQLiteSnapshotJSON, cur: DrizzleSQLiteSnapshotJSON) => Promise<string[]>;
 declare const pushSQLiteSchema: (imports: Record<string, unknown>, drizzleInstance: LibSQLDatabase<any>) => Promise<{
@@ -2635,6 +3110,11 @@ declare const pushSQLiteSchema: (imports: Record<string, unknown>, drizzleInstan
     statementsToExecute: string[];
     apply: () => Promise<void>;
 }>;
+declare const startStudioSQLiteServer: (imports: Record<string, unknown>, credentials: SqliteCredentials, options?: {
+    host?: string;
+    port?: number;
+    casing?: CasingType;
+}) => Promise<void>;
 declare const generateMySQLDrizzleJson: (imports: Record<string, unknown>, prevId?: string, casing?: CasingType) => Promise<MySqlSchema>;
 declare const generateMySQLMigration: (prev: DrizzleMySQLSnapshotJSON, cur: DrizzleMySQLSnapshotJSON) => Promise<string[]>;
 declare const pushMySQLSchema: (imports: Record<string, unknown>, drizzleInstance: MySql2Database<any>, databaseName: string) => Promise<{
@@ -2643,6 +3123,11 @@ declare const pushMySQLSchema: (imports: Record<string, unknown>, drizzleInstanc
     statementsToExecute: string[];
     apply: () => Promise<void>;
 }>;
+declare const startStudioMySQLServer: (imports: Record<string, unknown>, credentials: MysqlCredentials, options?: {
+    host?: string;
+    port?: number;
+    casing?: CasingType;
+}) => 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<{
@@ -2651,6 +3136,11 @@ declare const pushSingleStoreSchema: (imports: Record<string, unknown>, drizzleI
     statementsToExecute: string[];
     apply: () => Promise<void>;
 }>;
+declare const startStudioSingleStoreServer: (imports: Record<string, unknown>, credentials: SingleStoreCredentials, options?: {
+    host?: string;
+    port?: number;
+    casing?: CasingType;
+}) => Promise<void>;
 declare const upPgSnapshot: (snapshot: Record<string, unknown>) => {
     version: "7";
     dialect: "postgresql";
@@ -2843,4 +3333,4 @@ declare const upPgSnapshot: (snapshot: Record<string, unknown>) => {
     } | undefined;
 } | Record<string, unknown>;
 
-export { type DrizzleMySQLSnapshotJSON, type DrizzleSQLiteSnapshotJSON, type DrizzleSingleStoreSnapshotJSON, type DrizzleSnapshotJSON, generateDrizzleJson, generateMigration, generateMySQLDrizzleJson, generateMySQLMigration, generateSQLiteDrizzleJson, generateSQLiteMigration, generateSingleStoreDrizzleJson, generateSingleStoreMigration, pushMySQLSchema, pushSQLiteSchema, pushSchema, pushSingleStoreSchema, upPgSnapshot };
+export { type DrizzleMySQLSnapshotJSON, type DrizzleSQLiteSnapshotJSON, type DrizzleSingleStoreSnapshotJSON, type DrizzleSnapshotJSON, generateDrizzleJson, generateMigration, generateMySQLDrizzleJson, generateMySQLMigration, generateSQLiteDrizzleJson, generateSQLiteMigration, generateSingleStoreDrizzleJson, generateSingleStoreMigration, pushMySQLSchema, pushSQLiteSchema, pushSchema, pushSingleStoreSchema, startStudioMySQLServer, startStudioPostgresServer, startStudioSQLiteServer, startStudioSingleStoreServer, upPgSnapshot };