@malloy-publisher/sdk 0.0.205 → 0.0.206
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/{ServerProvider-CV37_sr_.es.js → ServerProvider-Bl1dhff8.es.js} +908 -1305
- package/dist/ServerProvider-DAUs13RZ.cjs.js +1 -0
- package/dist/client/api.d.ts +332 -416
- package/dist/client/index.cjs.js +1 -1
- package/dist/client/index.es.js +52 -55
- package/dist/components/Materializations/CreateMaterializationDialog.d.ts +0 -1
- package/dist/components/Materializations/ManifestView.d.ts +6 -7
- package/dist/components/Materializations/utils.d.ts +20 -16
- package/dist/components/ServerProvider.d.ts +1 -2
- package/dist/components/given/GivenInput.d.ts +13 -8
- package/dist/{core-BWQQVODR.cjs.js → core-DPwA_AfV.cjs.js} +1 -1
- package/dist/{core-C2sQrwVu.es.js → core-pPlPr7jK.es.js} +1 -1
- package/dist/hooks/useGivensForm.d.ts +0 -2
- package/dist/{index-CBRWGN55.es.js → index-BCj2kFTK.es.js} +8184 -8157
- package/dist/{index-Dky6W6d1.cjs.js → index-LRaPE9ej.cjs.js} +77 -77
- package/dist/index.cjs.js +1 -1
- package/dist/index.es.js +2 -2
- package/package.json +1 -1
- package/src/components/Materializations/CreateMaterializationDialog.tsx +6 -20
- package/src/components/Materializations/ManifestView.tsx +29 -46
- package/src/components/Materializations/MaterializationDetailDialog.tsx +104 -74
- package/src/components/Materializations/MaterializationRunsList.tsx +2 -1
- package/src/components/Materializations/Materializations.tsx +13 -85
- package/src/components/Materializations/utils.ts +60 -27
- package/src/components/Model/Model.tsx +39 -0
- package/src/components/Notebook/Notebook.tsx +22 -9
- package/src/components/Package/Package.tsx +1 -1
- package/src/components/ServerProvider.tsx +0 -2
- package/src/components/given/GivenInput.tsx +54 -31
- package/src/hooks/useGivensForm.ts +0 -12
- package/dist/ServerProvider-Ci6NBOLe.cjs.js +0 -1
package/dist/client/api.d.ts
CHANGED
|
@@ -169,13 +169,88 @@ export interface BigqueryConnection {
|
|
|
169
169
|
'queryTimeoutMilliseconds'?: string;
|
|
170
170
|
}
|
|
171
171
|
/**
|
|
172
|
-
*
|
|
172
|
+
*
|
|
173
|
+
* @export
|
|
174
|
+
* @interface BuildGraph
|
|
175
|
+
*/
|
|
176
|
+
export interface BuildGraph {
|
|
177
|
+
/**
|
|
178
|
+
*
|
|
179
|
+
* @type {string}
|
|
180
|
+
* @memberof BuildGraph
|
|
181
|
+
*/
|
|
182
|
+
'connectionName': string;
|
|
183
|
+
/**
|
|
184
|
+
* Leveled build nodes; each inner array is one parallelizable level, levels run in order.
|
|
185
|
+
* @type {Array<Array<BuildNode>>}
|
|
186
|
+
* @memberof BuildGraph
|
|
187
|
+
*/
|
|
188
|
+
'nodes': Array<Array<BuildNode>>;
|
|
189
|
+
}
|
|
190
|
+
/**
|
|
191
|
+
*
|
|
192
|
+
* @export
|
|
193
|
+
* @interface BuildInstruction
|
|
194
|
+
*/
|
|
195
|
+
export interface BuildInstruction {
|
|
196
|
+
/**
|
|
197
|
+
* Identifies which planned source this instruction is for (matches PersistSourcePlan.buildId).
|
|
198
|
+
* @type {string}
|
|
199
|
+
* @memberof BuildInstruction
|
|
200
|
+
*/
|
|
201
|
+
'buildId': string;
|
|
202
|
+
/**
|
|
203
|
+
* Optional convenience echo of \"sourceName@modelURL\"; buildId is authoritative.
|
|
204
|
+
* @type {string}
|
|
205
|
+
* @memberof BuildInstruction
|
|
206
|
+
*/
|
|
207
|
+
'sourceID'?: string;
|
|
208
|
+
/**
|
|
209
|
+
* CP-assigned surrogate id for the materialized table about to be produced.
|
|
210
|
+
* @type {string}
|
|
211
|
+
* @memberof BuildInstruction
|
|
212
|
+
*/
|
|
213
|
+
'materializedTableId': string;
|
|
214
|
+
/**
|
|
215
|
+
* Fully-qualified, dialect-quoted table name to create. The publisher writes here verbatim.
|
|
216
|
+
* @type {string}
|
|
217
|
+
* @memberof BuildInstruction
|
|
218
|
+
*/
|
|
219
|
+
'physicalTableName': string;
|
|
220
|
+
/**
|
|
221
|
+
*
|
|
222
|
+
* @type {Realization}
|
|
223
|
+
* @memberof BuildInstruction
|
|
224
|
+
*/
|
|
225
|
+
'realization': Realization;
|
|
226
|
+
}
|
|
227
|
+
/**
|
|
228
|
+
* Round 2 input. Per-source instructions assigned by the control plane.
|
|
229
|
+
* @export
|
|
230
|
+
* @interface BuildInstructions
|
|
231
|
+
*/
|
|
232
|
+
export interface BuildInstructions {
|
|
233
|
+
/**
|
|
234
|
+
*
|
|
235
|
+
* @type {Array<BuildInstruction>}
|
|
236
|
+
* @memberof BuildInstructions
|
|
237
|
+
*/
|
|
238
|
+
'sources': Array<BuildInstruction>;
|
|
239
|
+
}
|
|
240
|
+
/**
|
|
241
|
+
* Round 2 output. Maps each buildId a build produced to its physical table. Returned inline; the control plane persists it.
|
|
173
242
|
* @export
|
|
174
243
|
* @interface BuildManifest
|
|
175
244
|
*/
|
|
176
245
|
export interface BuildManifest {
|
|
177
246
|
/**
|
|
178
|
-
*
|
|
247
|
+
*
|
|
248
|
+
* @type {string}
|
|
249
|
+
* @memberof BuildManifest
|
|
250
|
+
*/
|
|
251
|
+
'builtAt'?: string;
|
|
252
|
+
/**
|
|
253
|
+
* Map of buildId to manifest entry.
|
|
179
254
|
* @type {{ [key: string]: ManifestEntry; }}
|
|
180
255
|
* @memberof BuildManifest
|
|
181
256
|
*/
|
|
@@ -183,12 +258,52 @@ export interface BuildManifest {
|
|
|
183
258
|
[key: string]: ManifestEntry;
|
|
184
259
|
};
|
|
185
260
|
/**
|
|
186
|
-
* Whether
|
|
261
|
+
* Whether unresolved references should error.
|
|
187
262
|
* @type {boolean}
|
|
188
263
|
* @memberof BuildManifest
|
|
189
264
|
*/
|
|
190
265
|
'strict'?: boolean;
|
|
191
266
|
}
|
|
267
|
+
/**
|
|
268
|
+
*
|
|
269
|
+
* @export
|
|
270
|
+
* @interface BuildNode
|
|
271
|
+
*/
|
|
272
|
+
export interface BuildNode {
|
|
273
|
+
/**
|
|
274
|
+
* sourceName@modelURL
|
|
275
|
+
* @type {string}
|
|
276
|
+
* @memberof BuildNode
|
|
277
|
+
*/
|
|
278
|
+
'sourceID': string;
|
|
279
|
+
/**
|
|
280
|
+
* Upstream sourceIDs in this graph.
|
|
281
|
+
* @type {Array<string>}
|
|
282
|
+
* @memberof BuildNode
|
|
283
|
+
*/
|
|
284
|
+
'dependsOn'?: Array<string>;
|
|
285
|
+
}
|
|
286
|
+
/**
|
|
287
|
+
* Round 1 output. Mirrors Malloy\'s native build plan plus the minimal per-source detail the control plane needs in v0 to assign identity/naming/realization. Lineage, policy, and connection capability are intentionally omitted until they carry real data.
|
|
288
|
+
* @export
|
|
289
|
+
* @interface BuildPlan
|
|
290
|
+
*/
|
|
291
|
+
export interface BuildPlan {
|
|
292
|
+
/**
|
|
293
|
+
* Dependency-ordered build graphs, one per connection.
|
|
294
|
+
* @type {Array<BuildGraph>}
|
|
295
|
+
* @memberof BuildPlan
|
|
296
|
+
*/
|
|
297
|
+
'graphs': Array<BuildGraph>;
|
|
298
|
+
/**
|
|
299
|
+
* Map of sourceID (\"sourceName@modelURL\") to per-source plan.
|
|
300
|
+
* @type {{ [key: string]: PersistSourcePlan; }}
|
|
301
|
+
* @memberof BuildPlan
|
|
302
|
+
*/
|
|
303
|
+
'sources': {
|
|
304
|
+
[key: string]: PersistSourcePlan;
|
|
305
|
+
};
|
|
306
|
+
}
|
|
192
307
|
/**
|
|
193
308
|
* Database column definition
|
|
194
309
|
* @export
|
|
@@ -561,23 +676,29 @@ export interface CreateConnection409Response {
|
|
|
561
676
|
'error'?: string;
|
|
562
677
|
}
|
|
563
678
|
/**
|
|
564
|
-
* Options for
|
|
679
|
+
* Options for starting a materialization. Auto-run by default; opt into the two-round control-plane-driven flow with pauseBetweenPhases.
|
|
565
680
|
* @export
|
|
566
681
|
* @interface CreateMaterializationRequest
|
|
567
682
|
*/
|
|
568
683
|
export interface CreateMaterializationRequest {
|
|
569
684
|
/**
|
|
570
|
-
*
|
|
685
|
+
* When false (default) the publisher runs all phases in one pass — self-assigns table names (the \"#@ persist name=\" value, else the source name), builds with realization=COPY, assembles the manifest, and auto-loads it into the package models. When true it pauses at BUILD_PLAN_READY for the control plane to send Round 2 build instructions.
|
|
571
686
|
* @type {boolean}
|
|
572
687
|
* @memberof CreateMaterializationRequest
|
|
573
688
|
*/
|
|
574
|
-
'
|
|
689
|
+
'pauseBetweenPhases'?: boolean;
|
|
575
690
|
/**
|
|
576
|
-
*
|
|
691
|
+
* Build a new table even when a source\'s buildId is unchanged.
|
|
577
692
|
* @type {boolean}
|
|
578
693
|
* @memberof CreateMaterializationRequest
|
|
579
694
|
*/
|
|
580
|
-
'
|
|
695
|
+
'forceRefresh'?: boolean;
|
|
696
|
+
/**
|
|
697
|
+
* Restrict the plan/build to these persist source names. Omit = all persist sources.
|
|
698
|
+
* @type {Array<string>}
|
|
699
|
+
* @memberof CreateMaterializationRequest
|
|
700
|
+
*/
|
|
701
|
+
'sourceNames'?: Array<string>;
|
|
581
702
|
}
|
|
582
703
|
/**
|
|
583
704
|
* Embedded database within a Malloy package
|
|
@@ -782,31 +903,6 @@ export interface Environment {
|
|
|
782
903
|
* @memberof Environment
|
|
783
904
|
*/
|
|
784
905
|
'packages'?: Array<Package>;
|
|
785
|
-
/**
|
|
786
|
-
*
|
|
787
|
-
* @type {EnvironmentMaterializationStorage}
|
|
788
|
-
* @memberof Environment
|
|
789
|
-
*/
|
|
790
|
-
'materializationStorage'?: EnvironmentMaterializationStorage;
|
|
791
|
-
}
|
|
792
|
-
/**
|
|
793
|
-
* 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.
|
|
794
|
-
* @export
|
|
795
|
-
* @interface EnvironmentMaterializationStorage
|
|
796
|
-
*/
|
|
797
|
-
export interface EnvironmentMaterializationStorage {
|
|
798
|
-
/**
|
|
799
|
-
* PostgreSQL connection URL for the DuckLake catalog metadata store
|
|
800
|
-
* @type {string}
|
|
801
|
-
* @memberof EnvironmentMaterializationStorage
|
|
802
|
-
*/
|
|
803
|
-
'catalogUrl'?: string;
|
|
804
|
-
/**
|
|
805
|
-
* Cloud storage path (s3:// or gs://) for DuckLake data files
|
|
806
|
-
* @type {string}
|
|
807
|
-
* @memberof EnvironmentMaterializationStorage
|
|
808
|
-
*/
|
|
809
|
-
'dataPath'?: string;
|
|
810
906
|
}
|
|
811
907
|
/**
|
|
812
908
|
* **DEPRECATED**: Use the `Given` schema (native Malloy runtime parameters) instead. See docs/givens.md for migration recipes. A filter declared via #(filter) annotation on a Malloy source.
|
|
@@ -986,20 +1082,56 @@ export interface LogMessageRangeStart {
|
|
|
986
1082
|
'character'?: number;
|
|
987
1083
|
}
|
|
988
1084
|
/**
|
|
989
|
-
* A single entry in the build manifest
|
|
1085
|
+
* A single entry in the build manifest.
|
|
990
1086
|
* @export
|
|
991
1087
|
* @interface ManifestEntry
|
|
992
1088
|
*/
|
|
993
1089
|
export interface ManifestEntry {
|
|
994
1090
|
/**
|
|
995
|
-
*
|
|
1091
|
+
*
|
|
1092
|
+
* @type {string}
|
|
1093
|
+
* @memberof ManifestEntry
|
|
1094
|
+
*/
|
|
1095
|
+
'buildId': string;
|
|
1096
|
+
/**
|
|
1097
|
+
*
|
|
1098
|
+
* @type {string}
|
|
1099
|
+
* @memberof ManifestEntry
|
|
1100
|
+
*/
|
|
1101
|
+
'sourceName'?: string;
|
|
1102
|
+
/**
|
|
1103
|
+
* Echoes the CP-assigned id from the BuildInstruction.
|
|
1104
|
+
* @type {string}
|
|
1105
|
+
* @memberof ManifestEntry
|
|
1106
|
+
*/
|
|
1107
|
+
'materializedTableId'?: string;
|
|
1108
|
+
/**
|
|
1109
|
+
* Name of the materialized table.
|
|
996
1110
|
* @type {string}
|
|
997
1111
|
* @memberof ManifestEntry
|
|
998
1112
|
*/
|
|
999
|
-
'
|
|
1113
|
+
'physicalTableName': string;
|
|
1114
|
+
/**
|
|
1115
|
+
*
|
|
1116
|
+
* @type {string}
|
|
1117
|
+
* @memberof ManifestEntry
|
|
1118
|
+
*/
|
|
1119
|
+
'connectionName'?: string;
|
|
1120
|
+
/**
|
|
1121
|
+
*
|
|
1122
|
+
* @type {Realization}
|
|
1123
|
+
* @memberof ManifestEntry
|
|
1124
|
+
*/
|
|
1125
|
+
'realization'?: Realization;
|
|
1126
|
+
/**
|
|
1127
|
+
*
|
|
1128
|
+
* @type {number}
|
|
1129
|
+
* @memberof ManifestEntry
|
|
1130
|
+
*/
|
|
1131
|
+
'rowCount'?: number | null;
|
|
1000
1132
|
}
|
|
1001
1133
|
/**
|
|
1002
|
-
* A record of a package
|
|
1134
|
+
* A record of one two-round materialization run for a package.
|
|
1003
1135
|
* @export
|
|
1004
1136
|
* @interface Materialization
|
|
1005
1137
|
*/
|
|
@@ -1022,12 +1154,30 @@ export interface Materialization {
|
|
|
1022
1154
|
* @memberof Materialization
|
|
1023
1155
|
*/
|
|
1024
1156
|
'packageName'?: string;
|
|
1157
|
+
/**
|
|
1158
|
+
* Echoes the create-time flag. False (default) = auto-run all phases; true = pause at BUILD_PLAN_READY for control-plane-driven Round 2.
|
|
1159
|
+
* @type {boolean}
|
|
1160
|
+
* @memberof Materialization
|
|
1161
|
+
*/
|
|
1162
|
+
'pauseBetweenPhases'?: boolean;
|
|
1025
1163
|
/**
|
|
1026
1164
|
*
|
|
1027
|
-
* @type {
|
|
1165
|
+
* @type {MaterializationStatus}
|
|
1028
1166
|
* @memberof Materialization
|
|
1029
1167
|
*/
|
|
1030
|
-
'status'?:
|
|
1168
|
+
'status'?: MaterializationStatus;
|
|
1169
|
+
/**
|
|
1170
|
+
*
|
|
1171
|
+
* @type {BuildPlan}
|
|
1172
|
+
* @memberof Materialization
|
|
1173
|
+
*/
|
|
1174
|
+
'buildPlan'?: BuildPlan | null;
|
|
1175
|
+
/**
|
|
1176
|
+
*
|
|
1177
|
+
* @type {BuildManifest}
|
|
1178
|
+
* @memberof Materialization
|
|
1179
|
+
*/
|
|
1180
|
+
'manifest'?: BuildManifest | null;
|
|
1031
1181
|
/**
|
|
1032
1182
|
*
|
|
1033
1183
|
* @type {string}
|
|
@@ -1065,14 +1215,20 @@ export interface Materialization {
|
|
|
1065
1215
|
*/
|
|
1066
1216
|
'updatedAt'?: string;
|
|
1067
1217
|
}
|
|
1068
|
-
|
|
1218
|
+
/**
|
|
1219
|
+
* Phase-aware status of a two-round materialization run.
|
|
1220
|
+
* @export
|
|
1221
|
+
* @enum {string}
|
|
1222
|
+
*/
|
|
1223
|
+
export declare const MaterializationStatus: {
|
|
1069
1224
|
readonly Pending: "PENDING";
|
|
1070
|
-
readonly
|
|
1071
|
-
readonly
|
|
1225
|
+
readonly BuildPlanReady: "BUILD_PLAN_READY";
|
|
1226
|
+
readonly ManifestRowsReady: "MANIFEST_ROWS_READY";
|
|
1227
|
+
readonly ManifestFileReady: "MANIFEST_FILE_READY";
|
|
1072
1228
|
readonly Failed: "FAILED";
|
|
1073
1229
|
readonly Cancelled: "CANCELLED";
|
|
1074
1230
|
};
|
|
1075
|
-
export type
|
|
1231
|
+
export type MaterializationStatus = typeof MaterializationStatus[keyof typeof MaterializationStatus];
|
|
1076
1232
|
/**
|
|
1077
1233
|
* Malloy model metadata and status information
|
|
1078
1234
|
* @export
|
|
@@ -1312,7 +1468,36 @@ export interface Package {
|
|
|
1312
1468
|
* @memberof Package
|
|
1313
1469
|
*/
|
|
1314
1470
|
'location'?: string;
|
|
1471
|
+
/**
|
|
1472
|
+
* Optional opt-in for curated discovery. When present, only these model file paths (relative to the package root) are listed via `listModels()`, and within-file discovery is filtered to each model\'s `export {}` closure. When absent or empty, every model is listed with its full source set (backward-compatible). Every other .malloy file still compiles for import/join resolution but is hidden from listings once `explores` is declared. Notebooks are always listed regardless of this field.
|
|
1473
|
+
* @type {Array<string>}
|
|
1474
|
+
* @memberof Package
|
|
1475
|
+
*/
|
|
1476
|
+
'explores'?: Array<string>;
|
|
1477
|
+
/**
|
|
1478
|
+
* Actionable messages for declared explores that do not resolve to a real model in this package (e.g. a misspelled path, or a notebook listed as an explore). Server-computed and read-only: it is ignored on create/update requests and only ever returned in responses. Present only when there are such problems. Loading is fail-safe — the unresolved entry simply lists nothing rather than exposing everything — so this is the signal that a package is misconfigured; publishing such a package is rejected.
|
|
1479
|
+
* @type {Array<string>}
|
|
1480
|
+
* @memberof Package
|
|
1481
|
+
*/
|
|
1482
|
+
'exploresWarnings'?: Array<string>;
|
|
1483
|
+
/**
|
|
1484
|
+
* Controls whether the discovery surface is also a query boundary. `\"declared\"` (the default) makes queryable == discoverable: when `explores` is declared, only `explores` model files — and within them only the `export {}` closure — are valid top-level query targets; every other source still compiles, imports, joins, and extends but is not directly queryable (denied with 404). `\"all\"` decouples them: `explores`/`export {}` gate discovery only and every compiled source stays directly queryable. When `explores` is absent there is no curated surface, so both modes are equivalent (everything queryable). Invalid values fall back to `\"declared\"`. Identity-based access is a separate concern — see `#(authorize)`.
|
|
1485
|
+
* @type {string}
|
|
1486
|
+
* @memberof Package
|
|
1487
|
+
*/
|
|
1488
|
+
'queryableSources'?: PackageQueryableSourcesEnum;
|
|
1489
|
+
/**
|
|
1490
|
+
* URI (gs:// or s3://) of the control-plane-computed manifest for this package. On (re)load the worker reads it and binds persist references (buildId -> physicalTableName). Null = serve live.
|
|
1491
|
+
* @type {string}
|
|
1492
|
+
* @memberof Package
|
|
1493
|
+
*/
|
|
1494
|
+
'manifestLocation'?: string | null;
|
|
1315
1495
|
}
|
|
1496
|
+
export declare const PackageQueryableSourcesEnum: {
|
|
1497
|
+
readonly Declared: "declared";
|
|
1498
|
+
readonly All: "all";
|
|
1499
|
+
};
|
|
1500
|
+
export type PackageQueryableSourcesEnum = typeof PackageQueryableSourcesEnum[keyof typeof PackageQueryableSourcesEnum];
|
|
1316
1501
|
/**
|
|
1317
1502
|
* Static HTML page (in-package data app) within a Malloy package
|
|
1318
1503
|
* @export
|
|
@@ -1344,6 +1529,55 @@ export interface Page {
|
|
|
1344
1529
|
*/
|
|
1345
1530
|
'title'?: string;
|
|
1346
1531
|
}
|
|
1532
|
+
/**
|
|
1533
|
+
*
|
|
1534
|
+
* @export
|
|
1535
|
+
* @interface PersistSourcePlan
|
|
1536
|
+
*/
|
|
1537
|
+
export interface PersistSourcePlan {
|
|
1538
|
+
/**
|
|
1539
|
+
*
|
|
1540
|
+
* @type {string}
|
|
1541
|
+
* @memberof PersistSourcePlan
|
|
1542
|
+
*/
|
|
1543
|
+
'name': string;
|
|
1544
|
+
/**
|
|
1545
|
+
*
|
|
1546
|
+
* @type {string}
|
|
1547
|
+
* @memberof PersistSourcePlan
|
|
1548
|
+
*/
|
|
1549
|
+
'sourceID': string;
|
|
1550
|
+
/**
|
|
1551
|
+
*
|
|
1552
|
+
* @type {string}
|
|
1553
|
+
* @memberof PersistSourcePlan
|
|
1554
|
+
*/
|
|
1555
|
+
'connectionName': string;
|
|
1556
|
+
/**
|
|
1557
|
+
*
|
|
1558
|
+
* @type {string}
|
|
1559
|
+
* @memberof PersistSourcePlan
|
|
1560
|
+
*/
|
|
1561
|
+
'dialect'?: string;
|
|
1562
|
+
/**
|
|
1563
|
+
* hash(connectionDigest + canonical logical SQL).
|
|
1564
|
+
* @type {string}
|
|
1565
|
+
* @memberof PersistSourcePlan
|
|
1566
|
+
*/
|
|
1567
|
+
'buildId': string;
|
|
1568
|
+
/**
|
|
1569
|
+
* The source\'s build SQL (with the build manifest applied for upstream rewrites).
|
|
1570
|
+
* @type {string}
|
|
1571
|
+
* @memberof PersistSourcePlan
|
|
1572
|
+
*/
|
|
1573
|
+
'sql': string;
|
|
1574
|
+
/**
|
|
1575
|
+
* Output schema of the source.
|
|
1576
|
+
* @type {Array<Column>}
|
|
1577
|
+
* @memberof PersistSourcePlan
|
|
1578
|
+
*/
|
|
1579
|
+
'columns': Array<Column>;
|
|
1580
|
+
}
|
|
1347
1581
|
/**
|
|
1348
1582
|
*
|
|
1349
1583
|
* @export
|
|
@@ -1598,6 +1832,16 @@ export interface RawNotebook {
|
|
|
1598
1832
|
*/
|
|
1599
1833
|
'sources'?: Array<Source>;
|
|
1600
1834
|
}
|
|
1835
|
+
/**
|
|
1836
|
+
* SNAPSHOT = warehouse clone/snapshot; COPY = CREATE TABLE AS SELECT.
|
|
1837
|
+
* @export
|
|
1838
|
+
* @enum {string}
|
|
1839
|
+
*/
|
|
1840
|
+
export declare const Realization: {
|
|
1841
|
+
readonly Snapshot: "SNAPSHOT";
|
|
1842
|
+
readonly Copy: "COPY";
|
|
1843
|
+
};
|
|
1844
|
+
export type Realization = typeof Realization[keyof typeof Realization];
|
|
1601
1845
|
/**
|
|
1602
1846
|
* AWS S3 connection configuration for DuckDB
|
|
1603
1847
|
* @export
|
|
@@ -1902,31 +2146,6 @@ export interface TableDescription {
|
|
|
1902
2146
|
*/
|
|
1903
2147
|
'columns'?: Array<Column>;
|
|
1904
2148
|
}
|
|
1905
|
-
/**
|
|
1906
|
-
*
|
|
1907
|
-
* @export
|
|
1908
|
-
* @interface TableSource
|
|
1909
|
-
*/
|
|
1910
|
-
export interface TableSource {
|
|
1911
|
-
/**
|
|
1912
|
-
* Resource path to the table source.
|
|
1913
|
-
* @type {string}
|
|
1914
|
-
* @memberof TableSource
|
|
1915
|
-
*/
|
|
1916
|
-
'resource'?: string;
|
|
1917
|
-
/**
|
|
1918
|
-
*
|
|
1919
|
-
* @type {string}
|
|
1920
|
-
* @memberof TableSource
|
|
1921
|
-
*/
|
|
1922
|
-
'source'?: string;
|
|
1923
|
-
/**
|
|
1924
|
-
* Table fields
|
|
1925
|
-
* @type {Array<Column>}
|
|
1926
|
-
* @memberof TableSource
|
|
1927
|
-
*/
|
|
1928
|
-
'columns'?: Array<Column>;
|
|
1929
|
-
}
|
|
1930
2149
|
/**
|
|
1931
2150
|
*
|
|
1932
2151
|
* @export
|
|
@@ -2133,29 +2352,6 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2133
2352
|
* @throws {RequiredError}
|
|
2134
2353
|
*/
|
|
2135
2354
|
getConnection: (environmentName: string, connectionName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2136
|
-
/**
|
|
2137
|
-
* **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.
|
|
2138
|
-
* @summary Get SQL source (deprecated)
|
|
2139
|
-
* @param {string} environmentName Name of the environment
|
|
2140
|
-
* @param {string} connectionName Name of the connection
|
|
2141
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2142
|
-
* @param {*} [options] Override http request option.
|
|
2143
|
-
* @deprecated
|
|
2144
|
-
* @throws {RequiredError}
|
|
2145
|
-
*/
|
|
2146
|
-
getSqlsource: (environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2147
|
-
/**
|
|
2148
|
-
* **DEPRECATED**: Use the POST version instead. Creates a Malloy source from a SQL statement using the specified connection, resolved in the context of the named package.
|
|
2149
|
-
* @summary Get SQL source (per-package, deprecated)
|
|
2150
|
-
* @param {string} environmentName Name of the environment
|
|
2151
|
-
* @param {string} packageName Name of the package whose connection context to use
|
|
2152
|
-
* @param {string} connectionName Name of the connection
|
|
2153
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2154
|
-
* @param {*} [options] Override http request option.
|
|
2155
|
-
* @deprecated
|
|
2156
|
-
* @throws {RequiredError}
|
|
2157
|
-
*/
|
|
2158
|
-
getSqlsourceInPackage: (environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2159
2355
|
/**
|
|
2160
2356
|
* 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.
|
|
2161
2357
|
* @summary Get table details from database
|
|
@@ -2179,29 +2375,6 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2179
2375
|
* @throws {RequiredError}
|
|
2180
2376
|
*/
|
|
2181
2377
|
getTableInPackage: (environmentName: string, packageName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2182
|
-
/**
|
|
2183
|
-
* **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.
|
|
2184
|
-
* @summary Create temporary table (deprecated)
|
|
2185
|
-
* @param {string} environmentName Name of the environment
|
|
2186
|
-
* @param {string} connectionName Name of the connection
|
|
2187
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2188
|
-
* @param {*} [options] Override http request option.
|
|
2189
|
-
* @deprecated
|
|
2190
|
-
* @throws {RequiredError}
|
|
2191
|
-
*/
|
|
2192
|
-
getTemporarytable: (environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2193
|
-
/**
|
|
2194
|
-
* **DEPRECATED**: Use the POST version instead. Creates a temporary table from a SQL statement using the specified connection, resolved in the context of the named package.
|
|
2195
|
-
* @summary Create temporary table (per-package, deprecated)
|
|
2196
|
-
* @param {string} environmentName Name of the environment
|
|
2197
|
-
* @param {string} packageName Name of the package whose connection context to use
|
|
2198
|
-
* @param {string} connectionName Name of the connection
|
|
2199
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2200
|
-
* @param {*} [options] Override http request option.
|
|
2201
|
-
* @deprecated
|
|
2202
|
-
* @throws {RequiredError}
|
|
2203
|
-
*/
|
|
2204
|
-
getTemporarytableInPackage: (environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2205
2378
|
/**
|
|
2206
2379
|
* Retrieves a list of all database connections configured for the specified environment. Each connection includes its configuration, type, and status information. This endpoint is useful for discovering available data sources within an environment.
|
|
2207
2380
|
* @summary List environment database connections
|
|
@@ -2258,11 +2431,10 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2258
2431
|
* @param {string} environmentName Name of the environment
|
|
2259
2432
|
* @param {string} connectionName Name of the connection
|
|
2260
2433
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2261
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2262
2434
|
* @param {*} [options] Override http request option.
|
|
2263
2435
|
* @throws {RequiredError}
|
|
2264
2436
|
*/
|
|
2265
|
-
postQuerydata: (environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2437
|
+
postQuerydata: (environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2266
2438
|
/**
|
|
2267
2439
|
* Executes a SQL statement against the specified database connection, resolved in the context of the named package, and returns the results. Subject to the same PUBLISHER_MAX_QUERY_ROWS row cap as the environment-level sqlQuery endpoint.
|
|
2268
2440
|
* @summary Execute SQL query (per-package)
|
|
@@ -2270,11 +2442,10 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2270
2442
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2271
2443
|
* @param {string} connectionName Name of the connection
|
|
2272
2444
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2273
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2274
2445
|
* @param {*} [options] Override http request option.
|
|
2275
2446
|
* @throws {RequiredError}
|
|
2276
2447
|
*/
|
|
2277
|
-
postQuerydataInPackage: (environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2448
|
+
postQuerydataInPackage: (environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2278
2449
|
/**
|
|
2279
2450
|
* 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.
|
|
2280
2451
|
* @summary Create SQL source from statement
|
|
@@ -2361,29 +2532,6 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2361
2532
|
* @throws {RequiredError}
|
|
2362
2533
|
*/
|
|
2363
2534
|
getConnection(environmentName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Connection>>;
|
|
2364
|
-
/**
|
|
2365
|
-
* **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.
|
|
2366
|
-
* @summary Get SQL source (deprecated)
|
|
2367
|
-
* @param {string} environmentName Name of the environment
|
|
2368
|
-
* @param {string} connectionName Name of the connection
|
|
2369
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2370
|
-
* @param {*} [options] Override http request option.
|
|
2371
|
-
* @deprecated
|
|
2372
|
-
* @throws {RequiredError}
|
|
2373
|
-
*/
|
|
2374
|
-
getSqlsource(environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SqlSource>>;
|
|
2375
|
-
/**
|
|
2376
|
-
* **DEPRECATED**: Use the POST version instead. Creates a Malloy source from a SQL statement using the specified connection, resolved in the context of the named package.
|
|
2377
|
-
* @summary Get SQL source (per-package, deprecated)
|
|
2378
|
-
* @param {string} environmentName Name of the environment
|
|
2379
|
-
* @param {string} packageName Name of the package whose connection context to use
|
|
2380
|
-
* @param {string} connectionName Name of the connection
|
|
2381
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2382
|
-
* @param {*} [options] Override http request option.
|
|
2383
|
-
* @deprecated
|
|
2384
|
-
* @throws {RequiredError}
|
|
2385
|
-
*/
|
|
2386
|
-
getSqlsourceInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SqlSource>>;
|
|
2387
2535
|
/**
|
|
2388
2536
|
* 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.
|
|
2389
2537
|
* @summary Get table details from database
|
|
@@ -2407,29 +2555,6 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2407
2555
|
* @throws {RequiredError}
|
|
2408
2556
|
*/
|
|
2409
2557
|
getTableInPackage(environmentName: string, packageName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Table>>;
|
|
2410
|
-
/**
|
|
2411
|
-
* **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.
|
|
2412
|
-
* @summary Create temporary table (deprecated)
|
|
2413
|
-
* @param {string} environmentName Name of the environment
|
|
2414
|
-
* @param {string} connectionName Name of the connection
|
|
2415
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2416
|
-
* @param {*} [options] Override http request option.
|
|
2417
|
-
* @deprecated
|
|
2418
|
-
* @throws {RequiredError}
|
|
2419
|
-
*/
|
|
2420
|
-
getTemporarytable(environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemporaryTable>>;
|
|
2421
|
-
/**
|
|
2422
|
-
* **DEPRECATED**: Use the POST version instead. Creates a temporary table from a SQL statement using the specified connection, resolved in the context of the named package.
|
|
2423
|
-
* @summary Create temporary table (per-package, deprecated)
|
|
2424
|
-
* @param {string} environmentName Name of the environment
|
|
2425
|
-
* @param {string} packageName Name of the package whose connection context to use
|
|
2426
|
-
* @param {string} connectionName Name of the connection
|
|
2427
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2428
|
-
* @param {*} [options] Override http request option.
|
|
2429
|
-
* @deprecated
|
|
2430
|
-
* @throws {RequiredError}
|
|
2431
|
-
*/
|
|
2432
|
-
getTemporarytableInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemporaryTable>>;
|
|
2433
2558
|
/**
|
|
2434
2559
|
* Retrieves a list of all database connections configured for the specified environment. Each connection includes its configuration, type, and status information. This endpoint is useful for discovering available data sources within an environment.
|
|
2435
2560
|
* @summary List environment database connections
|
|
@@ -2486,11 +2611,10 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2486
2611
|
* @param {string} environmentName Name of the environment
|
|
2487
2612
|
* @param {string} connectionName Name of the connection
|
|
2488
2613
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2489
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2490
2614
|
* @param {*} [options] Override http request option.
|
|
2491
2615
|
* @throws {RequiredError}
|
|
2492
2616
|
*/
|
|
2493
|
-
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2617
|
+
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryData>>;
|
|
2494
2618
|
/**
|
|
2495
2619
|
* Executes a SQL statement against the specified database connection, resolved in the context of the named package, and returns the results. Subject to the same PUBLISHER_MAX_QUERY_ROWS row cap as the environment-level sqlQuery endpoint.
|
|
2496
2620
|
* @summary Execute SQL query (per-package)
|
|
@@ -2498,11 +2622,10 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2498
2622
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2499
2623
|
* @param {string} connectionName Name of the connection
|
|
2500
2624
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2501
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2502
2625
|
* @param {*} [options] Override http request option.
|
|
2503
2626
|
* @throws {RequiredError}
|
|
2504
2627
|
*/
|
|
2505
|
-
postQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2628
|
+
postQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryData>>;
|
|
2506
2629
|
/**
|
|
2507
2630
|
* 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.
|
|
2508
2631
|
* @summary Create SQL source from statement
|
|
@@ -2589,29 +2712,6 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2589
2712
|
* @throws {RequiredError}
|
|
2590
2713
|
*/
|
|
2591
2714
|
getConnection(environmentName: string, connectionName: string, options?: RawAxiosRequestConfig): AxiosPromise<Connection>;
|
|
2592
|
-
/**
|
|
2593
|
-
* **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.
|
|
2594
|
-
* @summary Get SQL source (deprecated)
|
|
2595
|
-
* @param {string} environmentName Name of the environment
|
|
2596
|
-
* @param {string} connectionName Name of the connection
|
|
2597
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2598
|
-
* @param {*} [options] Override http request option.
|
|
2599
|
-
* @deprecated
|
|
2600
|
-
* @throws {RequiredError}
|
|
2601
|
-
*/
|
|
2602
|
-
getSqlsource(environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<SqlSource>;
|
|
2603
|
-
/**
|
|
2604
|
-
* **DEPRECATED**: Use the POST version instead. Creates a Malloy source from a SQL statement using the specified connection, resolved in the context of the named package.
|
|
2605
|
-
* @summary Get SQL source (per-package, deprecated)
|
|
2606
|
-
* @param {string} environmentName Name of the environment
|
|
2607
|
-
* @param {string} packageName Name of the package whose connection context to use
|
|
2608
|
-
* @param {string} connectionName Name of the connection
|
|
2609
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2610
|
-
* @param {*} [options] Override http request option.
|
|
2611
|
-
* @deprecated
|
|
2612
|
-
* @throws {RequiredError}
|
|
2613
|
-
*/
|
|
2614
|
-
getSqlsourceInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<SqlSource>;
|
|
2615
2715
|
/**
|
|
2616
2716
|
* 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.
|
|
2617
2717
|
* @summary Get table details from database
|
|
@@ -2635,29 +2735,6 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2635
2735
|
* @throws {RequiredError}
|
|
2636
2736
|
*/
|
|
2637
2737
|
getTableInPackage(environmentName: string, packageName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): AxiosPromise<Table>;
|
|
2638
|
-
/**
|
|
2639
|
-
* **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.
|
|
2640
|
-
* @summary Create temporary table (deprecated)
|
|
2641
|
-
* @param {string} environmentName Name of the environment
|
|
2642
|
-
* @param {string} connectionName Name of the connection
|
|
2643
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2644
|
-
* @param {*} [options] Override http request option.
|
|
2645
|
-
* @deprecated
|
|
2646
|
-
* @throws {RequiredError}
|
|
2647
|
-
*/
|
|
2648
|
-
getTemporarytable(environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<TemporaryTable>;
|
|
2649
|
-
/**
|
|
2650
|
-
* **DEPRECATED**: Use the POST version instead. Creates a temporary table from a SQL statement using the specified connection, resolved in the context of the named package.
|
|
2651
|
-
* @summary Create temporary table (per-package, deprecated)
|
|
2652
|
-
* @param {string} environmentName Name of the environment
|
|
2653
|
-
* @param {string} packageName Name of the package whose connection context to use
|
|
2654
|
-
* @param {string} connectionName Name of the connection
|
|
2655
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2656
|
-
* @param {*} [options] Override http request option.
|
|
2657
|
-
* @deprecated
|
|
2658
|
-
* @throws {RequiredError}
|
|
2659
|
-
*/
|
|
2660
|
-
getTemporarytableInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<TemporaryTable>;
|
|
2661
2738
|
/**
|
|
2662
2739
|
* Retrieves a list of all database connections configured for the specified environment. Each connection includes its configuration, type, and status information. This endpoint is useful for discovering available data sources within an environment.
|
|
2663
2740
|
* @summary List environment database connections
|
|
@@ -2714,11 +2791,10 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2714
2791
|
* @param {string} environmentName Name of the environment
|
|
2715
2792
|
* @param {string} connectionName Name of the connection
|
|
2716
2793
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2717
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2718
2794
|
* @param {*} [options] Override http request option.
|
|
2719
2795
|
* @throws {RequiredError}
|
|
2720
2796
|
*/
|
|
2721
|
-
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2797
|
+
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): AxiosPromise<QueryData>;
|
|
2722
2798
|
/**
|
|
2723
2799
|
* Executes a SQL statement against the specified database connection, resolved in the context of the named package, and returns the results. Subject to the same PUBLISHER_MAX_QUERY_ROWS row cap as the environment-level sqlQuery endpoint.
|
|
2724
2800
|
* @summary Execute SQL query (per-package)
|
|
@@ -2726,11 +2802,10 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2726
2802
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2727
2803
|
* @param {string} connectionName Name of the connection
|
|
2728
2804
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2729
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2730
2805
|
* @param {*} [options] Override http request option.
|
|
2731
2806
|
* @throws {RequiredError}
|
|
2732
2807
|
*/
|
|
2733
|
-
postQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2808
|
+
postQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): AxiosPromise<QueryData>;
|
|
2734
2809
|
/**
|
|
2735
2810
|
* 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.
|
|
2736
2811
|
* @summary Create SQL source from statement
|
|
@@ -2822,31 +2897,6 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2822
2897
|
* @memberof ConnectionsApi
|
|
2823
2898
|
*/
|
|
2824
2899
|
getConnection(environmentName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Connection, any, {}>>;
|
|
2825
|
-
/**
|
|
2826
|
-
* **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.
|
|
2827
|
-
* @summary Get SQL source (deprecated)
|
|
2828
|
-
* @param {string} environmentName Name of the environment
|
|
2829
|
-
* @param {string} connectionName Name of the connection
|
|
2830
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2831
|
-
* @param {*} [options] Override http request option.
|
|
2832
|
-
* @deprecated
|
|
2833
|
-
* @throws {RequiredError}
|
|
2834
|
-
* @memberof ConnectionsApi
|
|
2835
|
-
*/
|
|
2836
|
-
getSqlsource(environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<SqlSource, any, {}>>;
|
|
2837
|
-
/**
|
|
2838
|
-
* **DEPRECATED**: Use the POST version instead. Creates a Malloy source from a SQL statement using the specified connection, resolved in the context of the named package.
|
|
2839
|
-
* @summary Get SQL source (per-package, deprecated)
|
|
2840
|
-
* @param {string} environmentName Name of the environment
|
|
2841
|
-
* @param {string} packageName Name of the package whose connection context to use
|
|
2842
|
-
* @param {string} connectionName Name of the connection
|
|
2843
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2844
|
-
* @param {*} [options] Override http request option.
|
|
2845
|
-
* @deprecated
|
|
2846
|
-
* @throws {RequiredError}
|
|
2847
|
-
* @memberof ConnectionsApi
|
|
2848
|
-
*/
|
|
2849
|
-
getSqlsourceInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<SqlSource, any, {}>>;
|
|
2850
2900
|
/**
|
|
2851
2901
|
* 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.
|
|
2852
2902
|
* @summary Get table details from database
|
|
@@ -2872,31 +2922,6 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2872
2922
|
* @memberof ConnectionsApi
|
|
2873
2923
|
*/
|
|
2874
2924
|
getTableInPackage(environmentName: string, packageName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Table, any, {}>>;
|
|
2875
|
-
/**
|
|
2876
|
-
* **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.
|
|
2877
|
-
* @summary Create temporary table (deprecated)
|
|
2878
|
-
* @param {string} environmentName Name of the environment
|
|
2879
|
-
* @param {string} connectionName Name of the connection
|
|
2880
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2881
|
-
* @param {*} [options] Override http request option.
|
|
2882
|
-
* @deprecated
|
|
2883
|
-
* @throws {RequiredError}
|
|
2884
|
-
* @memberof ConnectionsApi
|
|
2885
|
-
*/
|
|
2886
|
-
getTemporarytable(environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<TemporaryTable, any, {}>>;
|
|
2887
|
-
/**
|
|
2888
|
-
* **DEPRECATED**: Use the POST version instead. Creates a temporary table from a SQL statement using the specified connection, resolved in the context of the named package.
|
|
2889
|
-
* @summary Create temporary table (per-package, deprecated)
|
|
2890
|
-
* @param {string} environmentName Name of the environment
|
|
2891
|
-
* @param {string} packageName Name of the package whose connection context to use
|
|
2892
|
-
* @param {string} connectionName Name of the connection
|
|
2893
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2894
|
-
* @param {*} [options] Override http request option.
|
|
2895
|
-
* @deprecated
|
|
2896
|
-
* @throws {RequiredError}
|
|
2897
|
-
* @memberof ConnectionsApi
|
|
2898
|
-
*/
|
|
2899
|
-
getTemporarytableInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<TemporaryTable, any, {}>>;
|
|
2900
2925
|
/**
|
|
2901
2926
|
* Retrieves a list of all database connections configured for the specified environment. Each connection includes its configuration, type, and status information. This endpoint is useful for discovering available data sources within an environment.
|
|
2902
2927
|
* @summary List environment database connections
|
|
@@ -2958,12 +2983,11 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2958
2983
|
* @param {string} environmentName Name of the environment
|
|
2959
2984
|
* @param {string} connectionName Name of the connection
|
|
2960
2985
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2961
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2962
2986
|
* @param {*} [options] Override http request option.
|
|
2963
2987
|
* @throws {RequiredError}
|
|
2964
2988
|
* @memberof ConnectionsApi
|
|
2965
2989
|
*/
|
|
2966
|
-
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2990
|
+
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<QueryData, any, {}>>;
|
|
2967
2991
|
/**
|
|
2968
2992
|
* Executes a SQL statement against the specified database connection, resolved in the context of the named package, and returns the results. Subject to the same PUBLISHER_MAX_QUERY_ROWS row cap as the environment-level sqlQuery endpoint.
|
|
2969
2993
|
* @summary Execute SQL query (per-package)
|
|
@@ -2971,12 +2995,11 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2971
2995
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2972
2996
|
* @param {string} connectionName Name of the connection
|
|
2973
2997
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2974
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2975
2998
|
* @param {*} [options] Override http request option.
|
|
2976
2999
|
* @throws {RequiredError}
|
|
2977
3000
|
* @memberof ConnectionsApi
|
|
2978
3001
|
*/
|
|
2979
|
-
postQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
3002
|
+
postQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<QueryData, any, {}>>;
|
|
2980
3003
|
/**
|
|
2981
3004
|
* 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.
|
|
2982
3005
|
* @summary Create SQL source from statement
|
|
@@ -3356,125 +3379,14 @@ export declare class EnvironmentsApi extends BaseAPI {
|
|
|
3356
3379
|
*/
|
|
3357
3380
|
updateEnvironment(environmentName: string, environment: Environment, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Environment, any, {}>>;
|
|
3358
3381
|
}
|
|
3359
|
-
/**
|
|
3360
|
-
* ManifestsApi - axios parameter creator
|
|
3361
|
-
* @export
|
|
3362
|
-
*/
|
|
3363
|
-
export declare const ManifestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3364
|
-
/**
|
|
3365
|
-
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
3366
|
-
* @summary Get the build manifest for a package
|
|
3367
|
-
* @param {string} environmentName Name of the environment
|
|
3368
|
-
* @param {string} packageName Name of the package
|
|
3369
|
-
* @param {*} [options] Override http request option.
|
|
3370
|
-
* @throws {RequiredError}
|
|
3371
|
-
*/
|
|
3372
|
-
getManifest: (environmentName: string, packageName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3373
|
-
/**
|
|
3374
|
-
* 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.
|
|
3375
|
-
* @summary Perform an action on the package manifest
|
|
3376
|
-
* @param {string} environmentName Name of the environment
|
|
3377
|
-
* @param {string} packageName Name of the package
|
|
3378
|
-
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
3379
|
-
* @param {*} [options] Override http request option.
|
|
3380
|
-
* @throws {RequiredError}
|
|
3381
|
-
*/
|
|
3382
|
-
manifestAction: (environmentName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3383
|
-
};
|
|
3384
|
-
/**
|
|
3385
|
-
* ManifestsApi - functional programming interface
|
|
3386
|
-
* @export
|
|
3387
|
-
*/
|
|
3388
|
-
export declare const ManifestsApiFp: (configuration?: Configuration) => {
|
|
3389
|
-
/**
|
|
3390
|
-
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
3391
|
-
* @summary Get the build manifest for a package
|
|
3392
|
-
* @param {string} environmentName Name of the environment
|
|
3393
|
-
* @param {string} packageName Name of the package
|
|
3394
|
-
* @param {*} [options] Override http request option.
|
|
3395
|
-
* @throws {RequiredError}
|
|
3396
|
-
*/
|
|
3397
|
-
getManifest(environmentName: string, packageName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BuildManifest>>;
|
|
3398
|
-
/**
|
|
3399
|
-
* 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.
|
|
3400
|
-
* @summary Perform an action on the package manifest
|
|
3401
|
-
* @param {string} environmentName Name of the environment
|
|
3402
|
-
* @param {string} packageName Name of the package
|
|
3403
|
-
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
3404
|
-
* @param {*} [options] Override http request option.
|
|
3405
|
-
* @throws {RequiredError}
|
|
3406
|
-
*/
|
|
3407
|
-
manifestAction(environmentName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BuildManifest>>;
|
|
3408
|
-
};
|
|
3409
|
-
/**
|
|
3410
|
-
* ManifestsApi - factory interface
|
|
3411
|
-
* @export
|
|
3412
|
-
*/
|
|
3413
|
-
export declare const ManifestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3414
|
-
/**
|
|
3415
|
-
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
3416
|
-
* @summary Get the build manifest for a package
|
|
3417
|
-
* @param {string} environmentName Name of the environment
|
|
3418
|
-
* @param {string} packageName Name of the package
|
|
3419
|
-
* @param {*} [options] Override http request option.
|
|
3420
|
-
* @throws {RequiredError}
|
|
3421
|
-
*/
|
|
3422
|
-
getManifest(environmentName: string, packageName: string, options?: RawAxiosRequestConfig): AxiosPromise<BuildManifest>;
|
|
3423
|
-
/**
|
|
3424
|
-
* 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.
|
|
3425
|
-
* @summary Perform an action on the package manifest
|
|
3426
|
-
* @param {string} environmentName Name of the environment
|
|
3427
|
-
* @param {string} packageName Name of the package
|
|
3428
|
-
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
3429
|
-
* @param {*} [options] Override http request option.
|
|
3430
|
-
* @throws {RequiredError}
|
|
3431
|
-
*/
|
|
3432
|
-
manifestAction(environmentName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig): AxiosPromise<BuildManifest>;
|
|
3433
|
-
};
|
|
3434
|
-
/**
|
|
3435
|
-
* ManifestsApi - object-oriented interface
|
|
3436
|
-
* @export
|
|
3437
|
-
* @class ManifestsApi
|
|
3438
|
-
* @extends {BaseAPI}
|
|
3439
|
-
*/
|
|
3440
|
-
export declare class ManifestsApi extends BaseAPI {
|
|
3441
|
-
/**
|
|
3442
|
-
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
3443
|
-
* @summary Get the build manifest for a package
|
|
3444
|
-
* @param {string} environmentName Name of the environment
|
|
3445
|
-
* @param {string} packageName Name of the package
|
|
3446
|
-
* @param {*} [options] Override http request option.
|
|
3447
|
-
* @throws {RequiredError}
|
|
3448
|
-
* @memberof ManifestsApi
|
|
3449
|
-
*/
|
|
3450
|
-
getManifest(environmentName: string, packageName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<BuildManifest, any, {}>>;
|
|
3451
|
-
/**
|
|
3452
|
-
* 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.
|
|
3453
|
-
* @summary Perform an action on the package manifest
|
|
3454
|
-
* @param {string} environmentName Name of the environment
|
|
3455
|
-
* @param {string} packageName Name of the package
|
|
3456
|
-
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
3457
|
-
* @param {*} [options] Override http request option.
|
|
3458
|
-
* @throws {RequiredError}
|
|
3459
|
-
* @memberof ManifestsApi
|
|
3460
|
-
*/
|
|
3461
|
-
manifestAction(environmentName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig): Promise< AxiosResponse<BuildManifest, any, {}>>;
|
|
3462
|
-
}
|
|
3463
|
-
/**
|
|
3464
|
-
* @export
|
|
3465
|
-
*/
|
|
3466
|
-
export declare const ManifestActionActionEnum: {
|
|
3467
|
-
readonly Reload: "reload";
|
|
3468
|
-
};
|
|
3469
|
-
export type ManifestActionActionEnum = typeof ManifestActionActionEnum[keyof typeof ManifestActionActionEnum];
|
|
3470
3382
|
/**
|
|
3471
3383
|
* MaterializationsApi - axios parameter creator
|
|
3472
3384
|
* @export
|
|
3473
3385
|
*/
|
|
3474
3386
|
export declare const MaterializationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3475
3387
|
/**
|
|
3476
|
-
*
|
|
3477
|
-
* @summary Create a materialization
|
|
3388
|
+
* Starts Round 1 of the two-round build protocol: asynchronously compiles the package, computes a build plan (per-source buildId, output columns, dependency/column lineage, connection capability), and pauses at BUILD_PLAN_READY without writing any tables. The control plane then issues Round 2 via POST .../materializations/{materializationId}?action=build with build instructions.
|
|
3389
|
+
* @summary Create a materialization (Round 1)
|
|
3478
3390
|
* @param {string} environmentName Name of the environment
|
|
3479
3391
|
* @param {string} packageName Name of the package
|
|
3480
3392
|
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
@@ -3483,15 +3395,16 @@ export declare const MaterializationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
3483
3395
|
*/
|
|
3484
3396
|
createMaterialization: (environmentName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3485
3397
|
/**
|
|
3486
|
-
* Deletes a terminal (
|
|
3398
|
+
* Deletes a terminal (MANIFEST_FILE_READY, FAILED, or CANCELLED) materialization record. By default this removes the publisher\'s record only; the control plane owns table GC. Set dropTables=true to also drop the physical tables this run produced (from the materialization\'s manifest) as a best-effort cleanup.
|
|
3487
3399
|
* @summary Delete a materialization
|
|
3488
3400
|
* @param {string} environmentName Name of the environment
|
|
3489
3401
|
* @param {string} packageName Name of the package
|
|
3490
3402
|
* @param {string} materializationId ID of the materialization
|
|
3403
|
+
* @param {boolean} [dropTables] When true, also drop the physical tables recorded in the materialization\'s manifest before deleting the record. Defaults to false (record-only delete; the control plane owns table GC).
|
|
3491
3404
|
* @param {*} [options] Override http request option.
|
|
3492
3405
|
* @throws {RequiredError}
|
|
3493
3406
|
*/
|
|
3494
|
-
deleteMaterialization: (environmentName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3407
|
+
deleteMaterialization: (environmentName: string, packageName: string, materializationId: string, dropTables?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3495
3408
|
/**
|
|
3496
3409
|
*
|
|
3497
3410
|
* @summary Get a specific materialization
|
|
@@ -3514,16 +3427,17 @@ export declare const MaterializationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
3514
3427
|
*/
|
|
3515
3428
|
listMaterializations: (environmentName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3516
3429
|
/**
|
|
3517
|
-
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `
|
|
3430
|
+
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `build` - Round 2. Provide BuildInstructions (CP-assigned table id, physical table name, and realization per source). Builds only the instructed sources into the exact names provided and assembles the manifest. Valid only when the materialization is at BUILD_PLAN_READY. Returns 202. * `stop` - Cancels a PENDING, BUILD_PLAN_READY, or building materialization. Returns 200.
|
|
3518
3431
|
* @summary Perform an action on a materialization
|
|
3519
3432
|
* @param {string} environmentName Name of the environment
|
|
3520
3433
|
* @param {string} packageName Name of the package
|
|
3521
3434
|
* @param {string} materializationId ID of the materialization
|
|
3522
3435
|
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
3436
|
+
* @param {BuildInstructions} [buildInstructions]
|
|
3523
3437
|
* @param {*} [options] Override http request option.
|
|
3524
3438
|
* @throws {RequiredError}
|
|
3525
3439
|
*/
|
|
3526
|
-
materializationAction: (environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3440
|
+
materializationAction: (environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, buildInstructions?: BuildInstructions, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3527
3441
|
};
|
|
3528
3442
|
/**
|
|
3529
3443
|
* MaterializationsApi - functional programming interface
|
|
@@ -3531,8 +3445,8 @@ export declare const MaterializationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
3531
3445
|
*/
|
|
3532
3446
|
export declare const MaterializationsApiFp: (configuration?: Configuration) => {
|
|
3533
3447
|
/**
|
|
3534
|
-
*
|
|
3535
|
-
* @summary Create a materialization
|
|
3448
|
+
* Starts Round 1 of the two-round build protocol: asynchronously compiles the package, computes a build plan (per-source buildId, output columns, dependency/column lineage, connection capability), and pauses at BUILD_PLAN_READY without writing any tables. The control plane then issues Round 2 via POST .../materializations/{materializationId}?action=build with build instructions.
|
|
3449
|
+
* @summary Create a materialization (Round 1)
|
|
3536
3450
|
* @param {string} environmentName Name of the environment
|
|
3537
3451
|
* @param {string} packageName Name of the package
|
|
3538
3452
|
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
@@ -3541,15 +3455,16 @@ export declare const MaterializationsApiFp: (configuration?: Configuration) => {
|
|
|
3541
3455
|
*/
|
|
3542
3456
|
createMaterialization(environmentName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Materialization>>;
|
|
3543
3457
|
/**
|
|
3544
|
-
* Deletes a terminal (
|
|
3458
|
+
* Deletes a terminal (MANIFEST_FILE_READY, FAILED, or CANCELLED) materialization record. By default this removes the publisher\'s record only; the control plane owns table GC. Set dropTables=true to also drop the physical tables this run produced (from the materialization\'s manifest) as a best-effort cleanup.
|
|
3545
3459
|
* @summary Delete a materialization
|
|
3546
3460
|
* @param {string} environmentName Name of the environment
|
|
3547
3461
|
* @param {string} packageName Name of the package
|
|
3548
3462
|
* @param {string} materializationId ID of the materialization
|
|
3463
|
+
* @param {boolean} [dropTables] When true, also drop the physical tables recorded in the materialization\'s manifest before deleting the record. Defaults to false (record-only delete; the control plane owns table GC).
|
|
3549
3464
|
* @param {*} [options] Override http request option.
|
|
3550
3465
|
* @throws {RequiredError}
|
|
3551
3466
|
*/
|
|
3552
|
-
deleteMaterialization(environmentName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3467
|
+
deleteMaterialization(environmentName: string, packageName: string, materializationId: string, dropTables?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3553
3468
|
/**
|
|
3554
3469
|
*
|
|
3555
3470
|
* @summary Get a specific materialization
|
|
@@ -3572,16 +3487,17 @@ export declare const MaterializationsApiFp: (configuration?: Configuration) => {
|
|
|
3572
3487
|
*/
|
|
3573
3488
|
listMaterializations(environmentName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Materialization>>>;
|
|
3574
3489
|
/**
|
|
3575
|
-
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `
|
|
3490
|
+
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `build` - Round 2. Provide BuildInstructions (CP-assigned table id, physical table name, and realization per source). Builds only the instructed sources into the exact names provided and assembles the manifest. Valid only when the materialization is at BUILD_PLAN_READY. Returns 202. * `stop` - Cancels a PENDING, BUILD_PLAN_READY, or building materialization. Returns 200.
|
|
3576
3491
|
* @summary Perform an action on a materialization
|
|
3577
3492
|
* @param {string} environmentName Name of the environment
|
|
3578
3493
|
* @param {string} packageName Name of the package
|
|
3579
3494
|
* @param {string} materializationId ID of the materialization
|
|
3580
3495
|
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
3496
|
+
* @param {BuildInstructions} [buildInstructions]
|
|
3581
3497
|
* @param {*} [options] Override http request option.
|
|
3582
3498
|
* @throws {RequiredError}
|
|
3583
3499
|
*/
|
|
3584
|
-
materializationAction(environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Materialization>>;
|
|
3500
|
+
materializationAction(environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, buildInstructions?: BuildInstructions, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Materialization>>;
|
|
3585
3501
|
};
|
|
3586
3502
|
/**
|
|
3587
3503
|
* MaterializationsApi - factory interface
|
|
@@ -3589,8 +3505,8 @@ export declare const MaterializationsApiFp: (configuration?: Configuration) => {
|
|
|
3589
3505
|
*/
|
|
3590
3506
|
export declare const MaterializationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3591
3507
|
/**
|
|
3592
|
-
*
|
|
3593
|
-
* @summary Create a materialization
|
|
3508
|
+
* Starts Round 1 of the two-round build protocol: asynchronously compiles the package, computes a build plan (per-source buildId, output columns, dependency/column lineage, connection capability), and pauses at BUILD_PLAN_READY without writing any tables. The control plane then issues Round 2 via POST .../materializations/{materializationId}?action=build with build instructions.
|
|
3509
|
+
* @summary Create a materialization (Round 1)
|
|
3594
3510
|
* @param {string} environmentName Name of the environment
|
|
3595
3511
|
* @param {string} packageName Name of the package
|
|
3596
3512
|
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
@@ -3599,15 +3515,16 @@ export declare const MaterializationsApiFactory: (configuration?: Configuration,
|
|
|
3599
3515
|
*/
|
|
3600
3516
|
createMaterialization(environmentName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig): AxiosPromise<Materialization>;
|
|
3601
3517
|
/**
|
|
3602
|
-
* Deletes a terminal (
|
|
3518
|
+
* Deletes a terminal (MANIFEST_FILE_READY, FAILED, or CANCELLED) materialization record. By default this removes the publisher\'s record only; the control plane owns table GC. Set dropTables=true to also drop the physical tables this run produced (from the materialization\'s manifest) as a best-effort cleanup.
|
|
3603
3519
|
* @summary Delete a materialization
|
|
3604
3520
|
* @param {string} environmentName Name of the environment
|
|
3605
3521
|
* @param {string} packageName Name of the package
|
|
3606
3522
|
* @param {string} materializationId ID of the materialization
|
|
3523
|
+
* @param {boolean} [dropTables] When true, also drop the physical tables recorded in the materialization\'s manifest before deleting the record. Defaults to false (record-only delete; the control plane owns table GC).
|
|
3607
3524
|
* @param {*} [options] Override http request option.
|
|
3608
3525
|
* @throws {RequiredError}
|
|
3609
3526
|
*/
|
|
3610
|
-
deleteMaterialization(environmentName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3527
|
+
deleteMaterialization(environmentName: string, packageName: string, materializationId: string, dropTables?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3611
3528
|
/**
|
|
3612
3529
|
*
|
|
3613
3530
|
* @summary Get a specific materialization
|
|
@@ -3630,16 +3547,17 @@ export declare const MaterializationsApiFactory: (configuration?: Configuration,
|
|
|
3630
3547
|
*/
|
|
3631
3548
|
listMaterializations(environmentName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Materialization>>;
|
|
3632
3549
|
/**
|
|
3633
|
-
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `
|
|
3550
|
+
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `build` - Round 2. Provide BuildInstructions (CP-assigned table id, physical table name, and realization per source). Builds only the instructed sources into the exact names provided and assembles the manifest. Valid only when the materialization is at BUILD_PLAN_READY. Returns 202. * `stop` - Cancels a PENDING, BUILD_PLAN_READY, or building materialization. Returns 200.
|
|
3634
3551
|
* @summary Perform an action on a materialization
|
|
3635
3552
|
* @param {string} environmentName Name of the environment
|
|
3636
3553
|
* @param {string} packageName Name of the package
|
|
3637
3554
|
* @param {string} materializationId ID of the materialization
|
|
3638
3555
|
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
3556
|
+
* @param {BuildInstructions} [buildInstructions]
|
|
3639
3557
|
* @param {*} [options] Override http request option.
|
|
3640
3558
|
* @throws {RequiredError}
|
|
3641
3559
|
*/
|
|
3642
|
-
materializationAction(environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig): AxiosPromise<Materialization>;
|
|
3560
|
+
materializationAction(environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, buildInstructions?: BuildInstructions, options?: RawAxiosRequestConfig): AxiosPromise<Materialization>;
|
|
3643
3561
|
};
|
|
3644
3562
|
/**
|
|
3645
3563
|
* MaterializationsApi - object-oriented interface
|
|
@@ -3649,8 +3567,8 @@ export declare const MaterializationsApiFactory: (configuration?: Configuration,
|
|
|
3649
3567
|
*/
|
|
3650
3568
|
export declare class MaterializationsApi extends BaseAPI {
|
|
3651
3569
|
/**
|
|
3652
|
-
*
|
|
3653
|
-
* @summary Create a materialization
|
|
3570
|
+
* Starts Round 1 of the two-round build protocol: asynchronously compiles the package, computes a build plan (per-source buildId, output columns, dependency/column lineage, connection capability), and pauses at BUILD_PLAN_READY without writing any tables. The control plane then issues Round 2 via POST .../materializations/{materializationId}?action=build with build instructions.
|
|
3571
|
+
* @summary Create a materialization (Round 1)
|
|
3654
3572
|
* @param {string} environmentName Name of the environment
|
|
3655
3573
|
* @param {string} packageName Name of the package
|
|
3656
3574
|
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
@@ -3660,16 +3578,17 @@ export declare class MaterializationsApi extends BaseAPI {
|
|
|
3660
3578
|
*/
|
|
3661
3579
|
createMaterialization(environmentName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Materialization, any, {}>>;
|
|
3662
3580
|
/**
|
|
3663
|
-
* Deletes a terminal (
|
|
3581
|
+
* Deletes a terminal (MANIFEST_FILE_READY, FAILED, or CANCELLED) materialization record. By default this removes the publisher\'s record only; the control plane owns table GC. Set dropTables=true to also drop the physical tables this run produced (from the materialization\'s manifest) as a best-effort cleanup.
|
|
3664
3582
|
* @summary Delete a materialization
|
|
3665
3583
|
* @param {string} environmentName Name of the environment
|
|
3666
3584
|
* @param {string} packageName Name of the package
|
|
3667
3585
|
* @param {string} materializationId ID of the materialization
|
|
3586
|
+
* @param {boolean} [dropTables] When true, also drop the physical tables recorded in the materialization\'s manifest before deleting the record. Defaults to false (record-only delete; the control plane owns table GC).
|
|
3668
3587
|
* @param {*} [options] Override http request option.
|
|
3669
3588
|
* @throws {RequiredError}
|
|
3670
3589
|
* @memberof MaterializationsApi
|
|
3671
3590
|
*/
|
|
3672
|
-
deleteMaterialization(environmentName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<void, any, {}>>;
|
|
3591
|
+
deleteMaterialization(environmentName: string, packageName: string, materializationId: string, dropTables?: boolean, options?: RawAxiosRequestConfig): Promise< AxiosResponse<void, any, {}>>;
|
|
3673
3592
|
/**
|
|
3674
3593
|
*
|
|
3675
3594
|
* @summary Get a specific materialization
|
|
@@ -3694,23 +3613,24 @@ export declare class MaterializationsApi extends BaseAPI {
|
|
|
3694
3613
|
*/
|
|
3695
3614
|
listMaterializations(environmentName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Materialization[], any, {}>>;
|
|
3696
3615
|
/**
|
|
3697
|
-
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `
|
|
3616
|
+
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `build` - Round 2. Provide BuildInstructions (CP-assigned table id, physical table name, and realization per source). Builds only the instructed sources into the exact names provided and assembles the manifest. Valid only when the materialization is at BUILD_PLAN_READY. Returns 202. * `stop` - Cancels a PENDING, BUILD_PLAN_READY, or building materialization. Returns 200.
|
|
3698
3617
|
* @summary Perform an action on a materialization
|
|
3699
3618
|
* @param {string} environmentName Name of the environment
|
|
3700
3619
|
* @param {string} packageName Name of the package
|
|
3701
3620
|
* @param {string} materializationId ID of the materialization
|
|
3702
3621
|
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
3622
|
+
* @param {BuildInstructions} [buildInstructions]
|
|
3703
3623
|
* @param {*} [options] Override http request option.
|
|
3704
3624
|
* @throws {RequiredError}
|
|
3705
3625
|
* @memberof MaterializationsApi
|
|
3706
3626
|
*/
|
|
3707
|
-
materializationAction(environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Materialization, any, {}>>;
|
|
3627
|
+
materializationAction(environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, buildInstructions?: BuildInstructions, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Materialization, any, {}>>;
|
|
3708
3628
|
}
|
|
3709
3629
|
/**
|
|
3710
3630
|
* @export
|
|
3711
3631
|
*/
|
|
3712
3632
|
export declare const MaterializationActionActionEnum: {
|
|
3713
|
-
readonly
|
|
3633
|
+
readonly Build: "build";
|
|
3714
3634
|
readonly Stop: "stop";
|
|
3715
3635
|
};
|
|
3716
3636
|
export type MaterializationActionActionEnum = typeof MaterializationActionActionEnum[keyof typeof MaterializationActionActionEnum];
|
|
@@ -4107,11 +4027,10 @@ export declare const PackagesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
4107
4027
|
* @summary Create a new package
|
|
4108
4028
|
* @param {string} environmentName Name of the environment
|
|
4109
4029
|
* @param {Package} _package
|
|
4110
|
-
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
4111
4030
|
* @param {*} [options] Override http request option.
|
|
4112
4031
|
* @throws {RequiredError}
|
|
4113
4032
|
*/
|
|
4114
|
-
createPackage: (environmentName: string, _package: Package,
|
|
4033
|
+
createPackage: (environmentName: string, _package: Package, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4115
4034
|
/**
|
|
4116
4035
|
* 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.
|
|
4117
4036
|
* @summary Delete a package
|
|
@@ -4161,11 +4080,10 @@ export declare const PackagesApiFp: (configuration?: Configuration) => {
|
|
|
4161
4080
|
* @summary Create a new package
|
|
4162
4081
|
* @param {string} environmentName Name of the environment
|
|
4163
4082
|
* @param {Package} _package
|
|
4164
|
-
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
4165
4083
|
* @param {*} [options] Override http request option.
|
|
4166
4084
|
* @throws {RequiredError}
|
|
4167
4085
|
*/
|
|
4168
|
-
createPackage(environmentName: string, _package: Package,
|
|
4086
|
+
createPackage(environmentName: string, _package: Package, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
4169
4087
|
/**
|
|
4170
4088
|
* 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.
|
|
4171
4089
|
* @summary Delete a package
|
|
@@ -4215,11 +4133,10 @@ export declare const PackagesApiFactory: (configuration?: Configuration, basePat
|
|
|
4215
4133
|
* @summary Create a new package
|
|
4216
4134
|
* @param {string} environmentName Name of the environment
|
|
4217
4135
|
* @param {Package} _package
|
|
4218
|
-
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
4219
4136
|
* @param {*} [options] Override http request option.
|
|
4220
4137
|
* @throws {RequiredError}
|
|
4221
4138
|
*/
|
|
4222
|
-
createPackage(environmentName: string, _package: Package,
|
|
4139
|
+
createPackage(environmentName: string, _package: Package, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
4223
4140
|
/**
|
|
4224
4141
|
* 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.
|
|
4225
4142
|
* @summary Delete a package
|
|
@@ -4271,12 +4188,11 @@ export declare class PackagesApi extends BaseAPI {
|
|
|
4271
4188
|
* @summary Create a new package
|
|
4272
4189
|
* @param {string} environmentName Name of the environment
|
|
4273
4190
|
* @param {Package} _package
|
|
4274
|
-
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
4275
4191
|
* @param {*} [options] Override http request option.
|
|
4276
4192
|
* @throws {RequiredError}
|
|
4277
4193
|
* @memberof PackagesApi
|
|
4278
4194
|
*/
|
|
4279
|
-
createPackage(environmentName: string, _package: Package,
|
|
4195
|
+
createPackage(environmentName: string, _package: Package, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Package, any, {}>>;
|
|
4280
4196
|
/**
|
|
4281
4197
|
* 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.
|
|
4282
4198
|
* @summary Delete a package
|