@credibledata/cred-cli 0.1.3 → 0.1.4
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.
- package/dist/client/api.js +12 -4
- package/dist/client/api.js.map +1 -1
- package/generate-client.sh +2 -0
- package/package.json +1 -1
- package/src/client/api.ts +164 -47
package/generate-client.sh
CHANGED
|
@@ -14,6 +14,8 @@ Connection_allOf_mysqlConnection=ConnectionMysqlConnection,\
|
|
|
14
14
|
Connection_allOf_postgresConnection=ConnectionPostgresConnection,\
|
|
15
15
|
Connection_allOf_snowflakeConnection=ConnectionSnowflakeConnection,\
|
|
16
16
|
Connection_allOf_trinoConnection=ConnectionTrinoConnection,\
|
|
17
|
+
Connection_allOf_duckdbConnection=ConnectionDuckdbConnection,\
|
|
18
|
+
Connection_allOf_motherduckConnection=ConnectionMotherduckConnection,\
|
|
17
19
|
createOrUpdatePackage_request=CreateOrUpdatePackageRequest,\
|
|
18
20
|
updateWorkspace_request=UpdateWorkspaceRequest,\
|
|
19
21
|
getGroupMembers_200_response=GetGroupMembersResponse,\
|
package/package.json
CHANGED
package/src/client/api.ts
CHANGED
|
@@ -43,19 +43,19 @@ export interface AddGroupMembersRequest {
|
|
|
43
43
|
*/
|
|
44
44
|
export interface Connection {
|
|
45
45
|
/**
|
|
46
|
-
* Resource path to the connection
|
|
46
|
+
* Resource path to the connection
|
|
47
47
|
* @type {string}
|
|
48
48
|
* @memberof Connection
|
|
49
49
|
*/
|
|
50
50
|
'resource'?: string;
|
|
51
51
|
/**
|
|
52
|
-
*
|
|
52
|
+
* Name of the connection
|
|
53
53
|
* @type {string}
|
|
54
54
|
* @memberof Connection
|
|
55
55
|
*/
|
|
56
56
|
'name'?: string;
|
|
57
57
|
/**
|
|
58
|
-
*
|
|
58
|
+
* Type of database connection
|
|
59
59
|
* @type {string}
|
|
60
60
|
* @memberof Connection
|
|
61
61
|
*/
|
|
@@ -96,6 +96,18 @@ export interface Connection {
|
|
|
96
96
|
* @memberof Connection
|
|
97
97
|
*/
|
|
98
98
|
'mysqlConnection'?: ConnectionMysqlConnection;
|
|
99
|
+
/**
|
|
100
|
+
*
|
|
101
|
+
* @type {ConnectionDuckdbConnection}
|
|
102
|
+
* @memberof Connection
|
|
103
|
+
*/
|
|
104
|
+
'duckdbConnection'?: ConnectionDuckdbConnection;
|
|
105
|
+
/**
|
|
106
|
+
*
|
|
107
|
+
* @type {ConnectionMotherduckConnection}
|
|
108
|
+
* @memberof Connection
|
|
109
|
+
*/
|
|
110
|
+
'motherduckConnection'?: ConnectionMotherduckConnection;
|
|
99
111
|
/**
|
|
100
112
|
* The list of tables to include, in the format `{dataset/schema}.{table}`. The first part represents the dataset or schema, and the second part is the table name. The second part can be a literal `*` to include all tables.
|
|
101
113
|
* @type {Array<string>}
|
|
@@ -115,262 +127,366 @@ export const ConnectionTypeEnum = {
|
|
|
115
127
|
Bigquery: 'bigquery',
|
|
116
128
|
Snowflake: 'snowflake',
|
|
117
129
|
Trino: 'trino',
|
|
118
|
-
Mysql: 'mysql'
|
|
130
|
+
Mysql: 'mysql',
|
|
131
|
+
Duckdb: 'duckdb',
|
|
132
|
+
Motherduck: 'motherduck'
|
|
119
133
|
} as const;
|
|
120
134
|
|
|
121
135
|
export type ConnectionTypeEnum = typeof ConnectionTypeEnum[keyof typeof ConnectionTypeEnum];
|
|
122
136
|
|
|
123
137
|
/**
|
|
124
|
-
*
|
|
138
|
+
* Attached DuckDB database
|
|
139
|
+
* @export
|
|
140
|
+
* @interface ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
141
|
+
*/
|
|
142
|
+
export interface ConnectionAllOfDuckdbConnectionAttachedDatabases {
|
|
143
|
+
/**
|
|
144
|
+
*
|
|
145
|
+
* @type {string}
|
|
146
|
+
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
147
|
+
*/
|
|
148
|
+
'name'?: string;
|
|
149
|
+
/**
|
|
150
|
+
* Type of database connection
|
|
151
|
+
* @type {string}
|
|
152
|
+
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
153
|
+
*/
|
|
154
|
+
'type'?: ConnectionAllOfDuckdbConnectionAttachedDatabasesTypeEnum;
|
|
155
|
+
/**
|
|
156
|
+
*
|
|
157
|
+
* @type {ConnectionAttributes}
|
|
158
|
+
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
159
|
+
*/
|
|
160
|
+
'attributes'?: ConnectionAttributes;
|
|
161
|
+
/**
|
|
162
|
+
*
|
|
163
|
+
* @type {ConnectionBigqueryConnection}
|
|
164
|
+
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
165
|
+
*/
|
|
166
|
+
'bigqueryConnection'?: ConnectionBigqueryConnection;
|
|
167
|
+
/**
|
|
168
|
+
*
|
|
169
|
+
* @type {ConnectionSnowflakeConnection}
|
|
170
|
+
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
171
|
+
*/
|
|
172
|
+
'snowflakeConnection'?: ConnectionSnowflakeConnection;
|
|
173
|
+
/**
|
|
174
|
+
*
|
|
175
|
+
* @type {ConnectionPostgresConnection}
|
|
176
|
+
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
177
|
+
*/
|
|
178
|
+
'postgresConnection'?: ConnectionPostgresConnection;
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
export const ConnectionAllOfDuckdbConnectionAttachedDatabasesTypeEnum = {
|
|
182
|
+
Bigquery: 'bigquery',
|
|
183
|
+
Snowflake: 'snowflake',
|
|
184
|
+
Postgres: 'postgres'
|
|
185
|
+
} as const;
|
|
186
|
+
|
|
187
|
+
export type ConnectionAllOfDuckdbConnectionAttachedDatabasesTypeEnum = typeof ConnectionAllOfDuckdbConnectionAttachedDatabasesTypeEnum[keyof typeof ConnectionAllOfDuckdbConnectionAttachedDatabasesTypeEnum];
|
|
188
|
+
|
|
189
|
+
/**
|
|
190
|
+
* Connection capabilities and configuration attributes
|
|
125
191
|
* @export
|
|
126
192
|
* @interface ConnectionAttributes
|
|
127
193
|
*/
|
|
128
194
|
export interface ConnectionAttributes {
|
|
129
195
|
/**
|
|
130
|
-
*
|
|
196
|
+
* SQL dialect name for the connection
|
|
131
197
|
* @type {string}
|
|
132
198
|
* @memberof ConnectionAttributes
|
|
133
199
|
*/
|
|
134
200
|
'dialectName'?: string;
|
|
135
201
|
/**
|
|
136
|
-
*
|
|
202
|
+
* Whether the connection uses connection pooling
|
|
137
203
|
* @type {boolean}
|
|
138
204
|
* @memberof ConnectionAttributes
|
|
139
205
|
*/
|
|
140
206
|
'isPool'?: boolean;
|
|
141
207
|
/**
|
|
142
|
-
*
|
|
208
|
+
* Whether the connection supports persistent storage operations
|
|
143
209
|
* @type {boolean}
|
|
144
210
|
* @memberof ConnectionAttributes
|
|
145
211
|
*/
|
|
146
212
|
'canPersist'?: boolean;
|
|
147
213
|
/**
|
|
148
|
-
*
|
|
214
|
+
* Whether the connection supports streaming query results
|
|
149
215
|
* @type {boolean}
|
|
150
216
|
* @memberof ConnectionAttributes
|
|
151
217
|
*/
|
|
152
218
|
'canStream'?: boolean;
|
|
153
219
|
}
|
|
154
220
|
/**
|
|
155
|
-
*
|
|
221
|
+
* Google BigQuery database connection configuration
|
|
156
222
|
* @export
|
|
157
223
|
* @interface ConnectionBigqueryConnection
|
|
158
224
|
*/
|
|
159
225
|
export interface ConnectionBigqueryConnection {
|
|
160
226
|
/**
|
|
161
|
-
*
|
|
227
|
+
* Default BigQuery project ID for queries
|
|
162
228
|
* @type {string}
|
|
163
229
|
* @memberof ConnectionBigqueryConnection
|
|
164
230
|
*/
|
|
165
231
|
'defaultProjectId'?: string;
|
|
166
232
|
/**
|
|
167
|
-
*
|
|
233
|
+
* BigQuery project ID for billing purposes
|
|
168
234
|
* @type {string}
|
|
169
235
|
* @memberof ConnectionBigqueryConnection
|
|
170
236
|
*/
|
|
171
237
|
'billingProjectId'?: string;
|
|
172
238
|
/**
|
|
173
|
-
*
|
|
239
|
+
* BigQuery dataset location/region
|
|
174
240
|
* @type {string}
|
|
175
241
|
* @memberof ConnectionBigqueryConnection
|
|
176
242
|
*/
|
|
177
243
|
'location'?: string;
|
|
178
244
|
/**
|
|
179
|
-
*
|
|
245
|
+
* JSON string containing Google Cloud service account credentials
|
|
180
246
|
* @type {string}
|
|
181
247
|
* @memberof ConnectionBigqueryConnection
|
|
182
248
|
*/
|
|
183
249
|
'serviceAccountKeyJson'?: string;
|
|
184
250
|
/**
|
|
185
|
-
*
|
|
251
|
+
* Maximum bytes to bill for query execution (prevents runaway costs)
|
|
186
252
|
* @type {string}
|
|
187
253
|
* @memberof ConnectionBigqueryConnection
|
|
188
254
|
*/
|
|
189
255
|
'maximumBytesBilled'?: string;
|
|
190
256
|
/**
|
|
191
|
-
*
|
|
257
|
+
* Query timeout in milliseconds
|
|
192
258
|
* @type {string}
|
|
193
259
|
* @memberof ConnectionBigqueryConnection
|
|
194
260
|
*/
|
|
195
261
|
'queryTimeoutMilliseconds'?: string;
|
|
196
262
|
}
|
|
197
263
|
/**
|
|
198
|
-
*
|
|
264
|
+
* DuckDB database connection configuration
|
|
265
|
+
* @export
|
|
266
|
+
* @interface ConnectionDuckdbConnection
|
|
267
|
+
*/
|
|
268
|
+
export interface ConnectionDuckdbConnection {
|
|
269
|
+
/**
|
|
270
|
+
*
|
|
271
|
+
* @type {Array<ConnectionAllOfDuckdbConnectionAttachedDatabases>}
|
|
272
|
+
* @memberof ConnectionDuckdbConnection
|
|
273
|
+
*/
|
|
274
|
+
'attachedDatabases'?: Array<ConnectionAllOfDuckdbConnectionAttachedDatabases>;
|
|
275
|
+
}
|
|
276
|
+
/**
|
|
277
|
+
* MotherDuck database connection configuration
|
|
278
|
+
* @export
|
|
279
|
+
* @interface ConnectionMotherduckConnection
|
|
280
|
+
*/
|
|
281
|
+
export interface ConnectionMotherduckConnection {
|
|
282
|
+
/**
|
|
283
|
+
* MotherDuck access token
|
|
284
|
+
* @type {string}
|
|
285
|
+
* @memberof ConnectionMotherduckConnection
|
|
286
|
+
*/
|
|
287
|
+
'accessToken'?: string;
|
|
288
|
+
/**
|
|
289
|
+
* MotherDuck database name
|
|
290
|
+
* @type {string}
|
|
291
|
+
* @memberof ConnectionMotherduckConnection
|
|
292
|
+
*/
|
|
293
|
+
'database'?: string;
|
|
294
|
+
}
|
|
295
|
+
/**
|
|
296
|
+
* MySQL database connection configuration
|
|
199
297
|
* @export
|
|
200
298
|
* @interface ConnectionMysqlConnection
|
|
201
299
|
*/
|
|
202
300
|
export interface ConnectionMysqlConnection {
|
|
203
301
|
/**
|
|
204
|
-
*
|
|
302
|
+
* MySQL server hostname or IP address
|
|
205
303
|
* @type {string}
|
|
206
304
|
* @memberof ConnectionMysqlConnection
|
|
207
305
|
*/
|
|
208
306
|
'host'?: string;
|
|
209
307
|
/**
|
|
210
|
-
*
|
|
308
|
+
* MySQL server port number
|
|
211
309
|
* @type {number}
|
|
212
310
|
* @memberof ConnectionMysqlConnection
|
|
213
311
|
*/
|
|
214
312
|
'port'?: number;
|
|
215
313
|
/**
|
|
216
|
-
*
|
|
314
|
+
* Name of the MySQL database
|
|
217
315
|
* @type {string}
|
|
218
316
|
* @memberof ConnectionMysqlConnection
|
|
219
317
|
*/
|
|
220
318
|
'database'?: string;
|
|
221
319
|
/**
|
|
222
|
-
*
|
|
320
|
+
* MySQL username for authentication
|
|
223
321
|
* @type {string}
|
|
224
322
|
* @memberof ConnectionMysqlConnection
|
|
225
323
|
*/
|
|
226
324
|
'user'?: string;
|
|
227
325
|
/**
|
|
228
|
-
*
|
|
326
|
+
* MySQL password for authentication
|
|
229
327
|
* @type {string}
|
|
230
328
|
* @memberof ConnectionMysqlConnection
|
|
231
329
|
*/
|
|
232
330
|
'password'?: string;
|
|
233
331
|
}
|
|
234
332
|
/**
|
|
235
|
-
*
|
|
333
|
+
* PostgreSQL database connection configuration
|
|
236
334
|
* @export
|
|
237
335
|
* @interface ConnectionPostgresConnection
|
|
238
336
|
*/
|
|
239
337
|
export interface ConnectionPostgresConnection {
|
|
240
338
|
/**
|
|
241
|
-
*
|
|
339
|
+
* PostgreSQL server hostname or IP address
|
|
242
340
|
* @type {string}
|
|
243
341
|
* @memberof ConnectionPostgresConnection
|
|
244
342
|
*/
|
|
245
343
|
'host'?: string;
|
|
246
344
|
/**
|
|
247
|
-
*
|
|
345
|
+
* PostgreSQL server port number
|
|
248
346
|
* @type {number}
|
|
249
347
|
* @memberof ConnectionPostgresConnection
|
|
250
348
|
*/
|
|
251
349
|
'port'?: number;
|
|
252
350
|
/**
|
|
253
|
-
*
|
|
351
|
+
* Name of the PostgreSQL database
|
|
254
352
|
* @type {string}
|
|
255
353
|
* @memberof ConnectionPostgresConnection
|
|
256
354
|
*/
|
|
257
355
|
'databaseName'?: string;
|
|
258
356
|
/**
|
|
259
|
-
*
|
|
357
|
+
* PostgreSQL username for authentication
|
|
260
358
|
* @type {string}
|
|
261
359
|
* @memberof ConnectionPostgresConnection
|
|
262
360
|
*/
|
|
263
361
|
'userName'?: string;
|
|
264
362
|
/**
|
|
265
|
-
*
|
|
363
|
+
* PostgreSQL password for authentication
|
|
266
364
|
* @type {string}
|
|
267
365
|
* @memberof ConnectionPostgresConnection
|
|
268
366
|
*/
|
|
269
367
|
'password'?: string;
|
|
270
368
|
/**
|
|
271
|
-
*
|
|
369
|
+
* Complete PostgreSQL connection string (alternative to individual parameters)
|
|
272
370
|
* @type {string}
|
|
273
371
|
* @memberof ConnectionPostgresConnection
|
|
274
372
|
*/
|
|
275
373
|
'connectionString'?: string;
|
|
276
374
|
}
|
|
277
375
|
/**
|
|
278
|
-
*
|
|
376
|
+
* Snowflake database connection configuration
|
|
279
377
|
* @export
|
|
280
378
|
* @interface ConnectionSnowflakeConnection
|
|
281
379
|
*/
|
|
282
380
|
export interface ConnectionSnowflakeConnection {
|
|
283
381
|
/**
|
|
284
|
-
*
|
|
382
|
+
* Snowflake account identifier
|
|
285
383
|
* @type {string}
|
|
286
384
|
* @memberof ConnectionSnowflakeConnection
|
|
287
385
|
*/
|
|
288
386
|
'account'?: string;
|
|
289
387
|
/**
|
|
290
|
-
*
|
|
388
|
+
* Snowflake username for authentication
|
|
291
389
|
* @type {string}
|
|
292
390
|
* @memberof ConnectionSnowflakeConnection
|
|
293
391
|
*/
|
|
294
392
|
'username'?: string;
|
|
295
393
|
/**
|
|
296
|
-
*
|
|
394
|
+
* Snowflake password for authentication
|
|
297
395
|
* @type {string}
|
|
298
396
|
* @memberof ConnectionSnowflakeConnection
|
|
299
397
|
*/
|
|
300
398
|
'password'?: string;
|
|
301
399
|
/**
|
|
302
|
-
*
|
|
400
|
+
* Snowflake private key for authentication
|
|
401
|
+
* @type {string}
|
|
402
|
+
* @memberof ConnectionSnowflakeConnection
|
|
403
|
+
*/
|
|
404
|
+
'privateKey'?: string;
|
|
405
|
+
/**
|
|
406
|
+
* Passphrase for the Snowflake private key
|
|
407
|
+
* @type {string}
|
|
408
|
+
* @memberof ConnectionSnowflakeConnection
|
|
409
|
+
*/
|
|
410
|
+
'privateKeyPass'?: string;
|
|
411
|
+
/**
|
|
412
|
+
* Snowflake warehouse name
|
|
303
413
|
* @type {string}
|
|
304
414
|
* @memberof ConnectionSnowflakeConnection
|
|
305
415
|
*/
|
|
306
416
|
'warehouse'?: string;
|
|
307
417
|
/**
|
|
308
|
-
*
|
|
418
|
+
* Snowflake database name
|
|
309
419
|
* @type {string}
|
|
310
420
|
* @memberof ConnectionSnowflakeConnection
|
|
311
421
|
*/
|
|
312
422
|
'database'?: string;
|
|
313
423
|
/**
|
|
314
|
-
*
|
|
424
|
+
* Snowflake schema name
|
|
315
425
|
* @type {string}
|
|
316
426
|
* @memberof ConnectionSnowflakeConnection
|
|
317
427
|
*/
|
|
318
428
|
'schema'?: string;
|
|
319
429
|
/**
|
|
320
|
-
*
|
|
430
|
+
* Snowflake role name
|
|
321
431
|
* @type {string}
|
|
322
432
|
* @memberof ConnectionSnowflakeConnection
|
|
323
433
|
*/
|
|
324
434
|
'role'?: string;
|
|
325
435
|
/**
|
|
326
|
-
*
|
|
436
|
+
* Query response timeout in milliseconds
|
|
327
437
|
* @type {number}
|
|
328
438
|
* @memberof ConnectionSnowflakeConnection
|
|
329
439
|
*/
|
|
330
440
|
'responseTimeoutMilliseconds'?: number;
|
|
331
441
|
}
|
|
332
442
|
/**
|
|
333
|
-
*
|
|
443
|
+
* Trino database connection configuration
|
|
334
444
|
* @export
|
|
335
445
|
* @interface ConnectionTrinoConnection
|
|
336
446
|
*/
|
|
337
447
|
export interface ConnectionTrinoConnection {
|
|
338
448
|
/**
|
|
339
|
-
*
|
|
449
|
+
* Trino server hostname or IP address
|
|
340
450
|
* @type {string}
|
|
341
451
|
* @memberof ConnectionTrinoConnection
|
|
342
452
|
*/
|
|
343
453
|
'server'?: string;
|
|
344
454
|
/**
|
|
345
|
-
*
|
|
455
|
+
* Trino server port number
|
|
346
456
|
* @type {number}
|
|
347
457
|
* @memberof ConnectionTrinoConnection
|
|
348
458
|
*/
|
|
349
459
|
'port'?: number;
|
|
350
460
|
/**
|
|
351
|
-
*
|
|
461
|
+
* Trino catalog name
|
|
352
462
|
* @type {string}
|
|
353
463
|
* @memberof ConnectionTrinoConnection
|
|
354
464
|
*/
|
|
355
465
|
'catalog'?: string;
|
|
356
466
|
/**
|
|
357
|
-
*
|
|
467
|
+
* Trino schema name
|
|
358
468
|
* @type {string}
|
|
359
469
|
* @memberof ConnectionTrinoConnection
|
|
360
470
|
*/
|
|
361
471
|
'schema'?: string;
|
|
362
472
|
/**
|
|
363
|
-
*
|
|
473
|
+
* Trino username for authentication
|
|
364
474
|
* @type {string}
|
|
365
475
|
* @memberof ConnectionTrinoConnection
|
|
366
476
|
*/
|
|
367
477
|
'user'?: string;
|
|
368
478
|
/**
|
|
369
|
-
*
|
|
479
|
+
* Trino password for authentication
|
|
370
480
|
* @type {string}
|
|
371
481
|
* @memberof ConnectionTrinoConnection
|
|
372
482
|
*/
|
|
373
483
|
'password'?: string;
|
|
484
|
+
/**
|
|
485
|
+
* Peaka API key for authentication with Peaka-hosted Trino clusters
|
|
486
|
+
* @type {string}
|
|
487
|
+
* @memberof ConnectionTrinoConnection
|
|
488
|
+
*/
|
|
489
|
+
'peakaKey'?: string;
|
|
374
490
|
}
|
|
375
491
|
/**
|
|
376
492
|
* Represents a document within a workspace, such as a workbook or dashboard
|
|
@@ -1080,7 +1196,7 @@ export interface Version {
|
|
|
1080
1196
|
*/
|
|
1081
1197
|
'updatedAt'?: string;
|
|
1082
1198
|
/**
|
|
1083
|
-
* Current
|
|
1199
|
+
* Current status of the package version, controlling its availability
|
|
1084
1200
|
* @type {string}
|
|
1085
1201
|
* @memberof Version
|
|
1086
1202
|
*/
|
|
@@ -1089,7 +1205,8 @@ export interface Version {
|
|
|
1089
1205
|
|
|
1090
1206
|
export const VersionArchiveStatusEnum = {
|
|
1091
1207
|
Archive: 'archive',
|
|
1092
|
-
Unarchive: 'unarchive'
|
|
1208
|
+
Unarchive: 'unarchive',
|
|
1209
|
+
ErrorState: 'error_state'
|
|
1093
1210
|
} as const;
|
|
1094
1211
|
|
|
1095
1212
|
export type VersionArchiveStatusEnum = typeof VersionArchiveStatusEnum[keyof typeof VersionArchiveStatusEnum];
|