@malloydata/db-publisher 0.0.380 → 0.0.382
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.d.ts +1762 -406
- package/dist/client/api.js +1190 -152
- package/dist/client/api.js.map +1 -1
- package/dist/publisher_connection.js +4 -2
- package/dist/publisher_connection.js.map +1 -1
- package/dist/publisher_connection.unit.spec.js +13 -4
- package/dist/publisher_connection.unit.spec.js.map +1 -1
- package/package.json +2 -2
- package/publisher-api-doc.yaml +1095 -91
- package/src/client/api.ts +2938 -1042
- package/src/publisher_connection.ts +5 -4
- package/src/publisher_connection.unit.spec.ts +13 -8
package/dist/client/api.d.ts
CHANGED
|
@@ -55,13 +55,88 @@ export interface AttachedDatabase {
|
|
|
55
55
|
* @memberof AttachedDatabase
|
|
56
56
|
*/
|
|
57
57
|
'postgresConnection'?: PostgresConnection;
|
|
58
|
+
/**
|
|
59
|
+
*
|
|
60
|
+
* @type {GCSConnection}
|
|
61
|
+
* @memberof AttachedDatabase
|
|
62
|
+
*/
|
|
63
|
+
'gcsConnection'?: GCSConnection;
|
|
64
|
+
/**
|
|
65
|
+
*
|
|
66
|
+
* @type {S3Connection}
|
|
67
|
+
* @memberof AttachedDatabase
|
|
68
|
+
*/
|
|
69
|
+
's3Connection'?: S3Connection;
|
|
70
|
+
/**
|
|
71
|
+
*
|
|
72
|
+
* @type {AzureConnection}
|
|
73
|
+
* @memberof AttachedDatabase
|
|
74
|
+
*/
|
|
75
|
+
'azureConnection'?: AzureConnection;
|
|
58
76
|
}
|
|
59
77
|
export declare const AttachedDatabaseTypeEnum: {
|
|
60
78
|
readonly Bigquery: "bigquery";
|
|
61
79
|
readonly Snowflake: "snowflake";
|
|
62
80
|
readonly Postgres: "postgres";
|
|
81
|
+
readonly Gcs: "gcs";
|
|
82
|
+
readonly S3: "s3";
|
|
83
|
+
readonly Azure: "azure";
|
|
63
84
|
};
|
|
64
85
|
export type AttachedDatabaseTypeEnum = typeof AttachedDatabaseTypeEnum[keyof typeof AttachedDatabaseTypeEnum];
|
|
86
|
+
/**
|
|
87
|
+
* Azure Data Lake Storage (ADLS Gen2) / Blob Storage connection configuration Supports https://, http://, abfss://, and az:// URL schemes.
|
|
88
|
+
* @export
|
|
89
|
+
* @interface AzureConnection
|
|
90
|
+
*/
|
|
91
|
+
export interface AzureConnection {
|
|
92
|
+
/**
|
|
93
|
+
* Authentication method for Azure Storage
|
|
94
|
+
* @type {string}
|
|
95
|
+
* @memberof AzureConnection
|
|
96
|
+
*/
|
|
97
|
+
'authType': AzureConnectionAuthTypeEnum;
|
|
98
|
+
/**
|
|
99
|
+
* Full SAS URL including token; required for sas_token auth. Supports single file, directory glob (*.ext), or recursive (**) patterns. Example: https://account.blob.core.windows.net/container/path/_*.parquet?sp=rl&st=...
|
|
100
|
+
* @type {string}
|
|
101
|
+
* @memberof AzureConnection
|
|
102
|
+
*/
|
|
103
|
+
'sasUrl'?: string;
|
|
104
|
+
/**
|
|
105
|
+
* Azure AD tenant ID (required for service_principal)
|
|
106
|
+
* @type {string}
|
|
107
|
+
* @memberof AzureConnection
|
|
108
|
+
*/
|
|
109
|
+
'tenantId'?: string;
|
|
110
|
+
/**
|
|
111
|
+
* Azure AD application (client) ID (required for service_principal)
|
|
112
|
+
* @type {string}
|
|
113
|
+
* @memberof AzureConnection
|
|
114
|
+
*/
|
|
115
|
+
'clientId'?: string;
|
|
116
|
+
/**
|
|
117
|
+
* Azure AD client secret (required for service_principal)
|
|
118
|
+
* @type {string}
|
|
119
|
+
* @memberof AzureConnection
|
|
120
|
+
*/
|
|
121
|
+
'clientSecret'?: string;
|
|
122
|
+
/**
|
|
123
|
+
* Azure Storage account name (required for service_principal)
|
|
124
|
+
* @type {string}
|
|
125
|
+
* @memberof AzureConnection
|
|
126
|
+
*/
|
|
127
|
+
'accountName'?: string;
|
|
128
|
+
/**
|
|
129
|
+
* Azure file URL to query; required for service_principal auth. Supports single file, directory glob (*.ext), or recursive (**) patterns. Example: https://account.blob.core.windows.net/container/path/_**
|
|
130
|
+
* @type {string}
|
|
131
|
+
* @memberof AzureConnection
|
|
132
|
+
*/
|
|
133
|
+
'fileUrl'?: string;
|
|
134
|
+
}
|
|
135
|
+
export declare const AzureConnectionAuthTypeEnum: {
|
|
136
|
+
readonly ServicePrincipal: "service_principal";
|
|
137
|
+
readonly SasToken: "sas_token";
|
|
138
|
+
};
|
|
139
|
+
export type AzureConnectionAuthTypeEnum = typeof AzureConnectionAuthTypeEnum[keyof typeof AzureConnectionAuthTypeEnum];
|
|
65
140
|
/**
|
|
66
141
|
* Google BigQuery database connection configuration
|
|
67
142
|
* @export
|
|
@@ -105,6 +180,27 @@ export interface BigqueryConnection {
|
|
|
105
180
|
*/
|
|
106
181
|
'queryTimeoutMilliseconds'?: string;
|
|
107
182
|
}
|
|
183
|
+
/**
|
|
184
|
+
* Manifest mapping BuildIDs to materialized table names
|
|
185
|
+
* @export
|
|
186
|
+
* @interface BuildManifest
|
|
187
|
+
*/
|
|
188
|
+
export interface BuildManifest {
|
|
189
|
+
/**
|
|
190
|
+
* Map of BuildID to manifest entry
|
|
191
|
+
* @type {{ [key: string]: ManifestEntry; }}
|
|
192
|
+
* @memberof BuildManifest
|
|
193
|
+
*/
|
|
194
|
+
'entries'?: {
|
|
195
|
+
[key: string]: ManifestEntry;
|
|
196
|
+
};
|
|
197
|
+
/**
|
|
198
|
+
* Whether the manifest is in strict mode
|
|
199
|
+
* @type {boolean}
|
|
200
|
+
* @memberof BuildManifest
|
|
201
|
+
*/
|
|
202
|
+
'strict'?: boolean;
|
|
203
|
+
}
|
|
108
204
|
/**
|
|
109
205
|
* Database column definition
|
|
110
206
|
* @export
|
|
@@ -124,6 +220,111 @@ export interface Column {
|
|
|
124
220
|
*/
|
|
125
221
|
'type'?: string;
|
|
126
222
|
}
|
|
223
|
+
/**
|
|
224
|
+
* A compilation problem reported by the Malloy compiler
|
|
225
|
+
* @export
|
|
226
|
+
* @interface CompileProblem
|
|
227
|
+
*/
|
|
228
|
+
export interface CompileProblem {
|
|
229
|
+
/**
|
|
230
|
+
* Human-readable problem description
|
|
231
|
+
* @type {string}
|
|
232
|
+
* @memberof CompileProblem
|
|
233
|
+
*/
|
|
234
|
+
'message'?: string;
|
|
235
|
+
/**
|
|
236
|
+
* Severity level of the problem
|
|
237
|
+
* @type {string}
|
|
238
|
+
* @memberof CompileProblem
|
|
239
|
+
*/
|
|
240
|
+
'severity'?: CompileProblemSeverityEnum;
|
|
241
|
+
/**
|
|
242
|
+
* Machine-readable error code
|
|
243
|
+
* @type {string}
|
|
244
|
+
* @memberof CompileProblem
|
|
245
|
+
*/
|
|
246
|
+
'code'?: string;
|
|
247
|
+
/**
|
|
248
|
+
*
|
|
249
|
+
* @type {CompileProblemAt}
|
|
250
|
+
* @memberof CompileProblem
|
|
251
|
+
*/
|
|
252
|
+
'at'?: CompileProblemAt;
|
|
253
|
+
}
|
|
254
|
+
export declare const CompileProblemSeverityEnum: {
|
|
255
|
+
readonly Error: "error";
|
|
256
|
+
readonly Warn: "warn";
|
|
257
|
+
readonly Debug: "debug";
|
|
258
|
+
};
|
|
259
|
+
export type CompileProblemSeverityEnum = typeof CompileProblemSeverityEnum[keyof typeof CompileProblemSeverityEnum];
|
|
260
|
+
/**
|
|
261
|
+
* Source location of the problem
|
|
262
|
+
* @export
|
|
263
|
+
* @interface CompileProblemAt
|
|
264
|
+
*/
|
|
265
|
+
export interface CompileProblemAt {
|
|
266
|
+
/**
|
|
267
|
+
* URL of the source file
|
|
268
|
+
* @type {string}
|
|
269
|
+
* @memberof CompileProblemAt
|
|
270
|
+
*/
|
|
271
|
+
'url'?: string;
|
|
272
|
+
/**
|
|
273
|
+
* Character range within the source file
|
|
274
|
+
* @type {object}
|
|
275
|
+
* @memberof CompileProblemAt
|
|
276
|
+
*/
|
|
277
|
+
'range'?: object;
|
|
278
|
+
}
|
|
279
|
+
/**
|
|
280
|
+
* Request body for compiling Malloy source code
|
|
281
|
+
* @export
|
|
282
|
+
* @interface CompileRequest
|
|
283
|
+
*/
|
|
284
|
+
export interface CompileRequest {
|
|
285
|
+
/**
|
|
286
|
+
* Malloy source code to compile
|
|
287
|
+
* @type {string}
|
|
288
|
+
* @memberof CompileRequest
|
|
289
|
+
*/
|
|
290
|
+
'source': string;
|
|
291
|
+
/**
|
|
292
|
+
* If true, returns the generated SQL alongside compilation results (only available when compilation succeeds and the source contains a runnable query).
|
|
293
|
+
* @type {boolean}
|
|
294
|
+
* @memberof CompileRequest
|
|
295
|
+
*/
|
|
296
|
+
'includeSql'?: boolean;
|
|
297
|
+
}
|
|
298
|
+
/**
|
|
299
|
+
* Result of a Malloy source compilation check
|
|
300
|
+
* @export
|
|
301
|
+
* @interface CompileResult
|
|
302
|
+
*/
|
|
303
|
+
export interface CompileResult {
|
|
304
|
+
/**
|
|
305
|
+
* Overall compilation status — \"error\" if any problems have error severity
|
|
306
|
+
* @type {string}
|
|
307
|
+
* @memberof CompileResult
|
|
308
|
+
*/
|
|
309
|
+
'status'?: CompileResultStatusEnum;
|
|
310
|
+
/**
|
|
311
|
+
* List of compilation problems (errors and warnings)
|
|
312
|
+
* @type {Array<CompileProblem>}
|
|
313
|
+
* @memberof CompileResult
|
|
314
|
+
*/
|
|
315
|
+
'problems'?: Array<CompileProblem>;
|
|
316
|
+
/**
|
|
317
|
+
* Generated SQL for the compiled query. Only present when includeSql is true and compilation succeeds with a runnable query.
|
|
318
|
+
* @type {string}
|
|
319
|
+
* @memberof CompileResult
|
|
320
|
+
*/
|
|
321
|
+
'sql'?: string;
|
|
322
|
+
}
|
|
323
|
+
export declare const CompileResultStatusEnum: {
|
|
324
|
+
readonly Success: "success";
|
|
325
|
+
readonly Error: "error";
|
|
326
|
+
};
|
|
327
|
+
export type CompileResultStatusEnum = typeof CompileResultStatusEnum[keyof typeof CompileResultStatusEnum];
|
|
127
328
|
/**
|
|
128
329
|
* Compiled Malloy model with sources, queries, and metadata
|
|
129
330
|
* @export
|
|
@@ -172,43 +373,12 @@ export interface CompiledModel {
|
|
|
172
373
|
* @memberof CompiledModel
|
|
173
374
|
*/
|
|
174
375
|
'queries'?: Array<Query>;
|
|
175
|
-
}
|
|
176
|
-
/**
|
|
177
|
-
* Compiled Malloy notebook with cells, results, and execution data
|
|
178
|
-
* @export
|
|
179
|
-
* @interface CompiledNotebook
|
|
180
|
-
*/
|
|
181
|
-
export interface CompiledNotebook {
|
|
182
|
-
/**
|
|
183
|
-
* Resource path to the notebook
|
|
184
|
-
* @type {string}
|
|
185
|
-
* @memberof CompiledNotebook
|
|
186
|
-
*/
|
|
187
|
-
'resource'?: string;
|
|
188
|
-
/**
|
|
189
|
-
* Name of the package containing this notebook
|
|
190
|
-
* @type {string}
|
|
191
|
-
* @memberof CompiledNotebook
|
|
192
|
-
*/
|
|
193
|
-
'packageName'?: string;
|
|
194
|
-
/**
|
|
195
|
-
* Relative path to the notebook file within its package directory
|
|
196
|
-
* @type {string}
|
|
197
|
-
* @memberof CompiledNotebook
|
|
198
|
-
*/
|
|
199
|
-
'path'?: string;
|
|
200
|
-
/**
|
|
201
|
-
* Version of the Malloy compiler used to generate the notebook data
|
|
202
|
-
* @type {string}
|
|
203
|
-
* @memberof CompiledNotebook
|
|
204
|
-
*/
|
|
205
|
-
'malloyVersion'?: string;
|
|
206
376
|
/**
|
|
207
|
-
*
|
|
208
|
-
* @type {Array<
|
|
209
|
-
* @memberof
|
|
377
|
+
* Sources defined in this model
|
|
378
|
+
* @type {Array<Source>}
|
|
379
|
+
* @memberof CompiledModel
|
|
210
380
|
*/
|
|
211
|
-
'
|
|
381
|
+
'sources'?: Array<Source>;
|
|
212
382
|
}
|
|
213
383
|
/**
|
|
214
384
|
* Database connection configuration and metadata
|
|
@@ -282,6 +452,12 @@ export interface Connection {
|
|
|
282
452
|
* @memberof Connection
|
|
283
453
|
*/
|
|
284
454
|
'motherduckConnection'?: MotherDuckConnection;
|
|
455
|
+
/**
|
|
456
|
+
*
|
|
457
|
+
* @type {DucklakeConnection}
|
|
458
|
+
* @memberof Connection
|
|
459
|
+
*/
|
|
460
|
+
'ducklakeConnection'?: DucklakeConnection;
|
|
285
461
|
}
|
|
286
462
|
export declare const ConnectionTypeEnum: {
|
|
287
463
|
readonly Postgres: "postgres";
|
|
@@ -291,6 +467,7 @@ export declare const ConnectionTypeEnum: {
|
|
|
291
467
|
readonly Mysql: "mysql";
|
|
292
468
|
readonly Duckdb: "duckdb";
|
|
293
469
|
readonly Motherduck: "motherduck";
|
|
470
|
+
readonly Ducklake: "ducklake";
|
|
294
471
|
};
|
|
295
472
|
export type ConnectionTypeEnum = typeof ConnectionTypeEnum[keyof typeof ConnectionTypeEnum];
|
|
296
473
|
/**
|
|
@@ -348,6 +525,51 @@ export declare const ConnectionStatusStatusEnum: {
|
|
|
348
525
|
readonly Failed: "failed";
|
|
349
526
|
};
|
|
350
527
|
export type ConnectionStatusStatusEnum = typeof ConnectionStatusStatusEnum[keyof typeof ConnectionStatusStatusEnum];
|
|
528
|
+
/**
|
|
529
|
+
*
|
|
530
|
+
* @export
|
|
531
|
+
* @interface CreateConnection201Response
|
|
532
|
+
*/
|
|
533
|
+
export interface CreateConnection201Response {
|
|
534
|
+
/**
|
|
535
|
+
*
|
|
536
|
+
* @type {string}
|
|
537
|
+
* @memberof CreateConnection201Response
|
|
538
|
+
*/
|
|
539
|
+
'message'?: string;
|
|
540
|
+
}
|
|
541
|
+
/**
|
|
542
|
+
*
|
|
543
|
+
* @export
|
|
544
|
+
* @interface CreateConnection409Response
|
|
545
|
+
*/
|
|
546
|
+
export interface CreateConnection409Response {
|
|
547
|
+
/**
|
|
548
|
+
*
|
|
549
|
+
* @type {string}
|
|
550
|
+
* @memberof CreateConnection409Response
|
|
551
|
+
*/
|
|
552
|
+
'error'?: string;
|
|
553
|
+
}
|
|
554
|
+
/**
|
|
555
|
+
* Options for creating a materialization
|
|
556
|
+
* @export
|
|
557
|
+
* @interface CreateMaterializationRequest
|
|
558
|
+
*/
|
|
559
|
+
export interface CreateMaterializationRequest {
|
|
560
|
+
/**
|
|
561
|
+
* If true, forces rebuild of all sources even if their BuildID is unchanged
|
|
562
|
+
* @type {boolean}
|
|
563
|
+
* @memberof CreateMaterializationRequest
|
|
564
|
+
*/
|
|
565
|
+
'forceRefresh'?: boolean;
|
|
566
|
+
/**
|
|
567
|
+
* If true, automatically reloads the manifest into the Malloy Runtime after a successful materialization
|
|
568
|
+
* @type {boolean}
|
|
569
|
+
* @memberof CreateMaterializationRequest
|
|
570
|
+
*/
|
|
571
|
+
'autoLoadManifest'?: boolean;
|
|
572
|
+
}
|
|
351
573
|
/**
|
|
352
574
|
* Embedded database within a Malloy package
|
|
353
575
|
* @export
|
|
@@ -398,141 +620,432 @@ export interface DuckdbConnection {
|
|
|
398
620
|
'attachedDatabases'?: Array<AttachedDatabase>;
|
|
399
621
|
}
|
|
400
622
|
/**
|
|
401
|
-
*
|
|
623
|
+
* DuckLake lakehouse connection configuration
|
|
402
624
|
* @export
|
|
403
|
-
* @interface
|
|
625
|
+
* @interface DucklakeConnection
|
|
404
626
|
*/
|
|
405
|
-
export interface
|
|
406
|
-
/**
|
|
407
|
-
* Resource path to the model
|
|
408
|
-
* @type {string}
|
|
409
|
-
* @memberof Model
|
|
410
|
-
*/
|
|
411
|
-
'resource'?: string;
|
|
627
|
+
export interface DucklakeConnection {
|
|
412
628
|
/**
|
|
413
|
-
*
|
|
414
|
-
* @type {
|
|
415
|
-
* @memberof
|
|
629
|
+
*
|
|
630
|
+
* @type {DucklakeConnectionStorage}
|
|
631
|
+
* @memberof DucklakeConnection
|
|
416
632
|
*/
|
|
417
|
-
'
|
|
633
|
+
'storage': DucklakeConnectionStorage;
|
|
418
634
|
/**
|
|
419
|
-
*
|
|
420
|
-
* @type {
|
|
421
|
-
* @memberof
|
|
635
|
+
*
|
|
636
|
+
* @type {DucklakeConnectionCatalog}
|
|
637
|
+
* @memberof DucklakeConnection
|
|
422
638
|
*/
|
|
423
|
-
'
|
|
639
|
+
'catalog': DucklakeConnectionCatalog;
|
|
640
|
+
}
|
|
641
|
+
/**
|
|
642
|
+
* Catalog metadata connection configuration
|
|
643
|
+
* @export
|
|
644
|
+
* @interface DucklakeConnectionCatalog
|
|
645
|
+
*/
|
|
646
|
+
export interface DucklakeConnectionCatalog {
|
|
424
647
|
/**
|
|
425
|
-
*
|
|
426
|
-
* @type {
|
|
427
|
-
* @memberof
|
|
648
|
+
* PostgreSQL connection for DuckLake metadata catalog
|
|
649
|
+
* @type {PostgresConnection}
|
|
650
|
+
* @memberof DucklakeConnectionCatalog
|
|
428
651
|
*/
|
|
429
|
-
'
|
|
652
|
+
'postgresConnection': PostgresConnection;
|
|
430
653
|
}
|
|
431
654
|
/**
|
|
432
|
-
*
|
|
655
|
+
* Data storage connection configuration (S3 or GCS)
|
|
433
656
|
* @export
|
|
434
|
-
* @interface
|
|
657
|
+
* @interface DucklakeConnectionStorage
|
|
435
658
|
*/
|
|
436
|
-
export interface
|
|
659
|
+
export interface DucklakeConnectionStorage {
|
|
437
660
|
/**
|
|
438
|
-
*
|
|
661
|
+
* URL of the storage bucket (e.g. s3://my-bucket/path or gs://my-bucket/path)
|
|
439
662
|
* @type {string}
|
|
440
|
-
* @memberof
|
|
663
|
+
* @memberof DucklakeConnectionStorage
|
|
441
664
|
*/
|
|
442
|
-
'
|
|
665
|
+
'bucketUrl': string;
|
|
443
666
|
/**
|
|
444
|
-
*
|
|
445
|
-
* @type {
|
|
446
|
-
* @memberof
|
|
667
|
+
* AWS S3 connection configuration for data storage
|
|
668
|
+
* @type {S3Connection}
|
|
669
|
+
* @memberof DucklakeConnectionStorage
|
|
447
670
|
*/
|
|
448
|
-
'
|
|
671
|
+
's3Connection'?: S3Connection;
|
|
672
|
+
/**
|
|
673
|
+
* Google Cloud Storage connection configuration for data storage
|
|
674
|
+
* @type {GCSConnection}
|
|
675
|
+
* @memberof DucklakeConnectionStorage
|
|
676
|
+
*/
|
|
677
|
+
'gcsConnection'?: GCSConnection;
|
|
449
678
|
}
|
|
450
679
|
/**
|
|
451
|
-
*
|
|
680
|
+
* A filter declared via
|
|
452
681
|
* @export
|
|
453
|
-
* @interface
|
|
682
|
+
* @interface Filter
|
|
454
683
|
*/
|
|
455
|
-
export interface
|
|
684
|
+
export interface Filter {
|
|
456
685
|
/**
|
|
457
|
-
*
|
|
686
|
+
* Display name of the filter
|
|
458
687
|
* @type {string}
|
|
459
|
-
* @memberof
|
|
688
|
+
* @memberof Filter
|
|
460
689
|
*/
|
|
461
|
-
'
|
|
690
|
+
'name'?: string;
|
|
462
691
|
/**
|
|
463
|
-
*
|
|
692
|
+
* Dimension this filter targets
|
|
464
693
|
* @type {string}
|
|
465
|
-
* @memberof
|
|
694
|
+
* @memberof Filter
|
|
466
695
|
*/
|
|
467
|
-
'
|
|
468
|
-
}
|
|
469
|
-
/**
|
|
470
|
-
* MySQL database connection configuration
|
|
471
|
-
* @export
|
|
472
|
-
* @interface MysqlConnection
|
|
473
|
-
*/
|
|
474
|
-
export interface MysqlConnection {
|
|
696
|
+
'dimension'?: string;
|
|
475
697
|
/**
|
|
476
|
-
*
|
|
698
|
+
* Comparator type
|
|
477
699
|
* @type {string}
|
|
478
|
-
* @memberof
|
|
700
|
+
* @memberof Filter
|
|
479
701
|
*/
|
|
480
|
-
'
|
|
702
|
+
'type'?: FilterTypeEnum;
|
|
481
703
|
/**
|
|
482
|
-
*
|
|
483
|
-
* @type {
|
|
484
|
-
* @memberof
|
|
704
|
+
* Whether this filter is hidden from users
|
|
705
|
+
* @type {boolean}
|
|
706
|
+
* @memberof Filter
|
|
485
707
|
*/
|
|
486
|
-
'
|
|
708
|
+
'implicit'?: boolean;
|
|
487
709
|
/**
|
|
488
|
-
*
|
|
710
|
+
* Whether a value must be provided
|
|
711
|
+
* @type {boolean}
|
|
712
|
+
* @memberof Filter
|
|
713
|
+
*/
|
|
714
|
+
'required'?: boolean;
|
|
715
|
+
/**
|
|
716
|
+
* Malloy data type of the dimension (e.g. string, number, boolean, date, timestamp)
|
|
489
717
|
* @type {string}
|
|
490
|
-
* @memberof
|
|
718
|
+
* @memberof Filter
|
|
491
719
|
*/
|
|
492
|
-
'
|
|
720
|
+
'dimensionType'?: string;
|
|
721
|
+
}
|
|
722
|
+
export declare const FilterTypeEnum: {
|
|
723
|
+
readonly Equal: "equal";
|
|
724
|
+
readonly In: "in";
|
|
725
|
+
readonly Like: "like";
|
|
726
|
+
readonly GreaterThan: "greater_than";
|
|
727
|
+
readonly LessThan: "less_than";
|
|
728
|
+
};
|
|
729
|
+
export type FilterTypeEnum = typeof FilterTypeEnum[keyof typeof FilterTypeEnum];
|
|
730
|
+
/**
|
|
731
|
+
* Google Cloud Storage connection configuration for DuckDB
|
|
732
|
+
* @export
|
|
733
|
+
* @interface GCSConnection
|
|
734
|
+
*/
|
|
735
|
+
export interface GCSConnection {
|
|
493
736
|
/**
|
|
494
|
-
*
|
|
737
|
+
* GCS HMAC access key ID
|
|
495
738
|
* @type {string}
|
|
496
|
-
* @memberof
|
|
739
|
+
* @memberof GCSConnection
|
|
497
740
|
*/
|
|
498
|
-
'
|
|
741
|
+
'keyId': string;
|
|
499
742
|
/**
|
|
500
|
-
*
|
|
743
|
+
* GCS HMAC secret key
|
|
501
744
|
* @type {string}
|
|
502
|
-
* @memberof
|
|
745
|
+
* @memberof GCSConnection
|
|
503
746
|
*/
|
|
504
|
-
'
|
|
747
|
+
'secret': string;
|
|
505
748
|
}
|
|
506
749
|
/**
|
|
507
|
-
*
|
|
750
|
+
* A log message from render tag validation
|
|
508
751
|
* @export
|
|
509
|
-
* @interface
|
|
752
|
+
* @interface LogMessage
|
|
510
753
|
*/
|
|
511
|
-
export interface
|
|
754
|
+
export interface LogMessage {
|
|
512
755
|
/**
|
|
513
|
-
*
|
|
756
|
+
* URL of the source file related to this message
|
|
514
757
|
* @type {string}
|
|
515
|
-
* @memberof
|
|
758
|
+
* @memberof LogMessage
|
|
516
759
|
*/
|
|
517
|
-
'
|
|
760
|
+
'url'?: string;
|
|
518
761
|
/**
|
|
519
|
-
*
|
|
520
|
-
* @type {
|
|
521
|
-
* @memberof
|
|
762
|
+
*
|
|
763
|
+
* @type {LogMessageRange}
|
|
764
|
+
* @memberof LogMessage
|
|
522
765
|
*/
|
|
523
|
-
'
|
|
766
|
+
'range'?: LogMessageRange;
|
|
524
767
|
/**
|
|
525
|
-
*
|
|
768
|
+
* Severity level of the log message
|
|
526
769
|
* @type {string}
|
|
527
|
-
* @memberof
|
|
770
|
+
* @memberof LogMessage
|
|
528
771
|
*/
|
|
529
|
-
'
|
|
772
|
+
'severity'?: LogMessageSeverityEnum;
|
|
530
773
|
/**
|
|
531
|
-
*
|
|
774
|
+
* Human-readable log message
|
|
532
775
|
* @type {string}
|
|
533
|
-
* @memberof
|
|
776
|
+
* @memberof LogMessage
|
|
534
777
|
*/
|
|
535
|
-
'
|
|
778
|
+
'message'?: string;
|
|
779
|
+
}
|
|
780
|
+
export declare const LogMessageSeverityEnum: {
|
|
781
|
+
readonly Debug: "debug";
|
|
782
|
+
readonly Info: "info";
|
|
783
|
+
readonly Warn: "warn";
|
|
784
|
+
readonly Error: "error";
|
|
785
|
+
};
|
|
786
|
+
export type LogMessageSeverityEnum = typeof LogMessageSeverityEnum[keyof typeof LogMessageSeverityEnum];
|
|
787
|
+
/**
|
|
788
|
+
* Source location range for this message
|
|
789
|
+
* @export
|
|
790
|
+
* @interface LogMessageRange
|
|
791
|
+
*/
|
|
792
|
+
export interface LogMessageRange {
|
|
793
|
+
/**
|
|
794
|
+
*
|
|
795
|
+
* @type {LogMessageRangeStart}
|
|
796
|
+
* @memberof LogMessageRange
|
|
797
|
+
*/
|
|
798
|
+
'start'?: LogMessageRangeStart;
|
|
799
|
+
/**
|
|
800
|
+
*
|
|
801
|
+
* @type {LogMessageRangeStart}
|
|
802
|
+
* @memberof LogMessageRange
|
|
803
|
+
*/
|
|
804
|
+
'end'?: LogMessageRangeStart;
|
|
805
|
+
}
|
|
806
|
+
/**
|
|
807
|
+
*
|
|
808
|
+
* @export
|
|
809
|
+
* @interface LogMessageRangeStart
|
|
810
|
+
*/
|
|
811
|
+
export interface LogMessageRangeStart {
|
|
812
|
+
/**
|
|
813
|
+
*
|
|
814
|
+
* @type {number}
|
|
815
|
+
* @memberof LogMessageRangeStart
|
|
816
|
+
*/
|
|
817
|
+
'line'?: number;
|
|
818
|
+
/**
|
|
819
|
+
*
|
|
820
|
+
* @type {number}
|
|
821
|
+
* @memberof LogMessageRangeStart
|
|
822
|
+
*/
|
|
823
|
+
'character'?: number;
|
|
824
|
+
}
|
|
825
|
+
/**
|
|
826
|
+
* A single entry in the build manifest
|
|
827
|
+
* @export
|
|
828
|
+
* @interface ManifestEntry
|
|
829
|
+
*/
|
|
830
|
+
export interface ManifestEntry {
|
|
831
|
+
/**
|
|
832
|
+
* Name of the materialized table
|
|
833
|
+
* @type {string}
|
|
834
|
+
* @memberof ManifestEntry
|
|
835
|
+
*/
|
|
836
|
+
'tableName'?: string;
|
|
837
|
+
}
|
|
838
|
+
/**
|
|
839
|
+
* A record of a package materialization
|
|
840
|
+
* @export
|
|
841
|
+
* @interface Materialization
|
|
842
|
+
*/
|
|
843
|
+
export interface Materialization {
|
|
844
|
+
/**
|
|
845
|
+
*
|
|
846
|
+
* @type {string}
|
|
847
|
+
* @memberof Materialization
|
|
848
|
+
*/
|
|
849
|
+
'id'?: string;
|
|
850
|
+
/**
|
|
851
|
+
*
|
|
852
|
+
* @type {string}
|
|
853
|
+
* @memberof Materialization
|
|
854
|
+
*/
|
|
855
|
+
'projectId'?: string;
|
|
856
|
+
/**
|
|
857
|
+
*
|
|
858
|
+
* @type {string}
|
|
859
|
+
* @memberof Materialization
|
|
860
|
+
*/
|
|
861
|
+
'packageName'?: string;
|
|
862
|
+
/**
|
|
863
|
+
*
|
|
864
|
+
* @type {string}
|
|
865
|
+
* @memberof Materialization
|
|
866
|
+
*/
|
|
867
|
+
'status'?: MaterializationStatusEnum;
|
|
868
|
+
/**
|
|
869
|
+
*
|
|
870
|
+
* @type {string}
|
|
871
|
+
* @memberof Materialization
|
|
872
|
+
*/
|
|
873
|
+
'startedAt'?: string | null;
|
|
874
|
+
/**
|
|
875
|
+
*
|
|
876
|
+
* @type {string}
|
|
877
|
+
* @memberof Materialization
|
|
878
|
+
*/
|
|
879
|
+
'completedAt'?: string | null;
|
|
880
|
+
/**
|
|
881
|
+
* Error message if the materialization failed
|
|
882
|
+
* @type {string}
|
|
883
|
+
* @memberof Materialization
|
|
884
|
+
*/
|
|
885
|
+
'error'?: string | null;
|
|
886
|
+
/**
|
|
887
|
+
* Materialization metadata including build options, source counts, and durations
|
|
888
|
+
* @type {object}
|
|
889
|
+
* @memberof Materialization
|
|
890
|
+
*/
|
|
891
|
+
'metadata'?: object | null;
|
|
892
|
+
/**
|
|
893
|
+
*
|
|
894
|
+
* @type {string}
|
|
895
|
+
* @memberof Materialization
|
|
896
|
+
*/
|
|
897
|
+
'createdAt'?: string;
|
|
898
|
+
/**
|
|
899
|
+
*
|
|
900
|
+
* @type {string}
|
|
901
|
+
* @memberof Materialization
|
|
902
|
+
*/
|
|
903
|
+
'updatedAt'?: string;
|
|
904
|
+
}
|
|
905
|
+
export declare const MaterializationStatusEnum: {
|
|
906
|
+
readonly Pending: "PENDING";
|
|
907
|
+
readonly Running: "RUNNING";
|
|
908
|
+
readonly Success: "SUCCESS";
|
|
909
|
+
readonly Failed: "FAILED";
|
|
910
|
+
readonly Cancelled: "CANCELLED";
|
|
911
|
+
};
|
|
912
|
+
export type MaterializationStatusEnum = typeof MaterializationStatusEnum[keyof typeof MaterializationStatusEnum];
|
|
913
|
+
/**
|
|
914
|
+
* Malloy model metadata and status information
|
|
915
|
+
* @export
|
|
916
|
+
* @interface Model
|
|
917
|
+
*/
|
|
918
|
+
export interface Model {
|
|
919
|
+
/**
|
|
920
|
+
* Resource path to the model
|
|
921
|
+
* @type {string}
|
|
922
|
+
* @memberof Model
|
|
923
|
+
*/
|
|
924
|
+
'resource'?: string;
|
|
925
|
+
/**
|
|
926
|
+
* Name of the package containing this model
|
|
927
|
+
* @type {string}
|
|
928
|
+
* @memberof Model
|
|
929
|
+
*/
|
|
930
|
+
'packageName'?: string;
|
|
931
|
+
/**
|
|
932
|
+
* Relative path to the model file within its package directory
|
|
933
|
+
* @type {string}
|
|
934
|
+
* @memberof Model
|
|
935
|
+
*/
|
|
936
|
+
'path'?: string;
|
|
937
|
+
/**
|
|
938
|
+
* Error message if the model failed to compile or load
|
|
939
|
+
* @type {string}
|
|
940
|
+
* @memberof Model
|
|
941
|
+
*/
|
|
942
|
+
'error'?: string;
|
|
943
|
+
}
|
|
944
|
+
/**
|
|
945
|
+
* Standard error response format
|
|
946
|
+
* @export
|
|
947
|
+
* @interface ModelError
|
|
948
|
+
*/
|
|
949
|
+
export interface ModelError {
|
|
950
|
+
/**
|
|
951
|
+
* Human-readable error message describing what went wrong
|
|
952
|
+
* @type {string}
|
|
953
|
+
* @memberof ModelError
|
|
954
|
+
*/
|
|
955
|
+
'message': string;
|
|
956
|
+
/**
|
|
957
|
+
* Additional error details or context
|
|
958
|
+
* @type {string}
|
|
959
|
+
* @memberof ModelError
|
|
960
|
+
*/
|
|
961
|
+
'details'?: string;
|
|
962
|
+
}
|
|
963
|
+
/**
|
|
964
|
+
* MotherDuck database connection configuration
|
|
965
|
+
* @export
|
|
966
|
+
* @interface MotherDuckConnection
|
|
967
|
+
*/
|
|
968
|
+
export interface MotherDuckConnection {
|
|
969
|
+
/**
|
|
970
|
+
* MotherDuck access token
|
|
971
|
+
* @type {string}
|
|
972
|
+
* @memberof MotherDuckConnection
|
|
973
|
+
*/
|
|
974
|
+
'accessToken'?: string;
|
|
975
|
+
/**
|
|
976
|
+
* MotherDuck database name
|
|
977
|
+
* @type {string}
|
|
978
|
+
* @memberof MotherDuckConnection
|
|
979
|
+
*/
|
|
980
|
+
'database'?: string;
|
|
981
|
+
}
|
|
982
|
+
/**
|
|
983
|
+
* MySQL database connection configuration
|
|
984
|
+
* @export
|
|
985
|
+
* @interface MysqlConnection
|
|
986
|
+
*/
|
|
987
|
+
export interface MysqlConnection {
|
|
988
|
+
/**
|
|
989
|
+
* MySQL server hostname or IP address
|
|
990
|
+
* @type {string}
|
|
991
|
+
* @memberof MysqlConnection
|
|
992
|
+
*/
|
|
993
|
+
'host'?: string;
|
|
994
|
+
/**
|
|
995
|
+
* MySQL server port number
|
|
996
|
+
* @type {number}
|
|
997
|
+
* @memberof MysqlConnection
|
|
998
|
+
*/
|
|
999
|
+
'port'?: number;
|
|
1000
|
+
/**
|
|
1001
|
+
* Name of the MySQL database
|
|
1002
|
+
* @type {string}
|
|
1003
|
+
* @memberof MysqlConnection
|
|
1004
|
+
*/
|
|
1005
|
+
'database'?: string;
|
|
1006
|
+
/**
|
|
1007
|
+
* MySQL username for authentication
|
|
1008
|
+
* @type {string}
|
|
1009
|
+
* @memberof MysqlConnection
|
|
1010
|
+
*/
|
|
1011
|
+
'user'?: string;
|
|
1012
|
+
/**
|
|
1013
|
+
* MySQL password for authentication
|
|
1014
|
+
* @type {string}
|
|
1015
|
+
* @memberof MysqlConnection
|
|
1016
|
+
*/
|
|
1017
|
+
'password'?: string;
|
|
1018
|
+
}
|
|
1019
|
+
/**
|
|
1020
|
+
* Malloy notebook metadata and status information
|
|
1021
|
+
* @export
|
|
1022
|
+
* @interface Notebook
|
|
1023
|
+
*/
|
|
1024
|
+
export interface Notebook {
|
|
1025
|
+
/**
|
|
1026
|
+
* Resource path to the notebook
|
|
1027
|
+
* @type {string}
|
|
1028
|
+
* @memberof Notebook
|
|
1029
|
+
*/
|
|
1030
|
+
'resource'?: string;
|
|
1031
|
+
/**
|
|
1032
|
+
* Name of the package containing this notebook
|
|
1033
|
+
* @type {string}
|
|
1034
|
+
* @memberof Notebook
|
|
1035
|
+
*/
|
|
1036
|
+
'packageName'?: string;
|
|
1037
|
+
/**
|
|
1038
|
+
* Relative path to the notebook file within its package directory
|
|
1039
|
+
* @type {string}
|
|
1040
|
+
* @memberof Notebook
|
|
1041
|
+
*/
|
|
1042
|
+
'path'?: string;
|
|
1043
|
+
/**
|
|
1044
|
+
* Error message if the notebook failed to compile or load
|
|
1045
|
+
* @type {string}
|
|
1046
|
+
* @memberof Notebook
|
|
1047
|
+
*/
|
|
1048
|
+
'error'?: string;
|
|
536
1049
|
}
|
|
537
1050
|
/**
|
|
538
1051
|
* Individual cell within a Malloy notebook
|
|
@@ -547,29 +1060,65 @@ export interface NotebookCell {
|
|
|
547
1060
|
*/
|
|
548
1061
|
'type'?: NotebookCellTypeEnum;
|
|
549
1062
|
/**
|
|
550
|
-
* Text contents of the notebook cell
|
|
1063
|
+
* Text contents of the notebook cell (either markdown or Malloy code)
|
|
551
1064
|
* @type {string}
|
|
552
1065
|
* @memberof NotebookCell
|
|
553
1066
|
*/
|
|
554
1067
|
'text'?: string;
|
|
555
1068
|
/**
|
|
556
|
-
* JSON
|
|
1069
|
+
* Array of JSON strings containing SourceInfo objects made available in this cell
|
|
1070
|
+
* @type {Array<string>}
|
|
1071
|
+
* @memberof NotebookCell
|
|
1072
|
+
*/
|
|
1073
|
+
'newSources'?: Array<string>;
|
|
1074
|
+
/**
|
|
1075
|
+
* JSON string containing QueryInfo object for the query in this cell (if the cell contains a query)
|
|
557
1076
|
* @type {string}
|
|
558
1077
|
* @memberof NotebookCell
|
|
559
1078
|
*/
|
|
1079
|
+
'queryInfo'?: string;
|
|
1080
|
+
}
|
|
1081
|
+
export declare const NotebookCellTypeEnum: {
|
|
1082
|
+
readonly Markdown: "markdown";
|
|
1083
|
+
readonly Code: "code";
|
|
1084
|
+
};
|
|
1085
|
+
export type NotebookCellTypeEnum = typeof NotebookCellTypeEnum[keyof typeof NotebookCellTypeEnum];
|
|
1086
|
+
/**
|
|
1087
|
+
* Result of executing a notebook cell
|
|
1088
|
+
* @export
|
|
1089
|
+
* @interface NotebookCellResult
|
|
1090
|
+
*/
|
|
1091
|
+
export interface NotebookCellResult {
|
|
1092
|
+
/**
|
|
1093
|
+
* Type of notebook cell
|
|
1094
|
+
* @type {string}
|
|
1095
|
+
* @memberof NotebookCellResult
|
|
1096
|
+
*/
|
|
1097
|
+
'type'?: NotebookCellResultTypeEnum;
|
|
1098
|
+
/**
|
|
1099
|
+
* Text contents of the notebook cell
|
|
1100
|
+
* @type {string}
|
|
1101
|
+
* @memberof NotebookCellResult
|
|
1102
|
+
*/
|
|
1103
|
+
'text'?: string;
|
|
1104
|
+
/**
|
|
1105
|
+
* JSON string containing the execution result for this cell
|
|
1106
|
+
* @type {string}
|
|
1107
|
+
* @memberof NotebookCellResult
|
|
1108
|
+
*/
|
|
560
1109
|
'result'?: string;
|
|
561
1110
|
/**
|
|
562
1111
|
* Array of JSON strings containing SourceInfo objects made available in this cell
|
|
563
1112
|
* @type {Array<string>}
|
|
564
|
-
* @memberof
|
|
1113
|
+
* @memberof NotebookCellResult
|
|
565
1114
|
*/
|
|
566
1115
|
'newSources'?: Array<string>;
|
|
567
1116
|
}
|
|
568
|
-
export declare const
|
|
1117
|
+
export declare const NotebookCellResultTypeEnum: {
|
|
569
1118
|
readonly Markdown: "markdown";
|
|
570
1119
|
readonly Code: "code";
|
|
571
1120
|
};
|
|
572
|
-
export type
|
|
1121
|
+
export type NotebookCellResultTypeEnum = typeof NotebookCellResultTypeEnum[keyof typeof NotebookCellResultTypeEnum];
|
|
573
1122
|
/**
|
|
574
1123
|
* Represents a Malloy package containing models, notebooks, and embedded databases
|
|
575
1124
|
* @export
|
|
@@ -601,6 +1150,25 @@ export interface Package {
|
|
|
601
1150
|
*/
|
|
602
1151
|
'location'?: string;
|
|
603
1152
|
}
|
|
1153
|
+
/**
|
|
1154
|
+
*
|
|
1155
|
+
* @export
|
|
1156
|
+
* @interface PostQuerydataRequest
|
|
1157
|
+
*/
|
|
1158
|
+
export interface PostQuerydataRequest {
|
|
1159
|
+
/**
|
|
1160
|
+
*
|
|
1161
|
+
* @type {string}
|
|
1162
|
+
* @memberof PostQuerydataRequest
|
|
1163
|
+
*/
|
|
1164
|
+
'sqlStatement'?: string;
|
|
1165
|
+
/**
|
|
1166
|
+
* Options
|
|
1167
|
+
* @type {string}
|
|
1168
|
+
* @memberof PostQuerydataRequest
|
|
1169
|
+
*/
|
|
1170
|
+
'options'?: string;
|
|
1171
|
+
}
|
|
604
1172
|
/**
|
|
605
1173
|
*
|
|
606
1174
|
* @export
|
|
@@ -699,6 +1267,31 @@ export interface Project {
|
|
|
699
1267
|
* @memberof Project
|
|
700
1268
|
*/
|
|
701
1269
|
'packages'?: Array<Package>;
|
|
1270
|
+
/**
|
|
1271
|
+
*
|
|
1272
|
+
* @type {ProjectMaterializationStorage}
|
|
1273
|
+
* @memberof Project
|
|
1274
|
+
*/
|
|
1275
|
+
'materializationStorage'?: ProjectMaterializationStorage;
|
|
1276
|
+
}
|
|
1277
|
+
/**
|
|
1278
|
+
* Optional DuckLake-backed storage for materialization manifests (orchestrated mode). When set, manifests are stored in a shared DuckLake catalog instead of the local DuckDB database.
|
|
1279
|
+
* @export
|
|
1280
|
+
* @interface ProjectMaterializationStorage
|
|
1281
|
+
*/
|
|
1282
|
+
export interface ProjectMaterializationStorage {
|
|
1283
|
+
/**
|
|
1284
|
+
* PostgreSQL connection URL for the DuckLake catalog metadata store
|
|
1285
|
+
* @type {string}
|
|
1286
|
+
* @memberof ProjectMaterializationStorage
|
|
1287
|
+
*/
|
|
1288
|
+
'catalogUrl'?: string;
|
|
1289
|
+
/**
|
|
1290
|
+
* Cloud storage path (s3:// or gs://) for DuckLake data files
|
|
1291
|
+
* @type {string}
|
|
1292
|
+
* @memberof ProjectMaterializationStorage
|
|
1293
|
+
*/
|
|
1294
|
+
'dataPath'?: string;
|
|
702
1295
|
}
|
|
703
1296
|
/**
|
|
704
1297
|
* Named model query definition
|
|
@@ -768,13 +1361,38 @@ export interface QueryRequest {
|
|
|
768
1361
|
* @memberof QueryRequest
|
|
769
1362
|
*/
|
|
770
1363
|
'queryName'?: string;
|
|
1364
|
+
/**
|
|
1365
|
+
* If true, returns a simple JSON array of row objects in the form {\"columnName\": value}. If false (default), returns the full Malloy result with type metadata for rendering.
|
|
1366
|
+
* @type {boolean}
|
|
1367
|
+
* @memberof QueryRequest
|
|
1368
|
+
*/
|
|
1369
|
+
'compactJson'?: boolean;
|
|
771
1370
|
/**
|
|
772
1371
|
* Version ID
|
|
773
1372
|
* @type {string}
|
|
774
1373
|
* @memberof QueryRequest
|
|
775
1374
|
*/
|
|
776
1375
|
'versionId'?: string;
|
|
1376
|
+
/**
|
|
1377
|
+
* Filter parameter values keyed by filter name. Used with sources that declare
|
|
1378
|
+
* @type {{ [key: string]: QueryRequestFilterParamsValue; }}
|
|
1379
|
+
* @memberof QueryRequest
|
|
1380
|
+
*/
|
|
1381
|
+
'filterParams'?: {
|
|
1382
|
+
[key: string]: QueryRequestFilterParamsValue;
|
|
1383
|
+
};
|
|
1384
|
+
/**
|
|
1385
|
+
* When true, skip server-side
|
|
1386
|
+
* @type {boolean}
|
|
1387
|
+
* @memberof QueryRequest
|
|
1388
|
+
*/
|
|
1389
|
+
'bypassFilters'?: boolean;
|
|
777
1390
|
}
|
|
1391
|
+
/**
|
|
1392
|
+
* @type QueryRequestFilterParamsValue
|
|
1393
|
+
* @export
|
|
1394
|
+
*/
|
|
1395
|
+
export type QueryRequestFilterParamsValue = Array<string> | string;
|
|
778
1396
|
/**
|
|
779
1397
|
* Results from executing a Malloy query
|
|
780
1398
|
* @export
|
|
@@ -793,6 +1411,98 @@ export interface QueryResult {
|
|
|
793
1411
|
* @memberof QueryResult
|
|
794
1412
|
*/
|
|
795
1413
|
'resource'?: string;
|
|
1414
|
+
/**
|
|
1415
|
+
* Render tag validation messages (errors, warnings) detected during query preparation
|
|
1416
|
+
* @type {Array<LogMessage>}
|
|
1417
|
+
* @memberof QueryResult
|
|
1418
|
+
*/
|
|
1419
|
+
'renderLogs'?: Array<LogMessage>;
|
|
1420
|
+
}
|
|
1421
|
+
/**
|
|
1422
|
+
* Raw Malloy notebook with unexecuted cell contents
|
|
1423
|
+
* @export
|
|
1424
|
+
* @interface RawNotebook
|
|
1425
|
+
*/
|
|
1426
|
+
export interface RawNotebook {
|
|
1427
|
+
/**
|
|
1428
|
+
* Resource path to the notebook
|
|
1429
|
+
* @type {string}
|
|
1430
|
+
* @memberof RawNotebook
|
|
1431
|
+
*/
|
|
1432
|
+
'resource'?: string;
|
|
1433
|
+
/**
|
|
1434
|
+
* Name of the package containing this notebook
|
|
1435
|
+
* @type {string}
|
|
1436
|
+
* @memberof RawNotebook
|
|
1437
|
+
*/
|
|
1438
|
+
'packageName'?: string;
|
|
1439
|
+
/**
|
|
1440
|
+
* Relative path to the notebook file within its package directory
|
|
1441
|
+
* @type {string}
|
|
1442
|
+
* @memberof RawNotebook
|
|
1443
|
+
*/
|
|
1444
|
+
'path'?: string;
|
|
1445
|
+
/**
|
|
1446
|
+
* Version of the Malloy compiler used to generate the notebook data
|
|
1447
|
+
* @type {string}
|
|
1448
|
+
* @memberof RawNotebook
|
|
1449
|
+
*/
|
|
1450
|
+
'malloyVersion'?: string;
|
|
1451
|
+
/**
|
|
1452
|
+
* Array of notebook cells containing raw markdown and code content
|
|
1453
|
+
* @type {Array<NotebookCell>}
|
|
1454
|
+
* @memberof RawNotebook
|
|
1455
|
+
*/
|
|
1456
|
+
'notebookCells'?: Array<NotebookCell>;
|
|
1457
|
+
/**
|
|
1458
|
+
* Array of file-level (##) annotations attached to the notebook
|
|
1459
|
+
* @type {Array<string>}
|
|
1460
|
+
* @memberof RawNotebook
|
|
1461
|
+
*/
|
|
1462
|
+
'annotations'?: Array<string>;
|
|
1463
|
+
/**
|
|
1464
|
+
* Sources defined in the notebook\'s model
|
|
1465
|
+
* @type {Array<Source>}
|
|
1466
|
+
* @memberof RawNotebook
|
|
1467
|
+
*/
|
|
1468
|
+
'sources'?: Array<Source>;
|
|
1469
|
+
}
|
|
1470
|
+
/**
|
|
1471
|
+
* AWS S3 connection configuration for DuckDB
|
|
1472
|
+
* @export
|
|
1473
|
+
* @interface S3Connection
|
|
1474
|
+
*/
|
|
1475
|
+
export interface S3Connection {
|
|
1476
|
+
/**
|
|
1477
|
+
* AWS access key ID
|
|
1478
|
+
* @type {string}
|
|
1479
|
+
* @memberof S3Connection
|
|
1480
|
+
*/
|
|
1481
|
+
'accessKeyId': string;
|
|
1482
|
+
/**
|
|
1483
|
+
* AWS secret access key
|
|
1484
|
+
* @type {string}
|
|
1485
|
+
* @memberof S3Connection
|
|
1486
|
+
*/
|
|
1487
|
+
'secretAccessKey': string;
|
|
1488
|
+
/**
|
|
1489
|
+
* AWS region (e.g., us-east-1)
|
|
1490
|
+
* @type {string}
|
|
1491
|
+
* @memberof S3Connection
|
|
1492
|
+
*/
|
|
1493
|
+
'region'?: string;
|
|
1494
|
+
/**
|
|
1495
|
+
* Custom S3-compatible endpoint URL (optional, for MinIO, etc.)
|
|
1496
|
+
* @type {string}
|
|
1497
|
+
* @memberof S3Connection
|
|
1498
|
+
*/
|
|
1499
|
+
'endpoint'?: string;
|
|
1500
|
+
/**
|
|
1501
|
+
* AWS session token for temporary credentials (optional)
|
|
1502
|
+
* @type {string}
|
|
1503
|
+
* @memberof S3Connection
|
|
1504
|
+
*/
|
|
1505
|
+
'sessionToken'?: string;
|
|
796
1506
|
}
|
|
797
1507
|
/**
|
|
798
1508
|
* A schema name in a Connection.
|
|
@@ -849,7 +1559,25 @@ export interface ServerStatus {
|
|
|
849
1559
|
* @memberof ServerStatus
|
|
850
1560
|
*/
|
|
851
1561
|
'initialized'?: boolean;
|
|
1562
|
+
/**
|
|
1563
|
+
* Status of the server; initializing when the server is loading projects, packages and connections, serving when the server is initialized and ready to serve requests, and draining when the server is going to shut down
|
|
1564
|
+
* @type {string}
|
|
1565
|
+
* @memberof ServerStatus
|
|
1566
|
+
*/
|
|
1567
|
+
'operationalState'?: ServerStatusOperationalStateEnum;
|
|
1568
|
+
/**
|
|
1569
|
+
* Whether the server configuration is frozen (read-only mode). When true, all mutation operations are disabled.
|
|
1570
|
+
* @type {boolean}
|
|
1571
|
+
* @memberof ServerStatus
|
|
1572
|
+
*/
|
|
1573
|
+
'frozenConfig'?: boolean;
|
|
852
1574
|
}
|
|
1575
|
+
export declare const ServerStatusOperationalStateEnum: {
|
|
1576
|
+
readonly Initializing: "initializing";
|
|
1577
|
+
readonly Serving: "serving";
|
|
1578
|
+
readonly Draining: "draining";
|
|
1579
|
+
};
|
|
1580
|
+
export type ServerStatusOperationalStateEnum = typeof ServerStatusOperationalStateEnum[keyof typeof ServerStatusOperationalStateEnum];
|
|
853
1581
|
/**
|
|
854
1582
|
* Snowflake database connection configuration
|
|
855
1583
|
* @export
|
|
@@ -917,6 +1645,37 @@ export interface SnowflakeConnection {
|
|
|
917
1645
|
*/
|
|
918
1646
|
'responseTimeoutMilliseconds'?: number;
|
|
919
1647
|
}
|
|
1648
|
+
/**
|
|
1649
|
+
* A Malloy source defined in a model
|
|
1650
|
+
* @export
|
|
1651
|
+
* @interface Source
|
|
1652
|
+
*/
|
|
1653
|
+
export interface Source {
|
|
1654
|
+
/**
|
|
1655
|
+
* Name of the source
|
|
1656
|
+
* @type {string}
|
|
1657
|
+
* @memberof Source
|
|
1658
|
+
*/
|
|
1659
|
+
'name'?: string;
|
|
1660
|
+
/**
|
|
1661
|
+
* Annotations attached to the source
|
|
1662
|
+
* @type {Array<string>}
|
|
1663
|
+
* @memberof Source
|
|
1664
|
+
*/
|
|
1665
|
+
'annotations'?: Array<string>;
|
|
1666
|
+
/**
|
|
1667
|
+
* Views defined in this source
|
|
1668
|
+
* @type {Array<View>}
|
|
1669
|
+
* @memberof Source
|
|
1670
|
+
*/
|
|
1671
|
+
'views'?: Array<View>;
|
|
1672
|
+
/**
|
|
1673
|
+
* Filters declared on this source via
|
|
1674
|
+
* @type {Array<Filter>}
|
|
1675
|
+
* @memberof Source
|
|
1676
|
+
*/
|
|
1677
|
+
'filters'?: Array<Filter>;
|
|
1678
|
+
}
|
|
920
1679
|
/**
|
|
921
1680
|
*
|
|
922
1681
|
* @export
|
|
@@ -1092,6 +1851,61 @@ export interface TrinoConnection {
|
|
|
1092
1851
|
*/
|
|
1093
1852
|
'peakaKey'?: string;
|
|
1094
1853
|
}
|
|
1854
|
+
/**
|
|
1855
|
+
*
|
|
1856
|
+
* @export
|
|
1857
|
+
* @interface UpdateConnectionRequest
|
|
1858
|
+
*/
|
|
1859
|
+
export interface UpdateConnectionRequest {
|
|
1860
|
+
/**
|
|
1861
|
+
*
|
|
1862
|
+
* @type {PostgresConnection}
|
|
1863
|
+
* @memberof UpdateConnectionRequest
|
|
1864
|
+
*/
|
|
1865
|
+
'postgresConnection'?: PostgresConnection;
|
|
1866
|
+
/**
|
|
1867
|
+
*
|
|
1868
|
+
* @type {MysqlConnection}
|
|
1869
|
+
* @memberof UpdateConnectionRequest
|
|
1870
|
+
*/
|
|
1871
|
+
'mysqlConnection'?: MysqlConnection;
|
|
1872
|
+
/**
|
|
1873
|
+
*
|
|
1874
|
+
* @type {BigqueryConnection}
|
|
1875
|
+
* @memberof UpdateConnectionRequest
|
|
1876
|
+
*/
|
|
1877
|
+
'bigqueryConnection'?: BigqueryConnection;
|
|
1878
|
+
/**
|
|
1879
|
+
*
|
|
1880
|
+
* @type {SnowflakeConnection}
|
|
1881
|
+
* @memberof UpdateConnectionRequest
|
|
1882
|
+
*/
|
|
1883
|
+
'snowflakeConnection'?: SnowflakeConnection;
|
|
1884
|
+
/**
|
|
1885
|
+
*
|
|
1886
|
+
* @type {DuckdbConnection}
|
|
1887
|
+
* @memberof UpdateConnectionRequest
|
|
1888
|
+
*/
|
|
1889
|
+
'duckdbConnection'?: DuckdbConnection;
|
|
1890
|
+
/**
|
|
1891
|
+
*
|
|
1892
|
+
* @type {MotherDuckConnection}
|
|
1893
|
+
* @memberof UpdateConnectionRequest
|
|
1894
|
+
*/
|
|
1895
|
+
'motherduckConnection'?: MotherDuckConnection;
|
|
1896
|
+
/**
|
|
1897
|
+
*
|
|
1898
|
+
* @type {TrinoConnection}
|
|
1899
|
+
* @memberof UpdateConnectionRequest
|
|
1900
|
+
*/
|
|
1901
|
+
'trinoConnection'?: TrinoConnection;
|
|
1902
|
+
/**
|
|
1903
|
+
*
|
|
1904
|
+
* @type {DucklakeConnection}
|
|
1905
|
+
* @memberof UpdateConnectionRequest
|
|
1906
|
+
*/
|
|
1907
|
+
'ducklakeConnection'?: DucklakeConnection;
|
|
1908
|
+
}
|
|
1095
1909
|
/**
|
|
1096
1910
|
* Named model view definition
|
|
1097
1911
|
* @export
|
|
@@ -1122,25 +1936,44 @@ export interface WatchStatus {
|
|
|
1122
1936
|
* @type {boolean}
|
|
1123
1937
|
* @memberof WatchStatus
|
|
1124
1938
|
*/
|
|
1125
|
-
'enabled'
|
|
1939
|
+
'enabled': boolean;
|
|
1126
1940
|
/**
|
|
1127
1941
|
* Name of the project being watched for file changes
|
|
1128
1942
|
* @type {string}
|
|
1129
1943
|
* @memberof WatchStatus
|
|
1130
1944
|
*/
|
|
1131
|
-
'projectName'
|
|
1945
|
+
'projectName': string;
|
|
1132
1946
|
/**
|
|
1133
1947
|
* The file system path being monitored for changes, null if not watching
|
|
1134
1948
|
* @type {string}
|
|
1135
1949
|
* @memberof WatchStatus
|
|
1136
1950
|
*/
|
|
1137
|
-
'watchingPath'
|
|
1951
|
+
'watchingPath': string;
|
|
1138
1952
|
}
|
|
1139
1953
|
/**
|
|
1140
1954
|
* ConnectionsApi - axios parameter creator
|
|
1141
1955
|
* @export
|
|
1142
1956
|
*/
|
|
1143
1957
|
export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1958
|
+
/**
|
|
1959
|
+
* Creates a new database connection in the specified project.
|
|
1960
|
+
* @summary Create a new database connection
|
|
1961
|
+
* @param {string} projectName Name of the project
|
|
1962
|
+
* @param {string} connectionName Name of the connection
|
|
1963
|
+
* @param {Connection} connection
|
|
1964
|
+
* @param {*} [options] Override http request option.
|
|
1965
|
+
* @throws {RequiredError}
|
|
1966
|
+
*/
|
|
1967
|
+
createConnection: (projectName: string, connectionName: string, connection: Connection, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1968
|
+
/**
|
|
1969
|
+
* Permanently deletes a database connection from the project.
|
|
1970
|
+
* @summary Delete a database connection
|
|
1971
|
+
* @param {string} projectName Name of the project
|
|
1972
|
+
* @param {string} connectionName Name of the connection to delete
|
|
1973
|
+
* @param {*} [options] Override http request option.
|
|
1974
|
+
* @throws {RequiredError}
|
|
1975
|
+
*/
|
|
1976
|
+
deleteConnection: (projectName: string, connectionName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1144
1977
|
/**
|
|
1145
1978
|
* Retrieves detailed information about a specific database connection within a project. This includes connection configuration, credentials (if accessible), and metadata. Useful for inspecting connection settings and troubleshooting connectivity issues.
|
|
1146
1979
|
* @summary Get connection details
|
|
@@ -1185,17 +2018,152 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
1185
2018
|
*/
|
|
1186
2019
|
getTable: (projectName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1187
2020
|
/**
|
|
1188
|
-
*
|
|
1189
|
-
* @summary
|
|
2021
|
+
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a temporary table from a SQL statement using the specified connection. Temporary tables are useful for storing intermediate results during complex queries.
|
|
2022
|
+
* @summary Create temporary table (deprecated)
|
|
1190
2023
|
* @param {string} projectName Name of the project
|
|
1191
2024
|
* @param {string} connectionName Name of the connection
|
|
1192
|
-
* @param {string} [
|
|
1193
|
-
* @param {string} [tablePath] Table path
|
|
2025
|
+
* @param {string} [sqlStatement] SQL statement
|
|
1194
2026
|
* @param {*} [options] Override http request option.
|
|
1195
2027
|
* @deprecated
|
|
1196
2028
|
* @throws {RequiredError}
|
|
1197
2029
|
*/
|
|
1198
|
-
|
|
2030
|
+
getTemporarytable: (projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2031
|
+
/**
|
|
2032
|
+
* Retrieves a list of all database connections configured for the specified project. Each connection includes its configuration, type, and status information. This endpoint is useful for discovering available data sources within a project.
|
|
2033
|
+
* @summary List project database connections
|
|
2034
|
+
* @param {string} projectName Name of the project
|
|
2035
|
+
* @param {*} [options] Override http request option.
|
|
2036
|
+
* @throws {RequiredError}
|
|
2037
|
+
*/
|
|
2038
|
+
listConnections: (projectName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2039
|
+
/**
|
|
2040
|
+
* Retrieves a list of all schemas (databases) available in the specified connection. Each schema includes metadata such as name, description, and whether it\'s the default schema. This endpoint is useful for exploring the database structure and discovering available data sources.
|
|
2041
|
+
* @summary List database schemas
|
|
2042
|
+
* @param {string} projectName Name of the project
|
|
2043
|
+
* @param {string} connectionName Name of the connection
|
|
2044
|
+
* @param {*} [options] Override http request option.
|
|
2045
|
+
* @throws {RequiredError}
|
|
2046
|
+
*/
|
|
2047
|
+
listSchemas: (projectName: string, connectionName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2048
|
+
/**
|
|
2049
|
+
* Retrieves a list of all tables and views available in the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed.
|
|
2050
|
+
* @summary List tables in database
|
|
2051
|
+
* @param {string} projectName Name of the project
|
|
2052
|
+
* @param {string} connectionName Name of the connection
|
|
2053
|
+
* @param {string} schemaName Name of the schema
|
|
2054
|
+
* @param {Array<string>} [tableNames] List of table names to filter results. When provided, only returns metadata for the specified tables. When omitted, returns all tables in the schema.
|
|
2055
|
+
* @param {*} [options] Override http request option.
|
|
2056
|
+
* @throws {RequiredError}
|
|
2057
|
+
*/
|
|
2058
|
+
listTables: (projectName: string, connectionName: string, schemaName: string, tableNames?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2059
|
+
/**
|
|
2060
|
+
* Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
|
|
2061
|
+
* @summary Execute SQL query
|
|
2062
|
+
* @param {string} projectName Name of the project
|
|
2063
|
+
* @param {string} connectionName Name of the connection
|
|
2064
|
+
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2065
|
+
* @param {*} [options] Override http request option.
|
|
2066
|
+
* @throws {RequiredError}
|
|
2067
|
+
*/
|
|
2068
|
+
postQuerydata: (projectName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2069
|
+
/**
|
|
2070
|
+
* Creates a Malloy source from a SQL statement using the specified database connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
|
|
2071
|
+
* @summary Create SQL source from statement
|
|
2072
|
+
* @param {string} projectName Name of the project
|
|
2073
|
+
* @param {string} connectionName Name of the connection
|
|
2074
|
+
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
|
|
2075
|
+
* @param {*} [options] Override http request option.
|
|
2076
|
+
* @throws {RequiredError}
|
|
2077
|
+
*/
|
|
2078
|
+
postSqlsource: (projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2079
|
+
/**
|
|
2080
|
+
* Creates a temporary table from a SQL statement using the specified database connection. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
|
|
2081
|
+
* @summary Create temporary table
|
|
2082
|
+
* @param {string} projectName Name of the project
|
|
2083
|
+
* @param {string} connectionName Name of the connection
|
|
2084
|
+
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
|
|
2085
|
+
* @param {*} [options] Override http request option.
|
|
2086
|
+
* @throws {RequiredError}
|
|
2087
|
+
*/
|
|
2088
|
+
postTemporarytable: (projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2089
|
+
/**
|
|
2090
|
+
* Updates the configuration of an existing database connection.
|
|
2091
|
+
* @summary Update an existing database connection
|
|
2092
|
+
* @param {string} projectName Name of the project
|
|
2093
|
+
* @param {string} connectionName Name of the connection to update
|
|
2094
|
+
* @param {UpdateConnectionRequest} updateConnectionRequest
|
|
2095
|
+
* @param {*} [options] Override http request option.
|
|
2096
|
+
* @throws {RequiredError}
|
|
2097
|
+
*/
|
|
2098
|
+
updateConnection: (projectName: string, connectionName: string, updateConnectionRequest: UpdateConnectionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2099
|
+
};
|
|
2100
|
+
/**
|
|
2101
|
+
* ConnectionsApi - functional programming interface
|
|
2102
|
+
* @export
|
|
2103
|
+
*/
|
|
2104
|
+
export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
2105
|
+
/**
|
|
2106
|
+
* Creates a new database connection in the specified project.
|
|
2107
|
+
* @summary Create a new database connection
|
|
2108
|
+
* @param {string} projectName Name of the project
|
|
2109
|
+
* @param {string} connectionName Name of the connection
|
|
2110
|
+
* @param {Connection} connection
|
|
2111
|
+
* @param {*} [options] Override http request option.
|
|
2112
|
+
* @throws {RequiredError}
|
|
2113
|
+
*/
|
|
2114
|
+
createConnection(projectName: string, connectionName: string, connection: Connection, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateConnection201Response>>;
|
|
2115
|
+
/**
|
|
2116
|
+
* Permanently deletes a database connection from the project.
|
|
2117
|
+
* @summary Delete a database connection
|
|
2118
|
+
* @param {string} projectName Name of the project
|
|
2119
|
+
* @param {string} connectionName Name of the connection to delete
|
|
2120
|
+
* @param {*} [options] Override http request option.
|
|
2121
|
+
* @throws {RequiredError}
|
|
2122
|
+
*/
|
|
2123
|
+
deleteConnection(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateConnection201Response>>;
|
|
2124
|
+
/**
|
|
2125
|
+
* Retrieves detailed information about a specific database connection within a project. This includes connection configuration, credentials (if accessible), and metadata. Useful for inspecting connection settings and troubleshooting connectivity issues.
|
|
2126
|
+
* @summary Get connection details
|
|
2127
|
+
* @param {string} projectName Name of the project
|
|
2128
|
+
* @param {string} connectionName Name of the connection
|
|
2129
|
+
* @param {*} [options] Override http request option.
|
|
2130
|
+
* @throws {RequiredError}
|
|
2131
|
+
*/
|
|
2132
|
+
getConnection(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Connection>>;
|
|
2133
|
+
/**
|
|
2134
|
+
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Executes a SQL statement against the specified database connection and returns the results. The query results include data, metadata, and execution information.
|
|
2135
|
+
* @summary Execute SQL query (deprecated)
|
|
2136
|
+
* @param {string} projectName Name of the project
|
|
2137
|
+
* @param {string} connectionName Name of the connection
|
|
2138
|
+
* @param {string} [sqlStatement] SQL statement
|
|
2139
|
+
* @param {string} [_options] Options
|
|
2140
|
+
* @param {*} [options] Override http request option.
|
|
2141
|
+
* @deprecated
|
|
2142
|
+
* @throws {RequiredError}
|
|
2143
|
+
*/
|
|
2144
|
+
getQuerydata(projectName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryData>>;
|
|
2145
|
+
/**
|
|
2146
|
+
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a Malloy source from a SQL statement using the specified connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
|
|
2147
|
+
* @summary Get SQL source (deprecated)
|
|
2148
|
+
* @param {string} projectName Name of the project
|
|
2149
|
+
* @param {string} connectionName Name of the connection
|
|
2150
|
+
* @param {string} [sqlStatement] SQL statement
|
|
2151
|
+
* @param {*} [options] Override http request option.
|
|
2152
|
+
* @deprecated
|
|
2153
|
+
* @throws {RequiredError}
|
|
2154
|
+
*/
|
|
2155
|
+
getSqlsource(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SqlSource>>;
|
|
2156
|
+
/**
|
|
2157
|
+
* Retrieves a table from the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed. The tablePath is the full path to the table, including the schema name.
|
|
2158
|
+
* @summary Get table details from database
|
|
2159
|
+
* @param {string} projectName Name of the project
|
|
2160
|
+
* @param {string} connectionName Name of the connection
|
|
2161
|
+
* @param {string} schemaName Name of the schema
|
|
2162
|
+
* @param {string} tablePath Full path to the table
|
|
2163
|
+
* @param {*} [options] Override http request option.
|
|
2164
|
+
* @throws {RequiredError}
|
|
2165
|
+
*/
|
|
2166
|
+
getTable(projectName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Table>>;
|
|
1199
2167
|
/**
|
|
1200
2168
|
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a temporary table from a SQL statement using the specified connection. Temporary tables are useful for storing intermediate results during complex queries.
|
|
1201
2169
|
* @summary Create temporary table (deprecated)
|
|
@@ -1206,7 +2174,7 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
1206
2174
|
* @deprecated
|
|
1207
2175
|
* @throws {RequiredError}
|
|
1208
2176
|
*/
|
|
1209
|
-
getTemporarytable
|
|
2177
|
+
getTemporarytable(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemporaryTable>>;
|
|
1210
2178
|
/**
|
|
1211
2179
|
* Retrieves a list of all database connections configured for the specified project. Each connection includes its configuration, type, and status information. This endpoint is useful for discovering available data sources within a project.
|
|
1212
2180
|
* @summary List project database connections
|
|
@@ -1214,7 +2182,7 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
1214
2182
|
* @param {*} [options] Override http request option.
|
|
1215
2183
|
* @throws {RequiredError}
|
|
1216
2184
|
*/
|
|
1217
|
-
listConnections
|
|
2185
|
+
listConnections(projectName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Connection>>>;
|
|
1218
2186
|
/**
|
|
1219
2187
|
* Retrieves a list of all schemas (databases) available in the specified connection. Each schema includes metadata such as name, description, and whether it\'s the default schema. This endpoint is useful for exploring the database structure and discovering available data sources.
|
|
1220
2188
|
* @summary List database schemas
|
|
@@ -1223,28 +2191,175 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
1223
2191
|
* @param {*} [options] Override http request option.
|
|
1224
2192
|
* @throws {RequiredError}
|
|
1225
2193
|
*/
|
|
1226
|
-
listSchemas
|
|
2194
|
+
listSchemas(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Schema>>>;
|
|
2195
|
+
/**
|
|
2196
|
+
* Retrieves a list of all tables and views available in the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed.
|
|
2197
|
+
* @summary List tables in database
|
|
2198
|
+
* @param {string} projectName Name of the project
|
|
2199
|
+
* @param {string} connectionName Name of the connection
|
|
2200
|
+
* @param {string} schemaName Name of the schema
|
|
2201
|
+
* @param {Array<string>} [tableNames] List of table names to filter results. When provided, only returns metadata for the specified tables. When omitted, returns all tables in the schema.
|
|
2202
|
+
* @param {*} [options] Override http request option.
|
|
2203
|
+
* @throws {RequiredError}
|
|
2204
|
+
*/
|
|
2205
|
+
listTables(projectName: string, connectionName: string, schemaName: string, tableNames?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Table>>>;
|
|
2206
|
+
/**
|
|
2207
|
+
* Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
|
|
2208
|
+
* @summary Execute SQL query
|
|
2209
|
+
* @param {string} projectName Name of the project
|
|
2210
|
+
* @param {string} connectionName Name of the connection
|
|
2211
|
+
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2212
|
+
* @param {*} [options] Override http request option.
|
|
2213
|
+
* @throws {RequiredError}
|
|
2214
|
+
*/
|
|
2215
|
+
postQuerydata(projectName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryData>>;
|
|
2216
|
+
/**
|
|
2217
|
+
* Creates a Malloy source from a SQL statement using the specified database connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
|
|
2218
|
+
* @summary Create SQL source from statement
|
|
2219
|
+
* @param {string} projectName Name of the project
|
|
2220
|
+
* @param {string} connectionName Name of the connection
|
|
2221
|
+
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
|
|
2222
|
+
* @param {*} [options] Override http request option.
|
|
2223
|
+
* @throws {RequiredError}
|
|
2224
|
+
*/
|
|
2225
|
+
postSqlsource(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SqlSource>>;
|
|
2226
|
+
/**
|
|
2227
|
+
* Creates a temporary table from a SQL statement using the specified database connection. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
|
|
2228
|
+
* @summary Create temporary table
|
|
2229
|
+
* @param {string} projectName Name of the project
|
|
2230
|
+
* @param {string} connectionName Name of the connection
|
|
2231
|
+
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
|
|
2232
|
+
* @param {*} [options] Override http request option.
|
|
2233
|
+
* @throws {RequiredError}
|
|
2234
|
+
*/
|
|
2235
|
+
postTemporarytable(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemporaryTable>>;
|
|
2236
|
+
/**
|
|
2237
|
+
* Updates the configuration of an existing database connection.
|
|
2238
|
+
* @summary Update an existing database connection
|
|
2239
|
+
* @param {string} projectName Name of the project
|
|
2240
|
+
* @param {string} connectionName Name of the connection to update
|
|
2241
|
+
* @param {UpdateConnectionRequest} updateConnectionRequest
|
|
2242
|
+
* @param {*} [options] Override http request option.
|
|
2243
|
+
* @throws {RequiredError}
|
|
2244
|
+
*/
|
|
2245
|
+
updateConnection(projectName: string, connectionName: string, updateConnectionRequest: UpdateConnectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateConnection201Response>>;
|
|
2246
|
+
};
|
|
2247
|
+
/**
|
|
2248
|
+
* ConnectionsApi - factory interface
|
|
2249
|
+
* @export
|
|
2250
|
+
*/
|
|
2251
|
+
export declare const ConnectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2252
|
+
/**
|
|
2253
|
+
* Creates a new database connection in the specified project.
|
|
2254
|
+
* @summary Create a new database connection
|
|
2255
|
+
* @param {string} projectName Name of the project
|
|
2256
|
+
* @param {string} connectionName Name of the connection
|
|
2257
|
+
* @param {Connection} connection
|
|
2258
|
+
* @param {*} [options] Override http request option.
|
|
2259
|
+
* @throws {RequiredError}
|
|
2260
|
+
*/
|
|
2261
|
+
createConnection(projectName: string, connectionName: string, connection: Connection, options?: RawAxiosRequestConfig): AxiosPromise<CreateConnection201Response>;
|
|
2262
|
+
/**
|
|
2263
|
+
* Permanently deletes a database connection from the project.
|
|
2264
|
+
* @summary Delete a database connection
|
|
2265
|
+
* @param {string} projectName Name of the project
|
|
2266
|
+
* @param {string} connectionName Name of the connection to delete
|
|
2267
|
+
* @param {*} [options] Override http request option.
|
|
2268
|
+
* @throws {RequiredError}
|
|
2269
|
+
*/
|
|
2270
|
+
deleteConnection(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateConnection201Response>;
|
|
2271
|
+
/**
|
|
2272
|
+
* Retrieves detailed information about a specific database connection within a project. This includes connection configuration, credentials (if accessible), and metadata. Useful for inspecting connection settings and troubleshooting connectivity issues.
|
|
2273
|
+
* @summary Get connection details
|
|
2274
|
+
* @param {string} projectName Name of the project
|
|
2275
|
+
* @param {string} connectionName Name of the connection
|
|
2276
|
+
* @param {*} [options] Override http request option.
|
|
2277
|
+
* @throws {RequiredError}
|
|
2278
|
+
*/
|
|
2279
|
+
getConnection(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): AxiosPromise<Connection>;
|
|
2280
|
+
/**
|
|
2281
|
+
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Executes a SQL statement against the specified database connection and returns the results. The query results include data, metadata, and execution information.
|
|
2282
|
+
* @summary Execute SQL query (deprecated)
|
|
2283
|
+
* @param {string} projectName Name of the project
|
|
2284
|
+
* @param {string} connectionName Name of the connection
|
|
2285
|
+
* @param {string} [sqlStatement] SQL statement
|
|
2286
|
+
* @param {string} [_options] Options
|
|
2287
|
+
* @param {*} [options] Override http request option.
|
|
2288
|
+
* @deprecated
|
|
2289
|
+
* @throws {RequiredError}
|
|
2290
|
+
*/
|
|
2291
|
+
getQuerydata(projectName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig): AxiosPromise<QueryData>;
|
|
2292
|
+
/**
|
|
2293
|
+
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a Malloy source from a SQL statement using the specified connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
|
|
2294
|
+
* @summary Get SQL source (deprecated)
|
|
2295
|
+
* @param {string} projectName Name of the project
|
|
2296
|
+
* @param {string} connectionName Name of the connection
|
|
2297
|
+
* @param {string} [sqlStatement] SQL statement
|
|
2298
|
+
* @param {*} [options] Override http request option.
|
|
2299
|
+
* @deprecated
|
|
2300
|
+
* @throws {RequiredError}
|
|
2301
|
+
*/
|
|
2302
|
+
getSqlsource(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<SqlSource>;
|
|
2303
|
+
/**
|
|
2304
|
+
* Retrieves a table from the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed. The tablePath is the full path to the table, including the schema name.
|
|
2305
|
+
* @summary Get table details from database
|
|
2306
|
+
* @param {string} projectName Name of the project
|
|
2307
|
+
* @param {string} connectionName Name of the connection
|
|
2308
|
+
* @param {string} schemaName Name of the schema
|
|
2309
|
+
* @param {string} tablePath Full path to the table
|
|
2310
|
+
* @param {*} [options] Override http request option.
|
|
2311
|
+
* @throws {RequiredError}
|
|
2312
|
+
*/
|
|
2313
|
+
getTable(projectName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): AxiosPromise<Table>;
|
|
2314
|
+
/**
|
|
2315
|
+
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a temporary table from a SQL statement using the specified connection. Temporary tables are useful for storing intermediate results during complex queries.
|
|
2316
|
+
* @summary Create temporary table (deprecated)
|
|
2317
|
+
* @param {string} projectName Name of the project
|
|
2318
|
+
* @param {string} connectionName Name of the connection
|
|
2319
|
+
* @param {string} [sqlStatement] SQL statement
|
|
2320
|
+
* @param {*} [options] Override http request option.
|
|
2321
|
+
* @deprecated
|
|
2322
|
+
* @throws {RequiredError}
|
|
2323
|
+
*/
|
|
2324
|
+
getTemporarytable(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<TemporaryTable>;
|
|
2325
|
+
/**
|
|
2326
|
+
* Retrieves a list of all database connections configured for the specified project. Each connection includes its configuration, type, and status information. This endpoint is useful for discovering available data sources within a project.
|
|
2327
|
+
* @summary List project database connections
|
|
2328
|
+
* @param {string} projectName Name of the project
|
|
2329
|
+
* @param {*} [options] Override http request option.
|
|
2330
|
+
* @throws {RequiredError}
|
|
2331
|
+
*/
|
|
2332
|
+
listConnections(projectName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Connection>>;
|
|
2333
|
+
/**
|
|
2334
|
+
* Retrieves a list of all schemas (databases) available in the specified connection. Each schema includes metadata such as name, description, and whether it\'s the default schema. This endpoint is useful for exploring the database structure and discovering available data sources.
|
|
2335
|
+
* @summary List database schemas
|
|
2336
|
+
* @param {string} projectName Name of the project
|
|
2337
|
+
* @param {string} connectionName Name of the connection
|
|
2338
|
+
* @param {*} [options] Override http request option.
|
|
2339
|
+
* @throws {RequiredError}
|
|
2340
|
+
*/
|
|
2341
|
+
listSchemas(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Schema>>;
|
|
1227
2342
|
/**
|
|
1228
2343
|
* Retrieves a list of all tables and views available in the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed.
|
|
1229
2344
|
* @summary List tables in database
|
|
1230
2345
|
* @param {string} projectName Name of the project
|
|
1231
2346
|
* @param {string} connectionName Name of the connection
|
|
1232
2347
|
* @param {string} schemaName Name of the schema
|
|
2348
|
+
* @param {Array<string>} [tableNames] List of table names to filter results. When provided, only returns metadata for the specified tables. When omitted, returns all tables in the schema.
|
|
1233
2349
|
* @param {*} [options] Override http request option.
|
|
1234
2350
|
* @throws {RequiredError}
|
|
1235
2351
|
*/
|
|
1236
|
-
listTables
|
|
2352
|
+
listTables(projectName: string, connectionName: string, schemaName: string, tableNames?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<Table>>;
|
|
1237
2353
|
/**
|
|
1238
2354
|
* Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
|
|
1239
2355
|
* @summary Execute SQL query
|
|
1240
2356
|
* @param {string} projectName Name of the project
|
|
1241
2357
|
* @param {string} connectionName Name of the connection
|
|
1242
|
-
* @param {
|
|
1243
|
-
* @param {string} [_options] Options
|
|
2358
|
+
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
1244
2359
|
* @param {*} [options] Override http request option.
|
|
1245
2360
|
* @throws {RequiredError}
|
|
1246
2361
|
*/
|
|
1247
|
-
postQuerydata
|
|
2362
|
+
postQuerydata(projectName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): AxiosPromise<QueryData>;
|
|
1248
2363
|
/**
|
|
1249
2364
|
* Creates a Malloy source from a SQL statement using the specified database connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
|
|
1250
2365
|
* @summary Create SQL source from statement
|
|
@@ -1254,7 +2369,7 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
1254
2369
|
* @param {*} [options] Override http request option.
|
|
1255
2370
|
* @throws {RequiredError}
|
|
1256
2371
|
*/
|
|
1257
|
-
postSqlsource
|
|
2372
|
+
postSqlsource(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<SqlSource>;
|
|
1258
2373
|
/**
|
|
1259
2374
|
* Creates a temporary table from a SQL statement using the specified database connection. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
|
|
1260
2375
|
* @summary Create temporary table
|
|
@@ -1264,13 +2379,46 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
1264
2379
|
* @param {*} [options] Override http request option.
|
|
1265
2380
|
* @throws {RequiredError}
|
|
1266
2381
|
*/
|
|
1267
|
-
postTemporarytable
|
|
2382
|
+
postTemporarytable(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<TemporaryTable>;
|
|
2383
|
+
/**
|
|
2384
|
+
* Updates the configuration of an existing database connection.
|
|
2385
|
+
* @summary Update an existing database connection
|
|
2386
|
+
* @param {string} projectName Name of the project
|
|
2387
|
+
* @param {string} connectionName Name of the connection to update
|
|
2388
|
+
* @param {UpdateConnectionRequest} updateConnectionRequest
|
|
2389
|
+
* @param {*} [options] Override http request option.
|
|
2390
|
+
* @throws {RequiredError}
|
|
2391
|
+
*/
|
|
2392
|
+
updateConnection(projectName: string, connectionName: string, updateConnectionRequest: UpdateConnectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateConnection201Response>;
|
|
1268
2393
|
};
|
|
1269
2394
|
/**
|
|
1270
|
-
* ConnectionsApi -
|
|
2395
|
+
* ConnectionsApi - object-oriented interface
|
|
1271
2396
|
* @export
|
|
2397
|
+
* @class ConnectionsApi
|
|
2398
|
+
* @extends {BaseAPI}
|
|
1272
2399
|
*/
|
|
1273
|
-
export declare
|
|
2400
|
+
export declare class ConnectionsApi extends BaseAPI {
|
|
2401
|
+
/**
|
|
2402
|
+
* Creates a new database connection in the specified project.
|
|
2403
|
+
* @summary Create a new database connection
|
|
2404
|
+
* @param {string} projectName Name of the project
|
|
2405
|
+
* @param {string} connectionName Name of the connection
|
|
2406
|
+
* @param {Connection} connection
|
|
2407
|
+
* @param {*} [options] Override http request option.
|
|
2408
|
+
* @throws {RequiredError}
|
|
2409
|
+
* @memberof ConnectionsApi
|
|
2410
|
+
*/
|
|
2411
|
+
createConnection(projectName: string, connectionName: string, connection: Connection, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateConnection201Response, any, {}>>;
|
|
2412
|
+
/**
|
|
2413
|
+
* Permanently deletes a database connection from the project.
|
|
2414
|
+
* @summary Delete a database connection
|
|
2415
|
+
* @param {string} projectName Name of the project
|
|
2416
|
+
* @param {string} connectionName Name of the connection to delete
|
|
2417
|
+
* @param {*} [options] Override http request option.
|
|
2418
|
+
* @throws {RequiredError}
|
|
2419
|
+
* @memberof ConnectionsApi
|
|
2420
|
+
*/
|
|
2421
|
+
deleteConnection(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateConnection201Response, any, {}>>;
|
|
1274
2422
|
/**
|
|
1275
2423
|
* Retrieves detailed information about a specific database connection within a project. This includes connection configuration, credentials (if accessible), and metadata. Useful for inspecting connection settings and troubleshooting connectivity issues.
|
|
1276
2424
|
* @summary Get connection details
|
|
@@ -1278,8 +2426,9 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
1278
2426
|
* @param {string} connectionName Name of the connection
|
|
1279
2427
|
* @param {*} [options] Override http request option.
|
|
1280
2428
|
* @throws {RequiredError}
|
|
2429
|
+
* @memberof ConnectionsApi
|
|
1281
2430
|
*/
|
|
1282
|
-
getConnection(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios
|
|
2431
|
+
getConnection(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Connection, any, {}>>;
|
|
1283
2432
|
/**
|
|
1284
2433
|
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Executes a SQL statement against the specified database connection and returns the results. The query results include data, metadata, and execution information.
|
|
1285
2434
|
* @summary Execute SQL query (deprecated)
|
|
@@ -1290,8 +2439,9 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
1290
2439
|
* @param {*} [options] Override http request option.
|
|
1291
2440
|
* @deprecated
|
|
1292
2441
|
* @throws {RequiredError}
|
|
2442
|
+
* @memberof ConnectionsApi
|
|
1293
2443
|
*/
|
|
1294
|
-
getQuerydata(projectName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig): Promise<(axios
|
|
2444
|
+
getQuerydata(projectName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QueryData, any, {}>>;
|
|
1295
2445
|
/**
|
|
1296
2446
|
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a Malloy source from a SQL statement using the specified connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
|
|
1297
2447
|
* @summary Get SQL source (deprecated)
|
|
@@ -1301,8 +2451,9 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
1301
2451
|
* @param {*} [options] Override http request option.
|
|
1302
2452
|
* @deprecated
|
|
1303
2453
|
* @throws {RequiredError}
|
|
2454
|
+
* @memberof ConnectionsApi
|
|
1304
2455
|
*/
|
|
1305
|
-
getSqlsource(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios
|
|
2456
|
+
getSqlsource(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SqlSource, any, {}>>;
|
|
1306
2457
|
/**
|
|
1307
2458
|
* Retrieves a table from the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed. The tablePath is the full path to the table, including the schema name.
|
|
1308
2459
|
* @summary Get table details from database
|
|
@@ -1312,20 +2463,9 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
1312
2463
|
* @param {string} tablePath Full path to the table
|
|
1313
2464
|
* @param {*} [options] Override http request option.
|
|
1314
2465
|
* @throws {RequiredError}
|
|
2466
|
+
* @memberof ConnectionsApi
|
|
1315
2467
|
*/
|
|
1316
|
-
getTable(projectName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): Promise<(axios
|
|
1317
|
-
/**
|
|
1318
|
-
* Retrieves information about a specific table or view from the database connection. This includes table schema, column definitions, and metadata. The table can be specified by either tableKey or tablePath parameters, depending on the database type.
|
|
1319
|
-
* @summary Get table source information
|
|
1320
|
-
* @param {string} projectName Name of the project
|
|
1321
|
-
* @param {string} connectionName Name of the connection
|
|
1322
|
-
* @param {string} [tableKey] Table key
|
|
1323
|
-
* @param {string} [tablePath] Table path
|
|
1324
|
-
* @param {*} [options] Override http request option.
|
|
1325
|
-
* @deprecated
|
|
1326
|
-
* @throws {RequiredError}
|
|
1327
|
-
*/
|
|
1328
|
-
getTablesource(projectName: string, connectionName: string, tableKey?: string, tablePath?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TableSource>>;
|
|
2468
|
+
getTable(projectName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Table, any, {}>>;
|
|
1329
2469
|
/**
|
|
1330
2470
|
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a temporary table from a SQL statement using the specified connection. Temporary tables are useful for storing intermediate results during complex queries.
|
|
1331
2471
|
* @summary Create temporary table (deprecated)
|
|
@@ -1335,16 +2475,18 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
1335
2475
|
* @param {*} [options] Override http request option.
|
|
1336
2476
|
* @deprecated
|
|
1337
2477
|
* @throws {RequiredError}
|
|
2478
|
+
* @memberof ConnectionsApi
|
|
1338
2479
|
*/
|
|
1339
|
-
getTemporarytable(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios
|
|
2480
|
+
getTemporarytable(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TemporaryTable, any, {}>>;
|
|
1340
2481
|
/**
|
|
1341
2482
|
* Retrieves a list of all database connections configured for the specified project. Each connection includes its configuration, type, and status information. This endpoint is useful for discovering available data sources within a project.
|
|
1342
2483
|
* @summary List project database connections
|
|
1343
2484
|
* @param {string} projectName Name of the project
|
|
1344
2485
|
* @param {*} [options] Override http request option.
|
|
1345
2486
|
* @throws {RequiredError}
|
|
2487
|
+
* @memberof ConnectionsApi
|
|
1346
2488
|
*/
|
|
1347
|
-
listConnections(projectName: string, options?: RawAxiosRequestConfig): Promise<(axios
|
|
2489
|
+
listConnections(projectName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Connection[], any, {}>>;
|
|
1348
2490
|
/**
|
|
1349
2491
|
* Retrieves a list of all schemas (databases) available in the specified connection. Each schema includes metadata such as name, description, and whether it\'s the default schema. This endpoint is useful for exploring the database structure and discovering available data sources.
|
|
1350
2492
|
* @summary List database schemas
|
|
@@ -1352,29 +2494,32 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
1352
2494
|
* @param {string} connectionName Name of the connection
|
|
1353
2495
|
* @param {*} [options] Override http request option.
|
|
1354
2496
|
* @throws {RequiredError}
|
|
2497
|
+
* @memberof ConnectionsApi
|
|
1355
2498
|
*/
|
|
1356
|
-
listSchemas(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios
|
|
2499
|
+
listSchemas(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Schema[], any, {}>>;
|
|
1357
2500
|
/**
|
|
1358
2501
|
* Retrieves a list of all tables and views available in the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed.
|
|
1359
2502
|
* @summary List tables in database
|
|
1360
2503
|
* @param {string} projectName Name of the project
|
|
1361
2504
|
* @param {string} connectionName Name of the connection
|
|
1362
2505
|
* @param {string} schemaName Name of the schema
|
|
2506
|
+
* @param {Array<string>} [tableNames] List of table names to filter results. When provided, only returns metadata for the specified tables. When omitted, returns all tables in the schema.
|
|
1363
2507
|
* @param {*} [options] Override http request option.
|
|
1364
2508
|
* @throws {RequiredError}
|
|
2509
|
+
* @memberof ConnectionsApi
|
|
1365
2510
|
*/
|
|
1366
|
-
listTables(projectName: string, connectionName: string, schemaName: string, options?: RawAxiosRequestConfig): Promise<(axios
|
|
2511
|
+
listTables(projectName: string, connectionName: string, schemaName: string, tableNames?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Table[], any, {}>>;
|
|
1367
2512
|
/**
|
|
1368
2513
|
* Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
|
|
1369
2514
|
* @summary Execute SQL query
|
|
1370
2515
|
* @param {string} projectName Name of the project
|
|
1371
2516
|
* @param {string} connectionName Name of the connection
|
|
1372
|
-
* @param {
|
|
1373
|
-
* @param {string} [_options] Options
|
|
2517
|
+
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
1374
2518
|
* @param {*} [options] Override http request option.
|
|
1375
2519
|
* @throws {RequiredError}
|
|
2520
|
+
* @memberof ConnectionsApi
|
|
1376
2521
|
*/
|
|
1377
|
-
postQuerydata(projectName: string, connectionName: string,
|
|
2522
|
+
postQuerydata(projectName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QueryData, any, {}>>;
|
|
1378
2523
|
/**
|
|
1379
2524
|
* Creates a Malloy source from a SQL statement using the specified database connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
|
|
1380
2525
|
* @summary Create SQL source from statement
|
|
@@ -1383,8 +2528,9 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
1383
2528
|
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
|
|
1384
2529
|
* @param {*} [options] Override http request option.
|
|
1385
2530
|
* @throws {RequiredError}
|
|
2531
|
+
* @memberof ConnectionsApi
|
|
1386
2532
|
*/
|
|
1387
|
-
postSqlsource(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise<(axios
|
|
2533
|
+
postSqlsource(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SqlSource, any, {}>>;
|
|
1388
2534
|
/**
|
|
1389
2535
|
* Creates a temporary table from a SQL statement using the specified database connection. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
|
|
1390
2536
|
* @summary Create temporary table
|
|
@@ -1393,414 +2539,521 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
1393
2539
|
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
|
|
1394
2540
|
* @param {*} [options] Override http request option.
|
|
1395
2541
|
* @throws {RequiredError}
|
|
2542
|
+
* @memberof ConnectionsApi
|
|
1396
2543
|
*/
|
|
1397
|
-
postTemporarytable(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise<(axios
|
|
2544
|
+
postTemporarytable(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TemporaryTable, any, {}>>;
|
|
2545
|
+
/**
|
|
2546
|
+
* Updates the configuration of an existing database connection.
|
|
2547
|
+
* @summary Update an existing database connection
|
|
2548
|
+
* @param {string} projectName Name of the project
|
|
2549
|
+
* @param {string} connectionName Name of the connection to update
|
|
2550
|
+
* @param {UpdateConnectionRequest} updateConnectionRequest
|
|
2551
|
+
* @param {*} [options] Override http request option.
|
|
2552
|
+
* @throws {RequiredError}
|
|
2553
|
+
* @memberof ConnectionsApi
|
|
2554
|
+
*/
|
|
2555
|
+
updateConnection(projectName: string, connectionName: string, updateConnectionRequest: UpdateConnectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateConnection201Response, any, {}>>;
|
|
2556
|
+
}
|
|
2557
|
+
/**
|
|
2558
|
+
* ConnectionsTestApi - axios parameter creator
|
|
2559
|
+
* @export
|
|
2560
|
+
*/
|
|
2561
|
+
export declare const ConnectionsTestApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2562
|
+
/**
|
|
2563
|
+
* Validates a database connection configuration without adding it to any project. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to a project. Useful for troubleshooting connection issues and validating configurations during setup.
|
|
2564
|
+
* @summary Test database connection configuration
|
|
2565
|
+
* @param {Connection} connection
|
|
2566
|
+
* @param {*} [options] Override http request option.
|
|
2567
|
+
* @throws {RequiredError}
|
|
2568
|
+
*/
|
|
2569
|
+
testConnectionConfiguration: (connection: Connection, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1398
2570
|
};
|
|
1399
2571
|
/**
|
|
1400
|
-
*
|
|
2572
|
+
* ConnectionsTestApi - functional programming interface
|
|
1401
2573
|
* @export
|
|
1402
2574
|
*/
|
|
1403
|
-
export declare const
|
|
2575
|
+
export declare const ConnectionsTestApiFp: (configuration?: Configuration) => {
|
|
1404
2576
|
/**
|
|
1405
|
-
*
|
|
1406
|
-
* @summary
|
|
1407
|
-
* @param {
|
|
1408
|
-
* @param {string} connectionName Name of the connection
|
|
2577
|
+
* Validates a database connection configuration without adding it to any project. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to a project. Useful for troubleshooting connection issues and validating configurations during setup.
|
|
2578
|
+
* @summary Test database connection configuration
|
|
2579
|
+
* @param {Connection} connection
|
|
1409
2580
|
* @param {*} [options] Override http request option.
|
|
1410
2581
|
* @throws {RequiredError}
|
|
1411
2582
|
*/
|
|
1412
|
-
|
|
2583
|
+
testConnectionConfiguration(connection: Connection, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectionStatus>>;
|
|
2584
|
+
};
|
|
2585
|
+
/**
|
|
2586
|
+
* ConnectionsTestApi - factory interface
|
|
2587
|
+
* @export
|
|
2588
|
+
*/
|
|
2589
|
+
export declare const ConnectionsTestApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1413
2590
|
/**
|
|
1414
|
-
*
|
|
1415
|
-
* @summary
|
|
2591
|
+
* Validates a database connection configuration without adding it to any project. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to a project. Useful for troubleshooting connection issues and validating configurations during setup.
|
|
2592
|
+
* @summary Test database connection configuration
|
|
2593
|
+
* @param {Connection} connection
|
|
2594
|
+
* @param {*} [options] Override http request option.
|
|
2595
|
+
* @throws {RequiredError}
|
|
2596
|
+
*/
|
|
2597
|
+
testConnectionConfiguration(connection: Connection, options?: RawAxiosRequestConfig): AxiosPromise<ConnectionStatus>;
|
|
2598
|
+
};
|
|
2599
|
+
/**
|
|
2600
|
+
* ConnectionsTestApi - object-oriented interface
|
|
2601
|
+
* @export
|
|
2602
|
+
* @class ConnectionsTestApi
|
|
2603
|
+
* @extends {BaseAPI}
|
|
2604
|
+
*/
|
|
2605
|
+
export declare class ConnectionsTestApi extends BaseAPI {
|
|
2606
|
+
/**
|
|
2607
|
+
* Validates a database connection configuration without adding it to any project. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to a project. Useful for troubleshooting connection issues and validating configurations during setup.
|
|
2608
|
+
* @summary Test database connection configuration
|
|
2609
|
+
* @param {Connection} connection
|
|
2610
|
+
* @param {*} [options] Override http request option.
|
|
2611
|
+
* @throws {RequiredError}
|
|
2612
|
+
* @memberof ConnectionsTestApi
|
|
2613
|
+
*/
|
|
2614
|
+
testConnectionConfiguration(connection: Connection, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConnectionStatus, any, {}>>;
|
|
2615
|
+
}
|
|
2616
|
+
/**
|
|
2617
|
+
* DatabasesApi - axios parameter creator
|
|
2618
|
+
* @export
|
|
2619
|
+
*/
|
|
2620
|
+
export declare const DatabasesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2621
|
+
/**
|
|
2622
|
+
* Retrieves a list of all embedded databases within the specified package. These are typically DuckDB databases stored as .parquet files that provide local data storage for the package. Each database entry includes metadata about the database structure and content.
|
|
2623
|
+
* @summary List embedded databases
|
|
1416
2624
|
* @param {string} projectName Name of the project
|
|
1417
|
-
* @param {string}
|
|
1418
|
-
* @param {string} [
|
|
1419
|
-
* @param {string} [_options] Options
|
|
2625
|
+
* @param {string} packageName Name of the package
|
|
2626
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1420
2627
|
* @param {*} [options] Override http request option.
|
|
1421
|
-
* @deprecated
|
|
1422
2628
|
* @throws {RequiredError}
|
|
1423
2629
|
*/
|
|
1424
|
-
|
|
2630
|
+
listDatabases: (projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2631
|
+
};
|
|
2632
|
+
/**
|
|
2633
|
+
* DatabasesApi - functional programming interface
|
|
2634
|
+
* @export
|
|
2635
|
+
*/
|
|
2636
|
+
export declare const DatabasesApiFp: (configuration?: Configuration) => {
|
|
1425
2637
|
/**
|
|
1426
|
-
*
|
|
1427
|
-
* @summary
|
|
2638
|
+
* Retrieves a list of all embedded databases within the specified package. These are typically DuckDB databases stored as .parquet files that provide local data storage for the package. Each database entry includes metadata about the database structure and content.
|
|
2639
|
+
* @summary List embedded databases
|
|
1428
2640
|
* @param {string} projectName Name of the project
|
|
1429
|
-
* @param {string}
|
|
1430
|
-
* @param {string} [
|
|
2641
|
+
* @param {string} packageName Name of the package
|
|
2642
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1431
2643
|
* @param {*} [options] Override http request option.
|
|
1432
|
-
* @deprecated
|
|
1433
2644
|
* @throws {RequiredError}
|
|
1434
2645
|
*/
|
|
1435
|
-
|
|
2646
|
+
listDatabases(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Database>>>;
|
|
2647
|
+
};
|
|
2648
|
+
/**
|
|
2649
|
+
* DatabasesApi - factory interface
|
|
2650
|
+
* @export
|
|
2651
|
+
*/
|
|
2652
|
+
export declare const DatabasesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1436
2653
|
/**
|
|
1437
|
-
* Retrieves a
|
|
1438
|
-
* @summary
|
|
2654
|
+
* Retrieves a list of all embedded databases within the specified package. These are typically DuckDB databases stored as .parquet files that provide local data storage for the package. Each database entry includes metadata about the database structure and content.
|
|
2655
|
+
* @summary List embedded databases
|
|
1439
2656
|
* @param {string} projectName Name of the project
|
|
1440
|
-
* @param {string}
|
|
1441
|
-
* @param {string}
|
|
1442
|
-
* @param {string} tablePath Full path to the table
|
|
2657
|
+
* @param {string} packageName Name of the package
|
|
2658
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1443
2659
|
* @param {*} [options] Override http request option.
|
|
1444
2660
|
* @throws {RequiredError}
|
|
1445
2661
|
*/
|
|
1446
|
-
|
|
2662
|
+
listDatabases(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Database>>;
|
|
2663
|
+
};
|
|
2664
|
+
/**
|
|
2665
|
+
* DatabasesApi - object-oriented interface
|
|
2666
|
+
* @export
|
|
2667
|
+
* @class DatabasesApi
|
|
2668
|
+
* @extends {BaseAPI}
|
|
2669
|
+
*/
|
|
2670
|
+
export declare class DatabasesApi extends BaseAPI {
|
|
1447
2671
|
/**
|
|
1448
|
-
* Retrieves
|
|
1449
|
-
* @summary
|
|
2672
|
+
* Retrieves a list of all embedded databases within the specified package. These are typically DuckDB databases stored as .parquet files that provide local data storage for the package. Each database entry includes metadata about the database structure and content.
|
|
2673
|
+
* @summary List embedded databases
|
|
1450
2674
|
* @param {string} projectName Name of the project
|
|
1451
|
-
* @param {string}
|
|
1452
|
-
* @param {string} [
|
|
1453
|
-
* @param {string} [tablePath] Table path
|
|
2675
|
+
* @param {string} packageName Name of the package
|
|
2676
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1454
2677
|
* @param {*} [options] Override http request option.
|
|
1455
|
-
* @deprecated
|
|
1456
2678
|
* @throws {RequiredError}
|
|
2679
|
+
* @memberof DatabasesApi
|
|
1457
2680
|
*/
|
|
1458
|
-
|
|
2681
|
+
listDatabases(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Database[], any, {}>>;
|
|
2682
|
+
}
|
|
2683
|
+
/**
|
|
2684
|
+
* ManifestsApi - axios parameter creator
|
|
2685
|
+
* @export
|
|
2686
|
+
*/
|
|
2687
|
+
export declare const ManifestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1459
2688
|
/**
|
|
1460
|
-
*
|
|
1461
|
-
* @summary
|
|
2689
|
+
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
2690
|
+
* @summary Get the build manifest for a package
|
|
1462
2691
|
* @param {string} projectName Name of the project
|
|
1463
|
-
* @param {string}
|
|
1464
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2692
|
+
* @param {string} packageName Name of the package
|
|
1465
2693
|
* @param {*} [options] Override http request option.
|
|
1466
|
-
* @deprecated
|
|
1467
2694
|
* @throws {RequiredError}
|
|
1468
2695
|
*/
|
|
1469
|
-
|
|
2696
|
+
getManifest: (projectName: string, packageName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1470
2697
|
/**
|
|
1471
|
-
*
|
|
1472
|
-
* @summary
|
|
2698
|
+
* Performs an action on the package manifest. The action is specified via the `action` query parameter: * `reload` - Reads the build manifest from the shared store (DuckLake in orchestrated mode, local DuckDB in standalone mode) and recompiles every model in the package so subsequent queries resolve persisted sources to their materialized tables. Intended for orchestrated workers that did not themselves run the build; the endpoint does not write anything *into* storage.
|
|
2699
|
+
* @summary Perform an action on the package manifest
|
|
1473
2700
|
* @param {string} projectName Name of the project
|
|
2701
|
+
* @param {string} packageName Name of the package
|
|
2702
|
+
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
1474
2703
|
* @param {*} [options] Override http request option.
|
|
1475
2704
|
* @throws {RequiredError}
|
|
1476
2705
|
*/
|
|
1477
|
-
|
|
2706
|
+
manifestAction: (projectName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2707
|
+
};
|
|
2708
|
+
/**
|
|
2709
|
+
* ManifestsApi - functional programming interface
|
|
2710
|
+
* @export
|
|
2711
|
+
*/
|
|
2712
|
+
export declare const ManifestsApiFp: (configuration?: Configuration) => {
|
|
1478
2713
|
/**
|
|
1479
|
-
*
|
|
1480
|
-
* @summary
|
|
2714
|
+
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
2715
|
+
* @summary Get the build manifest for a package
|
|
1481
2716
|
* @param {string} projectName Name of the project
|
|
1482
|
-
* @param {string}
|
|
2717
|
+
* @param {string} packageName Name of the package
|
|
1483
2718
|
* @param {*} [options] Override http request option.
|
|
1484
2719
|
* @throws {RequiredError}
|
|
1485
2720
|
*/
|
|
1486
|
-
|
|
2721
|
+
getManifest(projectName: string, packageName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BuildManifest>>;
|
|
1487
2722
|
/**
|
|
1488
|
-
*
|
|
1489
|
-
* @summary
|
|
2723
|
+
* Performs an action on the package manifest. The action is specified via the `action` query parameter: * `reload` - Reads the build manifest from the shared store (DuckLake in orchestrated mode, local DuckDB in standalone mode) and recompiles every model in the package so subsequent queries resolve persisted sources to their materialized tables. Intended for orchestrated workers that did not themselves run the build; the endpoint does not write anything *into* storage.
|
|
2724
|
+
* @summary Perform an action on the package manifest
|
|
1490
2725
|
* @param {string} projectName Name of the project
|
|
1491
|
-
* @param {string}
|
|
1492
|
-
* @param {
|
|
2726
|
+
* @param {string} packageName Name of the package
|
|
2727
|
+
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
1493
2728
|
* @param {*} [options] Override http request option.
|
|
1494
2729
|
* @throws {RequiredError}
|
|
1495
2730
|
*/
|
|
1496
|
-
|
|
2731
|
+
manifestAction(projectName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BuildManifest>>;
|
|
2732
|
+
};
|
|
2733
|
+
/**
|
|
2734
|
+
* ManifestsApi - factory interface
|
|
2735
|
+
* @export
|
|
2736
|
+
*/
|
|
2737
|
+
export declare const ManifestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1497
2738
|
/**
|
|
1498
|
-
*
|
|
1499
|
-
* @summary
|
|
2739
|
+
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
2740
|
+
* @summary Get the build manifest for a package
|
|
1500
2741
|
* @param {string} projectName Name of the project
|
|
1501
|
-
* @param {string}
|
|
1502
|
-
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to execute
|
|
1503
|
-
* @param {string} [_options] Options
|
|
2742
|
+
* @param {string} packageName Name of the package
|
|
1504
2743
|
* @param {*} [options] Override http request option.
|
|
1505
2744
|
* @throws {RequiredError}
|
|
1506
2745
|
*/
|
|
1507
|
-
|
|
2746
|
+
getManifest(projectName: string, packageName: string, options?: RawAxiosRequestConfig): AxiosPromise<BuildManifest>;
|
|
1508
2747
|
/**
|
|
1509
|
-
*
|
|
1510
|
-
* @summary
|
|
2748
|
+
* Performs an action on the package manifest. The action is specified via the `action` query parameter: * `reload` - Reads the build manifest from the shared store (DuckLake in orchestrated mode, local DuckDB in standalone mode) and recompiles every model in the package so subsequent queries resolve persisted sources to their materialized tables. Intended for orchestrated workers that did not themselves run the build; the endpoint does not write anything *into* storage.
|
|
2749
|
+
* @summary Perform an action on the package manifest
|
|
1511
2750
|
* @param {string} projectName Name of the project
|
|
1512
|
-
* @param {string}
|
|
1513
|
-
* @param {
|
|
2751
|
+
* @param {string} packageName Name of the package
|
|
2752
|
+
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
1514
2753
|
* @param {*} [options] Override http request option.
|
|
1515
2754
|
* @throws {RequiredError}
|
|
1516
2755
|
*/
|
|
1517
|
-
|
|
2756
|
+
manifestAction(projectName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig): AxiosPromise<BuildManifest>;
|
|
2757
|
+
};
|
|
2758
|
+
/**
|
|
2759
|
+
* ManifestsApi - object-oriented interface
|
|
2760
|
+
* @export
|
|
2761
|
+
* @class ManifestsApi
|
|
2762
|
+
* @extends {BaseAPI}
|
|
2763
|
+
*/
|
|
2764
|
+
export declare class ManifestsApi extends BaseAPI {
|
|
1518
2765
|
/**
|
|
1519
|
-
*
|
|
1520
|
-
* @summary
|
|
2766
|
+
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
2767
|
+
* @summary Get the build manifest for a package
|
|
2768
|
+
* @param {string} projectName Name of the project
|
|
2769
|
+
* @param {string} packageName Name of the package
|
|
2770
|
+
* @param {*} [options] Override http request option.
|
|
2771
|
+
* @throws {RequiredError}
|
|
2772
|
+
* @memberof ManifestsApi
|
|
2773
|
+
*/
|
|
2774
|
+
getManifest(projectName: string, packageName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BuildManifest, any, {}>>;
|
|
2775
|
+
/**
|
|
2776
|
+
* Performs an action on the package manifest. The action is specified via the `action` query parameter: * `reload` - Reads the build manifest from the shared store (DuckLake in orchestrated mode, local DuckDB in standalone mode) and recompiles every model in the package so subsequent queries resolve persisted sources to their materialized tables. Intended for orchestrated workers that did not themselves run the build; the endpoint does not write anything *into* storage.
|
|
2777
|
+
* @summary Perform an action on the package manifest
|
|
1521
2778
|
* @param {string} projectName Name of the project
|
|
1522
|
-
* @param {string}
|
|
1523
|
-
* @param {
|
|
2779
|
+
* @param {string} packageName Name of the package
|
|
2780
|
+
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
1524
2781
|
* @param {*} [options] Override http request option.
|
|
1525
2782
|
* @throws {RequiredError}
|
|
2783
|
+
* @memberof ManifestsApi
|
|
1526
2784
|
*/
|
|
1527
|
-
|
|
2785
|
+
manifestAction(projectName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BuildManifest, any, {}>>;
|
|
2786
|
+
}
|
|
2787
|
+
/**
|
|
2788
|
+
* @export
|
|
2789
|
+
*/
|
|
2790
|
+
export declare const ManifestActionActionEnum: {
|
|
2791
|
+
readonly Reload: "reload";
|
|
1528
2792
|
};
|
|
2793
|
+
export type ManifestActionActionEnum = typeof ManifestActionActionEnum[keyof typeof ManifestActionActionEnum];
|
|
1529
2794
|
/**
|
|
1530
|
-
*
|
|
2795
|
+
* MaterializationsApi - axios parameter creator
|
|
1531
2796
|
* @export
|
|
1532
|
-
* @class ConnectionsApi
|
|
1533
|
-
* @extends {BaseAPI}
|
|
1534
2797
|
*/
|
|
1535
|
-
export declare
|
|
2798
|
+
export declare const MaterializationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1536
2799
|
/**
|
|
1537
|
-
*
|
|
1538
|
-
* @summary
|
|
2800
|
+
* Creates a new materialization in PENDING state for all persist sources across all models in the package. Use POST .../materializations/{materializationId}?action=start to begin execution.
|
|
2801
|
+
* @summary Create a materialization
|
|
1539
2802
|
* @param {string} projectName Name of the project
|
|
1540
|
-
* @param {string}
|
|
2803
|
+
* @param {string} packageName Name of the package
|
|
2804
|
+
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
1541
2805
|
* @param {*} [options] Override http request option.
|
|
1542
2806
|
* @throws {RequiredError}
|
|
1543
|
-
* @memberof ConnectionsApi
|
|
1544
2807
|
*/
|
|
1545
|
-
|
|
2808
|
+
createMaterialization: (projectName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1546
2809
|
/**
|
|
1547
|
-
*
|
|
1548
|
-
* @summary
|
|
2810
|
+
* Deletes a terminal (SUCCESS, FAILED, or CANCELLED) materialization record.
|
|
2811
|
+
* @summary Delete a materialization
|
|
1549
2812
|
* @param {string} projectName Name of the project
|
|
1550
|
-
* @param {string}
|
|
1551
|
-
* @param {string}
|
|
1552
|
-
* @param {string} [_options] Options
|
|
2813
|
+
* @param {string} packageName Name of the package
|
|
2814
|
+
* @param {string} materializationId ID of the materialization
|
|
1553
2815
|
* @param {*} [options] Override http request option.
|
|
1554
|
-
* @deprecated
|
|
1555
2816
|
* @throws {RequiredError}
|
|
1556
|
-
* @memberof ConnectionsApi
|
|
1557
2817
|
*/
|
|
1558
|
-
|
|
2818
|
+
deleteMaterialization: (projectName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1559
2819
|
/**
|
|
1560
|
-
*
|
|
1561
|
-
* @summary Get
|
|
2820
|
+
*
|
|
2821
|
+
* @summary Get a specific materialization
|
|
1562
2822
|
* @param {string} projectName Name of the project
|
|
1563
|
-
* @param {string}
|
|
1564
|
-
* @param {string}
|
|
2823
|
+
* @param {string} packageName Name of the package
|
|
2824
|
+
* @param {string} materializationId ID of the materialization
|
|
1565
2825
|
* @param {*} [options] Override http request option.
|
|
1566
|
-
* @deprecated
|
|
1567
2826
|
* @throws {RequiredError}
|
|
1568
|
-
* @memberof ConnectionsApi
|
|
1569
2827
|
*/
|
|
1570
|
-
|
|
2828
|
+
getMaterialization: (projectName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1571
2829
|
/**
|
|
1572
|
-
*
|
|
1573
|
-
* @summary
|
|
2830
|
+
* Returns the materialization history for the package, ordered by most recent first.
|
|
2831
|
+
* @summary List materializations for a package
|
|
1574
2832
|
* @param {string} projectName Name of the project
|
|
1575
|
-
* @param {string}
|
|
1576
|
-
* @param {
|
|
1577
|
-
* @param {
|
|
2833
|
+
* @param {string} packageName Name of the package
|
|
2834
|
+
* @param {number} [limit] Maximum number of materializations to return
|
|
2835
|
+
* @param {number} [offset] Number of materializations to skip
|
|
1578
2836
|
* @param {*} [options] Override http request option.
|
|
1579
2837
|
* @throws {RequiredError}
|
|
1580
|
-
* @memberof ConnectionsApi
|
|
1581
2838
|
*/
|
|
1582
|
-
|
|
2839
|
+
listMaterializations: (projectName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1583
2840
|
/**
|
|
1584
|
-
*
|
|
1585
|
-
* @summary
|
|
2841
|
+
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `start` - Transitions a PENDING materialization to RUNNING and begins execution in the background. Returns 202. * `stop` - Cancels a PENDING or RUNNING materialization. Returns 200.
|
|
2842
|
+
* @summary Perform an action on a materialization
|
|
1586
2843
|
* @param {string} projectName Name of the project
|
|
1587
|
-
* @param {string}
|
|
1588
|
-
* @param {string}
|
|
1589
|
-
* @param {
|
|
2844
|
+
* @param {string} packageName Name of the package
|
|
2845
|
+
* @param {string} materializationId ID of the materialization
|
|
2846
|
+
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
1590
2847
|
* @param {*} [options] Override http request option.
|
|
1591
|
-
* @deprecated
|
|
1592
2848
|
* @throws {RequiredError}
|
|
1593
|
-
* @memberof ConnectionsApi
|
|
1594
2849
|
*/
|
|
1595
|
-
|
|
2850
|
+
materializationAction: (projectName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2851
|
+
};
|
|
2852
|
+
/**
|
|
2853
|
+
* MaterializationsApi - functional programming interface
|
|
2854
|
+
* @export
|
|
2855
|
+
*/
|
|
2856
|
+
export declare const MaterializationsApiFp: (configuration?: Configuration) => {
|
|
1596
2857
|
/**
|
|
1597
|
-
*
|
|
1598
|
-
* @summary Create
|
|
2858
|
+
* Creates a new materialization in PENDING state for all persist sources across all models in the package. Use POST .../materializations/{materializationId}?action=start to begin execution.
|
|
2859
|
+
* @summary Create a materialization
|
|
1599
2860
|
* @param {string} projectName Name of the project
|
|
1600
|
-
* @param {string}
|
|
1601
|
-
* @param {
|
|
2861
|
+
* @param {string} packageName Name of the package
|
|
2862
|
+
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
1602
2863
|
* @param {*} [options] Override http request option.
|
|
1603
|
-
* @deprecated
|
|
1604
2864
|
* @throws {RequiredError}
|
|
1605
|
-
* @memberof ConnectionsApi
|
|
1606
2865
|
*/
|
|
1607
|
-
|
|
2866
|
+
createMaterialization(projectName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Materialization>>;
|
|
1608
2867
|
/**
|
|
1609
|
-
*
|
|
1610
|
-
* @summary
|
|
2868
|
+
* Deletes a terminal (SUCCESS, FAILED, or CANCELLED) materialization record.
|
|
2869
|
+
* @summary Delete a materialization
|
|
1611
2870
|
* @param {string} projectName Name of the project
|
|
2871
|
+
* @param {string} packageName Name of the package
|
|
2872
|
+
* @param {string} materializationId ID of the materialization
|
|
1612
2873
|
* @param {*} [options] Override http request option.
|
|
1613
2874
|
* @throws {RequiredError}
|
|
1614
|
-
* @memberof ConnectionsApi
|
|
1615
2875
|
*/
|
|
1616
|
-
|
|
2876
|
+
deleteMaterialization(projectName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1617
2877
|
/**
|
|
1618
|
-
*
|
|
1619
|
-
* @summary
|
|
2878
|
+
*
|
|
2879
|
+
* @summary Get a specific materialization
|
|
1620
2880
|
* @param {string} projectName Name of the project
|
|
1621
|
-
* @param {string}
|
|
2881
|
+
* @param {string} packageName Name of the package
|
|
2882
|
+
* @param {string} materializationId ID of the materialization
|
|
1622
2883
|
* @param {*} [options] Override http request option.
|
|
1623
2884
|
* @throws {RequiredError}
|
|
1624
|
-
* @memberof ConnectionsApi
|
|
1625
2885
|
*/
|
|
1626
|
-
|
|
2886
|
+
getMaterialization(projectName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Materialization>>;
|
|
1627
2887
|
/**
|
|
1628
|
-
*
|
|
1629
|
-
* @summary List
|
|
2888
|
+
* Returns the materialization history for the package, ordered by most recent first.
|
|
2889
|
+
* @summary List materializations for a package
|
|
1630
2890
|
* @param {string} projectName Name of the project
|
|
1631
|
-
* @param {string}
|
|
1632
|
-
* @param {
|
|
2891
|
+
* @param {string} packageName Name of the package
|
|
2892
|
+
* @param {number} [limit] Maximum number of materializations to return
|
|
2893
|
+
* @param {number} [offset] Number of materializations to skip
|
|
1633
2894
|
* @param {*} [options] Override http request option.
|
|
1634
2895
|
* @throws {RequiredError}
|
|
1635
|
-
* @memberof ConnectionsApi
|
|
1636
2896
|
*/
|
|
1637
|
-
|
|
2897
|
+
listMaterializations(projectName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Materialization>>>;
|
|
1638
2898
|
/**
|
|
1639
|
-
*
|
|
1640
|
-
* @summary
|
|
2899
|
+
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `start` - Transitions a PENDING materialization to RUNNING and begins execution in the background. Returns 202. * `stop` - Cancels a PENDING or RUNNING materialization. Returns 200.
|
|
2900
|
+
* @summary Perform an action on a materialization
|
|
1641
2901
|
* @param {string} projectName Name of the project
|
|
1642
|
-
* @param {string}
|
|
1643
|
-
* @param {
|
|
1644
|
-
* @param {
|
|
2902
|
+
* @param {string} packageName Name of the package
|
|
2903
|
+
* @param {string} materializationId ID of the materialization
|
|
2904
|
+
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
1645
2905
|
* @param {*} [options] Override http request option.
|
|
1646
2906
|
* @throws {RequiredError}
|
|
1647
|
-
* @memberof ConnectionsApi
|
|
1648
2907
|
*/
|
|
1649
|
-
|
|
2908
|
+
materializationAction(projectName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Materialization>>;
|
|
2909
|
+
};
|
|
2910
|
+
/**
|
|
2911
|
+
* MaterializationsApi - factory interface
|
|
2912
|
+
* @export
|
|
2913
|
+
*/
|
|
2914
|
+
export declare const MaterializationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1650
2915
|
/**
|
|
1651
|
-
* Creates a
|
|
1652
|
-
* @summary Create
|
|
2916
|
+
* Creates a new materialization in PENDING state for all persist sources across all models in the package. Use POST .../materializations/{materializationId}?action=start to begin execution.
|
|
2917
|
+
* @summary Create a materialization
|
|
1653
2918
|
* @param {string} projectName Name of the project
|
|
1654
|
-
* @param {string}
|
|
1655
|
-
* @param {
|
|
2919
|
+
* @param {string} packageName Name of the package
|
|
2920
|
+
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
1656
2921
|
* @param {*} [options] Override http request option.
|
|
1657
2922
|
* @throws {RequiredError}
|
|
1658
|
-
* @memberof ConnectionsApi
|
|
1659
2923
|
*/
|
|
1660
|
-
|
|
2924
|
+
createMaterialization(projectName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig): AxiosPromise<Materialization>;
|
|
1661
2925
|
/**
|
|
1662
|
-
*
|
|
1663
|
-
* @summary
|
|
2926
|
+
* Deletes a terminal (SUCCESS, FAILED, or CANCELLED) materialization record.
|
|
2927
|
+
* @summary Delete a materialization
|
|
1664
2928
|
* @param {string} projectName Name of the project
|
|
1665
|
-
* @param {string}
|
|
1666
|
-
* @param {
|
|
2929
|
+
* @param {string} packageName Name of the package
|
|
2930
|
+
* @param {string} materializationId ID of the materialization
|
|
1667
2931
|
* @param {*} [options] Override http request option.
|
|
1668
2932
|
* @throws {RequiredError}
|
|
1669
|
-
* @memberof ConnectionsApi
|
|
1670
2933
|
*/
|
|
1671
|
-
|
|
1672
|
-
}
|
|
1673
|
-
/**
|
|
1674
|
-
* ConnectionsTestApi - axios parameter creator
|
|
1675
|
-
* @export
|
|
1676
|
-
*/
|
|
1677
|
-
export declare const ConnectionsTestApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2934
|
+
deleteMaterialization(projectName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1678
2935
|
/**
|
|
1679
|
-
*
|
|
1680
|
-
* @summary
|
|
1681
|
-
* @param {
|
|
2936
|
+
*
|
|
2937
|
+
* @summary Get a specific materialization
|
|
2938
|
+
* @param {string} projectName Name of the project
|
|
2939
|
+
* @param {string} packageName Name of the package
|
|
2940
|
+
* @param {string} materializationId ID of the materialization
|
|
1682
2941
|
* @param {*} [options] Override http request option.
|
|
1683
2942
|
* @throws {RequiredError}
|
|
1684
2943
|
*/
|
|
1685
|
-
|
|
1686
|
-
};
|
|
1687
|
-
/**
|
|
1688
|
-
* ConnectionsTestApi - functional programming interface
|
|
1689
|
-
* @export
|
|
1690
|
-
*/
|
|
1691
|
-
export declare const ConnectionsTestApiFp: (configuration?: Configuration) => {
|
|
2944
|
+
getMaterialization(projectName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): AxiosPromise<Materialization>;
|
|
1692
2945
|
/**
|
|
1693
|
-
*
|
|
1694
|
-
* @summary
|
|
1695
|
-
* @param {
|
|
2946
|
+
* Returns the materialization history for the package, ordered by most recent first.
|
|
2947
|
+
* @summary List materializations for a package
|
|
2948
|
+
* @param {string} projectName Name of the project
|
|
2949
|
+
* @param {string} packageName Name of the package
|
|
2950
|
+
* @param {number} [limit] Maximum number of materializations to return
|
|
2951
|
+
* @param {number} [offset] Number of materializations to skip
|
|
1696
2952
|
* @param {*} [options] Override http request option.
|
|
1697
2953
|
* @throws {RequiredError}
|
|
1698
2954
|
*/
|
|
1699
|
-
|
|
1700
|
-
};
|
|
1701
|
-
/**
|
|
1702
|
-
* ConnectionsTestApi - factory interface
|
|
1703
|
-
* @export
|
|
1704
|
-
*/
|
|
1705
|
-
export declare const ConnectionsTestApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2955
|
+
listMaterializations(projectName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Materialization>>;
|
|
1706
2956
|
/**
|
|
1707
|
-
*
|
|
1708
|
-
* @summary
|
|
1709
|
-
* @param {
|
|
2957
|
+
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `start` - Transitions a PENDING materialization to RUNNING and begins execution in the background. Returns 202. * `stop` - Cancels a PENDING or RUNNING materialization. Returns 200.
|
|
2958
|
+
* @summary Perform an action on a materialization
|
|
2959
|
+
* @param {string} projectName Name of the project
|
|
2960
|
+
* @param {string} packageName Name of the package
|
|
2961
|
+
* @param {string} materializationId ID of the materialization
|
|
2962
|
+
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
1710
2963
|
* @param {*} [options] Override http request option.
|
|
1711
2964
|
* @throws {RequiredError}
|
|
1712
2965
|
*/
|
|
1713
|
-
|
|
2966
|
+
materializationAction(projectName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig): AxiosPromise<Materialization>;
|
|
1714
2967
|
};
|
|
1715
2968
|
/**
|
|
1716
|
-
*
|
|
2969
|
+
* MaterializationsApi - object-oriented interface
|
|
1717
2970
|
* @export
|
|
1718
|
-
* @class
|
|
2971
|
+
* @class MaterializationsApi
|
|
1719
2972
|
* @extends {BaseAPI}
|
|
1720
2973
|
*/
|
|
1721
|
-
export declare class
|
|
2974
|
+
export declare class MaterializationsApi extends BaseAPI {
|
|
1722
2975
|
/**
|
|
1723
|
-
*
|
|
1724
|
-
* @summary
|
|
1725
|
-
* @param {
|
|
2976
|
+
* Creates a new materialization in PENDING state for all persist sources across all models in the package. Use POST .../materializations/{materializationId}?action=start to begin execution.
|
|
2977
|
+
* @summary Create a materialization
|
|
2978
|
+
* @param {string} projectName Name of the project
|
|
2979
|
+
* @param {string} packageName Name of the package
|
|
2980
|
+
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
1726
2981
|
* @param {*} [options] Override http request option.
|
|
1727
2982
|
* @throws {RequiredError}
|
|
1728
|
-
* @memberof
|
|
2983
|
+
* @memberof MaterializationsApi
|
|
1729
2984
|
*/
|
|
1730
|
-
|
|
1731
|
-
}
|
|
1732
|
-
/**
|
|
1733
|
-
* DatabasesApi - axios parameter creator
|
|
1734
|
-
* @export
|
|
1735
|
-
*/
|
|
1736
|
-
export declare const DatabasesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2985
|
+
createMaterialization(projectName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Materialization, any, {}>>;
|
|
1737
2986
|
/**
|
|
1738
|
-
*
|
|
1739
|
-
* @summary
|
|
2987
|
+
* Deletes a terminal (SUCCESS, FAILED, or CANCELLED) materialization record.
|
|
2988
|
+
* @summary Delete a materialization
|
|
1740
2989
|
* @param {string} projectName Name of the project
|
|
1741
2990
|
* @param {string} packageName Name of the package
|
|
1742
|
-
* @param {string}
|
|
2991
|
+
* @param {string} materializationId ID of the materialization
|
|
1743
2992
|
* @param {*} [options] Override http request option.
|
|
1744
2993
|
* @throws {RequiredError}
|
|
2994
|
+
* @memberof MaterializationsApi
|
|
1745
2995
|
*/
|
|
1746
|
-
|
|
1747
|
-
};
|
|
1748
|
-
/**
|
|
1749
|
-
* DatabasesApi - functional programming interface
|
|
1750
|
-
* @export
|
|
1751
|
-
*/
|
|
1752
|
-
export declare const DatabasesApiFp: (configuration?: Configuration) => {
|
|
2996
|
+
deleteMaterialization(projectName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1753
2997
|
/**
|
|
1754
|
-
*
|
|
1755
|
-
* @summary
|
|
2998
|
+
*
|
|
2999
|
+
* @summary Get a specific materialization
|
|
1756
3000
|
* @param {string} projectName Name of the project
|
|
1757
3001
|
* @param {string} packageName Name of the package
|
|
1758
|
-
* @param {string}
|
|
3002
|
+
* @param {string} materializationId ID of the materialization
|
|
1759
3003
|
* @param {*} [options] Override http request option.
|
|
1760
3004
|
* @throws {RequiredError}
|
|
3005
|
+
* @memberof MaterializationsApi
|
|
1761
3006
|
*/
|
|
1762
|
-
|
|
1763
|
-
};
|
|
1764
|
-
/**
|
|
1765
|
-
* DatabasesApi - factory interface
|
|
1766
|
-
* @export
|
|
1767
|
-
*/
|
|
1768
|
-
export declare const DatabasesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3007
|
+
getMaterialization(projectName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Materialization, any, {}>>;
|
|
1769
3008
|
/**
|
|
1770
|
-
*
|
|
1771
|
-
* @summary List
|
|
3009
|
+
* Returns the materialization history for the package, ordered by most recent first.
|
|
3010
|
+
* @summary List materializations for a package
|
|
1772
3011
|
* @param {string} projectName Name of the project
|
|
1773
3012
|
* @param {string} packageName Name of the package
|
|
1774
|
-
* @param {
|
|
3013
|
+
* @param {number} [limit] Maximum number of materializations to return
|
|
3014
|
+
* @param {number} [offset] Number of materializations to skip
|
|
1775
3015
|
* @param {*} [options] Override http request option.
|
|
1776
3016
|
* @throws {RequiredError}
|
|
3017
|
+
* @memberof MaterializationsApi
|
|
1777
3018
|
*/
|
|
1778
|
-
|
|
1779
|
-
};
|
|
1780
|
-
/**
|
|
1781
|
-
* DatabasesApi - object-oriented interface
|
|
1782
|
-
* @export
|
|
1783
|
-
* @class DatabasesApi
|
|
1784
|
-
* @extends {BaseAPI}
|
|
1785
|
-
*/
|
|
1786
|
-
export declare class DatabasesApi extends BaseAPI {
|
|
3019
|
+
listMaterializations(projectName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Materialization[], any, {}>>;
|
|
1787
3020
|
/**
|
|
1788
|
-
*
|
|
1789
|
-
* @summary
|
|
3021
|
+
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `start` - Transitions a PENDING materialization to RUNNING and begins execution in the background. Returns 202. * `stop` - Cancels a PENDING or RUNNING materialization. Returns 200.
|
|
3022
|
+
* @summary Perform an action on a materialization
|
|
1790
3023
|
* @param {string} projectName Name of the project
|
|
1791
3024
|
* @param {string} packageName Name of the package
|
|
1792
|
-
* @param {string}
|
|
3025
|
+
* @param {string} materializationId ID of the materialization
|
|
3026
|
+
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
1793
3027
|
* @param {*} [options] Override http request option.
|
|
1794
3028
|
* @throws {RequiredError}
|
|
1795
|
-
* @memberof
|
|
3029
|
+
* @memberof MaterializationsApi
|
|
1796
3030
|
*/
|
|
1797
|
-
|
|
3031
|
+
materializationAction(projectName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Materialization, any, {}>>;
|
|
1798
3032
|
}
|
|
3033
|
+
/**
|
|
3034
|
+
* @export
|
|
3035
|
+
*/
|
|
3036
|
+
export declare const MaterializationActionActionEnum: {
|
|
3037
|
+
readonly Start: "start";
|
|
3038
|
+
readonly Stop: "stop";
|
|
3039
|
+
};
|
|
3040
|
+
export type MaterializationActionActionEnum = typeof MaterializationActionActionEnum[keyof typeof MaterializationActionActionEnum];
|
|
1799
3041
|
/**
|
|
1800
3042
|
* ModelsApi - axios parameter creator
|
|
1801
3043
|
* @export
|
|
1802
3044
|
*/
|
|
1803
3045
|
export declare const ModelsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3046
|
+
/**
|
|
3047
|
+
* Compiles Malloy source code in the context of a specific model file. The submitted source is appended to the full model content, giving it access to all sources, imports, and queries defined in the model. Relative imports resolve correctly against sibling model files. Returns compilation status and any problems (errors or warnings) found.
|
|
3048
|
+
* @summary Compile Malloy source code
|
|
3049
|
+
* @param {string} projectName Name of the project
|
|
3050
|
+
* @param {string} packageName Name of the package
|
|
3051
|
+
* @param {string} path Path to the model within the package (used to resolve relative imports)
|
|
3052
|
+
* @param {CompileRequest} compileRequest
|
|
3053
|
+
* @param {*} [options] Override http request option.
|
|
3054
|
+
* @throws {RequiredError}
|
|
3055
|
+
*/
|
|
3056
|
+
compileModelSource: (projectName: string, packageName: string, path: string, compileRequest: CompileRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1804
3057
|
/**
|
|
1805
3058
|
* Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
|
|
1806
3059
|
* @summary Execute Malloy query
|
|
@@ -1839,6 +3092,17 @@ export declare const ModelsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1839
3092
|
* @export
|
|
1840
3093
|
*/
|
|
1841
3094
|
export declare const ModelsApiFp: (configuration?: Configuration) => {
|
|
3095
|
+
/**
|
|
3096
|
+
* Compiles Malloy source code in the context of a specific model file. The submitted source is appended to the full model content, giving it access to all sources, imports, and queries defined in the model. Relative imports resolve correctly against sibling model files. Returns compilation status and any problems (errors or warnings) found.
|
|
3097
|
+
* @summary Compile Malloy source code
|
|
3098
|
+
* @param {string} projectName Name of the project
|
|
3099
|
+
* @param {string} packageName Name of the package
|
|
3100
|
+
* @param {string} path Path to the model within the package (used to resolve relative imports)
|
|
3101
|
+
* @param {CompileRequest} compileRequest
|
|
3102
|
+
* @param {*} [options] Override http request option.
|
|
3103
|
+
* @throws {RequiredError}
|
|
3104
|
+
*/
|
|
3105
|
+
compileModelSource(projectName: string, packageName: string, path: string, compileRequest: CompileRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompileResult>>;
|
|
1842
3106
|
/**
|
|
1843
3107
|
* Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
|
|
1844
3108
|
* @summary Execute Malloy query
|
|
@@ -1877,6 +3141,17 @@ export declare const ModelsApiFp: (configuration?: Configuration) => {
|
|
|
1877
3141
|
* @export
|
|
1878
3142
|
*/
|
|
1879
3143
|
export declare const ModelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3144
|
+
/**
|
|
3145
|
+
* Compiles Malloy source code in the context of a specific model file. The submitted source is appended to the full model content, giving it access to all sources, imports, and queries defined in the model. Relative imports resolve correctly against sibling model files. Returns compilation status and any problems (errors or warnings) found.
|
|
3146
|
+
* @summary Compile Malloy source code
|
|
3147
|
+
* @param {string} projectName Name of the project
|
|
3148
|
+
* @param {string} packageName Name of the package
|
|
3149
|
+
* @param {string} path Path to the model within the package (used to resolve relative imports)
|
|
3150
|
+
* @param {CompileRequest} compileRequest
|
|
3151
|
+
* @param {*} [options] Override http request option.
|
|
3152
|
+
* @throws {RequiredError}
|
|
3153
|
+
*/
|
|
3154
|
+
compileModelSource(projectName: string, packageName: string, path: string, compileRequest: CompileRequest, options?: RawAxiosRequestConfig): AxiosPromise<CompileResult>;
|
|
1880
3155
|
/**
|
|
1881
3156
|
* Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
|
|
1882
3157
|
* @summary Execute Malloy query
|
|
@@ -1917,6 +3192,18 @@ export declare const ModelsApiFactory: (configuration?: Configuration, basePath?
|
|
|
1917
3192
|
* @extends {BaseAPI}
|
|
1918
3193
|
*/
|
|
1919
3194
|
export declare class ModelsApi extends BaseAPI {
|
|
3195
|
+
/**
|
|
3196
|
+
* Compiles Malloy source code in the context of a specific model file. The submitted source is appended to the full model content, giving it access to all sources, imports, and queries defined in the model. Relative imports resolve correctly against sibling model files. Returns compilation status and any problems (errors or warnings) found.
|
|
3197
|
+
* @summary Compile Malloy source code
|
|
3198
|
+
* @param {string} projectName Name of the project
|
|
3199
|
+
* @param {string} packageName Name of the package
|
|
3200
|
+
* @param {string} path Path to the model within the package (used to resolve relative imports)
|
|
3201
|
+
* @param {CompileRequest} compileRequest
|
|
3202
|
+
* @param {*} [options] Override http request option.
|
|
3203
|
+
* @throws {RequiredError}
|
|
3204
|
+
* @memberof ModelsApi
|
|
3205
|
+
*/
|
|
3206
|
+
compileModelSource(projectName: string, packageName: string, path: string, compileRequest: CompileRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CompileResult, any, {}>>;
|
|
1920
3207
|
/**
|
|
1921
3208
|
* Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
|
|
1922
3209
|
* @summary Execute Malloy query
|
|
@@ -1959,8 +3246,22 @@ export declare class ModelsApi extends BaseAPI {
|
|
|
1959
3246
|
*/
|
|
1960
3247
|
export declare const NotebooksApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1961
3248
|
/**
|
|
1962
|
-
*
|
|
1963
|
-
* @summary
|
|
3249
|
+
* Executes a specific cell in a Malloy notebook by index. For code cells, this compiles and runs the Malloy code, returning query results and any new sources defined. For markdown cells, this simply returns the cell content.
|
|
3250
|
+
* @summary Execute a specific notebook cell
|
|
3251
|
+
* @param {string} projectName Name of the project
|
|
3252
|
+
* @param {string} packageName Name of the package
|
|
3253
|
+
* @param {string} path Path to notebook within the package
|
|
3254
|
+
* @param {number} cellIndex Index of the cell to execute (0-based)
|
|
3255
|
+
* @param {string} [versionId] Version identifier for the package
|
|
3256
|
+
* @param {string} [filterParams] JSON-encoded filter parameter values keyed by filter name
|
|
3257
|
+
* @param {ExecuteNotebookCellBypassFiltersEnum} [bypassFilters] When true, skip filter injection entirely
|
|
3258
|
+
* @param {*} [options] Override http request option.
|
|
3259
|
+
* @throws {RequiredError}
|
|
3260
|
+
*/
|
|
3261
|
+
executeNotebookCell: (projectName: string, packageName: string, path: string, cellIndex: number, versionId?: string, filterParams?: string, bypassFilters?: ExecuteNotebookCellBypassFiltersEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3262
|
+
/**
|
|
3263
|
+
* Retrieves a Malloy notebook with its raw cell contents (markdown and code). Cell execution should be done separately via the execute-notebook-cell endpoint.
|
|
3264
|
+
* @summary Get Malloy notebook cells
|
|
1964
3265
|
* @param {string} projectName Name of the project
|
|
1965
3266
|
* @param {string} packageName Name of the package
|
|
1966
3267
|
* @param {string} path Path to notebook within the package.
|
|
@@ -1986,8 +3287,22 @@ export declare const NotebooksApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1986
3287
|
*/
|
|
1987
3288
|
export declare const NotebooksApiFp: (configuration?: Configuration) => {
|
|
1988
3289
|
/**
|
|
1989
|
-
*
|
|
1990
|
-
* @summary
|
|
3290
|
+
* Executes a specific cell in a Malloy notebook by index. For code cells, this compiles and runs the Malloy code, returning query results and any new sources defined. For markdown cells, this simply returns the cell content.
|
|
3291
|
+
* @summary Execute a specific notebook cell
|
|
3292
|
+
* @param {string} projectName Name of the project
|
|
3293
|
+
* @param {string} packageName Name of the package
|
|
3294
|
+
* @param {string} path Path to notebook within the package
|
|
3295
|
+
* @param {number} cellIndex Index of the cell to execute (0-based)
|
|
3296
|
+
* @param {string} [versionId] Version identifier for the package
|
|
3297
|
+
* @param {string} [filterParams] JSON-encoded filter parameter values keyed by filter name
|
|
3298
|
+
* @param {ExecuteNotebookCellBypassFiltersEnum} [bypassFilters] When true, skip filter injection entirely
|
|
3299
|
+
* @param {*} [options] Override http request option.
|
|
3300
|
+
* @throws {RequiredError}
|
|
3301
|
+
*/
|
|
3302
|
+
executeNotebookCell(projectName: string, packageName: string, path: string, cellIndex: number, versionId?: string, filterParams?: string, bypassFilters?: ExecuteNotebookCellBypassFiltersEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotebookCellResult>>;
|
|
3303
|
+
/**
|
|
3304
|
+
* Retrieves a Malloy notebook with its raw cell contents (markdown and code). Cell execution should be done separately via the execute-notebook-cell endpoint.
|
|
3305
|
+
* @summary Get Malloy notebook cells
|
|
1991
3306
|
* @param {string} projectName Name of the project
|
|
1992
3307
|
* @param {string} packageName Name of the package
|
|
1993
3308
|
* @param {string} path Path to notebook within the package.
|
|
@@ -1995,7 +3310,7 @@ export declare const NotebooksApiFp: (configuration?: Configuration) => {
|
|
|
1995
3310
|
* @param {*} [options] Override http request option.
|
|
1996
3311
|
* @throws {RequiredError}
|
|
1997
3312
|
*/
|
|
1998
|
-
getNotebook(projectName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
3313
|
+
getNotebook(projectName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RawNotebook>>;
|
|
1999
3314
|
/**
|
|
2000
3315
|
* Retrieves a list of all Malloy notebooks within the specified package. Each notebook entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available notebooks and checking their status.
|
|
2001
3316
|
* @summary List package notebooks
|
|
@@ -2013,8 +3328,22 @@ export declare const NotebooksApiFp: (configuration?: Configuration) => {
|
|
|
2013
3328
|
*/
|
|
2014
3329
|
export declare const NotebooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2015
3330
|
/**
|
|
2016
|
-
*
|
|
2017
|
-
* @summary
|
|
3331
|
+
* Executes a specific cell in a Malloy notebook by index. For code cells, this compiles and runs the Malloy code, returning query results and any new sources defined. For markdown cells, this simply returns the cell content.
|
|
3332
|
+
* @summary Execute a specific notebook cell
|
|
3333
|
+
* @param {string} projectName Name of the project
|
|
3334
|
+
* @param {string} packageName Name of the package
|
|
3335
|
+
* @param {string} path Path to notebook within the package
|
|
3336
|
+
* @param {number} cellIndex Index of the cell to execute (0-based)
|
|
3337
|
+
* @param {string} [versionId] Version identifier for the package
|
|
3338
|
+
* @param {string} [filterParams] JSON-encoded filter parameter values keyed by filter name
|
|
3339
|
+
* @param {ExecuteNotebookCellBypassFiltersEnum} [bypassFilters] When true, skip filter injection entirely
|
|
3340
|
+
* @param {*} [options] Override http request option.
|
|
3341
|
+
* @throws {RequiredError}
|
|
3342
|
+
*/
|
|
3343
|
+
executeNotebookCell(projectName: string, packageName: string, path: string, cellIndex: number, versionId?: string, filterParams?: string, bypassFilters?: ExecuteNotebookCellBypassFiltersEnum, options?: RawAxiosRequestConfig): AxiosPromise<NotebookCellResult>;
|
|
3344
|
+
/**
|
|
3345
|
+
* Retrieves a Malloy notebook with its raw cell contents (markdown and code). Cell execution should be done separately via the execute-notebook-cell endpoint.
|
|
3346
|
+
* @summary Get Malloy notebook cells
|
|
2018
3347
|
* @param {string} projectName Name of the project
|
|
2019
3348
|
* @param {string} packageName Name of the package
|
|
2020
3349
|
* @param {string} path Path to notebook within the package.
|
|
@@ -2022,7 +3351,7 @@ export declare const NotebooksApiFactory: (configuration?: Configuration, basePa
|
|
|
2022
3351
|
* @param {*} [options] Override http request option.
|
|
2023
3352
|
* @throws {RequiredError}
|
|
2024
3353
|
*/
|
|
2025
|
-
getNotebook(projectName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
3354
|
+
getNotebook(projectName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<RawNotebook>;
|
|
2026
3355
|
/**
|
|
2027
3356
|
* Retrieves a list of all Malloy notebooks within the specified package. Each notebook entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available notebooks and checking their status.
|
|
2028
3357
|
* @summary List package notebooks
|
|
@@ -2042,8 +3371,23 @@ export declare const NotebooksApiFactory: (configuration?: Configuration, basePa
|
|
|
2042
3371
|
*/
|
|
2043
3372
|
export declare class NotebooksApi extends BaseAPI {
|
|
2044
3373
|
/**
|
|
2045
|
-
*
|
|
2046
|
-
* @summary
|
|
3374
|
+
* Executes a specific cell in a Malloy notebook by index. For code cells, this compiles and runs the Malloy code, returning query results and any new sources defined. For markdown cells, this simply returns the cell content.
|
|
3375
|
+
* @summary Execute a specific notebook cell
|
|
3376
|
+
* @param {string} projectName Name of the project
|
|
3377
|
+
* @param {string} packageName Name of the package
|
|
3378
|
+
* @param {string} path Path to notebook within the package
|
|
3379
|
+
* @param {number} cellIndex Index of the cell to execute (0-based)
|
|
3380
|
+
* @param {string} [versionId] Version identifier for the package
|
|
3381
|
+
* @param {string} [filterParams] JSON-encoded filter parameter values keyed by filter name
|
|
3382
|
+
* @param {ExecuteNotebookCellBypassFiltersEnum} [bypassFilters] When true, skip filter injection entirely
|
|
3383
|
+
* @param {*} [options] Override http request option.
|
|
3384
|
+
* @throws {RequiredError}
|
|
3385
|
+
* @memberof NotebooksApi
|
|
3386
|
+
*/
|
|
3387
|
+
executeNotebookCell(projectName: string, packageName: string, path: string, cellIndex: number, versionId?: string, filterParams?: string, bypassFilters?: ExecuteNotebookCellBypassFiltersEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NotebookCellResult, any, {}>>;
|
|
3388
|
+
/**
|
|
3389
|
+
* Retrieves a Malloy notebook with its raw cell contents (markdown and code). Cell execution should be done separately via the execute-notebook-cell endpoint.
|
|
3390
|
+
* @summary Get Malloy notebook cells
|
|
2047
3391
|
* @param {string} projectName Name of the project
|
|
2048
3392
|
* @param {string} packageName Name of the package
|
|
2049
3393
|
* @param {string} path Path to notebook within the package.
|
|
@@ -2052,7 +3396,7 @@ export declare class NotebooksApi extends BaseAPI {
|
|
|
2052
3396
|
* @throws {RequiredError}
|
|
2053
3397
|
* @memberof NotebooksApi
|
|
2054
3398
|
*/
|
|
2055
|
-
getNotebook(projectName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
3399
|
+
getNotebook(projectName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RawNotebook, any, {}>>;
|
|
2056
3400
|
/**
|
|
2057
3401
|
* Retrieves a list of all Malloy notebooks within the specified package. Each notebook entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available notebooks and checking their status.
|
|
2058
3402
|
* @summary List package notebooks
|
|
@@ -2065,6 +3409,14 @@ export declare class NotebooksApi extends BaseAPI {
|
|
|
2065
3409
|
*/
|
|
2066
3410
|
listNotebooks(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Notebook[], any, {}>>;
|
|
2067
3411
|
}
|
|
3412
|
+
/**
|
|
3413
|
+
* @export
|
|
3414
|
+
*/
|
|
3415
|
+
export declare const ExecuteNotebookCellBypassFiltersEnum: {
|
|
3416
|
+
readonly True: "true";
|
|
3417
|
+
readonly False: "false";
|
|
3418
|
+
};
|
|
3419
|
+
export type ExecuteNotebookCellBypassFiltersEnum = typeof ExecuteNotebookCellBypassFiltersEnum[keyof typeof ExecuteNotebookCellBypassFiltersEnum];
|
|
2068
3420
|
/**
|
|
2069
3421
|
* PackagesApi - axios parameter creator
|
|
2070
3422
|
* @export
|
|
@@ -2075,10 +3427,11 @@ export declare const PackagesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
2075
3427
|
* @summary Create a new package
|
|
2076
3428
|
* @param {string} projectName Name of the project
|
|
2077
3429
|
* @param {Package} _package
|
|
3430
|
+
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
2078
3431
|
* @param {*} [options] Override http request option.
|
|
2079
3432
|
* @throws {RequiredError}
|
|
2080
3433
|
*/
|
|
2081
|
-
createPackage: (projectName: string, _package: Package, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3434
|
+
createPackage: (projectName: string, _package: Package, autoLoadManifest?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2082
3435
|
/**
|
|
2083
3436
|
* Permanently deletes a package and all its associated resources including models, notebooks, databases, and metadata. This operation cannot be undone, so use with caution. The package must exist and be accessible for deletion.
|
|
2084
3437
|
* @summary Delete a package
|
|
@@ -2128,10 +3481,11 @@ export declare const PackagesApiFp: (configuration?: Configuration) => {
|
|
|
2128
3481
|
* @summary Create a new package
|
|
2129
3482
|
* @param {string} projectName Name of the project
|
|
2130
3483
|
* @param {Package} _package
|
|
3484
|
+
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
2131
3485
|
* @param {*} [options] Override http request option.
|
|
2132
3486
|
* @throws {RequiredError}
|
|
2133
3487
|
*/
|
|
2134
|
-
createPackage(projectName: string, _package: Package, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
3488
|
+
createPackage(projectName: string, _package: Package, autoLoadManifest?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
2135
3489
|
/**
|
|
2136
3490
|
* Permanently deletes a package and all its associated resources including models, notebooks, databases, and metadata. This operation cannot be undone, so use with caution. The package must exist and be accessible for deletion.
|
|
2137
3491
|
* @summary Delete a package
|
|
@@ -2181,10 +3535,11 @@ export declare const PackagesApiFactory: (configuration?: Configuration, basePat
|
|
|
2181
3535
|
* @summary Create a new package
|
|
2182
3536
|
* @param {string} projectName Name of the project
|
|
2183
3537
|
* @param {Package} _package
|
|
3538
|
+
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
2184
3539
|
* @param {*} [options] Override http request option.
|
|
2185
3540
|
* @throws {RequiredError}
|
|
2186
3541
|
*/
|
|
2187
|
-
createPackage(projectName: string, _package: Package, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
3542
|
+
createPackage(projectName: string, _package: Package, autoLoadManifest?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
2188
3543
|
/**
|
|
2189
3544
|
* Permanently deletes a package and all its associated resources including models, notebooks, databases, and metadata. This operation cannot be undone, so use with caution. The package must exist and be accessible for deletion.
|
|
2190
3545
|
* @summary Delete a package
|
|
@@ -2236,11 +3591,12 @@ export declare class PackagesApi extends BaseAPI {
|
|
|
2236
3591
|
* @summary Create a new package
|
|
2237
3592
|
* @param {string} projectName Name of the project
|
|
2238
3593
|
* @param {Package} _package
|
|
3594
|
+
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
2239
3595
|
* @param {*} [options] Override http request option.
|
|
2240
3596
|
* @throws {RequiredError}
|
|
2241
3597
|
* @memberof PackagesApi
|
|
2242
3598
|
*/
|
|
2243
|
-
createPackage(projectName: string, _package: Package, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Package, any, {}>>;
|
|
3599
|
+
createPackage(projectName: string, _package: Package, autoLoadManifest?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Package, any, {}>>;
|
|
2244
3600
|
/**
|
|
2245
3601
|
* Permanently deletes a package and all its associated resources including models, notebooks, databases, and metadata. This operation cannot be undone, so use with caution. The package must exist and be accessible for deletion.
|
|
2246
3602
|
* @summary Delete a package
|