@malloy-publisher/sdk 0.0.205 → 0.0.207
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-UAgM1ojG.cjs.js +1 -0
- package/dist/{ServerProvider-CV37_sr_.es.js → ServerProvider-jpXNccQX.es.js} +919 -1311
- package/dist/client/api.d.ts +356 -416
- package/dist/client/index.cjs.js +1 -1
- package/dist/client/index.es.js +53 -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-C2sQrwVu.es.js → core-AOmIKwkc.es.js} +1 -1
- package/dist/{core-BWQQVODR.cjs.js → core-D1ZybzhJ.cjs.js} +1 -1
- package/dist/hooks/useGivensForm.d.ts +0 -2
- package/dist/{index-Dky6W6d1.cjs.js → index-Di675Z82.cjs.js} +77 -77
- package/dist/{index-CBRWGN55.es.js → index-eoQZlIjY.es.js} +8184 -8157
- 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.
|
|
1110
|
+
* @type {string}
|
|
1111
|
+
* @memberof ManifestEntry
|
|
1112
|
+
*/
|
|
1113
|
+
'physicalTableName': string;
|
|
1114
|
+
/**
|
|
1115
|
+
*
|
|
996
1116
|
* @type {string}
|
|
997
1117
|
* @memberof ManifestEntry
|
|
998
1118
|
*/
|
|
999
|
-
'
|
|
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}
|
|
1166
|
+
* @memberof Materialization
|
|
1167
|
+
*/
|
|
1168
|
+
'status'?: MaterializationStatus;
|
|
1169
|
+
/**
|
|
1170
|
+
*
|
|
1171
|
+
* @type {BuildPlan}
|
|
1028
1172
|
* @memberof Materialization
|
|
1029
1173
|
*/
|
|
1030
|
-
'
|
|
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,60 @@ 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;
|
|
1495
|
+
/**
|
|
1496
|
+
* Server-computed, read-only: whether the control-plane build manifest is currently bound to this package\'s served models. `unbound` = no manifest configured, so the package serves live. `bound` = a manifest was fetched and applied, so persist sources route to their materialized physical tables. `live_fallback` = a `manifestLocation` is configured but the fetch/bind failed or timed out, so the package is serving live despite intending to be materialized-routed. Lets the control plane confirm a worker actually bound a distributed manifest rather than inferring it from logs.
|
|
1497
|
+
* @type {string}
|
|
1498
|
+
* @memberof Package
|
|
1499
|
+
*/
|
|
1500
|
+
'manifestBindingStatus'?: PackageManifestBindingStatusEnum;
|
|
1501
|
+
/**
|
|
1502
|
+
* Server-computed, read-only: number of buildId -> physical-table entries currently bound (0 when unbound or on live fallback).
|
|
1503
|
+
* @type {number}
|
|
1504
|
+
* @memberof Package
|
|
1505
|
+
*/
|
|
1506
|
+
'manifestEntryCount'?: number;
|
|
1507
|
+
/**
|
|
1508
|
+
* Server-computed, read-only: the manifest URI actually bound to the served models. Usually equals `manifestLocation`, but can differ after an in-memory auto-load following a materialization build (no URI), in which case it is null. Null whenever the package is unbound.
|
|
1509
|
+
* @type {string}
|
|
1510
|
+
* @memberof Package
|
|
1511
|
+
*/
|
|
1512
|
+
'boundManifestUri'?: string | null;
|
|
1315
1513
|
}
|
|
1514
|
+
export declare const PackageQueryableSourcesEnum: {
|
|
1515
|
+
readonly Declared: "declared";
|
|
1516
|
+
readonly All: "all";
|
|
1517
|
+
};
|
|
1518
|
+
export type PackageQueryableSourcesEnum = typeof PackageQueryableSourcesEnum[keyof typeof PackageQueryableSourcesEnum];
|
|
1519
|
+
export declare const PackageManifestBindingStatusEnum: {
|
|
1520
|
+
readonly Unbound: "unbound";
|
|
1521
|
+
readonly Bound: "bound";
|
|
1522
|
+
readonly LiveFallback: "live_fallback";
|
|
1523
|
+
};
|
|
1524
|
+
export type PackageManifestBindingStatusEnum = typeof PackageManifestBindingStatusEnum[keyof typeof PackageManifestBindingStatusEnum];
|
|
1316
1525
|
/**
|
|
1317
1526
|
* Static HTML page (in-package data app) within a Malloy package
|
|
1318
1527
|
* @export
|
|
@@ -1344,6 +1553,55 @@ export interface Page {
|
|
|
1344
1553
|
*/
|
|
1345
1554
|
'title'?: string;
|
|
1346
1555
|
}
|
|
1556
|
+
/**
|
|
1557
|
+
*
|
|
1558
|
+
* @export
|
|
1559
|
+
* @interface PersistSourcePlan
|
|
1560
|
+
*/
|
|
1561
|
+
export interface PersistSourcePlan {
|
|
1562
|
+
/**
|
|
1563
|
+
*
|
|
1564
|
+
* @type {string}
|
|
1565
|
+
* @memberof PersistSourcePlan
|
|
1566
|
+
*/
|
|
1567
|
+
'name': string;
|
|
1568
|
+
/**
|
|
1569
|
+
*
|
|
1570
|
+
* @type {string}
|
|
1571
|
+
* @memberof PersistSourcePlan
|
|
1572
|
+
*/
|
|
1573
|
+
'sourceID': string;
|
|
1574
|
+
/**
|
|
1575
|
+
*
|
|
1576
|
+
* @type {string}
|
|
1577
|
+
* @memberof PersistSourcePlan
|
|
1578
|
+
*/
|
|
1579
|
+
'connectionName': string;
|
|
1580
|
+
/**
|
|
1581
|
+
*
|
|
1582
|
+
* @type {string}
|
|
1583
|
+
* @memberof PersistSourcePlan
|
|
1584
|
+
*/
|
|
1585
|
+
'dialect'?: string;
|
|
1586
|
+
/**
|
|
1587
|
+
* hash(connectionDigest + canonical logical SQL).
|
|
1588
|
+
* @type {string}
|
|
1589
|
+
* @memberof PersistSourcePlan
|
|
1590
|
+
*/
|
|
1591
|
+
'buildId': string;
|
|
1592
|
+
/**
|
|
1593
|
+
* The source\'s build SQL (with the build manifest applied for upstream rewrites).
|
|
1594
|
+
* @type {string}
|
|
1595
|
+
* @memberof PersistSourcePlan
|
|
1596
|
+
*/
|
|
1597
|
+
'sql': string;
|
|
1598
|
+
/**
|
|
1599
|
+
* Output schema of the source.
|
|
1600
|
+
* @type {Array<Column>}
|
|
1601
|
+
* @memberof PersistSourcePlan
|
|
1602
|
+
*/
|
|
1603
|
+
'columns': Array<Column>;
|
|
1604
|
+
}
|
|
1347
1605
|
/**
|
|
1348
1606
|
*
|
|
1349
1607
|
* @export
|
|
@@ -1598,6 +1856,16 @@ export interface RawNotebook {
|
|
|
1598
1856
|
*/
|
|
1599
1857
|
'sources'?: Array<Source>;
|
|
1600
1858
|
}
|
|
1859
|
+
/**
|
|
1860
|
+
* SNAPSHOT = warehouse clone/snapshot; COPY = CREATE TABLE AS SELECT.
|
|
1861
|
+
* @export
|
|
1862
|
+
* @enum {string}
|
|
1863
|
+
*/
|
|
1864
|
+
export declare const Realization: {
|
|
1865
|
+
readonly Snapshot: "SNAPSHOT";
|
|
1866
|
+
readonly Copy: "COPY";
|
|
1867
|
+
};
|
|
1868
|
+
export type Realization = typeof Realization[keyof typeof Realization];
|
|
1601
1869
|
/**
|
|
1602
1870
|
* AWS S3 connection configuration for DuckDB
|
|
1603
1871
|
* @export
|
|
@@ -1902,31 +2170,6 @@ export interface TableDescription {
|
|
|
1902
2170
|
*/
|
|
1903
2171
|
'columns'?: Array<Column>;
|
|
1904
2172
|
}
|
|
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
2173
|
/**
|
|
1931
2174
|
*
|
|
1932
2175
|
* @export
|
|
@@ -2133,29 +2376,6 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2133
2376
|
* @throws {RequiredError}
|
|
2134
2377
|
*/
|
|
2135
2378
|
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
2379
|
/**
|
|
2160
2380
|
* 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
2381
|
* @summary Get table details from database
|
|
@@ -2179,29 +2399,6 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2179
2399
|
* @throws {RequiredError}
|
|
2180
2400
|
*/
|
|
2181
2401
|
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
2402
|
/**
|
|
2206
2403
|
* 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
2404
|
* @summary List environment database connections
|
|
@@ -2258,11 +2455,10 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2258
2455
|
* @param {string} environmentName Name of the environment
|
|
2259
2456
|
* @param {string} connectionName Name of the connection
|
|
2260
2457
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2261
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2262
2458
|
* @param {*} [options] Override http request option.
|
|
2263
2459
|
* @throws {RequiredError}
|
|
2264
2460
|
*/
|
|
2265
|
-
postQuerydata: (environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2461
|
+
postQuerydata: (environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2266
2462
|
/**
|
|
2267
2463
|
* 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
2464
|
* @summary Execute SQL query (per-package)
|
|
@@ -2270,11 +2466,10 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2270
2466
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2271
2467
|
* @param {string} connectionName Name of the connection
|
|
2272
2468
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2273
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2274
2469
|
* @param {*} [options] Override http request option.
|
|
2275
2470
|
* @throws {RequiredError}
|
|
2276
2471
|
*/
|
|
2277
|
-
postQuerydataInPackage: (environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2472
|
+
postQuerydataInPackage: (environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2278
2473
|
/**
|
|
2279
2474
|
* 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
2475
|
* @summary Create SQL source from statement
|
|
@@ -2361,29 +2556,6 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2361
2556
|
* @throws {RequiredError}
|
|
2362
2557
|
*/
|
|
2363
2558
|
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
2559
|
/**
|
|
2388
2560
|
* 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
2561
|
* @summary Get table details from database
|
|
@@ -2407,29 +2579,6 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2407
2579
|
* @throws {RequiredError}
|
|
2408
2580
|
*/
|
|
2409
2581
|
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
2582
|
/**
|
|
2434
2583
|
* 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
2584
|
* @summary List environment database connections
|
|
@@ -2486,11 +2635,10 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2486
2635
|
* @param {string} environmentName Name of the environment
|
|
2487
2636
|
* @param {string} connectionName Name of the connection
|
|
2488
2637
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2489
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2490
2638
|
* @param {*} [options] Override http request option.
|
|
2491
2639
|
* @throws {RequiredError}
|
|
2492
2640
|
*/
|
|
2493
|
-
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2641
|
+
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryData>>;
|
|
2494
2642
|
/**
|
|
2495
2643
|
* 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
2644
|
* @summary Execute SQL query (per-package)
|
|
@@ -2498,11 +2646,10 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2498
2646
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2499
2647
|
* @param {string} connectionName Name of the connection
|
|
2500
2648
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2501
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2502
2649
|
* @param {*} [options] Override http request option.
|
|
2503
2650
|
* @throws {RequiredError}
|
|
2504
2651
|
*/
|
|
2505
|
-
postQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2652
|
+
postQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryData>>;
|
|
2506
2653
|
/**
|
|
2507
2654
|
* 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
2655
|
* @summary Create SQL source from statement
|
|
@@ -2589,29 +2736,6 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2589
2736
|
* @throws {RequiredError}
|
|
2590
2737
|
*/
|
|
2591
2738
|
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
2739
|
/**
|
|
2616
2740
|
* 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
2741
|
* @summary Get table details from database
|
|
@@ -2635,29 +2759,6 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2635
2759
|
* @throws {RequiredError}
|
|
2636
2760
|
*/
|
|
2637
2761
|
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
2762
|
/**
|
|
2662
2763
|
* 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
2764
|
* @summary List environment database connections
|
|
@@ -2714,11 +2815,10 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2714
2815
|
* @param {string} environmentName Name of the environment
|
|
2715
2816
|
* @param {string} connectionName Name of the connection
|
|
2716
2817
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2717
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2718
2818
|
* @param {*} [options] Override http request option.
|
|
2719
2819
|
* @throws {RequiredError}
|
|
2720
2820
|
*/
|
|
2721
|
-
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2821
|
+
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): AxiosPromise<QueryData>;
|
|
2722
2822
|
/**
|
|
2723
2823
|
* 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
2824
|
* @summary Execute SQL query (per-package)
|
|
@@ -2726,11 +2826,10 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2726
2826
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2727
2827
|
* @param {string} connectionName Name of the connection
|
|
2728
2828
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2729
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2730
2829
|
* @param {*} [options] Override http request option.
|
|
2731
2830
|
* @throws {RequiredError}
|
|
2732
2831
|
*/
|
|
2733
|
-
postQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2832
|
+
postQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): AxiosPromise<QueryData>;
|
|
2734
2833
|
/**
|
|
2735
2834
|
* 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
2835
|
* @summary Create SQL source from statement
|
|
@@ -2822,31 +2921,6 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2822
2921
|
* @memberof ConnectionsApi
|
|
2823
2922
|
*/
|
|
2824
2923
|
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
2924
|
/**
|
|
2851
2925
|
* 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
2926
|
* @summary Get table details from database
|
|
@@ -2872,31 +2946,6 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2872
2946
|
* @memberof ConnectionsApi
|
|
2873
2947
|
*/
|
|
2874
2948
|
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
2949
|
/**
|
|
2901
2950
|
* 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
2951
|
* @summary List environment database connections
|
|
@@ -2958,12 +3007,11 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2958
3007
|
* @param {string} environmentName Name of the environment
|
|
2959
3008
|
* @param {string} connectionName Name of the connection
|
|
2960
3009
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2961
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2962
3010
|
* @param {*} [options] Override http request option.
|
|
2963
3011
|
* @throws {RequiredError}
|
|
2964
3012
|
* @memberof ConnectionsApi
|
|
2965
3013
|
*/
|
|
2966
|
-
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
3014
|
+
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<QueryData, any, {}>>;
|
|
2967
3015
|
/**
|
|
2968
3016
|
* 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
3017
|
* @summary Execute SQL query (per-package)
|
|
@@ -2971,12 +3019,11 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2971
3019
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2972
3020
|
* @param {string} connectionName Name of the connection
|
|
2973
3021
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2974
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2975
3022
|
* @param {*} [options] Override http request option.
|
|
2976
3023
|
* @throws {RequiredError}
|
|
2977
3024
|
* @memberof ConnectionsApi
|
|
2978
3025
|
*/
|
|
2979
|
-
postQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
3026
|
+
postQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<QueryData, any, {}>>;
|
|
2980
3027
|
/**
|
|
2981
3028
|
* 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
3029
|
* @summary Create SQL source from statement
|
|
@@ -3356,125 +3403,14 @@ export declare class EnvironmentsApi extends BaseAPI {
|
|
|
3356
3403
|
*/
|
|
3357
3404
|
updateEnvironment(environmentName: string, environment: Environment, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Environment, any, {}>>;
|
|
3358
3405
|
}
|
|
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
3406
|
/**
|
|
3471
3407
|
* MaterializationsApi - axios parameter creator
|
|
3472
3408
|
* @export
|
|
3473
3409
|
*/
|
|
3474
3410
|
export declare const MaterializationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3475
3411
|
/**
|
|
3476
|
-
*
|
|
3477
|
-
* @summary Create a materialization
|
|
3412
|
+
* 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.
|
|
3413
|
+
* @summary Create a materialization (Round 1)
|
|
3478
3414
|
* @param {string} environmentName Name of the environment
|
|
3479
3415
|
* @param {string} packageName Name of the package
|
|
3480
3416
|
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
@@ -3483,15 +3419,16 @@ export declare const MaterializationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
3483
3419
|
*/
|
|
3484
3420
|
createMaterialization: (environmentName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3485
3421
|
/**
|
|
3486
|
-
* Deletes a terminal (
|
|
3422
|
+
* 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
3423
|
* @summary Delete a materialization
|
|
3488
3424
|
* @param {string} environmentName Name of the environment
|
|
3489
3425
|
* @param {string} packageName Name of the package
|
|
3490
3426
|
* @param {string} materializationId ID of the materialization
|
|
3427
|
+
* @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
3428
|
* @param {*} [options] Override http request option.
|
|
3492
3429
|
* @throws {RequiredError}
|
|
3493
3430
|
*/
|
|
3494
|
-
deleteMaterialization: (environmentName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3431
|
+
deleteMaterialization: (environmentName: string, packageName: string, materializationId: string, dropTables?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3495
3432
|
/**
|
|
3496
3433
|
*
|
|
3497
3434
|
* @summary Get a specific materialization
|
|
@@ -3514,16 +3451,17 @@ export declare const MaterializationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
3514
3451
|
*/
|
|
3515
3452
|
listMaterializations: (environmentName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3516
3453
|
/**
|
|
3517
|
-
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `
|
|
3454
|
+
* 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
3455
|
* @summary Perform an action on a materialization
|
|
3519
3456
|
* @param {string} environmentName Name of the environment
|
|
3520
3457
|
* @param {string} packageName Name of the package
|
|
3521
3458
|
* @param {string} materializationId ID of the materialization
|
|
3522
3459
|
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
3460
|
+
* @param {BuildInstructions} [buildInstructions]
|
|
3523
3461
|
* @param {*} [options] Override http request option.
|
|
3524
3462
|
* @throws {RequiredError}
|
|
3525
3463
|
*/
|
|
3526
|
-
materializationAction: (environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3464
|
+
materializationAction: (environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, buildInstructions?: BuildInstructions, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3527
3465
|
};
|
|
3528
3466
|
/**
|
|
3529
3467
|
* MaterializationsApi - functional programming interface
|
|
@@ -3531,8 +3469,8 @@ export declare const MaterializationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
3531
3469
|
*/
|
|
3532
3470
|
export declare const MaterializationsApiFp: (configuration?: Configuration) => {
|
|
3533
3471
|
/**
|
|
3534
|
-
*
|
|
3535
|
-
* @summary Create a materialization
|
|
3472
|
+
* 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.
|
|
3473
|
+
* @summary Create a materialization (Round 1)
|
|
3536
3474
|
* @param {string} environmentName Name of the environment
|
|
3537
3475
|
* @param {string} packageName Name of the package
|
|
3538
3476
|
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
@@ -3541,15 +3479,16 @@ export declare const MaterializationsApiFp: (configuration?: Configuration) => {
|
|
|
3541
3479
|
*/
|
|
3542
3480
|
createMaterialization(environmentName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Materialization>>;
|
|
3543
3481
|
/**
|
|
3544
|
-
* Deletes a terminal (
|
|
3482
|
+
* 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
3483
|
* @summary Delete a materialization
|
|
3546
3484
|
* @param {string} environmentName Name of the environment
|
|
3547
3485
|
* @param {string} packageName Name of the package
|
|
3548
3486
|
* @param {string} materializationId ID of the materialization
|
|
3487
|
+
* @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
3488
|
* @param {*} [options] Override http request option.
|
|
3550
3489
|
* @throws {RequiredError}
|
|
3551
3490
|
*/
|
|
3552
|
-
deleteMaterialization(environmentName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3491
|
+
deleteMaterialization(environmentName: string, packageName: string, materializationId: string, dropTables?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3553
3492
|
/**
|
|
3554
3493
|
*
|
|
3555
3494
|
* @summary Get a specific materialization
|
|
@@ -3572,16 +3511,17 @@ export declare const MaterializationsApiFp: (configuration?: Configuration) => {
|
|
|
3572
3511
|
*/
|
|
3573
3512
|
listMaterializations(environmentName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Materialization>>>;
|
|
3574
3513
|
/**
|
|
3575
|
-
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `
|
|
3514
|
+
* 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
3515
|
* @summary Perform an action on a materialization
|
|
3577
3516
|
* @param {string} environmentName Name of the environment
|
|
3578
3517
|
* @param {string} packageName Name of the package
|
|
3579
3518
|
* @param {string} materializationId ID of the materialization
|
|
3580
3519
|
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
3520
|
+
* @param {BuildInstructions} [buildInstructions]
|
|
3581
3521
|
* @param {*} [options] Override http request option.
|
|
3582
3522
|
* @throws {RequiredError}
|
|
3583
3523
|
*/
|
|
3584
|
-
materializationAction(environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Materialization>>;
|
|
3524
|
+
materializationAction(environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, buildInstructions?: BuildInstructions, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Materialization>>;
|
|
3585
3525
|
};
|
|
3586
3526
|
/**
|
|
3587
3527
|
* MaterializationsApi - factory interface
|
|
@@ -3589,8 +3529,8 @@ export declare const MaterializationsApiFp: (configuration?: Configuration) => {
|
|
|
3589
3529
|
*/
|
|
3590
3530
|
export declare const MaterializationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3591
3531
|
/**
|
|
3592
|
-
*
|
|
3593
|
-
* @summary Create a materialization
|
|
3532
|
+
* 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.
|
|
3533
|
+
* @summary Create a materialization (Round 1)
|
|
3594
3534
|
* @param {string} environmentName Name of the environment
|
|
3595
3535
|
* @param {string} packageName Name of the package
|
|
3596
3536
|
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
@@ -3599,15 +3539,16 @@ export declare const MaterializationsApiFactory: (configuration?: Configuration,
|
|
|
3599
3539
|
*/
|
|
3600
3540
|
createMaterialization(environmentName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig): AxiosPromise<Materialization>;
|
|
3601
3541
|
/**
|
|
3602
|
-
* Deletes a terminal (
|
|
3542
|
+
* 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
3543
|
* @summary Delete a materialization
|
|
3604
3544
|
* @param {string} environmentName Name of the environment
|
|
3605
3545
|
* @param {string} packageName Name of the package
|
|
3606
3546
|
* @param {string} materializationId ID of the materialization
|
|
3547
|
+
* @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
3548
|
* @param {*} [options] Override http request option.
|
|
3608
3549
|
* @throws {RequiredError}
|
|
3609
3550
|
*/
|
|
3610
|
-
deleteMaterialization(environmentName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3551
|
+
deleteMaterialization(environmentName: string, packageName: string, materializationId: string, dropTables?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3611
3552
|
/**
|
|
3612
3553
|
*
|
|
3613
3554
|
* @summary Get a specific materialization
|
|
@@ -3630,16 +3571,17 @@ export declare const MaterializationsApiFactory: (configuration?: Configuration,
|
|
|
3630
3571
|
*/
|
|
3631
3572
|
listMaterializations(environmentName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Materialization>>;
|
|
3632
3573
|
/**
|
|
3633
|
-
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `
|
|
3574
|
+
* 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
3575
|
* @summary Perform an action on a materialization
|
|
3635
3576
|
* @param {string} environmentName Name of the environment
|
|
3636
3577
|
* @param {string} packageName Name of the package
|
|
3637
3578
|
* @param {string} materializationId ID of the materialization
|
|
3638
3579
|
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
3580
|
+
* @param {BuildInstructions} [buildInstructions]
|
|
3639
3581
|
* @param {*} [options] Override http request option.
|
|
3640
3582
|
* @throws {RequiredError}
|
|
3641
3583
|
*/
|
|
3642
|
-
materializationAction(environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig): AxiosPromise<Materialization>;
|
|
3584
|
+
materializationAction(environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, buildInstructions?: BuildInstructions, options?: RawAxiosRequestConfig): AxiosPromise<Materialization>;
|
|
3643
3585
|
};
|
|
3644
3586
|
/**
|
|
3645
3587
|
* MaterializationsApi - object-oriented interface
|
|
@@ -3649,8 +3591,8 @@ export declare const MaterializationsApiFactory: (configuration?: Configuration,
|
|
|
3649
3591
|
*/
|
|
3650
3592
|
export declare class MaterializationsApi extends BaseAPI {
|
|
3651
3593
|
/**
|
|
3652
|
-
*
|
|
3653
|
-
* @summary Create a materialization
|
|
3594
|
+
* 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.
|
|
3595
|
+
* @summary Create a materialization (Round 1)
|
|
3654
3596
|
* @param {string} environmentName Name of the environment
|
|
3655
3597
|
* @param {string} packageName Name of the package
|
|
3656
3598
|
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
@@ -3660,16 +3602,17 @@ export declare class MaterializationsApi extends BaseAPI {
|
|
|
3660
3602
|
*/
|
|
3661
3603
|
createMaterialization(environmentName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Materialization, any, {}>>;
|
|
3662
3604
|
/**
|
|
3663
|
-
* Deletes a terminal (
|
|
3605
|
+
* 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
3606
|
* @summary Delete a materialization
|
|
3665
3607
|
* @param {string} environmentName Name of the environment
|
|
3666
3608
|
* @param {string} packageName Name of the package
|
|
3667
3609
|
* @param {string} materializationId ID of the materialization
|
|
3610
|
+
* @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
3611
|
* @param {*} [options] Override http request option.
|
|
3669
3612
|
* @throws {RequiredError}
|
|
3670
3613
|
* @memberof MaterializationsApi
|
|
3671
3614
|
*/
|
|
3672
|
-
deleteMaterialization(environmentName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<void, any, {}>>;
|
|
3615
|
+
deleteMaterialization(environmentName: string, packageName: string, materializationId: string, dropTables?: boolean, options?: RawAxiosRequestConfig): Promise< AxiosResponse<void, any, {}>>;
|
|
3673
3616
|
/**
|
|
3674
3617
|
*
|
|
3675
3618
|
* @summary Get a specific materialization
|
|
@@ -3694,23 +3637,24 @@ export declare class MaterializationsApi extends BaseAPI {
|
|
|
3694
3637
|
*/
|
|
3695
3638
|
listMaterializations(environmentName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Materialization[], any, {}>>;
|
|
3696
3639
|
/**
|
|
3697
|
-
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `
|
|
3640
|
+
* 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
3641
|
* @summary Perform an action on a materialization
|
|
3699
3642
|
* @param {string} environmentName Name of the environment
|
|
3700
3643
|
* @param {string} packageName Name of the package
|
|
3701
3644
|
* @param {string} materializationId ID of the materialization
|
|
3702
3645
|
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
3646
|
+
* @param {BuildInstructions} [buildInstructions]
|
|
3703
3647
|
* @param {*} [options] Override http request option.
|
|
3704
3648
|
* @throws {RequiredError}
|
|
3705
3649
|
* @memberof MaterializationsApi
|
|
3706
3650
|
*/
|
|
3707
|
-
materializationAction(environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Materialization, any, {}>>;
|
|
3651
|
+
materializationAction(environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, buildInstructions?: BuildInstructions, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Materialization, any, {}>>;
|
|
3708
3652
|
}
|
|
3709
3653
|
/**
|
|
3710
3654
|
* @export
|
|
3711
3655
|
*/
|
|
3712
3656
|
export declare const MaterializationActionActionEnum: {
|
|
3713
|
-
readonly
|
|
3657
|
+
readonly Build: "build";
|
|
3714
3658
|
readonly Stop: "stop";
|
|
3715
3659
|
};
|
|
3716
3660
|
export type MaterializationActionActionEnum = typeof MaterializationActionActionEnum[keyof typeof MaterializationActionActionEnum];
|
|
@@ -4107,11 +4051,10 @@ export declare const PackagesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
4107
4051
|
* @summary Create a new package
|
|
4108
4052
|
* @param {string} environmentName Name of the environment
|
|
4109
4053
|
* @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
4054
|
* @param {*} [options] Override http request option.
|
|
4112
4055
|
* @throws {RequiredError}
|
|
4113
4056
|
*/
|
|
4114
|
-
createPackage: (environmentName: string, _package: Package,
|
|
4057
|
+
createPackage: (environmentName: string, _package: Package, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4115
4058
|
/**
|
|
4116
4059
|
* 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
4060
|
* @summary Delete a package
|
|
@@ -4161,11 +4104,10 @@ export declare const PackagesApiFp: (configuration?: Configuration) => {
|
|
|
4161
4104
|
* @summary Create a new package
|
|
4162
4105
|
* @param {string} environmentName Name of the environment
|
|
4163
4106
|
* @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
4107
|
* @param {*} [options] Override http request option.
|
|
4166
4108
|
* @throws {RequiredError}
|
|
4167
4109
|
*/
|
|
4168
|
-
createPackage(environmentName: string, _package: Package,
|
|
4110
|
+
createPackage(environmentName: string, _package: Package, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
4169
4111
|
/**
|
|
4170
4112
|
* 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
4113
|
* @summary Delete a package
|
|
@@ -4215,11 +4157,10 @@ export declare const PackagesApiFactory: (configuration?: Configuration, basePat
|
|
|
4215
4157
|
* @summary Create a new package
|
|
4216
4158
|
* @param {string} environmentName Name of the environment
|
|
4217
4159
|
* @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
4160
|
* @param {*} [options] Override http request option.
|
|
4220
4161
|
* @throws {RequiredError}
|
|
4221
4162
|
*/
|
|
4222
|
-
createPackage(environmentName: string, _package: Package,
|
|
4163
|
+
createPackage(environmentName: string, _package: Package, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
4223
4164
|
/**
|
|
4224
4165
|
* 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
4166
|
* @summary Delete a package
|
|
@@ -4271,12 +4212,11 @@ export declare class PackagesApi extends BaseAPI {
|
|
|
4271
4212
|
* @summary Create a new package
|
|
4272
4213
|
* @param {string} environmentName Name of the environment
|
|
4273
4214
|
* @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
4215
|
* @param {*} [options] Override http request option.
|
|
4276
4216
|
* @throws {RequiredError}
|
|
4277
4217
|
* @memberof PackagesApi
|
|
4278
4218
|
*/
|
|
4279
|
-
createPackage(environmentName: string, _package: Package,
|
|
4219
|
+
createPackage(environmentName: string, _package: Package, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Package, any, {}>>;
|
|
4280
4220
|
/**
|
|
4281
4221
|
* 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
4222
|
* @summary Delete a package
|