drizzle-kit 0.27.2 → 0.28.0

package/index-BfiZoTqG.d.mts

@@ -0,0 +1,293 @@
+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"];
+type Driver = (typeof drivers)[number];
+
+declare const dialects: readonly ["postgresql", "mysql", "sqlite", "turso"];
+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`
+ *
+ * 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) 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'>;
+} | {});
+/**
+ * **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`
+ *
+ * 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) 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
+ */
+declare function defineConfig(config: Config): Config;
+
+export { type CasingType as C, type Config as a, defineConfig as d };

package/index-BfiZoTqG.d.ts

@@ -0,0 +1,293 @@
+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"];
+type Driver = (typeof drivers)[number];
+
+declare const dialects: readonly ["postgresql", "mysql", "sqlite", "turso"];
+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`
+ *
+ * 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) 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'>;
+} | {});
+/**
+ * **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`
+ *
+ * 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) 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
+ */
+declare function defineConfig(config: Config): Config;
+
+export { type CasingType as C, type Config as a, defineConfig as d };