@malloy-publisher/sdk 0.0.181 → 0.0.183-dev
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-lOQXDlqB.cjs.js +1 -0
- package/dist/{ServerProvider-DN2wSIAZ.es.js → ServerProvider-on-8FH5Z.es.js} +1259 -764
- package/dist/client/api.d.ts +674 -20
- package/dist/client/index.cjs.js +1 -1
- package/dist/client/index.es.js +57 -44
- package/dist/core-CjeTkq8O.es.js +7515 -0
- package/dist/core-YNpOLuB1.cjs.js +148 -0
- package/dist/engine-oniguruma-BkproSVE.cjs.js +1 -0
- package/dist/engine-oniguruma-C4vnmooL.es.js +272 -0
- package/dist/github-light-BFTOhCbz.cjs.js +1 -0
- package/dist/github-light-JYsPkUQd.es.js +4 -0
- package/dist/hooks/useDimensionFilters.d.ts +2 -0
- package/dist/hooks/useDimensionalFilterRangeData.d.ts +19 -5
- package/dist/index-BOLBP6_i.cjs.js +233 -0
- package/dist/index-DRDu9kIV.es.js +53627 -0
- package/dist/index.cjs.js +1 -244
- package/dist/index.es.js +48 -58039
- package/dist/json-71t8ZF9g.es.js +6 -0
- package/dist/json-y-J1j5EW.cjs.js +1 -0
- package/dist/sql-BqWZrLHB.cjs.js +1 -0
- package/dist/sql-DCkt643-.es.js +6 -0
- package/dist/typescript-BqvpT6pB.cjs.js +1 -0
- package/dist/typescript-buWNZFwO.es.js +6 -0
- package/package.json +6 -8
- package/src/components/Notebook/Notebook.tsx +162 -108
- package/src/components/ServerProvider.tsx +8 -0
- package/src/components/filter/DimensionFilter.tsx +68 -39
- package/src/components/highlighter.ts +54 -32
- package/src/hooks/useDimensionFilters.ts +2 -0
- package/src/hooks/useDimensionalFilterRangeData.ts +27 -13
- package/src/index.ts +0 -5
- package/dist/ServerProvider-DSeOLGfV.cjs.js +0 -1
package/dist/client/api.d.ts
CHANGED
|
@@ -168,6 +168,27 @@ export interface BigqueryConnection {
|
|
|
168
168
|
*/
|
|
169
169
|
'queryTimeoutMilliseconds'?: string;
|
|
170
170
|
}
|
|
171
|
+
/**
|
|
172
|
+
* Manifest mapping BuildIDs to materialized table names
|
|
173
|
+
* @export
|
|
174
|
+
* @interface BuildManifest
|
|
175
|
+
*/
|
|
176
|
+
export interface BuildManifest {
|
|
177
|
+
/**
|
|
178
|
+
* Map of BuildID to manifest entry
|
|
179
|
+
* @type {{ [key: string]: ManifestEntry; }}
|
|
180
|
+
* @memberof BuildManifest
|
|
181
|
+
*/
|
|
182
|
+
'entries'?: {
|
|
183
|
+
[key: string]: ManifestEntry;
|
|
184
|
+
};
|
|
185
|
+
/**
|
|
186
|
+
* Whether the manifest is in strict mode
|
|
187
|
+
* @type {boolean}
|
|
188
|
+
* @memberof BuildManifest
|
|
189
|
+
*/
|
|
190
|
+
'strict'?: boolean;
|
|
191
|
+
}
|
|
171
192
|
/**
|
|
172
193
|
* Database column definition
|
|
173
194
|
* @export
|
|
@@ -340,6 +361,12 @@ export interface CompiledModel {
|
|
|
340
361
|
* @memberof CompiledModel
|
|
341
362
|
*/
|
|
342
363
|
'queries'?: Array<Query>;
|
|
364
|
+
/**
|
|
365
|
+
* Sources defined in this model
|
|
366
|
+
* @type {Array<Source>}
|
|
367
|
+
* @memberof CompiledModel
|
|
368
|
+
*/
|
|
369
|
+
'sources'?: Array<Source>;
|
|
343
370
|
}
|
|
344
371
|
/**
|
|
345
372
|
* Database connection configuration and metadata
|
|
@@ -512,6 +539,25 @@ export interface CreateConnection409Response {
|
|
|
512
539
|
*/
|
|
513
540
|
'error'?: string;
|
|
514
541
|
}
|
|
542
|
+
/**
|
|
543
|
+
* Options for creating a materialization
|
|
544
|
+
* @export
|
|
545
|
+
* @interface CreateMaterializationRequest
|
|
546
|
+
*/
|
|
547
|
+
export interface CreateMaterializationRequest {
|
|
548
|
+
/**
|
|
549
|
+
* If true, forces rebuild of all sources even if their BuildID is unchanged
|
|
550
|
+
* @type {boolean}
|
|
551
|
+
* @memberof CreateMaterializationRequest
|
|
552
|
+
*/
|
|
553
|
+
'forceRefresh'?: boolean;
|
|
554
|
+
/**
|
|
555
|
+
* If true, automatically reloads the manifest into the Malloy Runtime after a successful materialization
|
|
556
|
+
* @type {boolean}
|
|
557
|
+
* @memberof CreateMaterializationRequest
|
|
558
|
+
*/
|
|
559
|
+
'autoLoadManifest'?: boolean;
|
|
560
|
+
}
|
|
515
561
|
/**
|
|
516
562
|
* Embedded database within a Malloy package
|
|
517
563
|
* @export
|
|
@@ -618,6 +664,57 @@ export interface DucklakeConnectionStorage {
|
|
|
618
664
|
*/
|
|
619
665
|
'gcsConnection'?: GCSConnection;
|
|
620
666
|
}
|
|
667
|
+
/**
|
|
668
|
+
* A filter declared via
|
|
669
|
+
* @export
|
|
670
|
+
* @interface Filter
|
|
671
|
+
*/
|
|
672
|
+
export interface Filter {
|
|
673
|
+
/**
|
|
674
|
+
* Display name of the filter
|
|
675
|
+
* @type {string}
|
|
676
|
+
* @memberof Filter
|
|
677
|
+
*/
|
|
678
|
+
'name'?: string;
|
|
679
|
+
/**
|
|
680
|
+
* Dimension this filter targets
|
|
681
|
+
* @type {string}
|
|
682
|
+
* @memberof Filter
|
|
683
|
+
*/
|
|
684
|
+
'dimension'?: string;
|
|
685
|
+
/**
|
|
686
|
+
* Comparator type
|
|
687
|
+
* @type {string}
|
|
688
|
+
* @memberof Filter
|
|
689
|
+
*/
|
|
690
|
+
'type'?: FilterTypeEnum;
|
|
691
|
+
/**
|
|
692
|
+
* Whether this filter is hidden from users
|
|
693
|
+
* @type {boolean}
|
|
694
|
+
* @memberof Filter
|
|
695
|
+
*/
|
|
696
|
+
'implicit'?: boolean;
|
|
697
|
+
/**
|
|
698
|
+
* Whether a value must be provided
|
|
699
|
+
* @type {boolean}
|
|
700
|
+
* @memberof Filter
|
|
701
|
+
*/
|
|
702
|
+
'required'?: boolean;
|
|
703
|
+
/**
|
|
704
|
+
* Malloy data type of the dimension (e.g. string, number, boolean, date, timestamp)
|
|
705
|
+
* @type {string}
|
|
706
|
+
* @memberof Filter
|
|
707
|
+
*/
|
|
708
|
+
'dimensionType'?: string;
|
|
709
|
+
}
|
|
710
|
+
export declare const FilterTypeEnum: {
|
|
711
|
+
readonly Equal: "equal";
|
|
712
|
+
readonly In: "in";
|
|
713
|
+
readonly Like: "like";
|
|
714
|
+
readonly GreaterThan: "greater_than";
|
|
715
|
+
readonly LessThan: "less_than";
|
|
716
|
+
};
|
|
717
|
+
export type FilterTypeEnum = typeof FilterTypeEnum[keyof typeof FilterTypeEnum];
|
|
621
718
|
/**
|
|
622
719
|
* Google Cloud Storage connection configuration for DuckDB
|
|
623
720
|
* @export
|
|
@@ -713,6 +810,94 @@ export interface LogMessageRangeStart {
|
|
|
713
810
|
*/
|
|
714
811
|
'character'?: number;
|
|
715
812
|
}
|
|
813
|
+
/**
|
|
814
|
+
* A single entry in the build manifest
|
|
815
|
+
* @export
|
|
816
|
+
* @interface ManifestEntry
|
|
817
|
+
*/
|
|
818
|
+
export interface ManifestEntry {
|
|
819
|
+
/**
|
|
820
|
+
* Name of the materialized table
|
|
821
|
+
* @type {string}
|
|
822
|
+
* @memberof ManifestEntry
|
|
823
|
+
*/
|
|
824
|
+
'tableName'?: string;
|
|
825
|
+
}
|
|
826
|
+
/**
|
|
827
|
+
* A record of a package materialization
|
|
828
|
+
* @export
|
|
829
|
+
* @interface Materialization
|
|
830
|
+
*/
|
|
831
|
+
export interface Materialization {
|
|
832
|
+
/**
|
|
833
|
+
*
|
|
834
|
+
* @type {string}
|
|
835
|
+
* @memberof Materialization
|
|
836
|
+
*/
|
|
837
|
+
'id'?: string;
|
|
838
|
+
/**
|
|
839
|
+
*
|
|
840
|
+
* @type {string}
|
|
841
|
+
* @memberof Materialization
|
|
842
|
+
*/
|
|
843
|
+
'projectId'?: string;
|
|
844
|
+
/**
|
|
845
|
+
*
|
|
846
|
+
* @type {string}
|
|
847
|
+
* @memberof Materialization
|
|
848
|
+
*/
|
|
849
|
+
'packageName'?: string;
|
|
850
|
+
/**
|
|
851
|
+
*
|
|
852
|
+
* @type {string}
|
|
853
|
+
* @memberof Materialization
|
|
854
|
+
*/
|
|
855
|
+
'status'?: MaterializationStatusEnum;
|
|
856
|
+
/**
|
|
857
|
+
*
|
|
858
|
+
* @type {string}
|
|
859
|
+
* @memberof Materialization
|
|
860
|
+
*/
|
|
861
|
+
'startedAt'?: string | null;
|
|
862
|
+
/**
|
|
863
|
+
*
|
|
864
|
+
* @type {string}
|
|
865
|
+
* @memberof Materialization
|
|
866
|
+
*/
|
|
867
|
+
'completedAt'?: string | null;
|
|
868
|
+
/**
|
|
869
|
+
* Error message if the materialization failed
|
|
870
|
+
* @type {string}
|
|
871
|
+
* @memberof Materialization
|
|
872
|
+
*/
|
|
873
|
+
'error'?: string | null;
|
|
874
|
+
/**
|
|
875
|
+
* Materialization metadata including build options, source counts, and durations
|
|
876
|
+
* @type {object}
|
|
877
|
+
* @memberof Materialization
|
|
878
|
+
*/
|
|
879
|
+
'metadata'?: object | null;
|
|
880
|
+
/**
|
|
881
|
+
*
|
|
882
|
+
* @type {string}
|
|
883
|
+
* @memberof Materialization
|
|
884
|
+
*/
|
|
885
|
+
'createdAt'?: string;
|
|
886
|
+
/**
|
|
887
|
+
*
|
|
888
|
+
* @type {string}
|
|
889
|
+
* @memberof Materialization
|
|
890
|
+
*/
|
|
891
|
+
'updatedAt'?: string;
|
|
892
|
+
}
|
|
893
|
+
export declare const MaterializationStatusEnum: {
|
|
894
|
+
readonly Pending: "PENDING";
|
|
895
|
+
readonly Running: "RUNNING";
|
|
896
|
+
readonly Success: "SUCCESS";
|
|
897
|
+
readonly Failed: "FAILED";
|
|
898
|
+
readonly Cancelled: "CANCELLED";
|
|
899
|
+
};
|
|
900
|
+
export type MaterializationStatusEnum = typeof MaterializationStatusEnum[keyof typeof MaterializationStatusEnum];
|
|
716
901
|
/**
|
|
717
902
|
* Malloy model metadata and status information
|
|
718
903
|
* @export
|
|
@@ -953,6 +1138,25 @@ export interface Package {
|
|
|
953
1138
|
*/
|
|
954
1139
|
'location'?: string;
|
|
955
1140
|
}
|
|
1141
|
+
/**
|
|
1142
|
+
*
|
|
1143
|
+
* @export
|
|
1144
|
+
* @interface PostQuerydataRequest
|
|
1145
|
+
*/
|
|
1146
|
+
export interface PostQuerydataRequest {
|
|
1147
|
+
/**
|
|
1148
|
+
*
|
|
1149
|
+
* @type {string}
|
|
1150
|
+
* @memberof PostQuerydataRequest
|
|
1151
|
+
*/
|
|
1152
|
+
'sqlStatement'?: string;
|
|
1153
|
+
/**
|
|
1154
|
+
* Options
|
|
1155
|
+
* @type {string}
|
|
1156
|
+
* @memberof PostQuerydataRequest
|
|
1157
|
+
*/
|
|
1158
|
+
'options'?: string;
|
|
1159
|
+
}
|
|
956
1160
|
/**
|
|
957
1161
|
*
|
|
958
1162
|
* @export
|
|
@@ -1051,6 +1255,31 @@ export interface Project {
|
|
|
1051
1255
|
* @memberof Project
|
|
1052
1256
|
*/
|
|
1053
1257
|
'packages'?: Array<Package>;
|
|
1258
|
+
/**
|
|
1259
|
+
*
|
|
1260
|
+
* @type {ProjectMaterializationStorage}
|
|
1261
|
+
* @memberof Project
|
|
1262
|
+
*/
|
|
1263
|
+
'materializationStorage'?: ProjectMaterializationStorage;
|
|
1264
|
+
}
|
|
1265
|
+
/**
|
|
1266
|
+
* 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.
|
|
1267
|
+
* @export
|
|
1268
|
+
* @interface ProjectMaterializationStorage
|
|
1269
|
+
*/
|
|
1270
|
+
export interface ProjectMaterializationStorage {
|
|
1271
|
+
/**
|
|
1272
|
+
* PostgreSQL connection URL for the DuckLake catalog metadata store
|
|
1273
|
+
* @type {string}
|
|
1274
|
+
* @memberof ProjectMaterializationStorage
|
|
1275
|
+
*/
|
|
1276
|
+
'catalogUrl'?: string;
|
|
1277
|
+
/**
|
|
1278
|
+
* Cloud storage path (s3:// or gs://) for DuckLake data files
|
|
1279
|
+
* @type {string}
|
|
1280
|
+
* @memberof ProjectMaterializationStorage
|
|
1281
|
+
*/
|
|
1282
|
+
'dataPath'?: string;
|
|
1054
1283
|
}
|
|
1055
1284
|
/**
|
|
1056
1285
|
* Named model query definition
|
|
@@ -1132,6 +1361,20 @@ export interface QueryRequest {
|
|
|
1132
1361
|
* @memberof QueryRequest
|
|
1133
1362
|
*/
|
|
1134
1363
|
'versionId'?: string;
|
|
1364
|
+
/**
|
|
1365
|
+
* Filter parameter values keyed by filter name. Used with sources that declare \\#(filter) annotations. Each value is either a string or an array of strings.
|
|
1366
|
+
* @type {{ [key: string]: any; }}
|
|
1367
|
+
* @memberof QueryRequest
|
|
1368
|
+
*/
|
|
1369
|
+
'filterParams'?: {
|
|
1370
|
+
[key: string]: any;
|
|
1371
|
+
};
|
|
1372
|
+
/**
|
|
1373
|
+
* When true, skip server-side \\#(filter) injection entirely.
|
|
1374
|
+
* @type {boolean}
|
|
1375
|
+
* @memberof QueryRequest
|
|
1376
|
+
*/
|
|
1377
|
+
'bypassFilters'?: boolean;
|
|
1135
1378
|
}
|
|
1136
1379
|
/**
|
|
1137
1380
|
* Results from executing a Malloy query
|
|
@@ -1200,6 +1443,12 @@ export interface RawNotebook {
|
|
|
1200
1443
|
* @memberof RawNotebook
|
|
1201
1444
|
*/
|
|
1202
1445
|
'annotations'?: Array<string>;
|
|
1446
|
+
/**
|
|
1447
|
+
* Sources defined in the notebook\'s model
|
|
1448
|
+
* @type {Array<Source>}
|
|
1449
|
+
* @memberof RawNotebook
|
|
1450
|
+
*/
|
|
1451
|
+
'sources'?: Array<Source>;
|
|
1203
1452
|
}
|
|
1204
1453
|
/**
|
|
1205
1454
|
* AWS S3 connection configuration for DuckDB
|
|
@@ -1379,6 +1628,37 @@ export interface SnowflakeConnection {
|
|
|
1379
1628
|
*/
|
|
1380
1629
|
'responseTimeoutMilliseconds'?: number;
|
|
1381
1630
|
}
|
|
1631
|
+
/**
|
|
1632
|
+
* A Malloy source defined in a model
|
|
1633
|
+
* @export
|
|
1634
|
+
* @interface Source
|
|
1635
|
+
*/
|
|
1636
|
+
export interface Source {
|
|
1637
|
+
/**
|
|
1638
|
+
* Name of the source
|
|
1639
|
+
* @type {string}
|
|
1640
|
+
* @memberof Source
|
|
1641
|
+
*/
|
|
1642
|
+
'name'?: string;
|
|
1643
|
+
/**
|
|
1644
|
+
* Annotations attached to the source
|
|
1645
|
+
* @type {Array<string>}
|
|
1646
|
+
* @memberof Source
|
|
1647
|
+
*/
|
|
1648
|
+
'annotations'?: Array<string>;
|
|
1649
|
+
/**
|
|
1650
|
+
* Views defined in this source
|
|
1651
|
+
* @type {Array<View>}
|
|
1652
|
+
* @memberof Source
|
|
1653
|
+
*/
|
|
1654
|
+
'views'?: Array<View>;
|
|
1655
|
+
/**
|
|
1656
|
+
* Filters declared on this source via
|
|
1657
|
+
* @type {Array<Filter>}
|
|
1658
|
+
* @memberof Source
|
|
1659
|
+
*/
|
|
1660
|
+
'filters'?: Array<Filter>;
|
|
1661
|
+
}
|
|
1382
1662
|
/**
|
|
1383
1663
|
*
|
|
1384
1664
|
* @export
|
|
@@ -1764,12 +2044,11 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
1764
2044
|
* @summary Execute SQL query
|
|
1765
2045
|
* @param {string} projectName Name of the project
|
|
1766
2046
|
* @param {string} connectionName Name of the connection
|
|
1767
|
-
* @param {
|
|
1768
|
-
* @param {string} [_options] Options
|
|
2047
|
+
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
1769
2048
|
* @param {*} [options] Override http request option.
|
|
1770
2049
|
* @throws {RequiredError}
|
|
1771
2050
|
*/
|
|
1772
|
-
postQuerydata: (projectName: string, connectionName: string,
|
|
2051
|
+
postQuerydata: (projectName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1773
2052
|
/**
|
|
1774
2053
|
* 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.
|
|
1775
2054
|
* @summary Create SQL source from statement
|
|
@@ -1912,12 +2191,11 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
1912
2191
|
* @summary Execute SQL query
|
|
1913
2192
|
* @param {string} projectName Name of the project
|
|
1914
2193
|
* @param {string} connectionName Name of the connection
|
|
1915
|
-
* @param {
|
|
1916
|
-
* @param {string} [_options] Options
|
|
2194
|
+
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
1917
2195
|
* @param {*} [options] Override http request option.
|
|
1918
2196
|
* @throws {RequiredError}
|
|
1919
2197
|
*/
|
|
1920
|
-
postQuerydata(projectName: string, connectionName: string,
|
|
2198
|
+
postQuerydata(projectName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryData>>;
|
|
1921
2199
|
/**
|
|
1922
2200
|
* 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.
|
|
1923
2201
|
* @summary Create SQL source from statement
|
|
@@ -2060,12 +2338,11 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2060
2338
|
* @summary Execute SQL query
|
|
2061
2339
|
* @param {string} projectName Name of the project
|
|
2062
2340
|
* @param {string} connectionName Name of the connection
|
|
2063
|
-
* @param {
|
|
2064
|
-
* @param {string} [_options] Options
|
|
2341
|
+
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2065
2342
|
* @param {*} [options] Override http request option.
|
|
2066
2343
|
* @throws {RequiredError}
|
|
2067
2344
|
*/
|
|
2068
|
-
postQuerydata(projectName: string, connectionName: string,
|
|
2345
|
+
postQuerydata(projectName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): AxiosPromise<QueryData>;
|
|
2069
2346
|
/**
|
|
2070
2347
|
* Creates a Malloy source from a SQL statement using the specified database connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
|
|
2071
2348
|
* @summary Create SQL source from statement
|
|
@@ -2220,13 +2497,12 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2220
2497
|
* @summary Execute SQL query
|
|
2221
2498
|
* @param {string} projectName Name of the project
|
|
2222
2499
|
* @param {string} connectionName Name of the connection
|
|
2223
|
-
* @param {
|
|
2224
|
-
* @param {string} [_options] Options
|
|
2500
|
+
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2225
2501
|
* @param {*} [options] Override http request option.
|
|
2226
2502
|
* @throws {RequiredError}
|
|
2227
2503
|
* @memberof ConnectionsApi
|
|
2228
2504
|
*/
|
|
2229
|
-
postQuerydata(projectName: string, connectionName: string,
|
|
2505
|
+
postQuerydata(projectName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<QueryData, any, {}>>;
|
|
2230
2506
|
/**
|
|
2231
2507
|
* 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.
|
|
2232
2508
|
* @summary Create SQL source from statement
|
|
@@ -2387,6 +2663,364 @@ export declare class DatabasesApi extends BaseAPI {
|
|
|
2387
2663
|
*/
|
|
2388
2664
|
listDatabases(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Database[], any, {}>>;
|
|
2389
2665
|
}
|
|
2666
|
+
/**
|
|
2667
|
+
* ManifestsApi - axios parameter creator
|
|
2668
|
+
* @export
|
|
2669
|
+
*/
|
|
2670
|
+
export declare const ManifestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2671
|
+
/**
|
|
2672
|
+
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
2673
|
+
* @summary Get the build manifest for a package
|
|
2674
|
+
* @param {string} projectName Name of the project
|
|
2675
|
+
* @param {string} packageName Name of the package
|
|
2676
|
+
* @param {*} [options] Override http request option.
|
|
2677
|
+
* @throws {RequiredError}
|
|
2678
|
+
*/
|
|
2679
|
+
getManifest: (projectName: string, packageName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2680
|
+
/**
|
|
2681
|
+
* 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.
|
|
2682
|
+
* @summary Perform an action on the package manifest
|
|
2683
|
+
* @param {string} projectName Name of the project
|
|
2684
|
+
* @param {string} packageName Name of the package
|
|
2685
|
+
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
2686
|
+
* @param {*} [options] Override http request option.
|
|
2687
|
+
* @throws {RequiredError}
|
|
2688
|
+
*/
|
|
2689
|
+
manifestAction: (projectName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2690
|
+
};
|
|
2691
|
+
/**
|
|
2692
|
+
* ManifestsApi - functional programming interface
|
|
2693
|
+
* @export
|
|
2694
|
+
*/
|
|
2695
|
+
export declare const ManifestsApiFp: (configuration?: Configuration) => {
|
|
2696
|
+
/**
|
|
2697
|
+
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
2698
|
+
* @summary Get the build manifest for a package
|
|
2699
|
+
* @param {string} projectName Name of the project
|
|
2700
|
+
* @param {string} packageName Name of the package
|
|
2701
|
+
* @param {*} [options] Override http request option.
|
|
2702
|
+
* @throws {RequiredError}
|
|
2703
|
+
*/
|
|
2704
|
+
getManifest(projectName: string, packageName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BuildManifest>>;
|
|
2705
|
+
/**
|
|
2706
|
+
* 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.
|
|
2707
|
+
* @summary Perform an action on the package manifest
|
|
2708
|
+
* @param {string} projectName Name of the project
|
|
2709
|
+
* @param {string} packageName Name of the package
|
|
2710
|
+
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
2711
|
+
* @param {*} [options] Override http request option.
|
|
2712
|
+
* @throws {RequiredError}
|
|
2713
|
+
*/
|
|
2714
|
+
manifestAction(projectName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BuildManifest>>;
|
|
2715
|
+
};
|
|
2716
|
+
/**
|
|
2717
|
+
* ManifestsApi - factory interface
|
|
2718
|
+
* @export
|
|
2719
|
+
*/
|
|
2720
|
+
export declare const ManifestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2721
|
+
/**
|
|
2722
|
+
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
2723
|
+
* @summary Get the build manifest for a package
|
|
2724
|
+
* @param {string} projectName Name of the project
|
|
2725
|
+
* @param {string} packageName Name of the package
|
|
2726
|
+
* @param {*} [options] Override http request option.
|
|
2727
|
+
* @throws {RequiredError}
|
|
2728
|
+
*/
|
|
2729
|
+
getManifest(projectName: string, packageName: string, options?: RawAxiosRequestConfig): AxiosPromise<BuildManifest>;
|
|
2730
|
+
/**
|
|
2731
|
+
* 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.
|
|
2732
|
+
* @summary Perform an action on the package manifest
|
|
2733
|
+
* @param {string} projectName Name of the project
|
|
2734
|
+
* @param {string} packageName Name of the package
|
|
2735
|
+
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
2736
|
+
* @param {*} [options] Override http request option.
|
|
2737
|
+
* @throws {RequiredError}
|
|
2738
|
+
*/
|
|
2739
|
+
manifestAction(projectName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig): AxiosPromise<BuildManifest>;
|
|
2740
|
+
};
|
|
2741
|
+
/**
|
|
2742
|
+
* ManifestsApi - object-oriented interface
|
|
2743
|
+
* @export
|
|
2744
|
+
* @class ManifestsApi
|
|
2745
|
+
* @extends {BaseAPI}
|
|
2746
|
+
*/
|
|
2747
|
+
export declare class ManifestsApi extends BaseAPI {
|
|
2748
|
+
/**
|
|
2749
|
+
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
2750
|
+
* @summary Get the build manifest for a package
|
|
2751
|
+
* @param {string} projectName Name of the project
|
|
2752
|
+
* @param {string} packageName Name of the package
|
|
2753
|
+
* @param {*} [options] Override http request option.
|
|
2754
|
+
* @throws {RequiredError}
|
|
2755
|
+
* @memberof ManifestsApi
|
|
2756
|
+
*/
|
|
2757
|
+
getManifest(projectName: string, packageName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<BuildManifest, any, {}>>;
|
|
2758
|
+
/**
|
|
2759
|
+
* 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.
|
|
2760
|
+
* @summary Perform an action on the package manifest
|
|
2761
|
+
* @param {string} projectName Name of the project
|
|
2762
|
+
* @param {string} packageName Name of the package
|
|
2763
|
+
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
2764
|
+
* @param {*} [options] Override http request option.
|
|
2765
|
+
* @throws {RequiredError}
|
|
2766
|
+
* @memberof ManifestsApi
|
|
2767
|
+
*/
|
|
2768
|
+
manifestAction(projectName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig): Promise< AxiosResponse<BuildManifest, any, {}>>;
|
|
2769
|
+
}
|
|
2770
|
+
/**
|
|
2771
|
+
* @export
|
|
2772
|
+
*/
|
|
2773
|
+
export declare const ManifestActionActionEnum: {
|
|
2774
|
+
readonly Reload: "reload";
|
|
2775
|
+
};
|
|
2776
|
+
export type ManifestActionActionEnum = typeof ManifestActionActionEnum[keyof typeof ManifestActionActionEnum];
|
|
2777
|
+
/**
|
|
2778
|
+
* MaterializationsApi - axios parameter creator
|
|
2779
|
+
* @export
|
|
2780
|
+
*/
|
|
2781
|
+
export declare const MaterializationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2782
|
+
/**
|
|
2783
|
+
* Creates a new materialization in PENDING state for all persist sources across all models in the package. Use POST .../materializations/{materializationId}?action=start to begin execution.
|
|
2784
|
+
* @summary Create a materialization
|
|
2785
|
+
* @param {string} projectName Name of the project
|
|
2786
|
+
* @param {string} packageName Name of the package
|
|
2787
|
+
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
2788
|
+
* @param {*} [options] Override http request option.
|
|
2789
|
+
* @throws {RequiredError}
|
|
2790
|
+
*/
|
|
2791
|
+
createMaterialization: (projectName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2792
|
+
/**
|
|
2793
|
+
* Deletes a terminal (SUCCESS, FAILED, or CANCELLED) materialization record.
|
|
2794
|
+
* @summary Delete a materialization
|
|
2795
|
+
* @param {string} projectName Name of the project
|
|
2796
|
+
* @param {string} packageName Name of the package
|
|
2797
|
+
* @param {string} materializationId ID of the materialization
|
|
2798
|
+
* @param {*} [options] Override http request option.
|
|
2799
|
+
* @throws {RequiredError}
|
|
2800
|
+
*/
|
|
2801
|
+
deleteMaterialization: (projectName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2802
|
+
/**
|
|
2803
|
+
*
|
|
2804
|
+
* @summary Get a specific materialization
|
|
2805
|
+
* @param {string} projectName Name of the project
|
|
2806
|
+
* @param {string} packageName Name of the package
|
|
2807
|
+
* @param {string} materializationId ID of the materialization
|
|
2808
|
+
* @param {*} [options] Override http request option.
|
|
2809
|
+
* @throws {RequiredError}
|
|
2810
|
+
*/
|
|
2811
|
+
getMaterialization: (projectName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2812
|
+
/**
|
|
2813
|
+
* Returns the materialization history for the package, ordered by most recent first.
|
|
2814
|
+
* @summary List materializations for a package
|
|
2815
|
+
* @param {string} projectName Name of the project
|
|
2816
|
+
* @param {string} packageName Name of the package
|
|
2817
|
+
* @param {number} [limit] Maximum number of materializations to return
|
|
2818
|
+
* @param {number} [offset] Number of materializations to skip
|
|
2819
|
+
* @param {*} [options] Override http request option.
|
|
2820
|
+
* @throws {RequiredError}
|
|
2821
|
+
*/
|
|
2822
|
+
listMaterializations: (projectName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2823
|
+
/**
|
|
2824
|
+
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `start` - Transitions a PENDING materialization to RUNNING and begins execution in the background. Returns 202. * `stop` - Cancels a PENDING or RUNNING materialization. Returns 200.
|
|
2825
|
+
* @summary Perform an action on a materialization
|
|
2826
|
+
* @param {string} projectName Name of the project
|
|
2827
|
+
* @param {string} packageName Name of the package
|
|
2828
|
+
* @param {string} materializationId ID of the materialization
|
|
2829
|
+
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
2830
|
+
* @param {*} [options] Override http request option.
|
|
2831
|
+
* @throws {RequiredError}
|
|
2832
|
+
*/
|
|
2833
|
+
materializationAction: (projectName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2834
|
+
};
|
|
2835
|
+
/**
|
|
2836
|
+
* MaterializationsApi - functional programming interface
|
|
2837
|
+
* @export
|
|
2838
|
+
*/
|
|
2839
|
+
export declare const MaterializationsApiFp: (configuration?: Configuration) => {
|
|
2840
|
+
/**
|
|
2841
|
+
* Creates a new materialization in PENDING state for all persist sources across all models in the package. Use POST .../materializations/{materializationId}?action=start to begin execution.
|
|
2842
|
+
* @summary Create a materialization
|
|
2843
|
+
* @param {string} projectName Name of the project
|
|
2844
|
+
* @param {string} packageName Name of the package
|
|
2845
|
+
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
2846
|
+
* @param {*} [options] Override http request option.
|
|
2847
|
+
* @throws {RequiredError}
|
|
2848
|
+
*/
|
|
2849
|
+
createMaterialization(projectName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Materialization>>;
|
|
2850
|
+
/**
|
|
2851
|
+
* Deletes a terminal (SUCCESS, FAILED, or CANCELLED) materialization record.
|
|
2852
|
+
* @summary Delete a materialization
|
|
2853
|
+
* @param {string} projectName Name of the project
|
|
2854
|
+
* @param {string} packageName Name of the package
|
|
2855
|
+
* @param {string} materializationId ID of the materialization
|
|
2856
|
+
* @param {*} [options] Override http request option.
|
|
2857
|
+
* @throws {RequiredError}
|
|
2858
|
+
*/
|
|
2859
|
+
deleteMaterialization(projectName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2860
|
+
/**
|
|
2861
|
+
*
|
|
2862
|
+
* @summary Get a specific materialization
|
|
2863
|
+
* @param {string} projectName Name of the project
|
|
2864
|
+
* @param {string} packageName Name of the package
|
|
2865
|
+
* @param {string} materializationId ID of the materialization
|
|
2866
|
+
* @param {*} [options] Override http request option.
|
|
2867
|
+
* @throws {RequiredError}
|
|
2868
|
+
*/
|
|
2869
|
+
getMaterialization(projectName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Materialization>>;
|
|
2870
|
+
/**
|
|
2871
|
+
* Returns the materialization history for the package, ordered by most recent first.
|
|
2872
|
+
* @summary List materializations for a package
|
|
2873
|
+
* @param {string} projectName Name of the project
|
|
2874
|
+
* @param {string} packageName Name of the package
|
|
2875
|
+
* @param {number} [limit] Maximum number of materializations to return
|
|
2876
|
+
* @param {number} [offset] Number of materializations to skip
|
|
2877
|
+
* @param {*} [options] Override http request option.
|
|
2878
|
+
* @throws {RequiredError}
|
|
2879
|
+
*/
|
|
2880
|
+
listMaterializations(projectName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Materialization>>>;
|
|
2881
|
+
/**
|
|
2882
|
+
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `start` - Transitions a PENDING materialization to RUNNING and begins execution in the background. Returns 202. * `stop` - Cancels a PENDING or RUNNING materialization. Returns 200.
|
|
2883
|
+
* @summary Perform an action on a materialization
|
|
2884
|
+
* @param {string} projectName Name of the project
|
|
2885
|
+
* @param {string} packageName Name of the package
|
|
2886
|
+
* @param {string} materializationId ID of the materialization
|
|
2887
|
+
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
2888
|
+
* @param {*} [options] Override http request option.
|
|
2889
|
+
* @throws {RequiredError}
|
|
2890
|
+
*/
|
|
2891
|
+
materializationAction(projectName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Materialization>>;
|
|
2892
|
+
};
|
|
2893
|
+
/**
|
|
2894
|
+
* MaterializationsApi - factory interface
|
|
2895
|
+
* @export
|
|
2896
|
+
*/
|
|
2897
|
+
export declare const MaterializationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2898
|
+
/**
|
|
2899
|
+
* Creates a new materialization in PENDING state for all persist sources across all models in the package. Use POST .../materializations/{materializationId}?action=start to begin execution.
|
|
2900
|
+
* @summary Create a materialization
|
|
2901
|
+
* @param {string} projectName Name of the project
|
|
2902
|
+
* @param {string} packageName Name of the package
|
|
2903
|
+
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
2904
|
+
* @param {*} [options] Override http request option.
|
|
2905
|
+
* @throws {RequiredError}
|
|
2906
|
+
*/
|
|
2907
|
+
createMaterialization(projectName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig): AxiosPromise<Materialization>;
|
|
2908
|
+
/**
|
|
2909
|
+
* Deletes a terminal (SUCCESS, FAILED, or CANCELLED) materialization record.
|
|
2910
|
+
* @summary Delete a materialization
|
|
2911
|
+
* @param {string} projectName Name of the project
|
|
2912
|
+
* @param {string} packageName Name of the package
|
|
2913
|
+
* @param {string} materializationId ID of the materialization
|
|
2914
|
+
* @param {*} [options] Override http request option.
|
|
2915
|
+
* @throws {RequiredError}
|
|
2916
|
+
*/
|
|
2917
|
+
deleteMaterialization(projectName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2918
|
+
/**
|
|
2919
|
+
*
|
|
2920
|
+
* @summary Get a specific materialization
|
|
2921
|
+
* @param {string} projectName Name of the project
|
|
2922
|
+
* @param {string} packageName Name of the package
|
|
2923
|
+
* @param {string} materializationId ID of the materialization
|
|
2924
|
+
* @param {*} [options] Override http request option.
|
|
2925
|
+
* @throws {RequiredError}
|
|
2926
|
+
*/
|
|
2927
|
+
getMaterialization(projectName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): AxiosPromise<Materialization>;
|
|
2928
|
+
/**
|
|
2929
|
+
* Returns the materialization history for the package, ordered by most recent first.
|
|
2930
|
+
* @summary List materializations for a package
|
|
2931
|
+
* @param {string} projectName Name of the project
|
|
2932
|
+
* @param {string} packageName Name of the package
|
|
2933
|
+
* @param {number} [limit] Maximum number of materializations to return
|
|
2934
|
+
* @param {number} [offset] Number of materializations to skip
|
|
2935
|
+
* @param {*} [options] Override http request option.
|
|
2936
|
+
* @throws {RequiredError}
|
|
2937
|
+
*/
|
|
2938
|
+
listMaterializations(projectName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Materialization>>;
|
|
2939
|
+
/**
|
|
2940
|
+
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `start` - Transitions a PENDING materialization to RUNNING and begins execution in the background. Returns 202. * `stop` - Cancels a PENDING or RUNNING materialization. Returns 200.
|
|
2941
|
+
* @summary Perform an action on a materialization
|
|
2942
|
+
* @param {string} projectName Name of the project
|
|
2943
|
+
* @param {string} packageName Name of the package
|
|
2944
|
+
* @param {string} materializationId ID of the materialization
|
|
2945
|
+
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
2946
|
+
* @param {*} [options] Override http request option.
|
|
2947
|
+
* @throws {RequiredError}
|
|
2948
|
+
*/
|
|
2949
|
+
materializationAction(projectName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig): AxiosPromise<Materialization>;
|
|
2950
|
+
};
|
|
2951
|
+
/**
|
|
2952
|
+
* MaterializationsApi - object-oriented interface
|
|
2953
|
+
* @export
|
|
2954
|
+
* @class MaterializationsApi
|
|
2955
|
+
* @extends {BaseAPI}
|
|
2956
|
+
*/
|
|
2957
|
+
export declare class MaterializationsApi extends BaseAPI {
|
|
2958
|
+
/**
|
|
2959
|
+
* Creates a new materialization in PENDING state for all persist sources across all models in the package. Use POST .../materializations/{materializationId}?action=start to begin execution.
|
|
2960
|
+
* @summary Create a materialization
|
|
2961
|
+
* @param {string} projectName Name of the project
|
|
2962
|
+
* @param {string} packageName Name of the package
|
|
2963
|
+
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
2964
|
+
* @param {*} [options] Override http request option.
|
|
2965
|
+
* @throws {RequiredError}
|
|
2966
|
+
* @memberof MaterializationsApi
|
|
2967
|
+
*/
|
|
2968
|
+
createMaterialization(projectName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Materialization, any, {}>>;
|
|
2969
|
+
/**
|
|
2970
|
+
* Deletes a terminal (SUCCESS, FAILED, or CANCELLED) materialization record.
|
|
2971
|
+
* @summary Delete a materialization
|
|
2972
|
+
* @param {string} projectName Name of the project
|
|
2973
|
+
* @param {string} packageName Name of the package
|
|
2974
|
+
* @param {string} materializationId ID of the materialization
|
|
2975
|
+
* @param {*} [options] Override http request option.
|
|
2976
|
+
* @throws {RequiredError}
|
|
2977
|
+
* @memberof MaterializationsApi
|
|
2978
|
+
*/
|
|
2979
|
+
deleteMaterialization(projectName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<void, any, {}>>;
|
|
2980
|
+
/**
|
|
2981
|
+
*
|
|
2982
|
+
* @summary Get a specific materialization
|
|
2983
|
+
* @param {string} projectName Name of the project
|
|
2984
|
+
* @param {string} packageName Name of the package
|
|
2985
|
+
* @param {string} materializationId ID of the materialization
|
|
2986
|
+
* @param {*} [options] Override http request option.
|
|
2987
|
+
* @throws {RequiredError}
|
|
2988
|
+
* @memberof MaterializationsApi
|
|
2989
|
+
*/
|
|
2990
|
+
getMaterialization(projectName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Materialization, any, {}>>;
|
|
2991
|
+
/**
|
|
2992
|
+
* Returns the materialization history for the package, ordered by most recent first.
|
|
2993
|
+
* @summary List materializations for a package
|
|
2994
|
+
* @param {string} projectName Name of the project
|
|
2995
|
+
* @param {string} packageName Name of the package
|
|
2996
|
+
* @param {number} [limit] Maximum number of materializations to return
|
|
2997
|
+
* @param {number} [offset] Number of materializations to skip
|
|
2998
|
+
* @param {*} [options] Override http request option.
|
|
2999
|
+
* @throws {RequiredError}
|
|
3000
|
+
* @memberof MaterializationsApi
|
|
3001
|
+
*/
|
|
3002
|
+
listMaterializations(projectName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Materialization[], any, {}>>;
|
|
3003
|
+
/**
|
|
3004
|
+
* Performs an action on a materialization. The action is specified via the `action` query parameter: * `start` - Transitions a PENDING materialization to RUNNING and begins execution in the background. Returns 202. * `stop` - Cancels a PENDING or RUNNING materialization. Returns 200.
|
|
3005
|
+
* @summary Perform an action on a materialization
|
|
3006
|
+
* @param {string} projectName Name of the project
|
|
3007
|
+
* @param {string} packageName Name of the package
|
|
3008
|
+
* @param {string} materializationId ID of the materialization
|
|
3009
|
+
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
3010
|
+
* @param {*} [options] Override http request option.
|
|
3011
|
+
* @throws {RequiredError}
|
|
3012
|
+
* @memberof MaterializationsApi
|
|
3013
|
+
*/
|
|
3014
|
+
materializationAction(projectName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Materialization, any, {}>>;
|
|
3015
|
+
}
|
|
3016
|
+
/**
|
|
3017
|
+
* @export
|
|
3018
|
+
*/
|
|
3019
|
+
export declare const MaterializationActionActionEnum: {
|
|
3020
|
+
readonly Start: "start";
|
|
3021
|
+
readonly Stop: "stop";
|
|
3022
|
+
};
|
|
3023
|
+
export type MaterializationActionActionEnum = typeof MaterializationActionActionEnum[keyof typeof MaterializationActionActionEnum];
|
|
2390
3024
|
/**
|
|
2391
3025
|
* ModelsApi - axios parameter creator
|
|
2392
3026
|
* @export
|
|
@@ -2602,10 +3236,12 @@ export declare const NotebooksApiAxiosParamCreator: (configuration?: Configurati
|
|
|
2602
3236
|
* @param {string} path Path to notebook within the package
|
|
2603
3237
|
* @param {number} cellIndex Index of the cell to execute (0-based)
|
|
2604
3238
|
* @param {string} [versionId] Version identifier for the package
|
|
3239
|
+
* @param {string} [filterParams] JSON-encoded filter parameter values keyed by filter name
|
|
3240
|
+
* @param {ExecuteNotebookCellBypassFiltersEnum} [bypassFilters] When true, skip filter injection entirely
|
|
2605
3241
|
* @param {*} [options] Override http request option.
|
|
2606
3242
|
* @throws {RequiredError}
|
|
2607
3243
|
*/
|
|
2608
|
-
executeNotebookCell: (projectName: string, packageName: string, path: string, cellIndex: number, versionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3244
|
+
executeNotebookCell: (projectName: string, packageName: string, path: string, cellIndex: number, versionId?: string, filterParams?: string, bypassFilters?: ExecuteNotebookCellBypassFiltersEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2609
3245
|
/**
|
|
2610
3246
|
* Retrieves a Malloy notebook with its raw cell contents (markdown and code). Cell execution should be done separately via the execute-notebook-cell endpoint.
|
|
2611
3247
|
* @summary Get Malloy notebook cells
|
|
@@ -2641,10 +3277,12 @@ export declare const NotebooksApiFp: (configuration?: Configuration) => {
|
|
|
2641
3277
|
* @param {string} path Path to notebook within the package
|
|
2642
3278
|
* @param {number} cellIndex Index of the cell to execute (0-based)
|
|
2643
3279
|
* @param {string} [versionId] Version identifier for the package
|
|
3280
|
+
* @param {string} [filterParams] JSON-encoded filter parameter values keyed by filter name
|
|
3281
|
+
* @param {ExecuteNotebookCellBypassFiltersEnum} [bypassFilters] When true, skip filter injection entirely
|
|
2644
3282
|
* @param {*} [options] Override http request option.
|
|
2645
3283
|
* @throws {RequiredError}
|
|
2646
3284
|
*/
|
|
2647
|
-
executeNotebookCell(projectName: string, packageName: string, path: string, cellIndex: number, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotebookCellResult>>;
|
|
3285
|
+
executeNotebookCell(projectName: string, packageName: string, path: string, cellIndex: number, versionId?: string, filterParams?: string, bypassFilters?: ExecuteNotebookCellBypassFiltersEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotebookCellResult>>;
|
|
2648
3286
|
/**
|
|
2649
3287
|
* Retrieves a Malloy notebook with its raw cell contents (markdown and code). Cell execution should be done separately via the execute-notebook-cell endpoint.
|
|
2650
3288
|
* @summary Get Malloy notebook cells
|
|
@@ -2680,10 +3318,12 @@ export declare const NotebooksApiFactory: (configuration?: Configuration, basePa
|
|
|
2680
3318
|
* @param {string} path Path to notebook within the package
|
|
2681
3319
|
* @param {number} cellIndex Index of the cell to execute (0-based)
|
|
2682
3320
|
* @param {string} [versionId] Version identifier for the package
|
|
3321
|
+
* @param {string} [filterParams] JSON-encoded filter parameter values keyed by filter name
|
|
3322
|
+
* @param {ExecuteNotebookCellBypassFiltersEnum} [bypassFilters] When true, skip filter injection entirely
|
|
2683
3323
|
* @param {*} [options] Override http request option.
|
|
2684
3324
|
* @throws {RequiredError}
|
|
2685
3325
|
*/
|
|
2686
|
-
executeNotebookCell(projectName: string, packageName: string, path: string, cellIndex: number, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<NotebookCellResult>;
|
|
3326
|
+
executeNotebookCell(projectName: string, packageName: string, path: string, cellIndex: number, versionId?: string, filterParams?: string, bypassFilters?: ExecuteNotebookCellBypassFiltersEnum, options?: RawAxiosRequestConfig): AxiosPromise<NotebookCellResult>;
|
|
2687
3327
|
/**
|
|
2688
3328
|
* Retrieves a Malloy notebook with its raw cell contents (markdown and code). Cell execution should be done separately via the execute-notebook-cell endpoint.
|
|
2689
3329
|
* @summary Get Malloy notebook cells
|
|
@@ -2721,11 +3361,13 @@ export declare class NotebooksApi extends BaseAPI {
|
|
|
2721
3361
|
* @param {string} path Path to notebook within the package
|
|
2722
3362
|
* @param {number} cellIndex Index of the cell to execute (0-based)
|
|
2723
3363
|
* @param {string} [versionId] Version identifier for the package
|
|
3364
|
+
* @param {string} [filterParams] JSON-encoded filter parameter values keyed by filter name
|
|
3365
|
+
* @param {ExecuteNotebookCellBypassFiltersEnum} [bypassFilters] When true, skip filter injection entirely
|
|
2724
3366
|
* @param {*} [options] Override http request option.
|
|
2725
3367
|
* @throws {RequiredError}
|
|
2726
3368
|
* @memberof NotebooksApi
|
|
2727
3369
|
*/
|
|
2728
|
-
executeNotebookCell(projectName: string, packageName: string, path: string, cellIndex: number, versionId?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<NotebookCellResult, any, {}>>;
|
|
3370
|
+
executeNotebookCell(projectName: string, packageName: string, path: string, cellIndex: number, versionId?: string, filterParams?: string, bypassFilters?: ExecuteNotebookCellBypassFiltersEnum, options?: RawAxiosRequestConfig): Promise< AxiosResponse<NotebookCellResult, any, {}>>;
|
|
2729
3371
|
/**
|
|
2730
3372
|
* Retrieves a Malloy notebook with its raw cell contents (markdown and code). Cell execution should be done separately via the execute-notebook-cell endpoint.
|
|
2731
3373
|
* @summary Get Malloy notebook cells
|
|
@@ -2750,6 +3392,14 @@ export declare class NotebooksApi extends BaseAPI {
|
|
|
2750
3392
|
*/
|
|
2751
3393
|
listNotebooks(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Notebook[], any, {}>>;
|
|
2752
3394
|
}
|
|
3395
|
+
/**
|
|
3396
|
+
* @export
|
|
3397
|
+
*/
|
|
3398
|
+
export declare const ExecuteNotebookCellBypassFiltersEnum: {
|
|
3399
|
+
readonly True: "true";
|
|
3400
|
+
readonly False: "false";
|
|
3401
|
+
};
|
|
3402
|
+
export type ExecuteNotebookCellBypassFiltersEnum = typeof ExecuteNotebookCellBypassFiltersEnum[keyof typeof ExecuteNotebookCellBypassFiltersEnum];
|
|
2753
3403
|
/**
|
|
2754
3404
|
* PackagesApi - axios parameter creator
|
|
2755
3405
|
* @export
|
|
@@ -2760,10 +3410,11 @@ export declare const PackagesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
2760
3410
|
* @summary Create a new package
|
|
2761
3411
|
* @param {string} projectName Name of the project
|
|
2762
3412
|
* @param {Package} _package
|
|
3413
|
+
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
2763
3414
|
* @param {*} [options] Override http request option.
|
|
2764
3415
|
* @throws {RequiredError}
|
|
2765
3416
|
*/
|
|
2766
|
-
createPackage: (projectName: string, _package: Package, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3417
|
+
createPackage: (projectName: string, _package: Package, autoLoadManifest?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2767
3418
|
/**
|
|
2768
3419
|
* 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.
|
|
2769
3420
|
* @summary Delete a package
|
|
@@ -2813,10 +3464,11 @@ export declare const PackagesApiFp: (configuration?: Configuration) => {
|
|
|
2813
3464
|
* @summary Create a new package
|
|
2814
3465
|
* @param {string} projectName Name of the project
|
|
2815
3466
|
* @param {Package} _package
|
|
3467
|
+
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
2816
3468
|
* @param {*} [options] Override http request option.
|
|
2817
3469
|
* @throws {RequiredError}
|
|
2818
3470
|
*/
|
|
2819
|
-
createPackage(projectName: string, _package: Package, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
3471
|
+
createPackage(projectName: string, _package: Package, autoLoadManifest?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
2820
3472
|
/**
|
|
2821
3473
|
* 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.
|
|
2822
3474
|
* @summary Delete a package
|
|
@@ -2866,10 +3518,11 @@ export declare const PackagesApiFactory: (configuration?: Configuration, basePat
|
|
|
2866
3518
|
* @summary Create a new package
|
|
2867
3519
|
* @param {string} projectName Name of the project
|
|
2868
3520
|
* @param {Package} _package
|
|
3521
|
+
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
2869
3522
|
* @param {*} [options] Override http request option.
|
|
2870
3523
|
* @throws {RequiredError}
|
|
2871
3524
|
*/
|
|
2872
|
-
createPackage(projectName: string, _package: Package, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
3525
|
+
createPackage(projectName: string, _package: Package, autoLoadManifest?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
2873
3526
|
/**
|
|
2874
3527
|
* 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.
|
|
2875
3528
|
* @summary Delete a package
|
|
@@ -2921,11 +3574,12 @@ export declare class PackagesApi extends BaseAPI {
|
|
|
2921
3574
|
* @summary Create a new package
|
|
2922
3575
|
* @param {string} projectName Name of the project
|
|
2923
3576
|
* @param {Package} _package
|
|
3577
|
+
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
2924
3578
|
* @param {*} [options] Override http request option.
|
|
2925
3579
|
* @throws {RequiredError}
|
|
2926
3580
|
* @memberof PackagesApi
|
|
2927
3581
|
*/
|
|
2928
|
-
createPackage(projectName: string, _package: Package, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Package, any, {}>>;
|
|
3582
|
+
createPackage(projectName: string, _package: Package, autoLoadManifest?: boolean, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Package, any, {}>>;
|
|
2929
3583
|
/**
|
|
2930
3584
|
* 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.
|
|
2931
3585
|
* @summary Delete a package
|