@raypx-kit/drizzle-kit 0.0.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,340 @@
1
+ import { t as Dialect } from "./schemaValidator-OgLXlvBV.mjs";
2
+ import { PGlite } from "@electric-sql/pglite";
3
+ import { ConnectionOptions } from "tls";
4
+ //#region src/cli/validations/common.d.ts
5
+ declare const drivers: readonly ["d1-http", "expo", "aws-data-api", "pglite", "durable-sqlite", "sqlite-cloud"];
6
+ type Driver = (typeof drivers)[number];
7
+ //#endregion
8
+ //#region src/index.d.ts
9
+ type SslOptions = {
10
+ pfx?: string;
11
+ key?: string;
12
+ passphrase?: string;
13
+ cert?: string;
14
+ ca?: string | string[];
15
+ crl?: string | string[];
16
+ ciphers?: string;
17
+ rejectUnauthorized?: boolean;
18
+ };
19
+ type Verify<T, U extends T> = U;
20
+ /**
21
+ * **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
22
+ * adjustments may be necessary for you. See https://orm.drizzle.team/kit-docs/upgrade-21#how-to-migrate-to-0210**
23
+ *
24
+ * **Config** usage:
25
+ *
26
+ * `dialect` - mandatory and is responsible for explicitly providing a databse dialect you are using for all the commands
27
+ * *Possible values*: `postgresql`, `mysql`, `sqlite`, `singlestore
28
+ *
29
+ * See https://orm.drizzle.team/kit-docs/config-reference#dialect
30
+ *
31
+ * ---
32
+ * `schema` - param lets you define where your schema file/files live.
33
+ * You can have as many separate schema files as you want and define paths to them using glob or array of globs syntax.
34
+ *
35
+ * See https://orm.drizzle.team/kit-docs/config-reference#schema
36
+ *
37
+ * ---
38
+ * `out` - allows you to define the folder for your migrations and a folder, where drizzle will introspect the schema and relations
39
+ *
40
+ * See https://orm.drizzle.team/kit-docs/config-reference#out
41
+ *
42
+ * ---
43
+ * `driver` - optional param that is responsible for explicitly providing a driver to use when accessing a database
44
+ * *Possible values*: `aws-data-api`, `d1-http`, `expo`, `turso`, `pglite`
45
+ * 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
46
+ *
47
+ * See https://orm.drizzle.team/kit-docs/config-reference#driver
48
+ *
49
+ * ---
50
+ *
51
+ * `dbCredentials` - an object to define your connection to the database. For more info please check the docs
52
+ *
53
+ * See https://orm.drizzle.team/kit-docs/config-reference#dbcredentials
54
+ *
55
+ * ---
56
+ *
57
+ * `migrations` - param let’s you specify a custom table and schema(PostgreSQL only) for migrations.
58
+ * By default, all information about executed migrations will be stored in the database inside
59
+ * the `__drizzle_migrations` table, and for PostgreSQL, inside the drizzle schema.
60
+ * However, you can configure where to store those records.
61
+ *
62
+ * See https://orm.drizzle.team/kit-docs/config-reference#migrations
63
+ *
64
+ * ---
65
+ *
66
+ * `breakpoints` - param lets you enable/disable SQL statement breakpoints in generated migrations.
67
+ * It’s optional and true by default, it’s necessary to properly apply migrations on databases,
68
+ * that do not support multiple DDL alternation statements in one transaction(MySQL, SQLite, SingleStore) and
69
+ * Drizzle ORM has to apply them sequentially one by one.
70
+ *
71
+ * See https://orm.drizzle.team/kit-docs/config-reference#breakpoints
72
+ *
73
+ * ---
74
+ *
75
+ * `tablesFilters` - param lets you filter tables with glob syntax for db push command.
76
+ * It’s useful when you have only one database avaialable for several separate projects with separate sql schemas.
77
+ *
78
+ * How to define multi-project tables with Drizzle ORM — see https://orm.drizzle.team/docs/goodies#multi-project-schema
79
+ *
80
+ * See https://orm.drizzle.team/kit-docs/config-reference#tablesfilters
81
+ *
82
+ * ---
83
+ *
84
+ * `schemaFilter` - parameter allows you to define which schema in PostgreSQL should be used for either introspect or push commands.
85
+ * This parameter accepts a single schema as a string or an array of schemas as strings.
86
+ * No glob pattern is supported here. By default, drizzle will use the public schema for both commands,
87
+ * but you can add any schema you need.
88
+ *
89
+ * For example, having schemaFilter: ["my_schema"] will only look for tables in both the database and
90
+ * drizzle schema that are a part of the my_schema schema.
91
+ *
92
+ * See https://orm.drizzle.team/kit-docs/config-reference#schemafilter
93
+ *
94
+ * ---
95
+ *
96
+ * `verbose` - command is used for drizzle-kit push commands and prints all statements that will be executed.
97
+ *
98
+ * > Note: This command will only print the statements that should be executed.
99
+ * To approve them before applying, please refer to the `strict` command.
100
+ *
101
+ * See https://orm.drizzle.team/kit-docs/config-reference#verbose
102
+ *
103
+ * ---
104
+ *
105
+ * `strict` - command is used for drizzle-kit push commands and will always ask for your confirmation,
106
+ * either to execute all statements needed to sync your schema with the database or not.
107
+ *
108
+ * See https://orm.drizzle.team/kit-docs/config-reference#strict
109
+ */
110
+ type Config = {
111
+ dialect: Dialect;
112
+ out?: string;
113
+ breakpoints?: boolean;
114
+ tablesFilter?: string | string[];
115
+ extensionsFilters?: 'postgis'[];
116
+ schemaFilter?: string | string[];
117
+ schema?: string | string[];
118
+ verbose?: boolean;
119
+ migrations?: {
120
+ table?: string;
121
+ schema?: string;
122
+ };
123
+ introspect?: {
124
+ casing: 'camel' | 'preserve';
125
+ };
126
+ entities?: {
127
+ roles?: boolean | {
128
+ provider?: 'supabase' | 'neon' | string & {};
129
+ exclude?: string[];
130
+ include?: string[];
131
+ };
132
+ };
133
+ } & ({
134
+ dialect: Verify<Dialect, 'turso'>;
135
+ dbCredentials: {
136
+ url: string;
137
+ authToken?: string;
138
+ };
139
+ } | {
140
+ dialect: Verify<Dialect, 'sqlite'>;
141
+ dbCredentials: {
142
+ url: string;
143
+ };
144
+ } | {
145
+ dialect: Verify<Dialect, 'postgresql'>;
146
+ dbCredentials: ({
147
+ host: string;
148
+ port?: number;
149
+ user?: string;
150
+ password?: string;
151
+ database: string;
152
+ ssl?: boolean | 'require' | 'allow' | 'prefer' | 'verify-full' | ConnectionOptions;
153
+ } & {}) | {
154
+ url: string;
155
+ };
156
+ } | {
157
+ dialect: Verify<Dialect, 'postgresql'>;
158
+ driver: Verify<Driver, 'aws-data-api'>;
159
+ dbCredentials: {
160
+ database: string;
161
+ secretArn: string;
162
+ resourceArn: string;
163
+ };
164
+ } | {
165
+ dialect: Verify<Dialect, 'postgresql'>;
166
+ driver: Verify<Driver, 'pglite'>;
167
+ dbCredentials: {
168
+ url: string;
169
+ };
170
+ } | {
171
+ dialect: Verify<Dialect, 'postgresql'>;
172
+ driver: Verify<Driver, 'pglite'>;
173
+ client: PGlite;
174
+ } | {
175
+ dialect: Verify<Dialect, 'mysql'>;
176
+ dbCredentials: {
177
+ host: string;
178
+ port?: number;
179
+ user?: string;
180
+ password?: string;
181
+ database: string;
182
+ ssl?: string | SslOptions;
183
+ } | {
184
+ url: string;
185
+ };
186
+ } | {
187
+ dialect: Verify<Dialect, 'sqlite'>;
188
+ driver: Verify<Driver, 'd1-http'>;
189
+ dbCredentials: {
190
+ accountId: string;
191
+ databaseId: string;
192
+ token: string;
193
+ };
194
+ } | {
195
+ dialect: Verify<Dialect, 'sqlite'>;
196
+ driver: Verify<Driver, 'expo'>;
197
+ } | {
198
+ dialect: Verify<Dialect, 'sqlite'>;
199
+ driver: Verify<Driver, 'durable-sqlite'>;
200
+ } | {
201
+ dialect: Verify<Dialect, 'sqlite'>;
202
+ driver: Verify<Driver, 'sqlite-cloud'>;
203
+ } | {} | {
204
+ dialect: Verify<Dialect, 'singlestore'>;
205
+ dbCredentials: {
206
+ host: string;
207
+ port?: number;
208
+ user?: string;
209
+ password?: string;
210
+ database: string;
211
+ ssl?: string | SslOptions;
212
+ } | {
213
+ url: string;
214
+ };
215
+ } | {
216
+ dialect: Verify<Dialect, 'mssql'>;
217
+ dbCredentials: {
218
+ port: number;
219
+ user: string;
220
+ password: string;
221
+ database: string;
222
+ server: string;
223
+ options?: {
224
+ encrypt?: boolean;
225
+ trustServerCertificate?: boolean;
226
+ };
227
+ } | {
228
+ url: string;
229
+ };
230
+ } | {
231
+ dialect: Verify<Dialect, 'cockroach'>;
232
+ dbCredentials: ({
233
+ host: string;
234
+ port?: number;
235
+ user?: string;
236
+ password?: string;
237
+ database: string;
238
+ ssl?: boolean | 'require' | 'allow' | 'prefer' | 'verify-full' | ConnectionOptions;
239
+ } & {}) | {
240
+ url: string;
241
+ };
242
+ } | {
243
+ dialect: Verify<Dialect, 'duckdb'>;
244
+ dbCredentials: {
245
+ url: string;
246
+ };
247
+ });
248
+ /**
249
+ * **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
250
+ * adjustments may be necessary for you. See https://orm.drizzle.team/kit-docs/upgrade-21#how-to-migrate-to-0210**
251
+ *
252
+ * **Config** usage:
253
+ *
254
+ * `dialect` - mandatory and is responsible for explicitly providing a databse dialect you are using for all the commands
255
+ * *Possible values*: `postgresql`, `mysql`, `sqlite`, `singlestore`, `gel`
256
+ *
257
+ * See https://orm.drizzle.team/kit-docs/config-reference#dialect
258
+ *
259
+ * ---
260
+ * `schema` - param lets you define where your schema file/files live.
261
+ * You can have as many separate schema files as you want and define paths to them using glob or array of globs syntax.
262
+ *
263
+ * See https://orm.drizzle.team/kit-docs/config-reference#schema
264
+ *
265
+ * ---
266
+ * `out` - allows you to define the folder for your migrations and a folder, where drizzle will introspect the schema and relations
267
+ *
268
+ * See https://orm.drizzle.team/kit-docs/config-reference#out
269
+ *
270
+ * ---
271
+ * `driver` - optional param that is responsible for explicitly providing a driver to use when accessing a database
272
+ * *Possible values*: `aws-data-api`, `d1-http`, `expo`, `turso`, `pglite`
273
+ * 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
274
+ *
275
+ * See https://orm.drizzle.team/kit-docs/config-reference#driver
276
+ *
277
+ * ---
278
+ *
279
+ * `dbCredentials` - an object to define your connection to the database. For more info please check the docs
280
+ *
281
+ * See https://orm.drizzle.team/kit-docs/config-reference#dbcredentials
282
+ *
283
+ * ---
284
+ *
285
+ * `migrations` - param let’s you specify a custom table and schema(PostgreSQL only) for migrations.
286
+ * By default, all information about executed migrations will be stored in the database inside
287
+ * the `__drizzle_migrations` table, and for PostgreSQL, inside the drizzle schema.
288
+ * However, you can configure where to store those records.
289
+ *
290
+ * See https://orm.drizzle.team/kit-docs/config-reference#migrations
291
+ *
292
+ * ---
293
+ *
294
+ * `breakpoints` - param lets you enable/disable SQL statement breakpoints in generated migrations.
295
+ * It’s optional and true by default, it’s necessary to properly apply migrations on databases,
296
+ * that do not support multiple DDL alternation statements in one transaction(MySQL, SQLite, SingleStore) and
297
+ * Drizzle ORM has to apply them sequentially one by one.
298
+ *
299
+ * See https://orm.drizzle.team/kit-docs/config-reference#breakpoints
300
+ *
301
+ * ---
302
+ *
303
+ * `tablesFilters` - param lets you filter tables with glob syntax for db push command.
304
+ * It’s useful when you have only one database avaialable for several separate projects with separate sql schemas.
305
+ *
306
+ * How to define multi-project tables with Drizzle ORM — see https://orm.drizzle.team/docs/goodies#multi-project-schema
307
+ *
308
+ * See https://orm.drizzle.team/kit-docs/config-reference#tablesfilters
309
+ *
310
+ * ---
311
+ *
312
+ * `schemaFilter` - parameter allows you to define which schema in PostgreSQL should be used for either introspect or push commands.
313
+ * This parameter accepts a single schema as a string or an array of schemas as strings.
314
+ * No glob pattern is supported here. By default, drizzle will use the public schema for both commands,
315
+ * but you can add any schema you need.
316
+ *
317
+ * For example, having schemaFilter: ["my_schema"] will only look for tables in both the database and
318
+ * drizzle schema that are a part of the my_schema schema.
319
+ *
320
+ * See https://orm.drizzle.team/kit-docs/config-reference#schemafilter
321
+ *
322
+ * ---
323
+ *
324
+ * `verbose` - command is used for drizzle-kit push commands and prints all statements that will be executed.
325
+ *
326
+ * > Note: This command will only print the statements that should be executed.
327
+ * To approve them before applying, please refer to the `strict` command.
328
+ *
329
+ * See https://orm.drizzle.team/kit-docs/config-reference#verbose
330
+ *
331
+ * ---
332
+ *
333
+ * `strict` - command is used for drizzle-kit push commands and will always ask for your confirmation,
334
+ * either to execute all statements needed to sync your schema with the database or not.
335
+ *
336
+ * See https://orm.drizzle.team/kit-docs/config-reference#strict
337
+ */
338
+ declare function defineConfig(config: Config): Config;
339
+ //#endregion
340
+ export { Config, defineConfig };
@@ -0,0 +1,340 @@
1
+ import { t as Dialect } from "./schemaValidator-OgLXlvBV.js";
2
+ import { PGlite } from "@electric-sql/pglite";
3
+ import { ConnectionOptions } from "tls";
4
+ //#region src/cli/validations/common.d.ts
5
+ declare const drivers: readonly ["d1-http", "expo", "aws-data-api", "pglite", "durable-sqlite", "sqlite-cloud"];
6
+ type Driver = (typeof drivers)[number];
7
+ //#endregion
8
+ //#region src/index.d.ts
9
+ type SslOptions = {
10
+ pfx?: string;
11
+ key?: string;
12
+ passphrase?: string;
13
+ cert?: string;
14
+ ca?: string | string[];
15
+ crl?: string | string[];
16
+ ciphers?: string;
17
+ rejectUnauthorized?: boolean;
18
+ };
19
+ type Verify<T, U extends T> = U;
20
+ /**
21
+ * **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
22
+ * adjustments may be necessary for you. See https://orm.drizzle.team/kit-docs/upgrade-21#how-to-migrate-to-0210**
23
+ *
24
+ * **Config** usage:
25
+ *
26
+ * `dialect` - mandatory and is responsible for explicitly providing a databse dialect you are using for all the commands
27
+ * *Possible values*: `postgresql`, `mysql`, `sqlite`, `singlestore
28
+ *
29
+ * See https://orm.drizzle.team/kit-docs/config-reference#dialect
30
+ *
31
+ * ---
32
+ * `schema` - param lets you define where your schema file/files live.
33
+ * You can have as many separate schema files as you want and define paths to them using glob or array of globs syntax.
34
+ *
35
+ * See https://orm.drizzle.team/kit-docs/config-reference#schema
36
+ *
37
+ * ---
38
+ * `out` - allows you to define the folder for your migrations and a folder, where drizzle will introspect the schema and relations
39
+ *
40
+ * See https://orm.drizzle.team/kit-docs/config-reference#out
41
+ *
42
+ * ---
43
+ * `driver` - optional param that is responsible for explicitly providing a driver to use when accessing a database
44
+ * *Possible values*: `aws-data-api`, `d1-http`, `expo`, `turso`, `pglite`
45
+ * 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
46
+ *
47
+ * See https://orm.drizzle.team/kit-docs/config-reference#driver
48
+ *
49
+ * ---
50
+ *
51
+ * `dbCredentials` - an object to define your connection to the database. For more info please check the docs
52
+ *
53
+ * See https://orm.drizzle.team/kit-docs/config-reference#dbcredentials
54
+ *
55
+ * ---
56
+ *
57
+ * `migrations` - param let’s you specify a custom table and schema(PostgreSQL only) for migrations.
58
+ * By default, all information about executed migrations will be stored in the database inside
59
+ * the `__drizzle_migrations` table, and for PostgreSQL, inside the drizzle schema.
60
+ * However, you can configure where to store those records.
61
+ *
62
+ * See https://orm.drizzle.team/kit-docs/config-reference#migrations
63
+ *
64
+ * ---
65
+ *
66
+ * `breakpoints` - param lets you enable/disable SQL statement breakpoints in generated migrations.
67
+ * It’s optional and true by default, it’s necessary to properly apply migrations on databases,
68
+ * that do not support multiple DDL alternation statements in one transaction(MySQL, SQLite, SingleStore) and
69
+ * Drizzle ORM has to apply them sequentially one by one.
70
+ *
71
+ * See https://orm.drizzle.team/kit-docs/config-reference#breakpoints
72
+ *
73
+ * ---
74
+ *
75
+ * `tablesFilters` - param lets you filter tables with glob syntax for db push command.
76
+ * It’s useful when you have only one database avaialable for several separate projects with separate sql schemas.
77
+ *
78
+ * How to define multi-project tables with Drizzle ORM — see https://orm.drizzle.team/docs/goodies#multi-project-schema
79
+ *
80
+ * See https://orm.drizzle.team/kit-docs/config-reference#tablesfilters
81
+ *
82
+ * ---
83
+ *
84
+ * `schemaFilter` - parameter allows you to define which schema in PostgreSQL should be used for either introspect or push commands.
85
+ * This parameter accepts a single schema as a string or an array of schemas as strings.
86
+ * No glob pattern is supported here. By default, drizzle will use the public schema for both commands,
87
+ * but you can add any schema you need.
88
+ *
89
+ * For example, having schemaFilter: ["my_schema"] will only look for tables in both the database and
90
+ * drizzle schema that are a part of the my_schema schema.
91
+ *
92
+ * See https://orm.drizzle.team/kit-docs/config-reference#schemafilter
93
+ *
94
+ * ---
95
+ *
96
+ * `verbose` - command is used for drizzle-kit push commands and prints all statements that will be executed.
97
+ *
98
+ * > Note: This command will only print the statements that should be executed.
99
+ * To approve them before applying, please refer to the `strict` command.
100
+ *
101
+ * See https://orm.drizzle.team/kit-docs/config-reference#verbose
102
+ *
103
+ * ---
104
+ *
105
+ * `strict` - command is used for drizzle-kit push commands and will always ask for your confirmation,
106
+ * either to execute all statements needed to sync your schema with the database or not.
107
+ *
108
+ * See https://orm.drizzle.team/kit-docs/config-reference#strict
109
+ */
110
+ type Config = {
111
+ dialect: Dialect;
112
+ out?: string;
113
+ breakpoints?: boolean;
114
+ tablesFilter?: string | string[];
115
+ extensionsFilters?: 'postgis'[];
116
+ schemaFilter?: string | string[];
117
+ schema?: string | string[];
118
+ verbose?: boolean;
119
+ migrations?: {
120
+ table?: string;
121
+ schema?: string;
122
+ };
123
+ introspect?: {
124
+ casing: 'camel' | 'preserve';
125
+ };
126
+ entities?: {
127
+ roles?: boolean | {
128
+ provider?: 'supabase' | 'neon' | string & {};
129
+ exclude?: string[];
130
+ include?: string[];
131
+ };
132
+ };
133
+ } & ({
134
+ dialect: Verify<Dialect, 'turso'>;
135
+ dbCredentials: {
136
+ url: string;
137
+ authToken?: string;
138
+ };
139
+ } | {
140
+ dialect: Verify<Dialect, 'sqlite'>;
141
+ dbCredentials: {
142
+ url: string;
143
+ };
144
+ } | {
145
+ dialect: Verify<Dialect, 'postgresql'>;
146
+ dbCredentials: ({
147
+ host: string;
148
+ port?: number;
149
+ user?: string;
150
+ password?: string;
151
+ database: string;
152
+ ssl?: boolean | 'require' | 'allow' | 'prefer' | 'verify-full' | ConnectionOptions;
153
+ } & {}) | {
154
+ url: string;
155
+ };
156
+ } | {
157
+ dialect: Verify<Dialect, 'postgresql'>;
158
+ driver: Verify<Driver, 'aws-data-api'>;
159
+ dbCredentials: {
160
+ database: string;
161
+ secretArn: string;
162
+ resourceArn: string;
163
+ };
164
+ } | {
165
+ dialect: Verify<Dialect, 'postgresql'>;
166
+ driver: Verify<Driver, 'pglite'>;
167
+ dbCredentials: {
168
+ url: string;
169
+ };
170
+ } | {
171
+ dialect: Verify<Dialect, 'postgresql'>;
172
+ driver: Verify<Driver, 'pglite'>;
173
+ client: PGlite;
174
+ } | {
175
+ dialect: Verify<Dialect, 'mysql'>;
176
+ dbCredentials: {
177
+ host: string;
178
+ port?: number;
179
+ user?: string;
180
+ password?: string;
181
+ database: string;
182
+ ssl?: string | SslOptions;
183
+ } | {
184
+ url: string;
185
+ };
186
+ } | {
187
+ dialect: Verify<Dialect, 'sqlite'>;
188
+ driver: Verify<Driver, 'd1-http'>;
189
+ dbCredentials: {
190
+ accountId: string;
191
+ databaseId: string;
192
+ token: string;
193
+ };
194
+ } | {
195
+ dialect: Verify<Dialect, 'sqlite'>;
196
+ driver: Verify<Driver, 'expo'>;
197
+ } | {
198
+ dialect: Verify<Dialect, 'sqlite'>;
199
+ driver: Verify<Driver, 'durable-sqlite'>;
200
+ } | {
201
+ dialect: Verify<Dialect, 'sqlite'>;
202
+ driver: Verify<Driver, 'sqlite-cloud'>;
203
+ } | {} | {
204
+ dialect: Verify<Dialect, 'singlestore'>;
205
+ dbCredentials: {
206
+ host: string;
207
+ port?: number;
208
+ user?: string;
209
+ password?: string;
210
+ database: string;
211
+ ssl?: string | SslOptions;
212
+ } | {
213
+ url: string;
214
+ };
215
+ } | {
216
+ dialect: Verify<Dialect, 'mssql'>;
217
+ dbCredentials: {
218
+ port: number;
219
+ user: string;
220
+ password: string;
221
+ database: string;
222
+ server: string;
223
+ options?: {
224
+ encrypt?: boolean;
225
+ trustServerCertificate?: boolean;
226
+ };
227
+ } | {
228
+ url: string;
229
+ };
230
+ } | {
231
+ dialect: Verify<Dialect, 'cockroach'>;
232
+ dbCredentials: ({
233
+ host: string;
234
+ port?: number;
235
+ user?: string;
236
+ password?: string;
237
+ database: string;
238
+ ssl?: boolean | 'require' | 'allow' | 'prefer' | 'verify-full' | ConnectionOptions;
239
+ } & {}) | {
240
+ url: string;
241
+ };
242
+ } | {
243
+ dialect: Verify<Dialect, 'duckdb'>;
244
+ dbCredentials: {
245
+ url: string;
246
+ };
247
+ });
248
+ /**
249
+ * **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
250
+ * adjustments may be necessary for you. See https://orm.drizzle.team/kit-docs/upgrade-21#how-to-migrate-to-0210**
251
+ *
252
+ * **Config** usage:
253
+ *
254
+ * `dialect` - mandatory and is responsible for explicitly providing a databse dialect you are using for all the commands
255
+ * *Possible values*: `postgresql`, `mysql`, `sqlite`, `singlestore`, `gel`
256
+ *
257
+ * See https://orm.drizzle.team/kit-docs/config-reference#dialect
258
+ *
259
+ * ---
260
+ * `schema` - param lets you define where your schema file/files live.
261
+ * You can have as many separate schema files as you want and define paths to them using glob or array of globs syntax.
262
+ *
263
+ * See https://orm.drizzle.team/kit-docs/config-reference#schema
264
+ *
265
+ * ---
266
+ * `out` - allows you to define the folder for your migrations and a folder, where drizzle will introspect the schema and relations
267
+ *
268
+ * See https://orm.drizzle.team/kit-docs/config-reference#out
269
+ *
270
+ * ---
271
+ * `driver` - optional param that is responsible for explicitly providing a driver to use when accessing a database
272
+ * *Possible values*: `aws-data-api`, `d1-http`, `expo`, `turso`, `pglite`
273
+ * 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
274
+ *
275
+ * See https://orm.drizzle.team/kit-docs/config-reference#driver
276
+ *
277
+ * ---
278
+ *
279
+ * `dbCredentials` - an object to define your connection to the database. For more info please check the docs
280
+ *
281
+ * See https://orm.drizzle.team/kit-docs/config-reference#dbcredentials
282
+ *
283
+ * ---
284
+ *
285
+ * `migrations` - param let’s you specify a custom table and schema(PostgreSQL only) for migrations.
286
+ * By default, all information about executed migrations will be stored in the database inside
287
+ * the `__drizzle_migrations` table, and for PostgreSQL, inside the drizzle schema.
288
+ * However, you can configure where to store those records.
289
+ *
290
+ * See https://orm.drizzle.team/kit-docs/config-reference#migrations
291
+ *
292
+ * ---
293
+ *
294
+ * `breakpoints` - param lets you enable/disable SQL statement breakpoints in generated migrations.
295
+ * It’s optional and true by default, it’s necessary to properly apply migrations on databases,
296
+ * that do not support multiple DDL alternation statements in one transaction(MySQL, SQLite, SingleStore) and
297
+ * Drizzle ORM has to apply them sequentially one by one.
298
+ *
299
+ * See https://orm.drizzle.team/kit-docs/config-reference#breakpoints
300
+ *
301
+ * ---
302
+ *
303
+ * `tablesFilters` - param lets you filter tables with glob syntax for db push command.
304
+ * It’s useful when you have only one database avaialable for several separate projects with separate sql schemas.
305
+ *
306
+ * How to define multi-project tables with Drizzle ORM — see https://orm.drizzle.team/docs/goodies#multi-project-schema
307
+ *
308
+ * See https://orm.drizzle.team/kit-docs/config-reference#tablesfilters
309
+ *
310
+ * ---
311
+ *
312
+ * `schemaFilter` - parameter allows you to define which schema in PostgreSQL should be used for either introspect or push commands.
313
+ * This parameter accepts a single schema as a string or an array of schemas as strings.
314
+ * No glob pattern is supported here. By default, drizzle will use the public schema for both commands,
315
+ * but you can add any schema you need.
316
+ *
317
+ * For example, having schemaFilter: ["my_schema"] will only look for tables in both the database and
318
+ * drizzle schema that are a part of the my_schema schema.
319
+ *
320
+ * See https://orm.drizzle.team/kit-docs/config-reference#schemafilter
321
+ *
322
+ * ---
323
+ *
324
+ * `verbose` - command is used for drizzle-kit push commands and prints all statements that will be executed.
325
+ *
326
+ * > Note: This command will only print the statements that should be executed.
327
+ * To approve them before applying, please refer to the `strict` command.
328
+ *
329
+ * See https://orm.drizzle.team/kit-docs/config-reference#verbose
330
+ *
331
+ * ---
332
+ *
333
+ * `strict` - command is used for drizzle-kit push commands and will always ask for your confirmation,
334
+ * either to execute all statements needed to sync your schema with the database or not.
335
+ *
336
+ * See https://orm.drizzle.team/kit-docs/config-reference#strict
337
+ */
338
+ declare function defineConfig(config: Config): Config;
339
+ //#endregion
340
+ export { Config, defineConfig };