@malloy-publisher/sdk 0.0.204 → 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-Byndfro6.es.js → ServerProvider-Bl1dhff8.es.js} +875 -1141
- package/dist/ServerProvider-DAUs13RZ.cjs.js +1 -0
- package/dist/client/api.d.ts +464 -417
- package/dist/client/index.cjs.js +1 -1
- package/dist/client/index.es.js +55 -54
- 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/Package/ContentTypeIcon.d.ts +3 -4
- package/dist/components/PageViewer/PageViewer.d.ts +17 -0
- package/dist/components/PageViewer/index.d.ts +1 -0
- package/dist/components/ServerProvider.d.ts +2 -2
- package/dist/components/given/GivenInput.d.ts +13 -8
- package/dist/components/index.d.ts +1 -0
- package/dist/{core-rpX4ZiBw.cjs.js → core-DPwA_AfV.cjs.js} +1 -1
- package/dist/{core-DECXYL4E.es.js → core-pPlPr7jK.es.js} +1 -1
- package/dist/hooks/useGivensForm.d.ts +0 -2
- package/dist/{index-fCeepsZI.es.js → index-BCj2kFTK.es.js} +9215 -9015
- package/dist/{index-DDoMd3Vi.cjs.js → index-LRaPE9ej.cjs.js} +82 -82
- package/dist/index.cjs.js +1 -1
- package/dist/index.es.js +24 -23
- package/dist/utils/pageEmbed.d.ts +24 -0
- 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/ContentTypeIcon.tsx +16 -4
- package/src/components/Package/Package.tsx +115 -2
- package/src/components/PageViewer/PageViewer.tsx +164 -0
- package/src/components/PageViewer/index.ts +1 -0
- package/src/components/ServerProvider.tsx +2 -2
- package/src/components/given/GivenInput.tsx +54 -31
- package/src/components/index.ts +1 -0
- package/src/hooks/useGivensForm.ts +0 -12
- package/src/utils/pageEmbed.spec.ts +60 -0
- package/src/utils/pageEmbed.ts +46 -0
- package/dist/ServerProvider-DzJJm8Ss.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
|
+
*
|
|
996
1092
|
* @type {string}
|
|
997
1093
|
* @memberof ManifestEntry
|
|
998
1094
|
*/
|
|
999
|
-
'
|
|
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
|
+
*
|
|
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}
|
|
1166
|
+
* @memberof Materialization
|
|
1167
|
+
*/
|
|
1168
|
+
'status'?: MaterializationStatus;
|
|
1169
|
+
/**
|
|
1170
|
+
*
|
|
1171
|
+
* @type {BuildPlan}
|
|
1172
|
+
* @memberof Materialization
|
|
1173
|
+
*/
|
|
1174
|
+
'buildPlan'?: BuildPlan | null;
|
|
1175
|
+
/**
|
|
1176
|
+
*
|
|
1177
|
+
* @type {BuildManifest}
|
|
1028
1178
|
* @memberof Materialization
|
|
1029
1179
|
*/
|
|
1030
|
-
'
|
|
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,6 +1468,115 @@ 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
|
+
export declare const PackageQueryableSourcesEnum: {
|
|
1497
|
+
readonly Declared: "declared";
|
|
1498
|
+
readonly All: "all";
|
|
1499
|
+
};
|
|
1500
|
+
export type PackageQueryableSourcesEnum = typeof PackageQueryableSourcesEnum[keyof typeof PackageQueryableSourcesEnum];
|
|
1501
|
+
/**
|
|
1502
|
+
* Static HTML page (in-package data app) within a Malloy package
|
|
1503
|
+
* @export
|
|
1504
|
+
* @interface Page
|
|
1505
|
+
*/
|
|
1506
|
+
export interface Page {
|
|
1507
|
+
/**
|
|
1508
|
+
* Canonical URL to the served page. Root-relative and does NOT carry the /api/v0 prefix, because pages are static assets served off the server root rather than API resources.
|
|
1509
|
+
* @type {string}
|
|
1510
|
+
* @memberof Page
|
|
1511
|
+
*/
|
|
1512
|
+
'resource'?: string;
|
|
1513
|
+
/**
|
|
1514
|
+
* Name of the package containing this page
|
|
1515
|
+
* @type {string}
|
|
1516
|
+
* @memberof Page
|
|
1517
|
+
*/
|
|
1518
|
+
'packageName'?: string;
|
|
1519
|
+
/**
|
|
1520
|
+
* Relative path to the HTML file within its package directory
|
|
1521
|
+
* @type {string}
|
|
1522
|
+
* @memberof Page
|
|
1523
|
+
*/
|
|
1524
|
+
'path'?: string;
|
|
1525
|
+
/**
|
|
1526
|
+
* Title extracted from the file\'s <title> tag, or the path if not present
|
|
1527
|
+
* @type {string}
|
|
1528
|
+
* @memberof Page
|
|
1529
|
+
*/
|
|
1530
|
+
'title'?: string;
|
|
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>;
|
|
1315
1580
|
}
|
|
1316
1581
|
/**
|
|
1317
1582
|
*
|
|
@@ -1567,6 +1832,16 @@ export interface RawNotebook {
|
|
|
1567
1832
|
*/
|
|
1568
1833
|
'sources'?: Array<Source>;
|
|
1569
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];
|
|
1570
1845
|
/**
|
|
1571
1846
|
* AWS S3 connection configuration for DuckDB
|
|
1572
1847
|
* @export
|
|
@@ -1783,7 +2058,7 @@ export interface Source {
|
|
|
1783
2058
|
*/
|
|
1784
2059
|
'givens'?: Array<Given>;
|
|
1785
2060
|
/**
|
|
1786
|
-
* Effective authorize expressions declared on this source via `#(authorize)` / `##(authorize)` annotations — file-level expressions first, then the source\'s own. Each is a Malloy boolean expression over declared givens.
|
|
2061
|
+
* Effective authorize expressions declared on this source via `#(authorize)` / `##(authorize)` annotations — file-level expressions first, then the source\'s own. Each is a Malloy boolean expression over declared givens, evaluated as a disjunction (OR) and enforced at query time. A request that reads this source is denied with HTTP 403 unless at least one expression evaluates true for the supplied givens; an empty or absent list means unrestricted. Givens are caller-asserted, so this is a boundary only behind a trusted tier — see docs/authorize.md.
|
|
1787
2062
|
* @type {Array<string>}
|
|
1788
2063
|
* @memberof Source
|
|
1789
2064
|
*/
|
|
@@ -1871,31 +2146,6 @@ export interface TableDescription {
|
|
|
1871
2146
|
*/
|
|
1872
2147
|
'columns'?: Array<Column>;
|
|
1873
2148
|
}
|
|
1874
|
-
/**
|
|
1875
|
-
*
|
|
1876
|
-
* @export
|
|
1877
|
-
* @interface TableSource
|
|
1878
|
-
*/
|
|
1879
|
-
export interface TableSource {
|
|
1880
|
-
/**
|
|
1881
|
-
* Resource path to the table source.
|
|
1882
|
-
* @type {string}
|
|
1883
|
-
* @memberof TableSource
|
|
1884
|
-
*/
|
|
1885
|
-
'resource'?: string;
|
|
1886
|
-
/**
|
|
1887
|
-
*
|
|
1888
|
-
* @type {string}
|
|
1889
|
-
* @memberof TableSource
|
|
1890
|
-
*/
|
|
1891
|
-
'source'?: string;
|
|
1892
|
-
/**
|
|
1893
|
-
* Table fields
|
|
1894
|
-
* @type {Array<Column>}
|
|
1895
|
-
* @memberof TableSource
|
|
1896
|
-
*/
|
|
1897
|
-
'columns'?: Array<Column>;
|
|
1898
|
-
}
|
|
1899
2149
|
/**
|
|
1900
2150
|
*
|
|
1901
2151
|
* @export
|
|
@@ -2102,29 +2352,6 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2102
2352
|
* @throws {RequiredError}
|
|
2103
2353
|
*/
|
|
2104
2354
|
getConnection: (environmentName: string, connectionName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2105
|
-
/**
|
|
2106
|
-
* **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.
|
|
2107
|
-
* @summary Get SQL source (deprecated)
|
|
2108
|
-
* @param {string} environmentName Name of the environment
|
|
2109
|
-
* @param {string} connectionName Name of the connection
|
|
2110
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2111
|
-
* @param {*} [options] Override http request option.
|
|
2112
|
-
* @deprecated
|
|
2113
|
-
* @throws {RequiredError}
|
|
2114
|
-
*/
|
|
2115
|
-
getSqlsource: (environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2116
|
-
/**
|
|
2117
|
-
* **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.
|
|
2118
|
-
* @summary Get SQL source (per-package, deprecated)
|
|
2119
|
-
* @param {string} environmentName Name of the environment
|
|
2120
|
-
* @param {string} packageName Name of the package whose connection context to use
|
|
2121
|
-
* @param {string} connectionName Name of the connection
|
|
2122
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2123
|
-
* @param {*} [options] Override http request option.
|
|
2124
|
-
* @deprecated
|
|
2125
|
-
* @throws {RequiredError}
|
|
2126
|
-
*/
|
|
2127
|
-
getSqlsourceInPackage: (environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2128
2355
|
/**
|
|
2129
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.
|
|
2130
2357
|
* @summary Get table details from database
|
|
@@ -2148,29 +2375,6 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2148
2375
|
* @throws {RequiredError}
|
|
2149
2376
|
*/
|
|
2150
2377
|
getTableInPackage: (environmentName: string, packageName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2151
|
-
/**
|
|
2152
|
-
* **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.
|
|
2153
|
-
* @summary Create temporary table (deprecated)
|
|
2154
|
-
* @param {string} environmentName Name of the environment
|
|
2155
|
-
* @param {string} connectionName Name of the connection
|
|
2156
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2157
|
-
* @param {*} [options] Override http request option.
|
|
2158
|
-
* @deprecated
|
|
2159
|
-
* @throws {RequiredError}
|
|
2160
|
-
*/
|
|
2161
|
-
getTemporarytable: (environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2162
|
-
/**
|
|
2163
|
-
* **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.
|
|
2164
|
-
* @summary Create temporary table (per-package, deprecated)
|
|
2165
|
-
* @param {string} environmentName Name of the environment
|
|
2166
|
-
* @param {string} packageName Name of the package whose connection context to use
|
|
2167
|
-
* @param {string} connectionName Name of the connection
|
|
2168
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2169
|
-
* @param {*} [options] Override http request option.
|
|
2170
|
-
* @deprecated
|
|
2171
|
-
* @throws {RequiredError}
|
|
2172
|
-
*/
|
|
2173
|
-
getTemporarytableInPackage: (environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2174
2378
|
/**
|
|
2175
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.
|
|
2176
2380
|
* @summary List environment database connections
|
|
@@ -2227,11 +2431,10 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2227
2431
|
* @param {string} environmentName Name of the environment
|
|
2228
2432
|
* @param {string} connectionName Name of the connection
|
|
2229
2433
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2230
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2231
2434
|
* @param {*} [options] Override http request option.
|
|
2232
2435
|
* @throws {RequiredError}
|
|
2233
2436
|
*/
|
|
2234
|
-
postQuerydata: (environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2437
|
+
postQuerydata: (environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2235
2438
|
/**
|
|
2236
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.
|
|
2237
2440
|
* @summary Execute SQL query (per-package)
|
|
@@ -2239,11 +2442,10 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2239
2442
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2240
2443
|
* @param {string} connectionName Name of the connection
|
|
2241
2444
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2242
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2243
2445
|
* @param {*} [options] Override http request option.
|
|
2244
2446
|
* @throws {RequiredError}
|
|
2245
2447
|
*/
|
|
2246
|
-
postQuerydataInPackage: (environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2448
|
+
postQuerydataInPackage: (environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2247
2449
|
/**
|
|
2248
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.
|
|
2249
2451
|
* @summary Create SQL source from statement
|
|
@@ -2330,29 +2532,6 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2330
2532
|
* @throws {RequiredError}
|
|
2331
2533
|
*/
|
|
2332
2534
|
getConnection(environmentName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Connection>>;
|
|
2333
|
-
/**
|
|
2334
|
-
* **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.
|
|
2335
|
-
* @summary Get SQL source (deprecated)
|
|
2336
|
-
* @param {string} environmentName Name of the environment
|
|
2337
|
-
* @param {string} connectionName Name of the connection
|
|
2338
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2339
|
-
* @param {*} [options] Override http request option.
|
|
2340
|
-
* @deprecated
|
|
2341
|
-
* @throws {RequiredError}
|
|
2342
|
-
*/
|
|
2343
|
-
getSqlsource(environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SqlSource>>;
|
|
2344
|
-
/**
|
|
2345
|
-
* **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.
|
|
2346
|
-
* @summary Get SQL source (per-package, deprecated)
|
|
2347
|
-
* @param {string} environmentName Name of the environment
|
|
2348
|
-
* @param {string} packageName Name of the package whose connection context to use
|
|
2349
|
-
* @param {string} connectionName Name of the connection
|
|
2350
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2351
|
-
* @param {*} [options] Override http request option.
|
|
2352
|
-
* @deprecated
|
|
2353
|
-
* @throws {RequiredError}
|
|
2354
|
-
*/
|
|
2355
|
-
getSqlsourceInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SqlSource>>;
|
|
2356
2535
|
/**
|
|
2357
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.
|
|
2358
2537
|
* @summary Get table details from database
|
|
@@ -2376,29 +2555,6 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2376
2555
|
* @throws {RequiredError}
|
|
2377
2556
|
*/
|
|
2378
2557
|
getTableInPackage(environmentName: string, packageName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Table>>;
|
|
2379
|
-
/**
|
|
2380
|
-
* **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.
|
|
2381
|
-
* @summary Create temporary table (deprecated)
|
|
2382
|
-
* @param {string} environmentName Name of the environment
|
|
2383
|
-
* @param {string} connectionName Name of the connection
|
|
2384
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2385
|
-
* @param {*} [options] Override http request option.
|
|
2386
|
-
* @deprecated
|
|
2387
|
-
* @throws {RequiredError}
|
|
2388
|
-
*/
|
|
2389
|
-
getTemporarytable(environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemporaryTable>>;
|
|
2390
|
-
/**
|
|
2391
|
-
* **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.
|
|
2392
|
-
* @summary Create temporary table (per-package, deprecated)
|
|
2393
|
-
* @param {string} environmentName Name of the environment
|
|
2394
|
-
* @param {string} packageName Name of the package whose connection context to use
|
|
2395
|
-
* @param {string} connectionName Name of the connection
|
|
2396
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2397
|
-
* @param {*} [options] Override http request option.
|
|
2398
|
-
* @deprecated
|
|
2399
|
-
* @throws {RequiredError}
|
|
2400
|
-
*/
|
|
2401
|
-
getTemporarytableInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemporaryTable>>;
|
|
2402
2558
|
/**
|
|
2403
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.
|
|
2404
2560
|
* @summary List environment database connections
|
|
@@ -2455,11 +2611,10 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2455
2611
|
* @param {string} environmentName Name of the environment
|
|
2456
2612
|
* @param {string} connectionName Name of the connection
|
|
2457
2613
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2458
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2459
2614
|
* @param {*} [options] Override http request option.
|
|
2460
2615
|
* @throws {RequiredError}
|
|
2461
2616
|
*/
|
|
2462
|
-
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2617
|
+
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryData>>;
|
|
2463
2618
|
/**
|
|
2464
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.
|
|
2465
2620
|
* @summary Execute SQL query (per-package)
|
|
@@ -2467,11 +2622,10 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2467
2622
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2468
2623
|
* @param {string} connectionName Name of the connection
|
|
2469
2624
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2470
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2471
2625
|
* @param {*} [options] Override http request option.
|
|
2472
2626
|
* @throws {RequiredError}
|
|
2473
2627
|
*/
|
|
2474
|
-
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>>;
|
|
2475
2629
|
/**
|
|
2476
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.
|
|
2477
2631
|
* @summary Create SQL source from statement
|
|
@@ -2558,29 +2712,6 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2558
2712
|
* @throws {RequiredError}
|
|
2559
2713
|
*/
|
|
2560
2714
|
getConnection(environmentName: string, connectionName: string, options?: RawAxiosRequestConfig): AxiosPromise<Connection>;
|
|
2561
|
-
/**
|
|
2562
|
-
* **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.
|
|
2563
|
-
* @summary Get SQL source (deprecated)
|
|
2564
|
-
* @param {string} environmentName Name of the environment
|
|
2565
|
-
* @param {string} connectionName Name of the connection
|
|
2566
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2567
|
-
* @param {*} [options] Override http request option.
|
|
2568
|
-
* @deprecated
|
|
2569
|
-
* @throws {RequiredError}
|
|
2570
|
-
*/
|
|
2571
|
-
getSqlsource(environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<SqlSource>;
|
|
2572
|
-
/**
|
|
2573
|
-
* **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.
|
|
2574
|
-
* @summary Get SQL source (per-package, deprecated)
|
|
2575
|
-
* @param {string} environmentName Name of the environment
|
|
2576
|
-
* @param {string} packageName Name of the package whose connection context to use
|
|
2577
|
-
* @param {string} connectionName Name of the connection
|
|
2578
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2579
|
-
* @param {*} [options] Override http request option.
|
|
2580
|
-
* @deprecated
|
|
2581
|
-
* @throws {RequiredError}
|
|
2582
|
-
*/
|
|
2583
|
-
getSqlsourceInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<SqlSource>;
|
|
2584
2715
|
/**
|
|
2585
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.
|
|
2586
2717
|
* @summary Get table details from database
|
|
@@ -2604,29 +2735,6 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2604
2735
|
* @throws {RequiredError}
|
|
2605
2736
|
*/
|
|
2606
2737
|
getTableInPackage(environmentName: string, packageName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): AxiosPromise<Table>;
|
|
2607
|
-
/**
|
|
2608
|
-
* **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.
|
|
2609
|
-
* @summary Create temporary table (deprecated)
|
|
2610
|
-
* @param {string} environmentName Name of the environment
|
|
2611
|
-
* @param {string} connectionName Name of the connection
|
|
2612
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2613
|
-
* @param {*} [options] Override http request option.
|
|
2614
|
-
* @deprecated
|
|
2615
|
-
* @throws {RequiredError}
|
|
2616
|
-
*/
|
|
2617
|
-
getTemporarytable(environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<TemporaryTable>;
|
|
2618
|
-
/**
|
|
2619
|
-
* **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.
|
|
2620
|
-
* @summary Create temporary table (per-package, deprecated)
|
|
2621
|
-
* @param {string} environmentName Name of the environment
|
|
2622
|
-
* @param {string} packageName Name of the package whose connection context to use
|
|
2623
|
-
* @param {string} connectionName Name of the connection
|
|
2624
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2625
|
-
* @param {*} [options] Override http request option.
|
|
2626
|
-
* @deprecated
|
|
2627
|
-
* @throws {RequiredError}
|
|
2628
|
-
*/
|
|
2629
|
-
getTemporarytableInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<TemporaryTable>;
|
|
2630
2738
|
/**
|
|
2631
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.
|
|
2632
2740
|
* @summary List environment database connections
|
|
@@ -2683,11 +2791,10 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2683
2791
|
* @param {string} environmentName Name of the environment
|
|
2684
2792
|
* @param {string} connectionName Name of the connection
|
|
2685
2793
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2686
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2687
2794
|
* @param {*} [options] Override http request option.
|
|
2688
2795
|
* @throws {RequiredError}
|
|
2689
2796
|
*/
|
|
2690
|
-
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2797
|
+
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): AxiosPromise<QueryData>;
|
|
2691
2798
|
/**
|
|
2692
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.
|
|
2693
2800
|
* @summary Execute SQL query (per-package)
|
|
@@ -2695,11 +2802,10 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2695
2802
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2696
2803
|
* @param {string} connectionName Name of the connection
|
|
2697
2804
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2698
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2699
2805
|
* @param {*} [options] Override http request option.
|
|
2700
2806
|
* @throws {RequiredError}
|
|
2701
2807
|
*/
|
|
2702
|
-
postQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2808
|
+
postQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): AxiosPromise<QueryData>;
|
|
2703
2809
|
/**
|
|
2704
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.
|
|
2705
2811
|
* @summary Create SQL source from statement
|
|
@@ -2791,31 +2897,6 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2791
2897
|
* @memberof ConnectionsApi
|
|
2792
2898
|
*/
|
|
2793
2899
|
getConnection(environmentName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Connection, any, {}>>;
|
|
2794
|
-
/**
|
|
2795
|
-
* **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.
|
|
2796
|
-
* @summary Get SQL source (deprecated)
|
|
2797
|
-
* @param {string} environmentName Name of the environment
|
|
2798
|
-
* @param {string} connectionName Name of the connection
|
|
2799
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2800
|
-
* @param {*} [options] Override http request option.
|
|
2801
|
-
* @deprecated
|
|
2802
|
-
* @throws {RequiredError}
|
|
2803
|
-
* @memberof ConnectionsApi
|
|
2804
|
-
*/
|
|
2805
|
-
getSqlsource(environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<SqlSource, any, {}>>;
|
|
2806
|
-
/**
|
|
2807
|
-
* **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.
|
|
2808
|
-
* @summary Get SQL source (per-package, deprecated)
|
|
2809
|
-
* @param {string} environmentName Name of the environment
|
|
2810
|
-
* @param {string} packageName Name of the package whose connection context to use
|
|
2811
|
-
* @param {string} connectionName Name of the connection
|
|
2812
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2813
|
-
* @param {*} [options] Override http request option.
|
|
2814
|
-
* @deprecated
|
|
2815
|
-
* @throws {RequiredError}
|
|
2816
|
-
* @memberof ConnectionsApi
|
|
2817
|
-
*/
|
|
2818
|
-
getSqlsourceInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<SqlSource, any, {}>>;
|
|
2819
2900
|
/**
|
|
2820
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.
|
|
2821
2902
|
* @summary Get table details from database
|
|
@@ -2841,31 +2922,6 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2841
2922
|
* @memberof ConnectionsApi
|
|
2842
2923
|
*/
|
|
2843
2924
|
getTableInPackage(environmentName: string, packageName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Table, any, {}>>;
|
|
2844
|
-
/**
|
|
2845
|
-
* **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.
|
|
2846
|
-
* @summary Create temporary table (deprecated)
|
|
2847
|
-
* @param {string} environmentName Name of the environment
|
|
2848
|
-
* @param {string} connectionName Name of the connection
|
|
2849
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2850
|
-
* @param {*} [options] Override http request option.
|
|
2851
|
-
* @deprecated
|
|
2852
|
-
* @throws {RequiredError}
|
|
2853
|
-
* @memberof ConnectionsApi
|
|
2854
|
-
*/
|
|
2855
|
-
getTemporarytable(environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<TemporaryTable, any, {}>>;
|
|
2856
|
-
/**
|
|
2857
|
-
* **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.
|
|
2858
|
-
* @summary Create temporary table (per-package, deprecated)
|
|
2859
|
-
* @param {string} environmentName Name of the environment
|
|
2860
|
-
* @param {string} packageName Name of the package whose connection context to use
|
|
2861
|
-
* @param {string} connectionName Name of the connection
|
|
2862
|
-
* @param {string} [sqlStatement] SQL statement
|
|
2863
|
-
* @param {*} [options] Override http request option.
|
|
2864
|
-
* @deprecated
|
|
2865
|
-
* @throws {RequiredError}
|
|
2866
|
-
* @memberof ConnectionsApi
|
|
2867
|
-
*/
|
|
2868
|
-
getTemporarytableInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<TemporaryTable, any, {}>>;
|
|
2869
2925
|
/**
|
|
2870
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.
|
|
2871
2927
|
* @summary List environment database connections
|
|
@@ -2927,12 +2983,11 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2927
2983
|
* @param {string} environmentName Name of the environment
|
|
2928
2984
|
* @param {string} connectionName Name of the connection
|
|
2929
2985
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2930
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2931
2986
|
* @param {*} [options] Override http request option.
|
|
2932
2987
|
* @throws {RequiredError}
|
|
2933
2988
|
* @memberof ConnectionsApi
|
|
2934
2989
|
*/
|
|
2935
|
-
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest,
|
|
2990
|
+
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<QueryData, any, {}>>;
|
|
2936
2991
|
/**
|
|
2937
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.
|
|
2938
2993
|
* @summary Execute SQL query (per-package)
|
|
@@ -2940,12 +2995,11 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2940
2995
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2941
2996
|
* @param {string} connectionName Name of the connection
|
|
2942
2997
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2943
|
-
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2944
2998
|
* @param {*} [options] Override http request option.
|
|
2945
2999
|
* @throws {RequiredError}
|
|
2946
3000
|
* @memberof ConnectionsApi
|
|
2947
3001
|
*/
|
|
2948
|
-
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, {}>>;
|
|
2949
3003
|
/**
|
|
2950
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.
|
|
2951
3005
|
* @summary Create SQL source from statement
|
|
@@ -3325,125 +3379,14 @@ export declare class EnvironmentsApi extends BaseAPI {
|
|
|
3325
3379
|
*/
|
|
3326
3380
|
updateEnvironment(environmentName: string, environment: Environment, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Environment, any, {}>>;
|
|
3327
3381
|
}
|
|
3328
|
-
/**
|
|
3329
|
-
* ManifestsApi - axios parameter creator
|
|
3330
|
-
* @export
|
|
3331
|
-
*/
|
|
3332
|
-
export declare const ManifestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3333
|
-
/**
|
|
3334
|
-
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
3335
|
-
* @summary Get the build manifest for a package
|
|
3336
|
-
* @param {string} environmentName Name of the environment
|
|
3337
|
-
* @param {string} packageName Name of the package
|
|
3338
|
-
* @param {*} [options] Override http request option.
|
|
3339
|
-
* @throws {RequiredError}
|
|
3340
|
-
*/
|
|
3341
|
-
getManifest: (environmentName: string, packageName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3342
|
-
/**
|
|
3343
|
-
* 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.
|
|
3344
|
-
* @summary Perform an action on the package manifest
|
|
3345
|
-
* @param {string} environmentName Name of the environment
|
|
3346
|
-
* @param {string} packageName Name of the package
|
|
3347
|
-
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
3348
|
-
* @param {*} [options] Override http request option.
|
|
3349
|
-
* @throws {RequiredError}
|
|
3350
|
-
*/
|
|
3351
|
-
manifestAction: (environmentName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3352
|
-
};
|
|
3353
|
-
/**
|
|
3354
|
-
* ManifestsApi - functional programming interface
|
|
3355
|
-
* @export
|
|
3356
|
-
*/
|
|
3357
|
-
export declare const ManifestsApiFp: (configuration?: Configuration) => {
|
|
3358
|
-
/**
|
|
3359
|
-
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
3360
|
-
* @summary Get the build manifest for a package
|
|
3361
|
-
* @param {string} environmentName Name of the environment
|
|
3362
|
-
* @param {string} packageName Name of the package
|
|
3363
|
-
* @param {*} [options] Override http request option.
|
|
3364
|
-
* @throws {RequiredError}
|
|
3365
|
-
*/
|
|
3366
|
-
getManifest(environmentName: string, packageName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BuildManifest>>;
|
|
3367
|
-
/**
|
|
3368
|
-
* 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.
|
|
3369
|
-
* @summary Perform an action on the package manifest
|
|
3370
|
-
* @param {string} environmentName Name of the environment
|
|
3371
|
-
* @param {string} packageName Name of the package
|
|
3372
|
-
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
3373
|
-
* @param {*} [options] Override http request option.
|
|
3374
|
-
* @throws {RequiredError}
|
|
3375
|
-
*/
|
|
3376
|
-
manifestAction(environmentName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BuildManifest>>;
|
|
3377
|
-
};
|
|
3378
|
-
/**
|
|
3379
|
-
* ManifestsApi - factory interface
|
|
3380
|
-
* @export
|
|
3381
|
-
*/
|
|
3382
|
-
export declare const ManifestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3383
|
-
/**
|
|
3384
|
-
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
3385
|
-
* @summary Get the build manifest for a package
|
|
3386
|
-
* @param {string} environmentName Name of the environment
|
|
3387
|
-
* @param {string} packageName Name of the package
|
|
3388
|
-
* @param {*} [options] Override http request option.
|
|
3389
|
-
* @throws {RequiredError}
|
|
3390
|
-
*/
|
|
3391
|
-
getManifest(environmentName: string, packageName: string, options?: RawAxiosRequestConfig): AxiosPromise<BuildManifest>;
|
|
3392
|
-
/**
|
|
3393
|
-
* 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.
|
|
3394
|
-
* @summary Perform an action on the package manifest
|
|
3395
|
-
* @param {string} environmentName Name of the environment
|
|
3396
|
-
* @param {string} packageName Name of the package
|
|
3397
|
-
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
3398
|
-
* @param {*} [options] Override http request option.
|
|
3399
|
-
* @throws {RequiredError}
|
|
3400
|
-
*/
|
|
3401
|
-
manifestAction(environmentName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig): AxiosPromise<BuildManifest>;
|
|
3402
|
-
};
|
|
3403
|
-
/**
|
|
3404
|
-
* ManifestsApi - object-oriented interface
|
|
3405
|
-
* @export
|
|
3406
|
-
* @class ManifestsApi
|
|
3407
|
-
* @extends {BaseAPI}
|
|
3408
|
-
*/
|
|
3409
|
-
export declare class ManifestsApi extends BaseAPI {
|
|
3410
|
-
/**
|
|
3411
|
-
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
3412
|
-
* @summary Get the build manifest for a package
|
|
3413
|
-
* @param {string} environmentName Name of the environment
|
|
3414
|
-
* @param {string} packageName Name of the package
|
|
3415
|
-
* @param {*} [options] Override http request option.
|
|
3416
|
-
* @throws {RequiredError}
|
|
3417
|
-
* @memberof ManifestsApi
|
|
3418
|
-
*/
|
|
3419
|
-
getManifest(environmentName: string, packageName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<BuildManifest, any, {}>>;
|
|
3420
|
-
/**
|
|
3421
|
-
* 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.
|
|
3422
|
-
* @summary Perform an action on the package manifest
|
|
3423
|
-
* @param {string} environmentName Name of the environment
|
|
3424
|
-
* @param {string} packageName Name of the package
|
|
3425
|
-
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
3426
|
-
* @param {*} [options] Override http request option.
|
|
3427
|
-
* @throws {RequiredError}
|
|
3428
|
-
* @memberof ManifestsApi
|
|
3429
|
-
*/
|
|
3430
|
-
manifestAction(environmentName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig): Promise< AxiosResponse<BuildManifest, any, {}>>;
|
|
3431
|
-
}
|
|
3432
|
-
/**
|
|
3433
|
-
* @export
|
|
3434
|
-
*/
|
|
3435
|
-
export declare const ManifestActionActionEnum: {
|
|
3436
|
-
readonly Reload: "reload";
|
|
3437
|
-
};
|
|
3438
|
-
export type ManifestActionActionEnum = typeof ManifestActionActionEnum[keyof typeof ManifestActionActionEnum];
|
|
3439
3382
|
/**
|
|
3440
3383
|
* MaterializationsApi - axios parameter creator
|
|
3441
3384
|
* @export
|
|
3442
3385
|
*/
|
|
3443
3386
|
export declare const MaterializationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3444
3387
|
/**
|
|
3445
|
-
*
|
|
3446
|
-
* @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)
|
|
3447
3390
|
* @param {string} environmentName Name of the environment
|
|
3448
3391
|
* @param {string} packageName Name of the package
|
|
3449
3392
|
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
@@ -3452,15 +3395,16 @@ export declare const MaterializationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
3452
3395
|
*/
|
|
3453
3396
|
createMaterialization: (environmentName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3454
3397
|
/**
|
|
3455
|
-
* 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.
|
|
3456
3399
|
* @summary Delete a materialization
|
|
3457
3400
|
* @param {string} environmentName Name of the environment
|
|
3458
3401
|
* @param {string} packageName Name of the package
|
|
3459
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).
|
|
3460
3404
|
* @param {*} [options] Override http request option.
|
|
3461
3405
|
* @throws {RequiredError}
|
|
3462
3406
|
*/
|
|
3463
|
-
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>;
|
|
3464
3408
|
/**
|
|
3465
3409
|
*
|
|
3466
3410
|
* @summary Get a specific materialization
|
|
@@ -3483,16 +3427,17 @@ export declare const MaterializationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
3483
3427
|
*/
|
|
3484
3428
|
listMaterializations: (environmentName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3485
3429
|
/**
|
|
3486
|
-
* 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.
|
|
3487
3431
|
* @summary Perform an action on a materialization
|
|
3488
3432
|
* @param {string} environmentName Name of the environment
|
|
3489
3433
|
* @param {string} packageName Name of the package
|
|
3490
3434
|
* @param {string} materializationId ID of the materialization
|
|
3491
3435
|
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
3436
|
+
* @param {BuildInstructions} [buildInstructions]
|
|
3492
3437
|
* @param {*} [options] Override http request option.
|
|
3493
3438
|
* @throws {RequiredError}
|
|
3494
3439
|
*/
|
|
3495
|
-
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>;
|
|
3496
3441
|
};
|
|
3497
3442
|
/**
|
|
3498
3443
|
* MaterializationsApi - functional programming interface
|
|
@@ -3500,8 +3445,8 @@ export declare const MaterializationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
3500
3445
|
*/
|
|
3501
3446
|
export declare const MaterializationsApiFp: (configuration?: Configuration) => {
|
|
3502
3447
|
/**
|
|
3503
|
-
*
|
|
3504
|
-
* @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)
|
|
3505
3450
|
* @param {string} environmentName Name of the environment
|
|
3506
3451
|
* @param {string} packageName Name of the package
|
|
3507
3452
|
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
@@ -3510,15 +3455,16 @@ export declare const MaterializationsApiFp: (configuration?: Configuration) => {
|
|
|
3510
3455
|
*/
|
|
3511
3456
|
createMaterialization(environmentName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Materialization>>;
|
|
3512
3457
|
/**
|
|
3513
|
-
* 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.
|
|
3514
3459
|
* @summary Delete a materialization
|
|
3515
3460
|
* @param {string} environmentName Name of the environment
|
|
3516
3461
|
* @param {string} packageName Name of the package
|
|
3517
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).
|
|
3518
3464
|
* @param {*} [options] Override http request option.
|
|
3519
3465
|
* @throws {RequiredError}
|
|
3520
3466
|
*/
|
|
3521
|
-
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>>;
|
|
3522
3468
|
/**
|
|
3523
3469
|
*
|
|
3524
3470
|
* @summary Get a specific materialization
|
|
@@ -3541,16 +3487,17 @@ export declare const MaterializationsApiFp: (configuration?: Configuration) => {
|
|
|
3541
3487
|
*/
|
|
3542
3488
|
listMaterializations(environmentName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Materialization>>>;
|
|
3543
3489
|
/**
|
|
3544
|
-
* 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.
|
|
3545
3491
|
* @summary Perform an action on a materialization
|
|
3546
3492
|
* @param {string} environmentName Name of the environment
|
|
3547
3493
|
* @param {string} packageName Name of the package
|
|
3548
3494
|
* @param {string} materializationId ID of the materialization
|
|
3549
3495
|
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
3496
|
+
* @param {BuildInstructions} [buildInstructions]
|
|
3550
3497
|
* @param {*} [options] Override http request option.
|
|
3551
3498
|
* @throws {RequiredError}
|
|
3552
3499
|
*/
|
|
3553
|
-
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>>;
|
|
3554
3501
|
};
|
|
3555
3502
|
/**
|
|
3556
3503
|
* MaterializationsApi - factory interface
|
|
@@ -3558,8 +3505,8 @@ export declare const MaterializationsApiFp: (configuration?: Configuration) => {
|
|
|
3558
3505
|
*/
|
|
3559
3506
|
export declare const MaterializationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3560
3507
|
/**
|
|
3561
|
-
*
|
|
3562
|
-
* @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)
|
|
3563
3510
|
* @param {string} environmentName Name of the environment
|
|
3564
3511
|
* @param {string} packageName Name of the package
|
|
3565
3512
|
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
@@ -3568,15 +3515,16 @@ export declare const MaterializationsApiFactory: (configuration?: Configuration,
|
|
|
3568
3515
|
*/
|
|
3569
3516
|
createMaterialization(environmentName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig): AxiosPromise<Materialization>;
|
|
3570
3517
|
/**
|
|
3571
|
-
* 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.
|
|
3572
3519
|
* @summary Delete a materialization
|
|
3573
3520
|
* @param {string} environmentName Name of the environment
|
|
3574
3521
|
* @param {string} packageName Name of the package
|
|
3575
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).
|
|
3576
3524
|
* @param {*} [options] Override http request option.
|
|
3577
3525
|
* @throws {RequiredError}
|
|
3578
3526
|
*/
|
|
3579
|
-
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>;
|
|
3580
3528
|
/**
|
|
3581
3529
|
*
|
|
3582
3530
|
* @summary Get a specific materialization
|
|
@@ -3599,16 +3547,17 @@ export declare const MaterializationsApiFactory: (configuration?: Configuration,
|
|
|
3599
3547
|
*/
|
|
3600
3548
|
listMaterializations(environmentName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Materialization>>;
|
|
3601
3549
|
/**
|
|
3602
|
-
* 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.
|
|
3603
3551
|
* @summary Perform an action on a materialization
|
|
3604
3552
|
* @param {string} environmentName Name of the environment
|
|
3605
3553
|
* @param {string} packageName Name of the package
|
|
3606
3554
|
* @param {string} materializationId ID of the materialization
|
|
3607
3555
|
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
3556
|
+
* @param {BuildInstructions} [buildInstructions]
|
|
3608
3557
|
* @param {*} [options] Override http request option.
|
|
3609
3558
|
* @throws {RequiredError}
|
|
3610
3559
|
*/
|
|
3611
|
-
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>;
|
|
3612
3561
|
};
|
|
3613
3562
|
/**
|
|
3614
3563
|
* MaterializationsApi - object-oriented interface
|
|
@@ -3618,8 +3567,8 @@ export declare const MaterializationsApiFactory: (configuration?: Configuration,
|
|
|
3618
3567
|
*/
|
|
3619
3568
|
export declare class MaterializationsApi extends BaseAPI {
|
|
3620
3569
|
/**
|
|
3621
|
-
*
|
|
3622
|
-
* @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)
|
|
3623
3572
|
* @param {string} environmentName Name of the environment
|
|
3624
3573
|
* @param {string} packageName Name of the package
|
|
3625
3574
|
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
@@ -3629,16 +3578,17 @@ export declare class MaterializationsApi extends BaseAPI {
|
|
|
3629
3578
|
*/
|
|
3630
3579
|
createMaterialization(environmentName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Materialization, any, {}>>;
|
|
3631
3580
|
/**
|
|
3632
|
-
* 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.
|
|
3633
3582
|
* @summary Delete a materialization
|
|
3634
3583
|
* @param {string} environmentName Name of the environment
|
|
3635
3584
|
* @param {string} packageName Name of the package
|
|
3636
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).
|
|
3637
3587
|
* @param {*} [options] Override http request option.
|
|
3638
3588
|
* @throws {RequiredError}
|
|
3639
3589
|
* @memberof MaterializationsApi
|
|
3640
3590
|
*/
|
|
3641
|
-
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, {}>>;
|
|
3642
3592
|
/**
|
|
3643
3593
|
*
|
|
3644
3594
|
* @summary Get a specific materialization
|
|
@@ -3663,23 +3613,24 @@ export declare class MaterializationsApi extends BaseAPI {
|
|
|
3663
3613
|
*/
|
|
3664
3614
|
listMaterializations(environmentName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Materialization[], any, {}>>;
|
|
3665
3615
|
/**
|
|
3666
|
-
* 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.
|
|
3667
3617
|
* @summary Perform an action on a materialization
|
|
3668
3618
|
* @param {string} environmentName Name of the environment
|
|
3669
3619
|
* @param {string} packageName Name of the package
|
|
3670
3620
|
* @param {string} materializationId ID of the materialization
|
|
3671
3621
|
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
3622
|
+
* @param {BuildInstructions} [buildInstructions]
|
|
3672
3623
|
* @param {*} [options] Override http request option.
|
|
3673
3624
|
* @throws {RequiredError}
|
|
3674
3625
|
* @memberof MaterializationsApi
|
|
3675
3626
|
*/
|
|
3676
|
-
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, {}>>;
|
|
3677
3628
|
}
|
|
3678
3629
|
/**
|
|
3679
3630
|
* @export
|
|
3680
3631
|
*/
|
|
3681
3632
|
export declare const MaterializationActionActionEnum: {
|
|
3682
|
-
readonly
|
|
3633
|
+
readonly Build: "build";
|
|
3683
3634
|
readonly Stop: "stop";
|
|
3684
3635
|
};
|
|
3685
3636
|
export type MaterializationActionActionEnum = typeof MaterializationActionActionEnum[keyof typeof MaterializationActionActionEnum];
|
|
@@ -4076,11 +4027,10 @@ export declare const PackagesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
4076
4027
|
* @summary Create a new package
|
|
4077
4028
|
* @param {string} environmentName Name of the environment
|
|
4078
4029
|
* @param {Package} _package
|
|
4079
|
-
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
4080
4030
|
* @param {*} [options] Override http request option.
|
|
4081
4031
|
* @throws {RequiredError}
|
|
4082
4032
|
*/
|
|
4083
|
-
createPackage: (environmentName: string, _package: Package,
|
|
4033
|
+
createPackage: (environmentName: string, _package: Package, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4084
4034
|
/**
|
|
4085
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.
|
|
4086
4036
|
* @summary Delete a package
|
|
@@ -4130,11 +4080,10 @@ export declare const PackagesApiFp: (configuration?: Configuration) => {
|
|
|
4130
4080
|
* @summary Create a new package
|
|
4131
4081
|
* @param {string} environmentName Name of the environment
|
|
4132
4082
|
* @param {Package} _package
|
|
4133
|
-
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
4134
4083
|
* @param {*} [options] Override http request option.
|
|
4135
4084
|
* @throws {RequiredError}
|
|
4136
4085
|
*/
|
|
4137
|
-
createPackage(environmentName: string, _package: Package,
|
|
4086
|
+
createPackage(environmentName: string, _package: Package, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
4138
4087
|
/**
|
|
4139
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.
|
|
4140
4089
|
* @summary Delete a package
|
|
@@ -4184,11 +4133,10 @@ export declare const PackagesApiFactory: (configuration?: Configuration, basePat
|
|
|
4184
4133
|
* @summary Create a new package
|
|
4185
4134
|
* @param {string} environmentName Name of the environment
|
|
4186
4135
|
* @param {Package} _package
|
|
4187
|
-
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
4188
4136
|
* @param {*} [options] Override http request option.
|
|
4189
4137
|
* @throws {RequiredError}
|
|
4190
4138
|
*/
|
|
4191
|
-
createPackage(environmentName: string, _package: Package,
|
|
4139
|
+
createPackage(environmentName: string, _package: Package, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
4192
4140
|
/**
|
|
4193
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.
|
|
4194
4142
|
* @summary Delete a package
|
|
@@ -4240,12 +4188,11 @@ export declare class PackagesApi extends BaseAPI {
|
|
|
4240
4188
|
* @summary Create a new package
|
|
4241
4189
|
* @param {string} environmentName Name of the environment
|
|
4242
4190
|
* @param {Package} _package
|
|
4243
|
-
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
4244
4191
|
* @param {*} [options] Override http request option.
|
|
4245
4192
|
* @throws {RequiredError}
|
|
4246
4193
|
* @memberof PackagesApi
|
|
4247
4194
|
*/
|
|
4248
|
-
createPackage(environmentName: string, _package: Package,
|
|
4195
|
+
createPackage(environmentName: string, _package: Package, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Package, any, {}>>;
|
|
4249
4196
|
/**
|
|
4250
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.
|
|
4251
4198
|
* @summary Delete a package
|
|
@@ -4289,6 +4236,69 @@ export declare class PackagesApi extends BaseAPI {
|
|
|
4289
4236
|
*/
|
|
4290
4237
|
updatePackage(environmentName: string, packageName: string, _package: Package, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Package, any, {}>>;
|
|
4291
4238
|
}
|
|
4239
|
+
/**
|
|
4240
|
+
* PagesApi - axios parameter creator
|
|
4241
|
+
* @export
|
|
4242
|
+
*/
|
|
4243
|
+
export declare const PagesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4244
|
+
/**
|
|
4245
|
+
* Retrieves a list of all static HTML pages (in-package data apps) within the specified package. Each page entry includes the relative path, the package name, a canonical resource URL, and the page title (extracted from the file\'s <title> tag, falling back to the path). Used by the Publisher SPA to surface a clickable \"Pages\" section on the package detail view, and by anyone who wants to discover in-package data apps programmatically without scraping the directory. Recursive depth is capped server-side to keep this cheap on large packages.
|
|
4246
|
+
* @summary List package pages
|
|
4247
|
+
* @param {string} environmentName Name of the environment
|
|
4248
|
+
* @param {string} packageName Name of the package
|
|
4249
|
+
* @param {*} [options] Override http request option.
|
|
4250
|
+
* @throws {RequiredError}
|
|
4251
|
+
*/
|
|
4252
|
+
listPages: (environmentName: string, packageName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4253
|
+
};
|
|
4254
|
+
/**
|
|
4255
|
+
* PagesApi - functional programming interface
|
|
4256
|
+
* @export
|
|
4257
|
+
*/
|
|
4258
|
+
export declare const PagesApiFp: (configuration?: Configuration) => {
|
|
4259
|
+
/**
|
|
4260
|
+
* Retrieves a list of all static HTML pages (in-package data apps) within the specified package. Each page entry includes the relative path, the package name, a canonical resource URL, and the page title (extracted from the file\'s <title> tag, falling back to the path). Used by the Publisher SPA to surface a clickable \"Pages\" section on the package detail view, and by anyone who wants to discover in-package data apps programmatically without scraping the directory. Recursive depth is capped server-side to keep this cheap on large packages.
|
|
4261
|
+
* @summary List package pages
|
|
4262
|
+
* @param {string} environmentName Name of the environment
|
|
4263
|
+
* @param {string} packageName Name of the package
|
|
4264
|
+
* @param {*} [options] Override http request option.
|
|
4265
|
+
* @throws {RequiredError}
|
|
4266
|
+
*/
|
|
4267
|
+
listPages(environmentName: string, packageName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Page>>>;
|
|
4268
|
+
};
|
|
4269
|
+
/**
|
|
4270
|
+
* PagesApi - factory interface
|
|
4271
|
+
* @export
|
|
4272
|
+
*/
|
|
4273
|
+
export declare const PagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4274
|
+
/**
|
|
4275
|
+
* Retrieves a list of all static HTML pages (in-package data apps) within the specified package. Each page entry includes the relative path, the package name, a canonical resource URL, and the page title (extracted from the file\'s <title> tag, falling back to the path). Used by the Publisher SPA to surface a clickable \"Pages\" section on the package detail view, and by anyone who wants to discover in-package data apps programmatically without scraping the directory. Recursive depth is capped server-side to keep this cheap on large packages.
|
|
4276
|
+
* @summary List package pages
|
|
4277
|
+
* @param {string} environmentName Name of the environment
|
|
4278
|
+
* @param {string} packageName Name of the package
|
|
4279
|
+
* @param {*} [options] Override http request option.
|
|
4280
|
+
* @throws {RequiredError}
|
|
4281
|
+
*/
|
|
4282
|
+
listPages(environmentName: string, packageName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Page>>;
|
|
4283
|
+
};
|
|
4284
|
+
/**
|
|
4285
|
+
* PagesApi - object-oriented interface
|
|
4286
|
+
* @export
|
|
4287
|
+
* @class PagesApi
|
|
4288
|
+
* @extends {BaseAPI}
|
|
4289
|
+
*/
|
|
4290
|
+
export declare class PagesApi extends BaseAPI {
|
|
4291
|
+
/**
|
|
4292
|
+
* Retrieves a list of all static HTML pages (in-package data apps) within the specified package. Each page entry includes the relative path, the package name, a canonical resource URL, and the page title (extracted from the file\'s <title> tag, falling back to the path). Used by the Publisher SPA to surface a clickable \"Pages\" section on the package detail view, and by anyone who wants to discover in-package data apps programmatically without scraping the directory. Recursive depth is capped server-side to keep this cheap on large packages.
|
|
4293
|
+
* @summary List package pages
|
|
4294
|
+
* @param {string} environmentName Name of the environment
|
|
4295
|
+
* @param {string} packageName Name of the package
|
|
4296
|
+
* @param {*} [options] Override http request option.
|
|
4297
|
+
* @throws {RequiredError}
|
|
4298
|
+
* @memberof PagesApi
|
|
4299
|
+
*/
|
|
4300
|
+
listPages(environmentName: string, packageName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Page[], any, {}>>;
|
|
4301
|
+
}
|
|
4292
4302
|
/**
|
|
4293
4303
|
* PublisherApi - axios parameter creator
|
|
4294
4304
|
* @export
|
|
@@ -4371,6 +4381,15 @@ export declare const WatchModeApiAxiosParamCreator: (configuration?: Configurati
|
|
|
4371
4381
|
* @throws {RequiredError}
|
|
4372
4382
|
*/
|
|
4373
4383
|
stopWatching: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4384
|
+
/**
|
|
4385
|
+
* Opens a Server-Sent Events (SSE) stream of file-change events for the package, used by in-package HTML data apps (via the publisher.js runtime) to live-reload when their sources are edited. This is a long-lived `text/event-stream` connection, not a JSON endpoint, and is therefore not surfaced through the generated API clients — consume it with an `EventSource`. The stream emits: - `event: hello` (`data: connected`) once on connect. - `event: mode` (`data: enabled|disabled`) reporting whether watch mode is currently active for the environment. When `disabled`, no `changed` events will follow until watch mode is started. - `event: changed` (`data: changed`) each time a watched file in the package changes. - periodic `: heartbeat` comments to keep idle proxies from closing the connection.
|
|
4386
|
+
* @summary Stream package change events (SSE)
|
|
4387
|
+
* @param {string} environmentName Name of the environment
|
|
4388
|
+
* @param {string} packageName Name of the package
|
|
4389
|
+
* @param {*} [options] Override http request option.
|
|
4390
|
+
* @throws {RequiredError}
|
|
4391
|
+
*/
|
|
4392
|
+
streamPackageEvents: (environmentName: string, packageName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4374
4393
|
};
|
|
4375
4394
|
/**
|
|
4376
4395
|
* WatchModeApi - functional programming interface
|
|
@@ -4399,6 +4418,15 @@ export declare const WatchModeApiFp: (configuration?: Configuration) => {
|
|
|
4399
4418
|
* @throws {RequiredError}
|
|
4400
4419
|
*/
|
|
4401
4420
|
stopWatching(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4421
|
+
/**
|
|
4422
|
+
* Opens a Server-Sent Events (SSE) stream of file-change events for the package, used by in-package HTML data apps (via the publisher.js runtime) to live-reload when their sources are edited. This is a long-lived `text/event-stream` connection, not a JSON endpoint, and is therefore not surfaced through the generated API clients — consume it with an `EventSource`. The stream emits: - `event: hello` (`data: connected`) once on connect. - `event: mode` (`data: enabled|disabled`) reporting whether watch mode is currently active for the environment. When `disabled`, no `changed` events will follow until watch mode is started. - `event: changed` (`data: changed`) each time a watched file in the package changes. - periodic `: heartbeat` comments to keep idle proxies from closing the connection.
|
|
4423
|
+
* @summary Stream package change events (SSE)
|
|
4424
|
+
* @param {string} environmentName Name of the environment
|
|
4425
|
+
* @param {string} packageName Name of the package
|
|
4426
|
+
* @param {*} [options] Override http request option.
|
|
4427
|
+
* @throws {RequiredError}
|
|
4428
|
+
*/
|
|
4429
|
+
streamPackageEvents(environmentName: string, packageName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
4402
4430
|
};
|
|
4403
4431
|
/**
|
|
4404
4432
|
* WatchModeApi - factory interface
|
|
@@ -4427,6 +4455,15 @@ export declare const WatchModeApiFactory: (configuration?: Configuration, basePa
|
|
|
4427
4455
|
* @throws {RequiredError}
|
|
4428
4456
|
*/
|
|
4429
4457
|
stopWatching(options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4458
|
+
/**
|
|
4459
|
+
* Opens a Server-Sent Events (SSE) stream of file-change events for the package, used by in-package HTML data apps (via the publisher.js runtime) to live-reload when their sources are edited. This is a long-lived `text/event-stream` connection, not a JSON endpoint, and is therefore not surfaced through the generated API clients — consume it with an `EventSource`. The stream emits: - `event: hello` (`data: connected`) once on connect. - `event: mode` (`data: enabled|disabled`) reporting whether watch mode is currently active for the environment. When `disabled`, no `changed` events will follow until watch mode is started. - `event: changed` (`data: changed`) each time a watched file in the package changes. - periodic `: heartbeat` comments to keep idle proxies from closing the connection.
|
|
4460
|
+
* @summary Stream package change events (SSE)
|
|
4461
|
+
* @param {string} environmentName Name of the environment
|
|
4462
|
+
* @param {string} packageName Name of the package
|
|
4463
|
+
* @param {*} [options] Override http request option.
|
|
4464
|
+
* @throws {RequiredError}
|
|
4465
|
+
*/
|
|
4466
|
+
streamPackageEvents(environmentName: string, packageName: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
4430
4467
|
};
|
|
4431
4468
|
/**
|
|
4432
4469
|
* WatchModeApi - object-oriented interface
|
|
@@ -4460,4 +4497,14 @@ export declare class WatchModeApi extends BaseAPI {
|
|
|
4460
4497
|
* @memberof WatchModeApi
|
|
4461
4498
|
*/
|
|
4462
4499
|
stopWatching(options?: RawAxiosRequestConfig): Promise< AxiosResponse<void, any, {}>>;
|
|
4500
|
+
/**
|
|
4501
|
+
* Opens a Server-Sent Events (SSE) stream of file-change events for the package, used by in-package HTML data apps (via the publisher.js runtime) to live-reload when their sources are edited. This is a long-lived `text/event-stream` connection, not a JSON endpoint, and is therefore not surfaced through the generated API clients — consume it with an `EventSource`. The stream emits: - `event: hello` (`data: connected`) once on connect. - `event: mode` (`data: enabled|disabled`) reporting whether watch mode is currently active for the environment. When `disabled`, no `changed` events will follow until watch mode is started. - `event: changed` (`data: changed`) each time a watched file in the package changes. - periodic `: heartbeat` comments to keep idle proxies from closing the connection.
|
|
4502
|
+
* @summary Stream package change events (SSE)
|
|
4503
|
+
* @param {string} environmentName Name of the environment
|
|
4504
|
+
* @param {string} packageName Name of the package
|
|
4505
|
+
* @param {*} [options] Override http request option.
|
|
4506
|
+
* @throws {RequiredError}
|
|
4507
|
+
* @memberof WatchModeApi
|
|
4508
|
+
*/
|
|
4509
|
+
streamPackageEvents(environmentName: string, packageName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<string, any, {}>>;
|
|
4463
4510
|
}
|