@malloy-publisher/sdk 0.0.196-dev → 0.0.197-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/README.md +77 -77
- package/TREE_SHAKING.md +11 -11
- package/dist/{ServerProvider-CvZTC0sJ.es.js → ServerProvider-DDScRRDc.es.js} +1393 -1393
- package/dist/ServerProvider-IhQ4aYBm.cjs.js +1 -0
- package/dist/client/api.d.ts +674 -674
- package/dist/client/configuration.d.ts +1 -1
- package/dist/client/index.cjs.js +1 -1
- package/dist/client/index.d.ts +1 -1
- package/dist/client/index.es.js +53 -53
- package/dist/components/Environment/Environment.d.ts +6 -0
- package/dist/components/Environment/index.d.ts +2 -0
- package/dist/components/Home/AddEnvironmentDialog.d.ts +1 -0
- package/dist/components/Home/DeleteEnvironmentDialog.d.ts +5 -0
- package/dist/components/Home/EditEnvironmentDialog.d.ts +7 -0
- package/dist/components/Home/Home.d.ts +2 -2
- package/dist/components/ServerProvider.d.ts +4 -4
- package/dist/components/index.d.ts +1 -1
- package/dist/{core-mP4paWtU.cjs.js → core-7-3Jcsb0.cjs.js} +1 -1
- package/dist/{core-BrfQApxh.es.js → core-w79IMXAG.es.js} +1 -1
- package/dist/hooks/useDimensionFiltersFromSpec.d.ts +3 -3
- package/dist/hooks/useDimensionFiltersQuery.d.ts +3 -3
- package/dist/hooks/useDimensionalFilterRangeData.d.ts +4 -4
- package/dist/{index-ClRkROAM.es.js → index-CN0_kZSF.es.js} +13067 -13033
- package/dist/{index-CW09s4Xx.cjs.js → index-Xo_ADux9.cjs.js} +34 -34
- package/dist/index.cjs.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.es.js +21 -21
- package/dist/utils/formatting.d.ts +1 -1
- package/dist/utils/parsing.d.ts +2 -2
- package/package.json +1 -1
- package/src/components/Connections/DeleteConnectionDialog.tsx +1 -0
- package/src/components/Connections/EditConnectionDialog.tsx +2 -0
- package/src/components/{Project → Environment}/About.tsx +8 -4
- package/src/components/{Project → Environment}/AddPackageDialog.tsx +5 -3
- package/src/components/{Project → Environment}/ConnectionExplorer.tsx +14 -14
- package/src/components/{Project → Environment}/DeletePackageDialog.tsx +2 -2
- package/src/components/{Project → Environment}/EditPackageDialog.tsx +18 -13
- package/src/components/{Project/Project.tsx → Environment/Environment.tsx} +6 -6
- package/src/components/{Project → Environment}/Packages.tsx +6 -5
- package/src/components/Environment/index.ts +2 -0
- package/src/components/Home/{AddProjectDialog.tsx → AddEnvironmentDialog.tsx} +21 -18
- package/src/components/Home/{DeleteProjectDialog.tsx → DeleteEnvironmentDialog.tsx} +14 -13
- package/src/components/Home/{EditProjectDialog.tsx → EditEnvironmentDialog.tsx} +32 -28
- package/src/components/Home/Home.tsx +39 -38
- package/src/components/Model/ModelCell.tsx +2 -2
- package/src/components/Model/SourcesExplorer.tsx +2 -2
- package/src/components/Model/useModelData.ts +3 -3
- package/src/components/Notebook/Notebook.tsx +7 -7
- package/src/components/Package/Config.tsx +4 -4
- package/src/components/Package/Connections.tsx +15 -15
- package/src/components/Package/Databases.tsx +4 -4
- package/src/components/Package/Models.tsx +4 -4
- package/src/components/Package/Notebooks.tsx +4 -4
- package/src/components/QueryResult/QueryResult.tsx +6 -6
- package/src/components/ServerProvider.tsx +5 -5
- package/src/components/Workbook/ModelPicker.tsx +4 -4
- package/src/components/Workbook/Workbook.tsx +4 -4
- package/src/components/index.ts +1 -1
- package/src/hooks/useDimensionFiltersFromSpec.ts +5 -5
- package/src/hooks/useDimensionFiltersQuery.ts +6 -6
- package/src/hooks/useDimensionalFilterRangeData.ts +7 -7
- package/src/hooks/useRawQueryData.ts +3 -3
- package/src/index.ts +1 -1
- package/src/utils/formatting.spec.ts +22 -21
- package/src/utils/formatting.ts +8 -7
- package/src/utils/parsing.spec.ts +23 -19
- package/src/utils/parsing.ts +8 -6
- package/dist/ServerProvider-BMsmCksc.cjs.js +0 -1
- package/dist/components/Home/AddProjectDialog.d.ts +0 -1
- package/dist/components/Home/DeleteProjectDialog.d.ts +0 -5
- package/dist/components/Home/EditProjectDialog.d.ts +0 -7
- package/dist/components/Project/Project.d.ts +0 -6
- package/dist/components/Project/index.d.ts +0 -2
- package/src/components/Project/index.ts +0 -2
- /package/dist/components/{Project → Environment}/About.d.ts +0 -0
- /package/dist/components/{Project → Environment}/AddPackageDialog.d.ts +0 -0
- /package/dist/components/{Project → Environment}/ConnectionExplorer.d.ts +0 -0
- /package/dist/components/{Project → Environment}/DeletePackageDialog.d.ts +0 -0
- /package/dist/components/{Project → Environment}/EditPackageDialog.d.ts +0 -0
- /package/dist/components/{Project → Environment}/Packages.d.ts +0 -0
package/dist/client/api.d.ts
CHANGED
|
@@ -657,7 +657,7 @@ export interface DatabricksConnection {
|
|
|
657
657
|
'setupSQL'?: string;
|
|
658
658
|
}
|
|
659
659
|
/**
|
|
660
|
-
* DuckDB database connection configuration. Publisher intentionally exposes only data-source intent here. Database files, working directories, filesystem/network policy, extension loading, setup SQL, temp directories, and resource knobs are owned by Publisher so
|
|
660
|
+
* DuckDB database connection configuration. Publisher intentionally exposes only data-source intent here. Database files, working directories, filesystem/network policy, extension loading, setup SQL, temp directories, and resource knobs are owned by Publisher so environment configs cannot widen deployment policy through low-level DuckDB settings.
|
|
661
661
|
* @export
|
|
662
662
|
* @interface DuckdbConnection
|
|
663
663
|
*/
|
|
@@ -726,6 +726,74 @@ export interface DucklakeConnectionStorage {
|
|
|
726
726
|
*/
|
|
727
727
|
'gcsConnection'?: GCSConnection;
|
|
728
728
|
}
|
|
729
|
+
/**
|
|
730
|
+
* Represents a Malloy environment containing packages, connections, and other resources
|
|
731
|
+
* @export
|
|
732
|
+
* @interface Environment
|
|
733
|
+
*/
|
|
734
|
+
export interface Environment {
|
|
735
|
+
/**
|
|
736
|
+
* Resource path to the environment
|
|
737
|
+
* @type {string}
|
|
738
|
+
* @memberof Environment
|
|
739
|
+
*/
|
|
740
|
+
'resource'?: string;
|
|
741
|
+
/**
|
|
742
|
+
* Environment name
|
|
743
|
+
* @type {string}
|
|
744
|
+
* @memberof Environment
|
|
745
|
+
*/
|
|
746
|
+
'name'?: string;
|
|
747
|
+
/**
|
|
748
|
+
* Environment README content
|
|
749
|
+
* @type {string}
|
|
750
|
+
* @memberof Environment
|
|
751
|
+
*/
|
|
752
|
+
'readme'?: string;
|
|
753
|
+
/**
|
|
754
|
+
* Environment location, can be an absolute path or URI (e.g. github, s3, gcs, etc.)
|
|
755
|
+
* @type {string}
|
|
756
|
+
* @memberof Environment
|
|
757
|
+
*/
|
|
758
|
+
'location'?: string;
|
|
759
|
+
/**
|
|
760
|
+
* List of database connections configured for this environment
|
|
761
|
+
* @type {Array<Connection>}
|
|
762
|
+
* @memberof Environment
|
|
763
|
+
*/
|
|
764
|
+
'connections'?: Array<Connection>;
|
|
765
|
+
/**
|
|
766
|
+
* List of Malloy packages in this environment
|
|
767
|
+
* @type {Array<Package>}
|
|
768
|
+
* @memberof Environment
|
|
769
|
+
*/
|
|
770
|
+
'packages'?: Array<Package>;
|
|
771
|
+
/**
|
|
772
|
+
*
|
|
773
|
+
* @type {EnvironmentMaterializationStorage}
|
|
774
|
+
* @memberof Environment
|
|
775
|
+
*/
|
|
776
|
+
'materializationStorage'?: EnvironmentMaterializationStorage;
|
|
777
|
+
}
|
|
778
|
+
/**
|
|
779
|
+
* 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.
|
|
780
|
+
* @export
|
|
781
|
+
* @interface EnvironmentMaterializationStorage
|
|
782
|
+
*/
|
|
783
|
+
export interface EnvironmentMaterializationStorage {
|
|
784
|
+
/**
|
|
785
|
+
* PostgreSQL connection URL for the DuckLake catalog metadata store
|
|
786
|
+
* @type {string}
|
|
787
|
+
* @memberof EnvironmentMaterializationStorage
|
|
788
|
+
*/
|
|
789
|
+
'catalogUrl'?: string;
|
|
790
|
+
/**
|
|
791
|
+
* Cloud storage path (s3:// or gs://) for DuckLake data files
|
|
792
|
+
* @type {string}
|
|
793
|
+
* @memberof EnvironmentMaterializationStorage
|
|
794
|
+
*/
|
|
795
|
+
'dataPath'?: string;
|
|
796
|
+
}
|
|
729
797
|
/**
|
|
730
798
|
* A filter declared via
|
|
731
799
|
* @export
|
|
@@ -902,7 +970,7 @@ export interface Materialization {
|
|
|
902
970
|
* @type {string}
|
|
903
971
|
* @memberof Materialization
|
|
904
972
|
*/
|
|
905
|
-
'
|
|
973
|
+
'environmentId'?: string;
|
|
906
974
|
/**
|
|
907
975
|
*
|
|
908
976
|
* @type {string}
|
|
@@ -1275,74 +1343,6 @@ export interface PostgresConnection {
|
|
|
1275
1343
|
*/
|
|
1276
1344
|
'connectionString'?: string;
|
|
1277
1345
|
}
|
|
1278
|
-
/**
|
|
1279
|
-
* Represents a Malloy project containing packages, connections, and other resources
|
|
1280
|
-
* @export
|
|
1281
|
-
* @interface Project
|
|
1282
|
-
*/
|
|
1283
|
-
export interface Project {
|
|
1284
|
-
/**
|
|
1285
|
-
* Resource path to the project
|
|
1286
|
-
* @type {string}
|
|
1287
|
-
* @memberof Project
|
|
1288
|
-
*/
|
|
1289
|
-
'resource'?: string;
|
|
1290
|
-
/**
|
|
1291
|
-
* Project name
|
|
1292
|
-
* @type {string}
|
|
1293
|
-
* @memberof Project
|
|
1294
|
-
*/
|
|
1295
|
-
'name'?: string;
|
|
1296
|
-
/**
|
|
1297
|
-
* Project README content
|
|
1298
|
-
* @type {string}
|
|
1299
|
-
* @memberof Project
|
|
1300
|
-
*/
|
|
1301
|
-
'readme'?: string;
|
|
1302
|
-
/**
|
|
1303
|
-
* Project location, can be an absolute path or URI (e.g. github, s3, gcs, etc.)
|
|
1304
|
-
* @type {string}
|
|
1305
|
-
* @memberof Project
|
|
1306
|
-
*/
|
|
1307
|
-
'location'?: string;
|
|
1308
|
-
/**
|
|
1309
|
-
* List of database connections configured for this project
|
|
1310
|
-
* @type {Array<Connection>}
|
|
1311
|
-
* @memberof Project
|
|
1312
|
-
*/
|
|
1313
|
-
'connections'?: Array<Connection>;
|
|
1314
|
-
/**
|
|
1315
|
-
* List of Malloy packages in this project
|
|
1316
|
-
* @type {Array<Package>}
|
|
1317
|
-
* @memberof Project
|
|
1318
|
-
*/
|
|
1319
|
-
'packages'?: Array<Package>;
|
|
1320
|
-
/**
|
|
1321
|
-
*
|
|
1322
|
-
* @type {ProjectMaterializationStorage}
|
|
1323
|
-
* @memberof Project
|
|
1324
|
-
*/
|
|
1325
|
-
'materializationStorage'?: ProjectMaterializationStorage;
|
|
1326
|
-
}
|
|
1327
|
-
/**
|
|
1328
|
-
* 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.
|
|
1329
|
-
* @export
|
|
1330
|
-
* @interface ProjectMaterializationStorage
|
|
1331
|
-
*/
|
|
1332
|
-
export interface ProjectMaterializationStorage {
|
|
1333
|
-
/**
|
|
1334
|
-
* PostgreSQL connection URL for the DuckLake catalog metadata store
|
|
1335
|
-
* @type {string}
|
|
1336
|
-
* @memberof ProjectMaterializationStorage
|
|
1337
|
-
*/
|
|
1338
|
-
'catalogUrl'?: string;
|
|
1339
|
-
/**
|
|
1340
|
-
* Cloud storage path (s3:// or gs://) for DuckLake data files
|
|
1341
|
-
* @type {string}
|
|
1342
|
-
* @memberof ProjectMaterializationStorage
|
|
1343
|
-
*/
|
|
1344
|
-
'dataPath'?: string;
|
|
1345
|
-
}
|
|
1346
1346
|
/**
|
|
1347
1347
|
* Named model query definition
|
|
1348
1348
|
* @export
|
|
@@ -1593,11 +1593,11 @@ export interface ServerStatus {
|
|
|
1593
1593
|
*/
|
|
1594
1594
|
'timestamp'?: number;
|
|
1595
1595
|
/**
|
|
1596
|
-
* List of available
|
|
1597
|
-
* @type {Array<
|
|
1596
|
+
* List of available environments
|
|
1597
|
+
* @type {Array<Environment>}
|
|
1598
1598
|
* @memberof ServerStatus
|
|
1599
1599
|
*/
|
|
1600
|
-
'
|
|
1600
|
+
'environments'?: Array<Environment>;
|
|
1601
1601
|
/**
|
|
1602
1602
|
* Whether the server is fully initialized and ready to serve requests
|
|
1603
1603
|
* @type {boolean}
|
|
@@ -1605,7 +1605,7 @@ export interface ServerStatus {
|
|
|
1605
1605
|
*/
|
|
1606
1606
|
'initialized'?: boolean;
|
|
1607
1607
|
/**
|
|
1608
|
-
* Status of the server; initializing when the server is loading
|
|
1608
|
+
* Status of the server; initializing when the server is loading environments, packages and connections, serving when the server is initialized and ready to serve requests, and draining when the server is going to shut down
|
|
1609
1609
|
* @type {string}
|
|
1610
1610
|
* @memberof ServerStatus
|
|
1611
1611
|
*/
|
|
@@ -1741,17 +1741,17 @@ export interface SqlSource {
|
|
|
1741
1741
|
'source'?: string;
|
|
1742
1742
|
}
|
|
1743
1743
|
/**
|
|
1744
|
-
* Request to start file watching for
|
|
1744
|
+
* Request to start file watching for an environment
|
|
1745
1745
|
* @export
|
|
1746
1746
|
* @interface StartWatchRequest
|
|
1747
1747
|
*/
|
|
1748
1748
|
export interface StartWatchRequest {
|
|
1749
1749
|
/**
|
|
1750
|
-
* Name of the
|
|
1750
|
+
* Name of the environment to start watching for file changes
|
|
1751
1751
|
* @type {string}
|
|
1752
1752
|
* @memberof StartWatchRequest
|
|
1753
1753
|
*/
|
|
1754
|
-
'
|
|
1754
|
+
'environmentName': string;
|
|
1755
1755
|
}
|
|
1756
1756
|
/**
|
|
1757
1757
|
*
|
|
@@ -1989,11 +1989,11 @@ export interface WatchStatus {
|
|
|
1989
1989
|
*/
|
|
1990
1990
|
'enabled': boolean;
|
|
1991
1991
|
/**
|
|
1992
|
-
* Name of the
|
|
1992
|
+
* Name of the environment being watched for file changes
|
|
1993
1993
|
* @type {string}
|
|
1994
1994
|
* @memberof WatchStatus
|
|
1995
1995
|
*/
|
|
1996
|
-
'
|
|
1996
|
+
'environmentName': string;
|
|
1997
1997
|
/**
|
|
1998
1998
|
* The file system path being monitored for changes, null if not watching
|
|
1999
1999
|
* @type {string}
|
|
@@ -2007,37 +2007,37 @@ export interface WatchStatus {
|
|
|
2007
2007
|
*/
|
|
2008
2008
|
export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2009
2009
|
/**
|
|
2010
|
-
* Creates a new database connection in the specified
|
|
2010
|
+
* Creates a new database connection in the specified environment.
|
|
2011
2011
|
* @summary Create a new database connection
|
|
2012
|
-
* @param {string}
|
|
2012
|
+
* @param {string} environmentName Name of the environment
|
|
2013
2013
|
* @param {string} connectionName Name of the connection
|
|
2014
2014
|
* @param {Connection} connection
|
|
2015
2015
|
* @param {*} [options] Override http request option.
|
|
2016
2016
|
* @throws {RequiredError}
|
|
2017
2017
|
*/
|
|
2018
|
-
createConnection: (
|
|
2018
|
+
createConnection: (environmentName: string, connectionName: string, connection: Connection, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2019
2019
|
/**
|
|
2020
|
-
* Permanently deletes a database connection from the
|
|
2020
|
+
* Permanently deletes a database connection from the environment.
|
|
2021
2021
|
* @summary Delete a database connection
|
|
2022
|
-
* @param {string}
|
|
2022
|
+
* @param {string} environmentName Name of the environment
|
|
2023
2023
|
* @param {string} connectionName Name of the connection to delete
|
|
2024
2024
|
* @param {*} [options] Override http request option.
|
|
2025
2025
|
* @throws {RequiredError}
|
|
2026
2026
|
*/
|
|
2027
|
-
deleteConnection: (
|
|
2027
|
+
deleteConnection: (environmentName: string, connectionName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2028
2028
|
/**
|
|
2029
|
-
* Retrieves detailed information about a specific database connection within
|
|
2029
|
+
* Retrieves detailed information about a specific database connection within an environment. This includes connection configuration, credentials (if accessible), and metadata. Useful for inspecting connection settings and troubleshooting connectivity issues.
|
|
2030
2030
|
* @summary Get connection details
|
|
2031
|
-
* @param {string}
|
|
2031
|
+
* @param {string} environmentName Name of the environment
|
|
2032
2032
|
* @param {string} connectionName Name of the connection
|
|
2033
2033
|
* @param {*} [options] Override http request option.
|
|
2034
2034
|
* @throws {RequiredError}
|
|
2035
2035
|
*/
|
|
2036
|
-
getConnection: (
|
|
2036
|
+
getConnection: (environmentName: string, connectionName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2037
2037
|
/**
|
|
2038
2038
|
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Executes a SQL statement against the specified database connection and returns the results. The query results include data, metadata, and execution information.
|
|
2039
2039
|
* @summary Execute SQL query (deprecated)
|
|
2040
|
-
* @param {string}
|
|
2040
|
+
* @param {string} environmentName Name of the environment
|
|
2041
2041
|
* @param {string} connectionName Name of the connection
|
|
2042
2042
|
* @param {string} [sqlStatement] SQL statement
|
|
2043
2043
|
* @param {string} [_options] Options
|
|
@@ -2045,11 +2045,11 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2045
2045
|
* @deprecated
|
|
2046
2046
|
* @throws {RequiredError}
|
|
2047
2047
|
*/
|
|
2048
|
-
getQuerydata: (
|
|
2048
|
+
getQuerydata: (environmentName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2049
2049
|
/**
|
|
2050
2050
|
* **DEPRECATED**: Use the POST version instead. Executes a SQL statement against the specified database connection, resolved in the context of the named package, and returns the results.
|
|
2051
2051
|
* @summary Execute SQL query (per-package, deprecated)
|
|
2052
|
-
* @param {string}
|
|
2052
|
+
* @param {string} environmentName Name of the environment
|
|
2053
2053
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2054
2054
|
* @param {string} connectionName Name of the connection
|
|
2055
2055
|
* @param {string} [sqlStatement] SQL statement
|
|
@@ -2058,22 +2058,22 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2058
2058
|
* @deprecated
|
|
2059
2059
|
* @throws {RequiredError}
|
|
2060
2060
|
*/
|
|
2061
|
-
getQuerydataInPackage: (
|
|
2061
|
+
getQuerydataInPackage: (environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2062
2062
|
/**
|
|
2063
2063
|
* **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.
|
|
2064
2064
|
* @summary Get SQL source (deprecated)
|
|
2065
|
-
* @param {string}
|
|
2065
|
+
* @param {string} environmentName Name of the environment
|
|
2066
2066
|
* @param {string} connectionName Name of the connection
|
|
2067
2067
|
* @param {string} [sqlStatement] SQL statement
|
|
2068
2068
|
* @param {*} [options] Override http request option.
|
|
2069
2069
|
* @deprecated
|
|
2070
2070
|
* @throws {RequiredError}
|
|
2071
2071
|
*/
|
|
2072
|
-
getSqlsource: (
|
|
2072
|
+
getSqlsource: (environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2073
2073
|
/**
|
|
2074
2074
|
* **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.
|
|
2075
2075
|
* @summary Get SQL source (per-package, deprecated)
|
|
2076
|
-
* @param {string}
|
|
2076
|
+
* @param {string} environmentName Name of the environment
|
|
2077
2077
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2078
2078
|
* @param {string} connectionName Name of the connection
|
|
2079
2079
|
* @param {string} [sqlStatement] SQL statement
|
|
@@ -2081,22 +2081,22 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2081
2081
|
* @deprecated
|
|
2082
2082
|
* @throws {RequiredError}
|
|
2083
2083
|
*/
|
|
2084
|
-
getSqlsourceInPackage: (
|
|
2084
|
+
getSqlsourceInPackage: (environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2085
2085
|
/**
|
|
2086
2086
|
* 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.
|
|
2087
2087
|
* @summary Get table details from database
|
|
2088
|
-
* @param {string}
|
|
2088
|
+
* @param {string} environmentName Name of the environment
|
|
2089
2089
|
* @param {string} connectionName Name of the connection
|
|
2090
2090
|
* @param {string} schemaName Name of the schema
|
|
2091
2091
|
* @param {string} tablePath Full path to the table
|
|
2092
2092
|
* @param {*} [options] Override http request option.
|
|
2093
2093
|
* @throws {RequiredError}
|
|
2094
2094
|
*/
|
|
2095
|
-
getTable: (
|
|
2095
|
+
getTable: (environmentName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2096
2096
|
/**
|
|
2097
2097
|
* Retrieves a table from the specified database schema, resolved in the context of the named package.
|
|
2098
2098
|
* @summary Get table details from database (per-package)
|
|
2099
|
-
* @param {string}
|
|
2099
|
+
* @param {string} environmentName Name of the environment
|
|
2100
2100
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2101
2101
|
* @param {string} connectionName Name of the connection
|
|
2102
2102
|
* @param {string} schemaName Name of the schema
|
|
@@ -2104,22 +2104,22 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2104
2104
|
* @param {*} [options] Override http request option.
|
|
2105
2105
|
* @throws {RequiredError}
|
|
2106
2106
|
*/
|
|
2107
|
-
getTableInPackage: (
|
|
2107
|
+
getTableInPackage: (environmentName: string, packageName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2108
2108
|
/**
|
|
2109
2109
|
* **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.
|
|
2110
2110
|
* @summary Create temporary table (deprecated)
|
|
2111
|
-
* @param {string}
|
|
2111
|
+
* @param {string} environmentName Name of the environment
|
|
2112
2112
|
* @param {string} connectionName Name of the connection
|
|
2113
2113
|
* @param {string} [sqlStatement] SQL statement
|
|
2114
2114
|
* @param {*} [options] Override http request option.
|
|
2115
2115
|
* @deprecated
|
|
2116
2116
|
* @throws {RequiredError}
|
|
2117
2117
|
*/
|
|
2118
|
-
getTemporarytable: (
|
|
2118
|
+
getTemporarytable: (environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2119
2119
|
/**
|
|
2120
2120
|
* **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.
|
|
2121
2121
|
* @summary Create temporary table (per-package, deprecated)
|
|
2122
|
-
* @param {string}
|
|
2122
|
+
* @param {string} environmentName Name of the environment
|
|
2123
2123
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2124
2124
|
* @param {string} connectionName Name of the connection
|
|
2125
2125
|
* @param {string} [sqlStatement] SQL statement
|
|
@@ -2127,49 +2127,49 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2127
2127
|
* @deprecated
|
|
2128
2128
|
* @throws {RequiredError}
|
|
2129
2129
|
*/
|
|
2130
|
-
getTemporarytableInPackage: (
|
|
2130
|
+
getTemporarytableInPackage: (environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2131
2131
|
/**
|
|
2132
|
-
* Retrieves a list of all database connections configured for the specified
|
|
2133
|
-
* @summary List
|
|
2134
|
-
* @param {string}
|
|
2132
|
+
* 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.
|
|
2133
|
+
* @summary List environment database connections
|
|
2134
|
+
* @param {string} environmentName Name of the environment
|
|
2135
2135
|
* @param {*} [options] Override http request option.
|
|
2136
2136
|
* @throws {RequiredError}
|
|
2137
2137
|
*/
|
|
2138
|
-
listConnections: (
|
|
2138
|
+
listConnections: (environmentName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2139
2139
|
/**
|
|
2140
2140
|
* Retrieves a list of all schemas (databases) available in the specified connection. Each schema includes metadata such as name, description, and whether it\'s the default schema. This endpoint is useful for exploring the database structure and discovering available data sources.
|
|
2141
2141
|
* @summary List database schemas
|
|
2142
|
-
* @param {string}
|
|
2142
|
+
* @param {string} environmentName Name of the environment
|
|
2143
2143
|
* @param {string} connectionName Name of the connection
|
|
2144
2144
|
* @param {*} [options] Override http request option.
|
|
2145
2145
|
* @throws {RequiredError}
|
|
2146
2146
|
*/
|
|
2147
|
-
listSchemas: (
|
|
2147
|
+
listSchemas: (environmentName: string, connectionName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2148
2148
|
/**
|
|
2149
|
-
* Retrieves a list of all schemas (databases) available in the specified connection, resolved in the context of the named package. Required for `connectionName=\"duckdb\"`, which is per-package; works for any other connection name as well (resolution falls through to the
|
|
2149
|
+
* Retrieves a list of all schemas (databases) available in the specified connection, resolved in the context of the named package. Required for `connectionName=\"duckdb\"`, which is per-package; works for any other connection name as well (resolution falls through to the environment).
|
|
2150
2150
|
* @summary List database schemas (per-package)
|
|
2151
|
-
* @param {string}
|
|
2151
|
+
* @param {string} environmentName Name of the environment
|
|
2152
2152
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2153
2153
|
* @param {string} connectionName Name of the connection
|
|
2154
2154
|
* @param {*} [options] Override http request option.
|
|
2155
2155
|
* @throws {RequiredError}
|
|
2156
2156
|
*/
|
|
2157
|
-
listSchemasInPackage: (
|
|
2157
|
+
listSchemasInPackage: (environmentName: string, packageName: string, connectionName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2158
2158
|
/**
|
|
2159
2159
|
* Retrieves a list of all tables and views available in the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed.
|
|
2160
2160
|
* @summary List tables in database
|
|
2161
|
-
* @param {string}
|
|
2161
|
+
* @param {string} environmentName Name of the environment
|
|
2162
2162
|
* @param {string} connectionName Name of the connection
|
|
2163
2163
|
* @param {string} schemaName Name of the schema
|
|
2164
2164
|
* @param {Array<string>} [tableNames] List of table names to filter results. When provided, only returns metadata for the specified tables. When omitted, returns all tables in the schema.
|
|
2165
2165
|
* @param {*} [options] Override http request option.
|
|
2166
2166
|
* @throws {RequiredError}
|
|
2167
2167
|
*/
|
|
2168
|
-
listTables: (
|
|
2168
|
+
listTables: (environmentName: string, connectionName: string, schemaName: string, tableNames?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2169
2169
|
/**
|
|
2170
2170
|
* Retrieves a list of all tables and views available in the specified database schema, resolved in the context of the named package.
|
|
2171
2171
|
* @summary List tables in database (per-package)
|
|
2172
|
-
* @param {string}
|
|
2172
|
+
* @param {string} environmentName Name of the environment
|
|
2173
2173
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2174
2174
|
* @param {string} connectionName Name of the connection
|
|
2175
2175
|
* @param {string} schemaName Name of the schema
|
|
@@ -2177,22 +2177,22 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2177
2177
|
* @param {*} [options] Override http request option.
|
|
2178
2178
|
* @throws {RequiredError}
|
|
2179
2179
|
*/
|
|
2180
|
-
listTablesInPackage: (
|
|
2180
|
+
listTablesInPackage: (environmentName: string, packageName: string, connectionName: string, schemaName: string, tableNames?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2181
2181
|
/**
|
|
2182
2182
|
* Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
|
|
2183
2183
|
* @summary Execute SQL query
|
|
2184
|
-
* @param {string}
|
|
2184
|
+
* @param {string} environmentName Name of the environment
|
|
2185
2185
|
* @param {string} connectionName Name of the connection
|
|
2186
2186
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2187
2187
|
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2188
2188
|
* @param {*} [options] Override http request option.
|
|
2189
2189
|
* @throws {RequiredError}
|
|
2190
2190
|
*/
|
|
2191
|
-
postQuerydata: (
|
|
2191
|
+
postQuerydata: (environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, _options?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2192
2192
|
/**
|
|
2193
2193
|
* Executes a SQL statement against the specified database connection, resolved in the context of the named package, and returns the results.
|
|
2194
2194
|
* @summary Execute SQL query (per-package)
|
|
2195
|
-
* @param {string}
|
|
2195
|
+
* @param {string} environmentName Name of the environment
|
|
2196
2196
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2197
2197
|
* @param {string} connectionName Name of the connection
|
|
2198
2198
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
@@ -2200,59 +2200,59 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2200
2200
|
* @param {*} [options] Override http request option.
|
|
2201
2201
|
* @throws {RequiredError}
|
|
2202
2202
|
*/
|
|
2203
|
-
postQuerydataInPackage: (
|
|
2203
|
+
postQuerydataInPackage: (environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, _options?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2204
2204
|
/**
|
|
2205
2205
|
* 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.
|
|
2206
2206
|
* @summary Create SQL source from statement
|
|
2207
|
-
* @param {string}
|
|
2207
|
+
* @param {string} environmentName Name of the environment
|
|
2208
2208
|
* @param {string} connectionName Name of the connection
|
|
2209
2209
|
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
|
|
2210
2210
|
* @param {*} [options] Override http request option.
|
|
2211
2211
|
* @throws {RequiredError}
|
|
2212
2212
|
*/
|
|
2213
|
-
postSqlsource: (
|
|
2213
|
+
postSqlsource: (environmentName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2214
2214
|
/**
|
|
2215
2215
|
* Creates a Malloy source from a SQL statement using the specified connection, resolved in the context of the named package.
|
|
2216
2216
|
* @summary Create SQL source from statement (per-package)
|
|
2217
|
-
* @param {string}
|
|
2217
|
+
* @param {string} environmentName Name of the environment
|
|
2218
2218
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2219
2219
|
* @param {string} connectionName Name of the connection
|
|
2220
2220
|
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
|
|
2221
2221
|
* @param {*} [options] Override http request option.
|
|
2222
2222
|
* @throws {RequiredError}
|
|
2223
2223
|
*/
|
|
2224
|
-
postSqlsourceInPackage: (
|
|
2224
|
+
postSqlsourceInPackage: (environmentName: string, packageName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2225
2225
|
/**
|
|
2226
2226
|
* Creates a temporary table from a SQL statement using the specified database connection. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
|
|
2227
2227
|
* @summary Create temporary table
|
|
2228
|
-
* @param {string}
|
|
2228
|
+
* @param {string} environmentName Name of the environment
|
|
2229
2229
|
* @param {string} connectionName Name of the connection
|
|
2230
2230
|
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
|
|
2231
2231
|
* @param {*} [options] Override http request option.
|
|
2232
2232
|
* @throws {RequiredError}
|
|
2233
2233
|
*/
|
|
2234
|
-
postTemporarytable: (
|
|
2234
|
+
postTemporarytable: (environmentName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2235
2235
|
/**
|
|
2236
2236
|
* Creates a temporary table from a SQL statement using the specified database connection, resolved in the context of the named package.
|
|
2237
2237
|
* @summary Create temporary table (per-package)
|
|
2238
|
-
* @param {string}
|
|
2238
|
+
* @param {string} environmentName Name of the environment
|
|
2239
2239
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2240
2240
|
* @param {string} connectionName Name of the connection
|
|
2241
2241
|
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
|
|
2242
2242
|
* @param {*} [options] Override http request option.
|
|
2243
2243
|
* @throws {RequiredError}
|
|
2244
2244
|
*/
|
|
2245
|
-
postTemporarytableInPackage: (
|
|
2245
|
+
postTemporarytableInPackage: (environmentName: string, packageName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2246
2246
|
/**
|
|
2247
2247
|
* Updates the configuration of an existing database connection.
|
|
2248
2248
|
* @summary Update an existing database connection
|
|
2249
|
-
* @param {string}
|
|
2249
|
+
* @param {string} environmentName Name of the environment
|
|
2250
2250
|
* @param {string} connectionName Name of the connection to update
|
|
2251
2251
|
* @param {UpdateConnectionRequest} updateConnectionRequest
|
|
2252
2252
|
* @param {*} [options] Override http request option.
|
|
2253
2253
|
* @throws {RequiredError}
|
|
2254
2254
|
*/
|
|
2255
|
-
updateConnection: (
|
|
2255
|
+
updateConnection: (environmentName: string, connectionName: string, updateConnectionRequest: UpdateConnectionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2256
2256
|
};
|
|
2257
2257
|
/**
|
|
2258
2258
|
* ConnectionsApi - functional programming interface
|
|
@@ -2260,37 +2260,37 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2260
2260
|
*/
|
|
2261
2261
|
export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
2262
2262
|
/**
|
|
2263
|
-
* Creates a new database connection in the specified
|
|
2263
|
+
* Creates a new database connection in the specified environment.
|
|
2264
2264
|
* @summary Create a new database connection
|
|
2265
|
-
* @param {string}
|
|
2265
|
+
* @param {string} environmentName Name of the environment
|
|
2266
2266
|
* @param {string} connectionName Name of the connection
|
|
2267
2267
|
* @param {Connection} connection
|
|
2268
2268
|
* @param {*} [options] Override http request option.
|
|
2269
2269
|
* @throws {RequiredError}
|
|
2270
2270
|
*/
|
|
2271
|
-
createConnection(
|
|
2271
|
+
createConnection(environmentName: string, connectionName: string, connection: Connection, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateConnection201Response>>;
|
|
2272
2272
|
/**
|
|
2273
|
-
* Permanently deletes a database connection from the
|
|
2273
|
+
* Permanently deletes a database connection from the environment.
|
|
2274
2274
|
* @summary Delete a database connection
|
|
2275
|
-
* @param {string}
|
|
2275
|
+
* @param {string} environmentName Name of the environment
|
|
2276
2276
|
* @param {string} connectionName Name of the connection to delete
|
|
2277
2277
|
* @param {*} [options] Override http request option.
|
|
2278
2278
|
* @throws {RequiredError}
|
|
2279
2279
|
*/
|
|
2280
|
-
deleteConnection(
|
|
2280
|
+
deleteConnection(environmentName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateConnection201Response>>;
|
|
2281
2281
|
/**
|
|
2282
|
-
* Retrieves detailed information about a specific database connection within
|
|
2282
|
+
* Retrieves detailed information about a specific database connection within an environment. This includes connection configuration, credentials (if accessible), and metadata. Useful for inspecting connection settings and troubleshooting connectivity issues.
|
|
2283
2283
|
* @summary Get connection details
|
|
2284
|
-
* @param {string}
|
|
2284
|
+
* @param {string} environmentName Name of the environment
|
|
2285
2285
|
* @param {string} connectionName Name of the connection
|
|
2286
2286
|
* @param {*} [options] Override http request option.
|
|
2287
2287
|
* @throws {RequiredError}
|
|
2288
2288
|
*/
|
|
2289
|
-
getConnection(
|
|
2289
|
+
getConnection(environmentName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Connection>>;
|
|
2290
2290
|
/**
|
|
2291
2291
|
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Executes a SQL statement against the specified database connection and returns the results. The query results include data, metadata, and execution information.
|
|
2292
2292
|
* @summary Execute SQL query (deprecated)
|
|
2293
|
-
* @param {string}
|
|
2293
|
+
* @param {string} environmentName Name of the environment
|
|
2294
2294
|
* @param {string} connectionName Name of the connection
|
|
2295
2295
|
* @param {string} [sqlStatement] SQL statement
|
|
2296
2296
|
* @param {string} [_options] Options
|
|
@@ -2298,11 +2298,11 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2298
2298
|
* @deprecated
|
|
2299
2299
|
* @throws {RequiredError}
|
|
2300
2300
|
*/
|
|
2301
|
-
getQuerydata(
|
|
2301
|
+
getQuerydata(environmentName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryData>>;
|
|
2302
2302
|
/**
|
|
2303
2303
|
* **DEPRECATED**: Use the POST version instead. Executes a SQL statement against the specified database connection, resolved in the context of the named package, and returns the results.
|
|
2304
2304
|
* @summary Execute SQL query (per-package, deprecated)
|
|
2305
|
-
* @param {string}
|
|
2305
|
+
* @param {string} environmentName Name of the environment
|
|
2306
2306
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2307
2307
|
* @param {string} connectionName Name of the connection
|
|
2308
2308
|
* @param {string} [sqlStatement] SQL statement
|
|
@@ -2311,22 +2311,22 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2311
2311
|
* @deprecated
|
|
2312
2312
|
* @throws {RequiredError}
|
|
2313
2313
|
*/
|
|
2314
|
-
getQuerydataInPackage(
|
|
2314
|
+
getQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryData>>;
|
|
2315
2315
|
/**
|
|
2316
2316
|
* **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.
|
|
2317
2317
|
* @summary Get SQL source (deprecated)
|
|
2318
|
-
* @param {string}
|
|
2318
|
+
* @param {string} environmentName Name of the environment
|
|
2319
2319
|
* @param {string} connectionName Name of the connection
|
|
2320
2320
|
* @param {string} [sqlStatement] SQL statement
|
|
2321
2321
|
* @param {*} [options] Override http request option.
|
|
2322
2322
|
* @deprecated
|
|
2323
2323
|
* @throws {RequiredError}
|
|
2324
2324
|
*/
|
|
2325
|
-
getSqlsource(
|
|
2325
|
+
getSqlsource(environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SqlSource>>;
|
|
2326
2326
|
/**
|
|
2327
2327
|
* **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.
|
|
2328
2328
|
* @summary Get SQL source (per-package, deprecated)
|
|
2329
|
-
* @param {string}
|
|
2329
|
+
* @param {string} environmentName Name of the environment
|
|
2330
2330
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2331
2331
|
* @param {string} connectionName Name of the connection
|
|
2332
2332
|
* @param {string} [sqlStatement] SQL statement
|
|
@@ -2334,22 +2334,22 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2334
2334
|
* @deprecated
|
|
2335
2335
|
* @throws {RequiredError}
|
|
2336
2336
|
*/
|
|
2337
|
-
getSqlsourceInPackage(
|
|
2337
|
+
getSqlsourceInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SqlSource>>;
|
|
2338
2338
|
/**
|
|
2339
2339
|
* 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.
|
|
2340
2340
|
* @summary Get table details from database
|
|
2341
|
-
* @param {string}
|
|
2341
|
+
* @param {string} environmentName Name of the environment
|
|
2342
2342
|
* @param {string} connectionName Name of the connection
|
|
2343
2343
|
* @param {string} schemaName Name of the schema
|
|
2344
2344
|
* @param {string} tablePath Full path to the table
|
|
2345
2345
|
* @param {*} [options] Override http request option.
|
|
2346
2346
|
* @throws {RequiredError}
|
|
2347
2347
|
*/
|
|
2348
|
-
getTable(
|
|
2348
|
+
getTable(environmentName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Table>>;
|
|
2349
2349
|
/**
|
|
2350
2350
|
* Retrieves a table from the specified database schema, resolved in the context of the named package.
|
|
2351
2351
|
* @summary Get table details from database (per-package)
|
|
2352
|
-
* @param {string}
|
|
2352
|
+
* @param {string} environmentName Name of the environment
|
|
2353
2353
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2354
2354
|
* @param {string} connectionName Name of the connection
|
|
2355
2355
|
* @param {string} schemaName Name of the schema
|
|
@@ -2357,22 +2357,22 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2357
2357
|
* @param {*} [options] Override http request option.
|
|
2358
2358
|
* @throws {RequiredError}
|
|
2359
2359
|
*/
|
|
2360
|
-
getTableInPackage(
|
|
2360
|
+
getTableInPackage(environmentName: string, packageName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Table>>;
|
|
2361
2361
|
/**
|
|
2362
2362
|
* **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.
|
|
2363
2363
|
* @summary Create temporary table (deprecated)
|
|
2364
|
-
* @param {string}
|
|
2364
|
+
* @param {string} environmentName Name of the environment
|
|
2365
2365
|
* @param {string} connectionName Name of the connection
|
|
2366
2366
|
* @param {string} [sqlStatement] SQL statement
|
|
2367
2367
|
* @param {*} [options] Override http request option.
|
|
2368
2368
|
* @deprecated
|
|
2369
2369
|
* @throws {RequiredError}
|
|
2370
2370
|
*/
|
|
2371
|
-
getTemporarytable(
|
|
2371
|
+
getTemporarytable(environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemporaryTable>>;
|
|
2372
2372
|
/**
|
|
2373
2373
|
* **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.
|
|
2374
2374
|
* @summary Create temporary table (per-package, deprecated)
|
|
2375
|
-
* @param {string}
|
|
2375
|
+
* @param {string} environmentName Name of the environment
|
|
2376
2376
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2377
2377
|
* @param {string} connectionName Name of the connection
|
|
2378
2378
|
* @param {string} [sqlStatement] SQL statement
|
|
@@ -2380,49 +2380,49 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2380
2380
|
* @deprecated
|
|
2381
2381
|
* @throws {RequiredError}
|
|
2382
2382
|
*/
|
|
2383
|
-
getTemporarytableInPackage(
|
|
2383
|
+
getTemporarytableInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemporaryTable>>;
|
|
2384
2384
|
/**
|
|
2385
|
-
* Retrieves a list of all database connections configured for the specified
|
|
2386
|
-
* @summary List
|
|
2387
|
-
* @param {string}
|
|
2385
|
+
* 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.
|
|
2386
|
+
* @summary List environment database connections
|
|
2387
|
+
* @param {string} environmentName Name of the environment
|
|
2388
2388
|
* @param {*} [options] Override http request option.
|
|
2389
2389
|
* @throws {RequiredError}
|
|
2390
2390
|
*/
|
|
2391
|
-
listConnections(
|
|
2391
|
+
listConnections(environmentName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Connection>>>;
|
|
2392
2392
|
/**
|
|
2393
2393
|
* Retrieves a list of all schemas (databases) available in the specified connection. Each schema includes metadata such as name, description, and whether it\'s the default schema. This endpoint is useful for exploring the database structure and discovering available data sources.
|
|
2394
2394
|
* @summary List database schemas
|
|
2395
|
-
* @param {string}
|
|
2395
|
+
* @param {string} environmentName Name of the environment
|
|
2396
2396
|
* @param {string} connectionName Name of the connection
|
|
2397
2397
|
* @param {*} [options] Override http request option.
|
|
2398
2398
|
* @throws {RequiredError}
|
|
2399
2399
|
*/
|
|
2400
|
-
listSchemas(
|
|
2400
|
+
listSchemas(environmentName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Schema>>>;
|
|
2401
2401
|
/**
|
|
2402
|
-
* Retrieves a list of all schemas (databases) available in the specified connection, resolved in the context of the named package. Required for `connectionName=\"duckdb\"`, which is per-package; works for any other connection name as well (resolution falls through to the
|
|
2402
|
+
* Retrieves a list of all schemas (databases) available in the specified connection, resolved in the context of the named package. Required for `connectionName=\"duckdb\"`, which is per-package; works for any other connection name as well (resolution falls through to the environment).
|
|
2403
2403
|
* @summary List database schemas (per-package)
|
|
2404
|
-
* @param {string}
|
|
2404
|
+
* @param {string} environmentName Name of the environment
|
|
2405
2405
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2406
2406
|
* @param {string} connectionName Name of the connection
|
|
2407
2407
|
* @param {*} [options] Override http request option.
|
|
2408
2408
|
* @throws {RequiredError}
|
|
2409
2409
|
*/
|
|
2410
|
-
listSchemasInPackage(
|
|
2410
|
+
listSchemasInPackage(environmentName: string, packageName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Schema>>>;
|
|
2411
2411
|
/**
|
|
2412
2412
|
* Retrieves a list of all tables and views available in the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed.
|
|
2413
2413
|
* @summary List tables in database
|
|
2414
|
-
* @param {string}
|
|
2414
|
+
* @param {string} environmentName Name of the environment
|
|
2415
2415
|
* @param {string} connectionName Name of the connection
|
|
2416
2416
|
* @param {string} schemaName Name of the schema
|
|
2417
2417
|
* @param {Array<string>} [tableNames] List of table names to filter results. When provided, only returns metadata for the specified tables. When omitted, returns all tables in the schema.
|
|
2418
2418
|
* @param {*} [options] Override http request option.
|
|
2419
2419
|
* @throws {RequiredError}
|
|
2420
2420
|
*/
|
|
2421
|
-
listTables(
|
|
2421
|
+
listTables(environmentName: string, connectionName: string, schemaName: string, tableNames?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Table>>>;
|
|
2422
2422
|
/**
|
|
2423
2423
|
* Retrieves a list of all tables and views available in the specified database schema, resolved in the context of the named package.
|
|
2424
2424
|
* @summary List tables in database (per-package)
|
|
2425
|
-
* @param {string}
|
|
2425
|
+
* @param {string} environmentName Name of the environment
|
|
2426
2426
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2427
2427
|
* @param {string} connectionName Name of the connection
|
|
2428
2428
|
* @param {string} schemaName Name of the schema
|
|
@@ -2430,22 +2430,22 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2430
2430
|
* @param {*} [options] Override http request option.
|
|
2431
2431
|
* @throws {RequiredError}
|
|
2432
2432
|
*/
|
|
2433
|
-
listTablesInPackage(
|
|
2433
|
+
listTablesInPackage(environmentName: string, packageName: string, connectionName: string, schemaName: string, tableNames?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Table>>>;
|
|
2434
2434
|
/**
|
|
2435
2435
|
* Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
|
|
2436
2436
|
* @summary Execute SQL query
|
|
2437
|
-
* @param {string}
|
|
2437
|
+
* @param {string} environmentName Name of the environment
|
|
2438
2438
|
* @param {string} connectionName Name of the connection
|
|
2439
2439
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2440
2440
|
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2441
2441
|
* @param {*} [options] Override http request option.
|
|
2442
2442
|
* @throws {RequiredError}
|
|
2443
2443
|
*/
|
|
2444
|
-
postQuerydata(
|
|
2444
|
+
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, _options?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryData>>;
|
|
2445
2445
|
/**
|
|
2446
2446
|
* Executes a SQL statement against the specified database connection, resolved in the context of the named package, and returns the results.
|
|
2447
2447
|
* @summary Execute SQL query (per-package)
|
|
2448
|
-
* @param {string}
|
|
2448
|
+
* @param {string} environmentName Name of the environment
|
|
2449
2449
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2450
2450
|
* @param {string} connectionName Name of the connection
|
|
2451
2451
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
@@ -2453,59 +2453,59 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2453
2453
|
* @param {*} [options] Override http request option.
|
|
2454
2454
|
* @throws {RequiredError}
|
|
2455
2455
|
*/
|
|
2456
|
-
postQuerydataInPackage(
|
|
2456
|
+
postQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, _options?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryData>>;
|
|
2457
2457
|
/**
|
|
2458
2458
|
* 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.
|
|
2459
2459
|
* @summary Create SQL source from statement
|
|
2460
|
-
* @param {string}
|
|
2460
|
+
* @param {string} environmentName Name of the environment
|
|
2461
2461
|
* @param {string} connectionName Name of the connection
|
|
2462
2462
|
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
|
|
2463
2463
|
* @param {*} [options] Override http request option.
|
|
2464
2464
|
* @throws {RequiredError}
|
|
2465
2465
|
*/
|
|
2466
|
-
postSqlsource(
|
|
2466
|
+
postSqlsource(environmentName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SqlSource>>;
|
|
2467
2467
|
/**
|
|
2468
2468
|
* Creates a Malloy source from a SQL statement using the specified connection, resolved in the context of the named package.
|
|
2469
2469
|
* @summary Create SQL source from statement (per-package)
|
|
2470
|
-
* @param {string}
|
|
2470
|
+
* @param {string} environmentName Name of the environment
|
|
2471
2471
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2472
2472
|
* @param {string} connectionName Name of the connection
|
|
2473
2473
|
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
|
|
2474
2474
|
* @param {*} [options] Override http request option.
|
|
2475
2475
|
* @throws {RequiredError}
|
|
2476
2476
|
*/
|
|
2477
|
-
postSqlsourceInPackage(
|
|
2477
|
+
postSqlsourceInPackage(environmentName: string, packageName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SqlSource>>;
|
|
2478
2478
|
/**
|
|
2479
2479
|
* Creates a temporary table from a SQL statement using the specified database connection. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
|
|
2480
2480
|
* @summary Create temporary table
|
|
2481
|
-
* @param {string}
|
|
2481
|
+
* @param {string} environmentName Name of the environment
|
|
2482
2482
|
* @param {string} connectionName Name of the connection
|
|
2483
2483
|
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
|
|
2484
2484
|
* @param {*} [options] Override http request option.
|
|
2485
2485
|
* @throws {RequiredError}
|
|
2486
2486
|
*/
|
|
2487
|
-
postTemporarytable(
|
|
2487
|
+
postTemporarytable(environmentName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemporaryTable>>;
|
|
2488
2488
|
/**
|
|
2489
2489
|
* Creates a temporary table from a SQL statement using the specified database connection, resolved in the context of the named package.
|
|
2490
2490
|
* @summary Create temporary table (per-package)
|
|
2491
|
-
* @param {string}
|
|
2491
|
+
* @param {string} environmentName Name of the environment
|
|
2492
2492
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2493
2493
|
* @param {string} connectionName Name of the connection
|
|
2494
2494
|
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
|
|
2495
2495
|
* @param {*} [options] Override http request option.
|
|
2496
2496
|
* @throws {RequiredError}
|
|
2497
2497
|
*/
|
|
2498
|
-
postTemporarytableInPackage(
|
|
2498
|
+
postTemporarytableInPackage(environmentName: string, packageName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemporaryTable>>;
|
|
2499
2499
|
/**
|
|
2500
2500
|
* Updates the configuration of an existing database connection.
|
|
2501
2501
|
* @summary Update an existing database connection
|
|
2502
|
-
* @param {string}
|
|
2502
|
+
* @param {string} environmentName Name of the environment
|
|
2503
2503
|
* @param {string} connectionName Name of the connection to update
|
|
2504
2504
|
* @param {UpdateConnectionRequest} updateConnectionRequest
|
|
2505
2505
|
* @param {*} [options] Override http request option.
|
|
2506
2506
|
* @throws {RequiredError}
|
|
2507
2507
|
*/
|
|
2508
|
-
updateConnection(
|
|
2508
|
+
updateConnection(environmentName: string, connectionName: string, updateConnectionRequest: UpdateConnectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateConnection201Response>>;
|
|
2509
2509
|
};
|
|
2510
2510
|
/**
|
|
2511
2511
|
* ConnectionsApi - factory interface
|
|
@@ -2513,37 +2513,37 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
2513
2513
|
*/
|
|
2514
2514
|
export declare const ConnectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2515
2515
|
/**
|
|
2516
|
-
* Creates a new database connection in the specified
|
|
2516
|
+
* Creates a new database connection in the specified environment.
|
|
2517
2517
|
* @summary Create a new database connection
|
|
2518
|
-
* @param {string}
|
|
2518
|
+
* @param {string} environmentName Name of the environment
|
|
2519
2519
|
* @param {string} connectionName Name of the connection
|
|
2520
2520
|
* @param {Connection} connection
|
|
2521
2521
|
* @param {*} [options] Override http request option.
|
|
2522
2522
|
* @throws {RequiredError}
|
|
2523
2523
|
*/
|
|
2524
|
-
createConnection(
|
|
2524
|
+
createConnection(environmentName: string, connectionName: string, connection: Connection, options?: RawAxiosRequestConfig): AxiosPromise<CreateConnection201Response>;
|
|
2525
2525
|
/**
|
|
2526
|
-
* Permanently deletes a database connection from the
|
|
2526
|
+
* Permanently deletes a database connection from the environment.
|
|
2527
2527
|
* @summary Delete a database connection
|
|
2528
|
-
* @param {string}
|
|
2528
|
+
* @param {string} environmentName Name of the environment
|
|
2529
2529
|
* @param {string} connectionName Name of the connection to delete
|
|
2530
2530
|
* @param {*} [options] Override http request option.
|
|
2531
2531
|
* @throws {RequiredError}
|
|
2532
2532
|
*/
|
|
2533
|
-
deleteConnection(
|
|
2533
|
+
deleteConnection(environmentName: string, connectionName: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateConnection201Response>;
|
|
2534
2534
|
/**
|
|
2535
|
-
* Retrieves detailed information about a specific database connection within
|
|
2535
|
+
* Retrieves detailed information about a specific database connection within an environment. This includes connection configuration, credentials (if accessible), and metadata. Useful for inspecting connection settings and troubleshooting connectivity issues.
|
|
2536
2536
|
* @summary Get connection details
|
|
2537
|
-
* @param {string}
|
|
2537
|
+
* @param {string} environmentName Name of the environment
|
|
2538
2538
|
* @param {string} connectionName Name of the connection
|
|
2539
2539
|
* @param {*} [options] Override http request option.
|
|
2540
2540
|
* @throws {RequiredError}
|
|
2541
2541
|
*/
|
|
2542
|
-
getConnection(
|
|
2542
|
+
getConnection(environmentName: string, connectionName: string, options?: RawAxiosRequestConfig): AxiosPromise<Connection>;
|
|
2543
2543
|
/**
|
|
2544
2544
|
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Executes a SQL statement against the specified database connection and returns the results. The query results include data, metadata, and execution information.
|
|
2545
2545
|
* @summary Execute SQL query (deprecated)
|
|
2546
|
-
* @param {string}
|
|
2546
|
+
* @param {string} environmentName Name of the environment
|
|
2547
2547
|
* @param {string} connectionName Name of the connection
|
|
2548
2548
|
* @param {string} [sqlStatement] SQL statement
|
|
2549
2549
|
* @param {string} [_options] Options
|
|
@@ -2551,11 +2551,11 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2551
2551
|
* @deprecated
|
|
2552
2552
|
* @throws {RequiredError}
|
|
2553
2553
|
*/
|
|
2554
|
-
getQuerydata(
|
|
2554
|
+
getQuerydata(environmentName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig): AxiosPromise<QueryData>;
|
|
2555
2555
|
/**
|
|
2556
2556
|
* **DEPRECATED**: Use the POST version instead. Executes a SQL statement against the specified database connection, resolved in the context of the named package, and returns the results.
|
|
2557
2557
|
* @summary Execute SQL query (per-package, deprecated)
|
|
2558
|
-
* @param {string}
|
|
2558
|
+
* @param {string} environmentName Name of the environment
|
|
2559
2559
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2560
2560
|
* @param {string} connectionName Name of the connection
|
|
2561
2561
|
* @param {string} [sqlStatement] SQL statement
|
|
@@ -2564,22 +2564,22 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2564
2564
|
* @deprecated
|
|
2565
2565
|
* @throws {RequiredError}
|
|
2566
2566
|
*/
|
|
2567
|
-
getQuerydataInPackage(
|
|
2567
|
+
getQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig): AxiosPromise<QueryData>;
|
|
2568
2568
|
/**
|
|
2569
2569
|
* **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.
|
|
2570
2570
|
* @summary Get SQL source (deprecated)
|
|
2571
|
-
* @param {string}
|
|
2571
|
+
* @param {string} environmentName Name of the environment
|
|
2572
2572
|
* @param {string} connectionName Name of the connection
|
|
2573
2573
|
* @param {string} [sqlStatement] SQL statement
|
|
2574
2574
|
* @param {*} [options] Override http request option.
|
|
2575
2575
|
* @deprecated
|
|
2576
2576
|
* @throws {RequiredError}
|
|
2577
2577
|
*/
|
|
2578
|
-
getSqlsource(
|
|
2578
|
+
getSqlsource(environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<SqlSource>;
|
|
2579
2579
|
/**
|
|
2580
2580
|
* **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.
|
|
2581
2581
|
* @summary Get SQL source (per-package, deprecated)
|
|
2582
|
-
* @param {string}
|
|
2582
|
+
* @param {string} environmentName Name of the environment
|
|
2583
2583
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2584
2584
|
* @param {string} connectionName Name of the connection
|
|
2585
2585
|
* @param {string} [sqlStatement] SQL statement
|
|
@@ -2587,22 +2587,22 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2587
2587
|
* @deprecated
|
|
2588
2588
|
* @throws {RequiredError}
|
|
2589
2589
|
*/
|
|
2590
|
-
getSqlsourceInPackage(
|
|
2590
|
+
getSqlsourceInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<SqlSource>;
|
|
2591
2591
|
/**
|
|
2592
2592
|
* 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.
|
|
2593
2593
|
* @summary Get table details from database
|
|
2594
|
-
* @param {string}
|
|
2594
|
+
* @param {string} environmentName Name of the environment
|
|
2595
2595
|
* @param {string} connectionName Name of the connection
|
|
2596
2596
|
* @param {string} schemaName Name of the schema
|
|
2597
2597
|
* @param {string} tablePath Full path to the table
|
|
2598
2598
|
* @param {*} [options] Override http request option.
|
|
2599
2599
|
* @throws {RequiredError}
|
|
2600
2600
|
*/
|
|
2601
|
-
getTable(
|
|
2601
|
+
getTable(environmentName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): AxiosPromise<Table>;
|
|
2602
2602
|
/**
|
|
2603
2603
|
* Retrieves a table from the specified database schema, resolved in the context of the named package.
|
|
2604
2604
|
* @summary Get table details from database (per-package)
|
|
2605
|
-
* @param {string}
|
|
2605
|
+
* @param {string} environmentName Name of the environment
|
|
2606
2606
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2607
2607
|
* @param {string} connectionName Name of the connection
|
|
2608
2608
|
* @param {string} schemaName Name of the schema
|
|
@@ -2610,22 +2610,22 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2610
2610
|
* @param {*} [options] Override http request option.
|
|
2611
2611
|
* @throws {RequiredError}
|
|
2612
2612
|
*/
|
|
2613
|
-
getTableInPackage(
|
|
2613
|
+
getTableInPackage(environmentName: string, packageName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): AxiosPromise<Table>;
|
|
2614
2614
|
/**
|
|
2615
2615
|
* **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.
|
|
2616
2616
|
* @summary Create temporary table (deprecated)
|
|
2617
|
-
* @param {string}
|
|
2617
|
+
* @param {string} environmentName Name of the environment
|
|
2618
2618
|
* @param {string} connectionName Name of the connection
|
|
2619
2619
|
* @param {string} [sqlStatement] SQL statement
|
|
2620
2620
|
* @param {*} [options] Override http request option.
|
|
2621
2621
|
* @deprecated
|
|
2622
2622
|
* @throws {RequiredError}
|
|
2623
2623
|
*/
|
|
2624
|
-
getTemporarytable(
|
|
2624
|
+
getTemporarytable(environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<TemporaryTable>;
|
|
2625
2625
|
/**
|
|
2626
2626
|
* **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.
|
|
2627
2627
|
* @summary Create temporary table (per-package, deprecated)
|
|
2628
|
-
* @param {string}
|
|
2628
|
+
* @param {string} environmentName Name of the environment
|
|
2629
2629
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2630
2630
|
* @param {string} connectionName Name of the connection
|
|
2631
2631
|
* @param {string} [sqlStatement] SQL statement
|
|
@@ -2633,49 +2633,49 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2633
2633
|
* @deprecated
|
|
2634
2634
|
* @throws {RequiredError}
|
|
2635
2635
|
*/
|
|
2636
|
-
getTemporarytableInPackage(
|
|
2636
|
+
getTemporarytableInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<TemporaryTable>;
|
|
2637
2637
|
/**
|
|
2638
|
-
* Retrieves a list of all database connections configured for the specified
|
|
2639
|
-
* @summary List
|
|
2640
|
-
* @param {string}
|
|
2638
|
+
* 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.
|
|
2639
|
+
* @summary List environment database connections
|
|
2640
|
+
* @param {string} environmentName Name of the environment
|
|
2641
2641
|
* @param {*} [options] Override http request option.
|
|
2642
2642
|
* @throws {RequiredError}
|
|
2643
2643
|
*/
|
|
2644
|
-
listConnections(
|
|
2644
|
+
listConnections(environmentName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Connection>>;
|
|
2645
2645
|
/**
|
|
2646
2646
|
* Retrieves a list of all schemas (databases) available in the specified connection. Each schema includes metadata such as name, description, and whether it\'s the default schema. This endpoint is useful for exploring the database structure and discovering available data sources.
|
|
2647
2647
|
* @summary List database schemas
|
|
2648
|
-
* @param {string}
|
|
2648
|
+
* @param {string} environmentName Name of the environment
|
|
2649
2649
|
* @param {string} connectionName Name of the connection
|
|
2650
2650
|
* @param {*} [options] Override http request option.
|
|
2651
2651
|
* @throws {RequiredError}
|
|
2652
2652
|
*/
|
|
2653
|
-
listSchemas(
|
|
2653
|
+
listSchemas(environmentName: string, connectionName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Schema>>;
|
|
2654
2654
|
/**
|
|
2655
|
-
* Retrieves a list of all schemas (databases) available in the specified connection, resolved in the context of the named package. Required for `connectionName=\"duckdb\"`, which is per-package; works for any other connection name as well (resolution falls through to the
|
|
2655
|
+
* Retrieves a list of all schemas (databases) available in the specified connection, resolved in the context of the named package. Required for `connectionName=\"duckdb\"`, which is per-package; works for any other connection name as well (resolution falls through to the environment).
|
|
2656
2656
|
* @summary List database schemas (per-package)
|
|
2657
|
-
* @param {string}
|
|
2657
|
+
* @param {string} environmentName Name of the environment
|
|
2658
2658
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2659
2659
|
* @param {string} connectionName Name of the connection
|
|
2660
2660
|
* @param {*} [options] Override http request option.
|
|
2661
2661
|
* @throws {RequiredError}
|
|
2662
2662
|
*/
|
|
2663
|
-
listSchemasInPackage(
|
|
2663
|
+
listSchemasInPackage(environmentName: string, packageName: string, connectionName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Schema>>;
|
|
2664
2664
|
/**
|
|
2665
2665
|
* Retrieves a list of all tables and views available in the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed.
|
|
2666
2666
|
* @summary List tables in database
|
|
2667
|
-
* @param {string}
|
|
2667
|
+
* @param {string} environmentName Name of the environment
|
|
2668
2668
|
* @param {string} connectionName Name of the connection
|
|
2669
2669
|
* @param {string} schemaName Name of the schema
|
|
2670
2670
|
* @param {Array<string>} [tableNames] List of table names to filter results. When provided, only returns metadata for the specified tables. When omitted, returns all tables in the schema.
|
|
2671
2671
|
* @param {*} [options] Override http request option.
|
|
2672
2672
|
* @throws {RequiredError}
|
|
2673
2673
|
*/
|
|
2674
|
-
listTables(
|
|
2674
|
+
listTables(environmentName: string, connectionName: string, schemaName: string, tableNames?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<Table>>;
|
|
2675
2675
|
/**
|
|
2676
2676
|
* Retrieves a list of all tables and views available in the specified database schema, resolved in the context of the named package.
|
|
2677
2677
|
* @summary List tables in database (per-package)
|
|
2678
|
-
* @param {string}
|
|
2678
|
+
* @param {string} environmentName Name of the environment
|
|
2679
2679
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2680
2680
|
* @param {string} connectionName Name of the connection
|
|
2681
2681
|
* @param {string} schemaName Name of the schema
|
|
@@ -2683,22 +2683,22 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2683
2683
|
* @param {*} [options] Override http request option.
|
|
2684
2684
|
* @throws {RequiredError}
|
|
2685
2685
|
*/
|
|
2686
|
-
listTablesInPackage(
|
|
2686
|
+
listTablesInPackage(environmentName: string, packageName: string, connectionName: string, schemaName: string, tableNames?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<Table>>;
|
|
2687
2687
|
/**
|
|
2688
2688
|
* Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
|
|
2689
2689
|
* @summary Execute SQL query
|
|
2690
|
-
* @param {string}
|
|
2690
|
+
* @param {string} environmentName Name of the environment
|
|
2691
2691
|
* @param {string} connectionName Name of the connection
|
|
2692
2692
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2693
2693
|
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
2694
2694
|
* @param {*} [options] Override http request option.
|
|
2695
2695
|
* @throws {RequiredError}
|
|
2696
2696
|
*/
|
|
2697
|
-
postQuerydata(
|
|
2697
|
+
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, _options?: string, options?: RawAxiosRequestConfig): AxiosPromise<QueryData>;
|
|
2698
2698
|
/**
|
|
2699
2699
|
* Executes a SQL statement against the specified database connection, resolved in the context of the named package, and returns the results.
|
|
2700
2700
|
* @summary Execute SQL query (per-package)
|
|
2701
|
-
* @param {string}
|
|
2701
|
+
* @param {string} environmentName Name of the environment
|
|
2702
2702
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2703
2703
|
* @param {string} connectionName Name of the connection
|
|
2704
2704
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
@@ -2706,59 +2706,59 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2706
2706
|
* @param {*} [options] Override http request option.
|
|
2707
2707
|
* @throws {RequiredError}
|
|
2708
2708
|
*/
|
|
2709
|
-
postQuerydataInPackage(
|
|
2709
|
+
postQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, _options?: string, options?: RawAxiosRequestConfig): AxiosPromise<QueryData>;
|
|
2710
2710
|
/**
|
|
2711
2711
|
* 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.
|
|
2712
2712
|
* @summary Create SQL source from statement
|
|
2713
|
-
* @param {string}
|
|
2713
|
+
* @param {string} environmentName Name of the environment
|
|
2714
2714
|
* @param {string} connectionName Name of the connection
|
|
2715
2715
|
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
|
|
2716
2716
|
* @param {*} [options] Override http request option.
|
|
2717
2717
|
* @throws {RequiredError}
|
|
2718
2718
|
*/
|
|
2719
|
-
postSqlsource(
|
|
2719
|
+
postSqlsource(environmentName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<SqlSource>;
|
|
2720
2720
|
/**
|
|
2721
2721
|
* Creates a Malloy source from a SQL statement using the specified connection, resolved in the context of the named package.
|
|
2722
2722
|
* @summary Create SQL source from statement (per-package)
|
|
2723
|
-
* @param {string}
|
|
2723
|
+
* @param {string} environmentName Name of the environment
|
|
2724
2724
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2725
2725
|
* @param {string} connectionName Name of the connection
|
|
2726
2726
|
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
|
|
2727
2727
|
* @param {*} [options] Override http request option.
|
|
2728
2728
|
* @throws {RequiredError}
|
|
2729
2729
|
*/
|
|
2730
|
-
postSqlsourceInPackage(
|
|
2730
|
+
postSqlsourceInPackage(environmentName: string, packageName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<SqlSource>;
|
|
2731
2731
|
/**
|
|
2732
2732
|
* Creates a temporary table from a SQL statement using the specified database connection. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
|
|
2733
2733
|
* @summary Create temporary table
|
|
2734
|
-
* @param {string}
|
|
2734
|
+
* @param {string} environmentName Name of the environment
|
|
2735
2735
|
* @param {string} connectionName Name of the connection
|
|
2736
2736
|
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
|
|
2737
2737
|
* @param {*} [options] Override http request option.
|
|
2738
2738
|
* @throws {RequiredError}
|
|
2739
2739
|
*/
|
|
2740
|
-
postTemporarytable(
|
|
2740
|
+
postTemporarytable(environmentName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<TemporaryTable>;
|
|
2741
2741
|
/**
|
|
2742
2742
|
* Creates a temporary table from a SQL statement using the specified database connection, resolved in the context of the named package.
|
|
2743
2743
|
* @summary Create temporary table (per-package)
|
|
2744
|
-
* @param {string}
|
|
2744
|
+
* @param {string} environmentName Name of the environment
|
|
2745
2745
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2746
2746
|
* @param {string} connectionName Name of the connection
|
|
2747
2747
|
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
|
|
2748
2748
|
* @param {*} [options] Override http request option.
|
|
2749
2749
|
* @throws {RequiredError}
|
|
2750
2750
|
*/
|
|
2751
|
-
postTemporarytableInPackage(
|
|
2751
|
+
postTemporarytableInPackage(environmentName: string, packageName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<TemporaryTable>;
|
|
2752
2752
|
/**
|
|
2753
2753
|
* Updates the configuration of an existing database connection.
|
|
2754
2754
|
* @summary Update an existing database connection
|
|
2755
|
-
* @param {string}
|
|
2755
|
+
* @param {string} environmentName Name of the environment
|
|
2756
2756
|
* @param {string} connectionName Name of the connection to update
|
|
2757
2757
|
* @param {UpdateConnectionRequest} updateConnectionRequest
|
|
2758
2758
|
* @param {*} [options] Override http request option.
|
|
2759
2759
|
* @throws {RequiredError}
|
|
2760
2760
|
*/
|
|
2761
|
-
updateConnection(
|
|
2761
|
+
updateConnection(environmentName: string, connectionName: string, updateConnectionRequest: UpdateConnectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateConnection201Response>;
|
|
2762
2762
|
};
|
|
2763
2763
|
/**
|
|
2764
2764
|
* ConnectionsApi - object-oriented interface
|
|
@@ -2768,40 +2768,40 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
2768
2768
|
*/
|
|
2769
2769
|
export declare class ConnectionsApi extends BaseAPI {
|
|
2770
2770
|
/**
|
|
2771
|
-
* Creates a new database connection in the specified
|
|
2771
|
+
* Creates a new database connection in the specified environment.
|
|
2772
2772
|
* @summary Create a new database connection
|
|
2773
|
-
* @param {string}
|
|
2773
|
+
* @param {string} environmentName Name of the environment
|
|
2774
2774
|
* @param {string} connectionName Name of the connection
|
|
2775
2775
|
* @param {Connection} connection
|
|
2776
2776
|
* @param {*} [options] Override http request option.
|
|
2777
2777
|
* @throws {RequiredError}
|
|
2778
2778
|
* @memberof ConnectionsApi
|
|
2779
2779
|
*/
|
|
2780
|
-
createConnection(
|
|
2780
|
+
createConnection(environmentName: string, connectionName: string, connection: Connection, options?: RawAxiosRequestConfig): Promise< AxiosResponse<CreateConnection201Response, any, {}>>;
|
|
2781
2781
|
/**
|
|
2782
|
-
* Permanently deletes a database connection from the
|
|
2782
|
+
* Permanently deletes a database connection from the environment.
|
|
2783
2783
|
* @summary Delete a database connection
|
|
2784
|
-
* @param {string}
|
|
2784
|
+
* @param {string} environmentName Name of the environment
|
|
2785
2785
|
* @param {string} connectionName Name of the connection to delete
|
|
2786
2786
|
* @param {*} [options] Override http request option.
|
|
2787
2787
|
* @throws {RequiredError}
|
|
2788
2788
|
* @memberof ConnectionsApi
|
|
2789
2789
|
*/
|
|
2790
|
-
deleteConnection(
|
|
2790
|
+
deleteConnection(environmentName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<CreateConnection201Response, any, {}>>;
|
|
2791
2791
|
/**
|
|
2792
|
-
* Retrieves detailed information about a specific database connection within
|
|
2792
|
+
* Retrieves detailed information about a specific database connection within an environment. This includes connection configuration, credentials (if accessible), and metadata. Useful for inspecting connection settings and troubleshooting connectivity issues.
|
|
2793
2793
|
* @summary Get connection details
|
|
2794
|
-
* @param {string}
|
|
2794
|
+
* @param {string} environmentName Name of the environment
|
|
2795
2795
|
* @param {string} connectionName Name of the connection
|
|
2796
2796
|
* @param {*} [options] Override http request option.
|
|
2797
2797
|
* @throws {RequiredError}
|
|
2798
2798
|
* @memberof ConnectionsApi
|
|
2799
2799
|
*/
|
|
2800
|
-
getConnection(
|
|
2800
|
+
getConnection(environmentName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Connection, any, {}>>;
|
|
2801
2801
|
/**
|
|
2802
2802
|
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Executes a SQL statement against the specified database connection and returns the results. The query results include data, metadata, and execution information.
|
|
2803
2803
|
* @summary Execute SQL query (deprecated)
|
|
2804
|
-
* @param {string}
|
|
2804
|
+
* @param {string} environmentName Name of the environment
|
|
2805
2805
|
* @param {string} connectionName Name of the connection
|
|
2806
2806
|
* @param {string} [sqlStatement] SQL statement
|
|
2807
2807
|
* @param {string} [_options] Options
|
|
@@ -2810,11 +2810,11 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2810
2810
|
* @throws {RequiredError}
|
|
2811
2811
|
* @memberof ConnectionsApi
|
|
2812
2812
|
*/
|
|
2813
|
-
getQuerydata(
|
|
2813
|
+
getQuerydata(environmentName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<QueryData, any, {}>>;
|
|
2814
2814
|
/**
|
|
2815
2815
|
* **DEPRECATED**: Use the POST version instead. Executes a SQL statement against the specified database connection, resolved in the context of the named package, and returns the results.
|
|
2816
2816
|
* @summary Execute SQL query (per-package, deprecated)
|
|
2817
|
-
* @param {string}
|
|
2817
|
+
* @param {string} environmentName Name of the environment
|
|
2818
2818
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2819
2819
|
* @param {string} connectionName Name of the connection
|
|
2820
2820
|
* @param {string} [sqlStatement] SQL statement
|
|
@@ -2824,11 +2824,11 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2824
2824
|
* @throws {RequiredError}
|
|
2825
2825
|
* @memberof ConnectionsApi
|
|
2826
2826
|
*/
|
|
2827
|
-
getQuerydataInPackage(
|
|
2827
|
+
getQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<QueryData, any, {}>>;
|
|
2828
2828
|
/**
|
|
2829
2829
|
* **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.
|
|
2830
2830
|
* @summary Get SQL source (deprecated)
|
|
2831
|
-
* @param {string}
|
|
2831
|
+
* @param {string} environmentName Name of the environment
|
|
2832
2832
|
* @param {string} connectionName Name of the connection
|
|
2833
2833
|
* @param {string} [sqlStatement] SQL statement
|
|
2834
2834
|
* @param {*} [options] Override http request option.
|
|
@@ -2836,11 +2836,11 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2836
2836
|
* @throws {RequiredError}
|
|
2837
2837
|
* @memberof ConnectionsApi
|
|
2838
2838
|
*/
|
|
2839
|
-
getSqlsource(
|
|
2839
|
+
getSqlsource(environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<SqlSource, any, {}>>;
|
|
2840
2840
|
/**
|
|
2841
2841
|
* **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.
|
|
2842
2842
|
* @summary Get SQL source (per-package, deprecated)
|
|
2843
|
-
* @param {string}
|
|
2843
|
+
* @param {string} environmentName Name of the environment
|
|
2844
2844
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2845
2845
|
* @param {string} connectionName Name of the connection
|
|
2846
2846
|
* @param {string} [sqlStatement] SQL statement
|
|
@@ -2849,11 +2849,11 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2849
2849
|
* @throws {RequiredError}
|
|
2850
2850
|
* @memberof ConnectionsApi
|
|
2851
2851
|
*/
|
|
2852
|
-
getSqlsourceInPackage(
|
|
2852
|
+
getSqlsourceInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<SqlSource, any, {}>>;
|
|
2853
2853
|
/**
|
|
2854
2854
|
* 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.
|
|
2855
2855
|
* @summary Get table details from database
|
|
2856
|
-
* @param {string}
|
|
2856
|
+
* @param {string} environmentName Name of the environment
|
|
2857
2857
|
* @param {string} connectionName Name of the connection
|
|
2858
2858
|
* @param {string} schemaName Name of the schema
|
|
2859
2859
|
* @param {string} tablePath Full path to the table
|
|
@@ -2861,11 +2861,11 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2861
2861
|
* @throws {RequiredError}
|
|
2862
2862
|
* @memberof ConnectionsApi
|
|
2863
2863
|
*/
|
|
2864
|
-
getTable(
|
|
2864
|
+
getTable(environmentName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Table, any, {}>>;
|
|
2865
2865
|
/**
|
|
2866
2866
|
* Retrieves a table from the specified database schema, resolved in the context of the named package.
|
|
2867
2867
|
* @summary Get table details from database (per-package)
|
|
2868
|
-
* @param {string}
|
|
2868
|
+
* @param {string} environmentName Name of the environment
|
|
2869
2869
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2870
2870
|
* @param {string} connectionName Name of the connection
|
|
2871
2871
|
* @param {string} schemaName Name of the schema
|
|
@@ -2874,11 +2874,11 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2874
2874
|
* @throws {RequiredError}
|
|
2875
2875
|
* @memberof ConnectionsApi
|
|
2876
2876
|
*/
|
|
2877
|
-
getTableInPackage(
|
|
2877
|
+
getTableInPackage(environmentName: string, packageName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Table, any, {}>>;
|
|
2878
2878
|
/**
|
|
2879
2879
|
* **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.
|
|
2880
2880
|
* @summary Create temporary table (deprecated)
|
|
2881
|
-
* @param {string}
|
|
2881
|
+
* @param {string} environmentName Name of the environment
|
|
2882
2882
|
* @param {string} connectionName Name of the connection
|
|
2883
2883
|
* @param {string} [sqlStatement] SQL statement
|
|
2884
2884
|
* @param {*} [options] Override http request option.
|
|
@@ -2886,11 +2886,11 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2886
2886
|
* @throws {RequiredError}
|
|
2887
2887
|
* @memberof ConnectionsApi
|
|
2888
2888
|
*/
|
|
2889
|
-
getTemporarytable(
|
|
2889
|
+
getTemporarytable(environmentName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<TemporaryTable, any, {}>>;
|
|
2890
2890
|
/**
|
|
2891
2891
|
* **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.
|
|
2892
2892
|
* @summary Create temporary table (per-package, deprecated)
|
|
2893
|
-
* @param {string}
|
|
2893
|
+
* @param {string} environmentName Name of the environment
|
|
2894
2894
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2895
2895
|
* @param {string} connectionName Name of the connection
|
|
2896
2896
|
* @param {string} [sqlStatement] SQL statement
|
|
@@ -2899,41 +2899,41 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2899
2899
|
* @throws {RequiredError}
|
|
2900
2900
|
* @memberof ConnectionsApi
|
|
2901
2901
|
*/
|
|
2902
|
-
getTemporarytableInPackage(
|
|
2902
|
+
getTemporarytableInPackage(environmentName: string, packageName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<TemporaryTable, any, {}>>;
|
|
2903
2903
|
/**
|
|
2904
|
-
* Retrieves a list of all database connections configured for the specified
|
|
2905
|
-
* @summary List
|
|
2906
|
-
* @param {string}
|
|
2904
|
+
* 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.
|
|
2905
|
+
* @summary List environment database connections
|
|
2906
|
+
* @param {string} environmentName Name of the environment
|
|
2907
2907
|
* @param {*} [options] Override http request option.
|
|
2908
2908
|
* @throws {RequiredError}
|
|
2909
2909
|
* @memberof ConnectionsApi
|
|
2910
2910
|
*/
|
|
2911
|
-
listConnections(
|
|
2911
|
+
listConnections(environmentName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Connection[], any, {}>>;
|
|
2912
2912
|
/**
|
|
2913
2913
|
* Retrieves a list of all schemas (databases) available in the specified connection. Each schema includes metadata such as name, description, and whether it\'s the default schema. This endpoint is useful for exploring the database structure and discovering available data sources.
|
|
2914
2914
|
* @summary List database schemas
|
|
2915
|
-
* @param {string}
|
|
2915
|
+
* @param {string} environmentName Name of the environment
|
|
2916
2916
|
* @param {string} connectionName Name of the connection
|
|
2917
2917
|
* @param {*} [options] Override http request option.
|
|
2918
2918
|
* @throws {RequiredError}
|
|
2919
2919
|
* @memberof ConnectionsApi
|
|
2920
2920
|
*/
|
|
2921
|
-
listSchemas(
|
|
2921
|
+
listSchemas(environmentName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Schema[], any, {}>>;
|
|
2922
2922
|
/**
|
|
2923
|
-
* Retrieves a list of all schemas (databases) available in the specified connection, resolved in the context of the named package. Required for `connectionName=\"duckdb\"`, which is per-package; works for any other connection name as well (resolution falls through to the
|
|
2923
|
+
* Retrieves a list of all schemas (databases) available in the specified connection, resolved in the context of the named package. Required for `connectionName=\"duckdb\"`, which is per-package; works for any other connection name as well (resolution falls through to the environment).
|
|
2924
2924
|
* @summary List database schemas (per-package)
|
|
2925
|
-
* @param {string}
|
|
2925
|
+
* @param {string} environmentName Name of the environment
|
|
2926
2926
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2927
2927
|
* @param {string} connectionName Name of the connection
|
|
2928
2928
|
* @param {*} [options] Override http request option.
|
|
2929
2929
|
* @throws {RequiredError}
|
|
2930
2930
|
* @memberof ConnectionsApi
|
|
2931
2931
|
*/
|
|
2932
|
-
listSchemasInPackage(
|
|
2932
|
+
listSchemasInPackage(environmentName: string, packageName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Schema[], any, {}>>;
|
|
2933
2933
|
/**
|
|
2934
2934
|
* Retrieves a list of all tables and views available in the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed.
|
|
2935
2935
|
* @summary List tables in database
|
|
2936
|
-
* @param {string}
|
|
2936
|
+
* @param {string} environmentName Name of the environment
|
|
2937
2937
|
* @param {string} connectionName Name of the connection
|
|
2938
2938
|
* @param {string} schemaName Name of the schema
|
|
2939
2939
|
* @param {Array<string>} [tableNames] List of table names to filter results. When provided, only returns metadata for the specified tables. When omitted, returns all tables in the schema.
|
|
@@ -2941,11 +2941,11 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2941
2941
|
* @throws {RequiredError}
|
|
2942
2942
|
* @memberof ConnectionsApi
|
|
2943
2943
|
*/
|
|
2944
|
-
listTables(
|
|
2944
|
+
listTables(environmentName: string, connectionName: string, schemaName: string, tableNames?: Array<string>, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Table[], any, {}>>;
|
|
2945
2945
|
/**
|
|
2946
2946
|
* Retrieves a list of all tables and views available in the specified database schema, resolved in the context of the named package.
|
|
2947
2947
|
* @summary List tables in database (per-package)
|
|
2948
|
-
* @param {string}
|
|
2948
|
+
* @param {string} environmentName Name of the environment
|
|
2949
2949
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2950
2950
|
* @param {string} connectionName Name of the connection
|
|
2951
2951
|
* @param {string} schemaName Name of the schema
|
|
@@ -2954,11 +2954,11 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2954
2954
|
* @throws {RequiredError}
|
|
2955
2955
|
* @memberof ConnectionsApi
|
|
2956
2956
|
*/
|
|
2957
|
-
listTablesInPackage(
|
|
2957
|
+
listTablesInPackage(environmentName: string, packageName: string, connectionName: string, schemaName: string, tableNames?: Array<string>, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Table[], any, {}>>;
|
|
2958
2958
|
/**
|
|
2959
2959
|
* Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
|
|
2960
2960
|
* @summary Execute SQL query
|
|
2961
|
-
* @param {string}
|
|
2961
|
+
* @param {string} environmentName Name of the environment
|
|
2962
2962
|
* @param {string} connectionName Name of the connection
|
|
2963
2963
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
2964
2964
|
* @param {string} [_options] Options (deprecated; pass in body instead)
|
|
@@ -2966,11 +2966,11 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2966
2966
|
* @throws {RequiredError}
|
|
2967
2967
|
* @memberof ConnectionsApi
|
|
2968
2968
|
*/
|
|
2969
|
-
postQuerydata(
|
|
2969
|
+
postQuerydata(environmentName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, _options?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<QueryData, any, {}>>;
|
|
2970
2970
|
/**
|
|
2971
2971
|
* Executes a SQL statement against the specified database connection, resolved in the context of the named package, and returns the results.
|
|
2972
2972
|
* @summary Execute SQL query (per-package)
|
|
2973
|
-
* @param {string}
|
|
2973
|
+
* @param {string} environmentName Name of the environment
|
|
2974
2974
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2975
2975
|
* @param {string} connectionName Name of the connection
|
|
2976
2976
|
* @param {PostQuerydataRequest} postQuerydataRequest SQL statement to execute
|
|
@@ -2979,22 +2979,22 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
2979
2979
|
* @throws {RequiredError}
|
|
2980
2980
|
* @memberof ConnectionsApi
|
|
2981
2981
|
*/
|
|
2982
|
-
postQuerydataInPackage(
|
|
2982
|
+
postQuerydataInPackage(environmentName: string, packageName: string, connectionName: string, postQuerydataRequest: PostQuerydataRequest, _options?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<QueryData, any, {}>>;
|
|
2983
2983
|
/**
|
|
2984
2984
|
* 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.
|
|
2985
2985
|
* @summary Create SQL source from statement
|
|
2986
|
-
* @param {string}
|
|
2986
|
+
* @param {string} environmentName Name of the environment
|
|
2987
2987
|
* @param {string} connectionName Name of the connection
|
|
2988
2988
|
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
|
|
2989
2989
|
* @param {*} [options] Override http request option.
|
|
2990
2990
|
* @throws {RequiredError}
|
|
2991
2991
|
* @memberof ConnectionsApi
|
|
2992
2992
|
*/
|
|
2993
|
-
postSqlsource(
|
|
2993
|
+
postSqlsource(environmentName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<SqlSource, any, {}>>;
|
|
2994
2994
|
/**
|
|
2995
2995
|
* Creates a Malloy source from a SQL statement using the specified connection, resolved in the context of the named package.
|
|
2996
2996
|
* @summary Create SQL source from statement (per-package)
|
|
2997
|
-
* @param {string}
|
|
2997
|
+
* @param {string} environmentName Name of the environment
|
|
2998
2998
|
* @param {string} packageName Name of the package whose connection context to use
|
|
2999
2999
|
* @param {string} connectionName Name of the connection
|
|
3000
3000
|
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
|
|
@@ -3002,22 +3002,22 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
3002
3002
|
* @throws {RequiredError}
|
|
3003
3003
|
* @memberof ConnectionsApi
|
|
3004
3004
|
*/
|
|
3005
|
-
postSqlsourceInPackage(
|
|
3005
|
+
postSqlsourceInPackage(environmentName: string, packageName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<SqlSource, any, {}>>;
|
|
3006
3006
|
/**
|
|
3007
3007
|
* Creates a temporary table from a SQL statement using the specified database connection. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
|
|
3008
3008
|
* @summary Create temporary table
|
|
3009
|
-
* @param {string}
|
|
3009
|
+
* @param {string} environmentName Name of the environment
|
|
3010
3010
|
* @param {string} connectionName Name of the connection
|
|
3011
3011
|
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
|
|
3012
3012
|
* @param {*} [options] Override http request option.
|
|
3013
3013
|
* @throws {RequiredError}
|
|
3014
3014
|
* @memberof ConnectionsApi
|
|
3015
3015
|
*/
|
|
3016
|
-
postTemporarytable(
|
|
3016
|
+
postTemporarytable(environmentName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<TemporaryTable, any, {}>>;
|
|
3017
3017
|
/**
|
|
3018
3018
|
* Creates a temporary table from a SQL statement using the specified database connection, resolved in the context of the named package.
|
|
3019
3019
|
* @summary Create temporary table (per-package)
|
|
3020
|
-
* @param {string}
|
|
3020
|
+
* @param {string} environmentName Name of the environment
|
|
3021
3021
|
* @param {string} packageName Name of the package whose connection context to use
|
|
3022
3022
|
* @param {string} connectionName Name of the connection
|
|
3023
3023
|
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
|
|
@@ -3025,18 +3025,18 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
3025
3025
|
* @throws {RequiredError}
|
|
3026
3026
|
* @memberof ConnectionsApi
|
|
3027
3027
|
*/
|
|
3028
|
-
postTemporarytableInPackage(
|
|
3028
|
+
postTemporarytableInPackage(environmentName: string, packageName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<TemporaryTable, any, {}>>;
|
|
3029
3029
|
/**
|
|
3030
3030
|
* Updates the configuration of an existing database connection.
|
|
3031
3031
|
* @summary Update an existing database connection
|
|
3032
|
-
* @param {string}
|
|
3032
|
+
* @param {string} environmentName Name of the environment
|
|
3033
3033
|
* @param {string} connectionName Name of the connection to update
|
|
3034
3034
|
* @param {UpdateConnectionRequest} updateConnectionRequest
|
|
3035
3035
|
* @param {*} [options] Override http request option.
|
|
3036
3036
|
* @throws {RequiredError}
|
|
3037
3037
|
* @memberof ConnectionsApi
|
|
3038
3038
|
*/
|
|
3039
|
-
updateConnection(
|
|
3039
|
+
updateConnection(environmentName: string, connectionName: string, updateConnectionRequest: UpdateConnectionRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<CreateConnection201Response, any, {}>>;
|
|
3040
3040
|
}
|
|
3041
3041
|
/**
|
|
3042
3042
|
* ConnectionsTestApi - axios parameter creator
|
|
@@ -3044,7 +3044,7 @@ export declare class ConnectionsApi extends BaseAPI {
|
|
|
3044
3044
|
*/
|
|
3045
3045
|
export declare const ConnectionsTestApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3046
3046
|
/**
|
|
3047
|
-
* Validates a database connection configuration without adding it to any
|
|
3047
|
+
* Validates a database connection configuration without adding it to any environment. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to an environment. Useful for troubleshooting connection issues and validating configurations during setup.
|
|
3048
3048
|
* @summary Test database connection configuration
|
|
3049
3049
|
* @param {Connection} connection
|
|
3050
3050
|
* @param {*} [options] Override http request option.
|
|
@@ -3058,7 +3058,7 @@ export declare const ConnectionsTestApiAxiosParamCreator: (configuration?: Confi
|
|
|
3058
3058
|
*/
|
|
3059
3059
|
export declare const ConnectionsTestApiFp: (configuration?: Configuration) => {
|
|
3060
3060
|
/**
|
|
3061
|
-
* Validates a database connection configuration without adding it to any
|
|
3061
|
+
* Validates a database connection configuration without adding it to any environment. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to an environment. Useful for troubleshooting connection issues and validating configurations during setup.
|
|
3062
3062
|
* @summary Test database connection configuration
|
|
3063
3063
|
* @param {Connection} connection
|
|
3064
3064
|
* @param {*} [options] Override http request option.
|
|
@@ -3072,7 +3072,7 @@ export declare const ConnectionsTestApiFp: (configuration?: Configuration) => {
|
|
|
3072
3072
|
*/
|
|
3073
3073
|
export declare const ConnectionsTestApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3074
3074
|
/**
|
|
3075
|
-
* Validates a database connection configuration without adding it to any
|
|
3075
|
+
* Validates a database connection configuration without adding it to any environment. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to an environment. Useful for troubleshooting connection issues and validating configurations during setup.
|
|
3076
3076
|
* @summary Test database connection configuration
|
|
3077
3077
|
* @param {Connection} connection
|
|
3078
3078
|
* @param {*} [options] Override http request option.
|
|
@@ -3088,7 +3088,7 @@ export declare const ConnectionsTestApiFactory: (configuration?: Configuration,
|
|
|
3088
3088
|
*/
|
|
3089
3089
|
export declare class ConnectionsTestApi extends BaseAPI {
|
|
3090
3090
|
/**
|
|
3091
|
-
* Validates a database connection configuration without adding it to any
|
|
3091
|
+
* Validates a database connection configuration without adding it to any environment. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to an environment. Useful for troubleshooting connection issues and validating configurations during setup.
|
|
3092
3092
|
* @summary Test database connection configuration
|
|
3093
3093
|
* @param {Connection} connection
|
|
3094
3094
|
* @param {*} [options] Override http request option.
|
|
@@ -3105,13 +3105,13 @@ export declare const DatabasesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3105
3105
|
/**
|
|
3106
3106
|
* Retrieves a list of all embedded databases within the specified package. These are typically DuckDB databases stored as .parquet files that provide local data storage for the package. Each database entry includes metadata about the database structure and content.
|
|
3107
3107
|
* @summary List embedded databases
|
|
3108
|
-
* @param {string}
|
|
3108
|
+
* @param {string} environmentName Name of the environment
|
|
3109
3109
|
* @param {string} packageName Name of the package
|
|
3110
3110
|
* @param {string} [versionId] Version identifier for the package
|
|
3111
3111
|
* @param {*} [options] Override http request option.
|
|
3112
3112
|
* @throws {RequiredError}
|
|
3113
3113
|
*/
|
|
3114
|
-
listDatabases: (
|
|
3114
|
+
listDatabases: (environmentName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3115
3115
|
};
|
|
3116
3116
|
/**
|
|
3117
3117
|
* DatabasesApi - functional programming interface
|
|
@@ -3121,13 +3121,13 @@ export declare const DatabasesApiFp: (configuration?: Configuration) => {
|
|
|
3121
3121
|
/**
|
|
3122
3122
|
* Retrieves a list of all embedded databases within the specified package. These are typically DuckDB databases stored as .parquet files that provide local data storage for the package. Each database entry includes metadata about the database structure and content.
|
|
3123
3123
|
* @summary List embedded databases
|
|
3124
|
-
* @param {string}
|
|
3124
|
+
* @param {string} environmentName Name of the environment
|
|
3125
3125
|
* @param {string} packageName Name of the package
|
|
3126
3126
|
* @param {string} [versionId] Version identifier for the package
|
|
3127
3127
|
* @param {*} [options] Override http request option.
|
|
3128
3128
|
* @throws {RequiredError}
|
|
3129
3129
|
*/
|
|
3130
|
-
listDatabases(
|
|
3130
|
+
listDatabases(environmentName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Database>>>;
|
|
3131
3131
|
};
|
|
3132
3132
|
/**
|
|
3133
3133
|
* DatabasesApi - factory interface
|
|
@@ -3137,13 +3137,13 @@ export declare const DatabasesApiFactory: (configuration?: Configuration, basePa
|
|
|
3137
3137
|
/**
|
|
3138
3138
|
* Retrieves a list of all embedded databases within the specified package. These are typically DuckDB databases stored as .parquet files that provide local data storage for the package. Each database entry includes metadata about the database structure and content.
|
|
3139
3139
|
* @summary List embedded databases
|
|
3140
|
-
* @param {string}
|
|
3140
|
+
* @param {string} environmentName Name of the environment
|
|
3141
3141
|
* @param {string} packageName Name of the package
|
|
3142
3142
|
* @param {string} [versionId] Version identifier for the package
|
|
3143
3143
|
* @param {*} [options] Override http request option.
|
|
3144
3144
|
* @throws {RequiredError}
|
|
3145
3145
|
*/
|
|
3146
|
-
listDatabases(
|
|
3146
|
+
listDatabases(environmentName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Database>>;
|
|
3147
3147
|
};
|
|
3148
3148
|
/**
|
|
3149
3149
|
* DatabasesApi - object-oriented interface
|
|
@@ -3155,14 +3155,209 @@ export declare class DatabasesApi extends BaseAPI {
|
|
|
3155
3155
|
/**
|
|
3156
3156
|
* Retrieves a list of all embedded databases within the specified package. These are typically DuckDB databases stored as .parquet files that provide local data storage for the package. Each database entry includes metadata about the database structure and content.
|
|
3157
3157
|
* @summary List embedded databases
|
|
3158
|
-
* @param {string}
|
|
3158
|
+
* @param {string} environmentName Name of the environment
|
|
3159
3159
|
* @param {string} packageName Name of the package
|
|
3160
3160
|
* @param {string} [versionId] Version identifier for the package
|
|
3161
3161
|
* @param {*} [options] Override http request option.
|
|
3162
3162
|
* @throws {RequiredError}
|
|
3163
3163
|
* @memberof DatabasesApi
|
|
3164
3164
|
*/
|
|
3165
|
-
listDatabases(
|
|
3165
|
+
listDatabases(environmentName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Database[], any, {}>>;
|
|
3166
|
+
}
|
|
3167
|
+
/**
|
|
3168
|
+
* EnvironmentsApi - axios parameter creator
|
|
3169
|
+
* @export
|
|
3170
|
+
*/
|
|
3171
|
+
export declare const EnvironmentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3172
|
+
/**
|
|
3173
|
+
* Creates a new Malloy environment with the specified configuration. An environment serves as a container for packages, connections, and other resources. The environment will be initialized with the provided metadata and can immediately accept packages and connections.
|
|
3174
|
+
* @summary Create a new environment
|
|
3175
|
+
* @param {Environment} environment
|
|
3176
|
+
* @param {*} [options] Override http request option.
|
|
3177
|
+
* @throws {RequiredError}
|
|
3178
|
+
*/
|
|
3179
|
+
createEnvironment: (environment: Environment, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3180
|
+
/**
|
|
3181
|
+
* Permanently deletes an environment and all its associated resources including packages, connections, and metadata. This operation cannot be undone, so use with caution. The environment must exist and be accessible for deletion.
|
|
3182
|
+
* @summary Delete an environment
|
|
3183
|
+
* @param {string} environmentName Name of the environment
|
|
3184
|
+
* @param {*} [options] Override http request option.
|
|
3185
|
+
* @throws {RequiredError}
|
|
3186
|
+
*/
|
|
3187
|
+
deleteEnvironment: (environmentName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3188
|
+
/**
|
|
3189
|
+
* Retrieves detailed information about a specific environment, including its packages, connections, configuration, and metadata. The reload parameter can be used to refresh the environment state from disk before returning the information.
|
|
3190
|
+
* @summary Get environment details and metadata
|
|
3191
|
+
* @param {string} environmentName Name of the environment
|
|
3192
|
+
* @param {boolean} [reload] Load / reload the environment before returning result
|
|
3193
|
+
* @param {*} [options] Override http request option.
|
|
3194
|
+
* @throws {RequiredError}
|
|
3195
|
+
*/
|
|
3196
|
+
getEnvironment: (environmentName: string, reload?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3197
|
+
/**
|
|
3198
|
+
* Retrieves a list of all environments currently hosted on this Malloy Publisher server. Each environment contains metadata about its packages, connections, and configuration. This endpoint is typically used to discover available environments and their basic information.
|
|
3199
|
+
* @summary List all available environments
|
|
3200
|
+
* @param {*} [options] Override http request option.
|
|
3201
|
+
* @throws {RequiredError}
|
|
3202
|
+
*/
|
|
3203
|
+
listEnvironments: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3204
|
+
/**
|
|
3205
|
+
* Updates the configuration and metadata of an existing environment. This allows you to modify environment settings, update the README, change the location, or update other environment-level properties. The environment must exist and be accessible.
|
|
3206
|
+
* @summary Update environment configuration
|
|
3207
|
+
* @param {string} environmentName Name of the environment
|
|
3208
|
+
* @param {Environment} environment
|
|
3209
|
+
* @param {*} [options] Override http request option.
|
|
3210
|
+
* @throws {RequiredError}
|
|
3211
|
+
*/
|
|
3212
|
+
updateEnvironment: (environmentName: string, environment: Environment, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3213
|
+
};
|
|
3214
|
+
/**
|
|
3215
|
+
* EnvironmentsApi - functional programming interface
|
|
3216
|
+
* @export
|
|
3217
|
+
*/
|
|
3218
|
+
export declare const EnvironmentsApiFp: (configuration?: Configuration) => {
|
|
3219
|
+
/**
|
|
3220
|
+
* Creates a new Malloy environment with the specified configuration. An environment serves as a container for packages, connections, and other resources. The environment will be initialized with the provided metadata and can immediately accept packages and connections.
|
|
3221
|
+
* @summary Create a new environment
|
|
3222
|
+
* @param {Environment} environment
|
|
3223
|
+
* @param {*} [options] Override http request option.
|
|
3224
|
+
* @throws {RequiredError}
|
|
3225
|
+
*/
|
|
3226
|
+
createEnvironment(environment: Environment, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Environment>>;
|
|
3227
|
+
/**
|
|
3228
|
+
* Permanently deletes an environment and all its associated resources including packages, connections, and metadata. This operation cannot be undone, so use with caution. The environment must exist and be accessible for deletion.
|
|
3229
|
+
* @summary Delete an environment
|
|
3230
|
+
* @param {string} environmentName Name of the environment
|
|
3231
|
+
* @param {*} [options] Override http request option.
|
|
3232
|
+
* @throws {RequiredError}
|
|
3233
|
+
*/
|
|
3234
|
+
deleteEnvironment(environmentName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Environment>>;
|
|
3235
|
+
/**
|
|
3236
|
+
* Retrieves detailed information about a specific environment, including its packages, connections, configuration, and metadata. The reload parameter can be used to refresh the environment state from disk before returning the information.
|
|
3237
|
+
* @summary Get environment details and metadata
|
|
3238
|
+
* @param {string} environmentName Name of the environment
|
|
3239
|
+
* @param {boolean} [reload] Load / reload the environment before returning result
|
|
3240
|
+
* @param {*} [options] Override http request option.
|
|
3241
|
+
* @throws {RequiredError}
|
|
3242
|
+
*/
|
|
3243
|
+
getEnvironment(environmentName: string, reload?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Environment>>;
|
|
3244
|
+
/**
|
|
3245
|
+
* Retrieves a list of all environments currently hosted on this Malloy Publisher server. Each environment contains metadata about its packages, connections, and configuration. This endpoint is typically used to discover available environments and their basic information.
|
|
3246
|
+
* @summary List all available environments
|
|
3247
|
+
* @param {*} [options] Override http request option.
|
|
3248
|
+
* @throws {RequiredError}
|
|
3249
|
+
*/
|
|
3250
|
+
listEnvironments(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Environment>>>;
|
|
3251
|
+
/**
|
|
3252
|
+
* Updates the configuration and metadata of an existing environment. This allows you to modify environment settings, update the README, change the location, or update other environment-level properties. The environment must exist and be accessible.
|
|
3253
|
+
* @summary Update environment configuration
|
|
3254
|
+
* @param {string} environmentName Name of the environment
|
|
3255
|
+
* @param {Environment} environment
|
|
3256
|
+
* @param {*} [options] Override http request option.
|
|
3257
|
+
* @throws {RequiredError}
|
|
3258
|
+
*/
|
|
3259
|
+
updateEnvironment(environmentName: string, environment: Environment, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Environment>>;
|
|
3260
|
+
};
|
|
3261
|
+
/**
|
|
3262
|
+
* EnvironmentsApi - factory interface
|
|
3263
|
+
* @export
|
|
3264
|
+
*/
|
|
3265
|
+
export declare const EnvironmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3266
|
+
/**
|
|
3267
|
+
* Creates a new Malloy environment with the specified configuration. An environment serves as a container for packages, connections, and other resources. The environment will be initialized with the provided metadata and can immediately accept packages and connections.
|
|
3268
|
+
* @summary Create a new environment
|
|
3269
|
+
* @param {Environment} environment
|
|
3270
|
+
* @param {*} [options] Override http request option.
|
|
3271
|
+
* @throws {RequiredError}
|
|
3272
|
+
*/
|
|
3273
|
+
createEnvironment(environment: Environment, options?: RawAxiosRequestConfig): AxiosPromise<Environment>;
|
|
3274
|
+
/**
|
|
3275
|
+
* Permanently deletes an environment and all its associated resources including packages, connections, and metadata. This operation cannot be undone, so use with caution. The environment must exist and be accessible for deletion.
|
|
3276
|
+
* @summary Delete an environment
|
|
3277
|
+
* @param {string} environmentName Name of the environment
|
|
3278
|
+
* @param {*} [options] Override http request option.
|
|
3279
|
+
* @throws {RequiredError}
|
|
3280
|
+
*/
|
|
3281
|
+
deleteEnvironment(environmentName: string, options?: RawAxiosRequestConfig): AxiosPromise<Environment>;
|
|
3282
|
+
/**
|
|
3283
|
+
* Retrieves detailed information about a specific environment, including its packages, connections, configuration, and metadata. The reload parameter can be used to refresh the environment state from disk before returning the information.
|
|
3284
|
+
* @summary Get environment details and metadata
|
|
3285
|
+
* @param {string} environmentName Name of the environment
|
|
3286
|
+
* @param {boolean} [reload] Load / reload the environment before returning result
|
|
3287
|
+
* @param {*} [options] Override http request option.
|
|
3288
|
+
* @throws {RequiredError}
|
|
3289
|
+
*/
|
|
3290
|
+
getEnvironment(environmentName: string, reload?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Environment>;
|
|
3291
|
+
/**
|
|
3292
|
+
* Retrieves a list of all environments currently hosted on this Malloy Publisher server. Each environment contains metadata about its packages, connections, and configuration. This endpoint is typically used to discover available environments and their basic information.
|
|
3293
|
+
* @summary List all available environments
|
|
3294
|
+
* @param {*} [options] Override http request option.
|
|
3295
|
+
* @throws {RequiredError}
|
|
3296
|
+
*/
|
|
3297
|
+
listEnvironments(options?: RawAxiosRequestConfig): AxiosPromise<Array<Environment>>;
|
|
3298
|
+
/**
|
|
3299
|
+
* Updates the configuration and metadata of an existing environment. This allows you to modify environment settings, update the README, change the location, or update other environment-level properties. The environment must exist and be accessible.
|
|
3300
|
+
* @summary Update environment configuration
|
|
3301
|
+
* @param {string} environmentName Name of the environment
|
|
3302
|
+
* @param {Environment} environment
|
|
3303
|
+
* @param {*} [options] Override http request option.
|
|
3304
|
+
* @throws {RequiredError}
|
|
3305
|
+
*/
|
|
3306
|
+
updateEnvironment(environmentName: string, environment: Environment, options?: RawAxiosRequestConfig): AxiosPromise<Environment>;
|
|
3307
|
+
};
|
|
3308
|
+
/**
|
|
3309
|
+
* EnvironmentsApi - object-oriented interface
|
|
3310
|
+
* @export
|
|
3311
|
+
* @class EnvironmentsApi
|
|
3312
|
+
* @extends {BaseAPI}
|
|
3313
|
+
*/
|
|
3314
|
+
export declare class EnvironmentsApi extends BaseAPI {
|
|
3315
|
+
/**
|
|
3316
|
+
* Creates a new Malloy environment with the specified configuration. An environment serves as a container for packages, connections, and other resources. The environment will be initialized with the provided metadata and can immediately accept packages and connections.
|
|
3317
|
+
* @summary Create a new environment
|
|
3318
|
+
* @param {Environment} environment
|
|
3319
|
+
* @param {*} [options] Override http request option.
|
|
3320
|
+
* @throws {RequiredError}
|
|
3321
|
+
* @memberof EnvironmentsApi
|
|
3322
|
+
*/
|
|
3323
|
+
createEnvironment(environment: Environment, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Environment, any, {}>>;
|
|
3324
|
+
/**
|
|
3325
|
+
* Permanently deletes an environment and all its associated resources including packages, connections, and metadata. This operation cannot be undone, so use with caution. The environment must exist and be accessible for deletion.
|
|
3326
|
+
* @summary Delete an environment
|
|
3327
|
+
* @param {string} environmentName Name of the environment
|
|
3328
|
+
* @param {*} [options] Override http request option.
|
|
3329
|
+
* @throws {RequiredError}
|
|
3330
|
+
* @memberof EnvironmentsApi
|
|
3331
|
+
*/
|
|
3332
|
+
deleteEnvironment(environmentName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Environment, any, {}>>;
|
|
3333
|
+
/**
|
|
3334
|
+
* Retrieves detailed information about a specific environment, including its packages, connections, configuration, and metadata. The reload parameter can be used to refresh the environment state from disk before returning the information.
|
|
3335
|
+
* @summary Get environment details and metadata
|
|
3336
|
+
* @param {string} environmentName Name of the environment
|
|
3337
|
+
* @param {boolean} [reload] Load / reload the environment before returning result
|
|
3338
|
+
* @param {*} [options] Override http request option.
|
|
3339
|
+
* @throws {RequiredError}
|
|
3340
|
+
* @memberof EnvironmentsApi
|
|
3341
|
+
*/
|
|
3342
|
+
getEnvironment(environmentName: string, reload?: boolean, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Environment, any, {}>>;
|
|
3343
|
+
/**
|
|
3344
|
+
* Retrieves a list of all environments currently hosted on this Malloy Publisher server. Each environment contains metadata about its packages, connections, and configuration. This endpoint is typically used to discover available environments and their basic information.
|
|
3345
|
+
* @summary List all available environments
|
|
3346
|
+
* @param {*} [options] Override http request option.
|
|
3347
|
+
* @throws {RequiredError}
|
|
3348
|
+
* @memberof EnvironmentsApi
|
|
3349
|
+
*/
|
|
3350
|
+
listEnvironments(options?: RawAxiosRequestConfig): Promise< AxiosResponse<Environment[], any, {}>>;
|
|
3351
|
+
/**
|
|
3352
|
+
* Updates the configuration and metadata of an existing environment. This allows you to modify environment settings, update the README, change the location, or update other environment-level properties. The environment must exist and be accessible.
|
|
3353
|
+
* @summary Update environment configuration
|
|
3354
|
+
* @param {string} environmentName Name of the environment
|
|
3355
|
+
* @param {Environment} environment
|
|
3356
|
+
* @param {*} [options] Override http request option.
|
|
3357
|
+
* @throws {RequiredError}
|
|
3358
|
+
* @memberof EnvironmentsApi
|
|
3359
|
+
*/
|
|
3360
|
+
updateEnvironment(environmentName: string, environment: Environment, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Environment, any, {}>>;
|
|
3166
3361
|
}
|
|
3167
3362
|
/**
|
|
3168
3363
|
* ManifestsApi - axios parameter creator
|
|
@@ -3172,22 +3367,22 @@ export declare const ManifestsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3172
3367
|
/**
|
|
3173
3368
|
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
3174
3369
|
* @summary Get the build manifest for a package
|
|
3175
|
-
* @param {string}
|
|
3370
|
+
* @param {string} environmentName Name of the environment
|
|
3176
3371
|
* @param {string} packageName Name of the package
|
|
3177
3372
|
* @param {*} [options] Override http request option.
|
|
3178
3373
|
* @throws {RequiredError}
|
|
3179
3374
|
*/
|
|
3180
|
-
getManifest: (
|
|
3375
|
+
getManifest: (environmentName: string, packageName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3181
3376
|
/**
|
|
3182
3377
|
* 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.
|
|
3183
3378
|
* @summary Perform an action on the package manifest
|
|
3184
|
-
* @param {string}
|
|
3379
|
+
* @param {string} environmentName Name of the environment
|
|
3185
3380
|
* @param {string} packageName Name of the package
|
|
3186
3381
|
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
3187
3382
|
* @param {*} [options] Override http request option.
|
|
3188
3383
|
* @throws {RequiredError}
|
|
3189
3384
|
*/
|
|
3190
|
-
manifestAction: (
|
|
3385
|
+
manifestAction: (environmentName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3191
3386
|
};
|
|
3192
3387
|
/**
|
|
3193
3388
|
* ManifestsApi - functional programming interface
|
|
@@ -3197,22 +3392,22 @@ export declare const ManifestsApiFp: (configuration?: Configuration) => {
|
|
|
3197
3392
|
/**
|
|
3198
3393
|
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
3199
3394
|
* @summary Get the build manifest for a package
|
|
3200
|
-
* @param {string}
|
|
3395
|
+
* @param {string} environmentName Name of the environment
|
|
3201
3396
|
* @param {string} packageName Name of the package
|
|
3202
3397
|
* @param {*} [options] Override http request option.
|
|
3203
3398
|
* @throws {RequiredError}
|
|
3204
3399
|
*/
|
|
3205
|
-
getManifest(
|
|
3400
|
+
getManifest(environmentName: string, packageName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BuildManifest>>;
|
|
3206
3401
|
/**
|
|
3207
3402
|
* 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.
|
|
3208
3403
|
* @summary Perform an action on the package manifest
|
|
3209
|
-
* @param {string}
|
|
3404
|
+
* @param {string} environmentName Name of the environment
|
|
3210
3405
|
* @param {string} packageName Name of the package
|
|
3211
3406
|
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
3212
3407
|
* @param {*} [options] Override http request option.
|
|
3213
3408
|
* @throws {RequiredError}
|
|
3214
3409
|
*/
|
|
3215
|
-
manifestAction(
|
|
3410
|
+
manifestAction(environmentName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BuildManifest>>;
|
|
3216
3411
|
};
|
|
3217
3412
|
/**
|
|
3218
3413
|
* ManifestsApi - factory interface
|
|
@@ -3222,22 +3417,22 @@ export declare const ManifestsApiFactory: (configuration?: Configuration, basePa
|
|
|
3222
3417
|
/**
|
|
3223
3418
|
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
3224
3419
|
* @summary Get the build manifest for a package
|
|
3225
|
-
* @param {string}
|
|
3420
|
+
* @param {string} environmentName Name of the environment
|
|
3226
3421
|
* @param {string} packageName Name of the package
|
|
3227
3422
|
* @param {*} [options] Override http request option.
|
|
3228
3423
|
* @throws {RequiredError}
|
|
3229
3424
|
*/
|
|
3230
|
-
getManifest(
|
|
3425
|
+
getManifest(environmentName: string, packageName: string, options?: RawAxiosRequestConfig): AxiosPromise<BuildManifest>;
|
|
3231
3426
|
/**
|
|
3232
3427
|
* 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.
|
|
3233
3428
|
* @summary Perform an action on the package manifest
|
|
3234
|
-
* @param {string}
|
|
3429
|
+
* @param {string} environmentName Name of the environment
|
|
3235
3430
|
* @param {string} packageName Name of the package
|
|
3236
3431
|
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
3237
3432
|
* @param {*} [options] Override http request option.
|
|
3238
3433
|
* @throws {RequiredError}
|
|
3239
3434
|
*/
|
|
3240
|
-
manifestAction(
|
|
3435
|
+
manifestAction(environmentName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig): AxiosPromise<BuildManifest>;
|
|
3241
3436
|
};
|
|
3242
3437
|
/**
|
|
3243
3438
|
* ManifestsApi - object-oriented interface
|
|
@@ -3249,24 +3444,24 @@ export declare class ManifestsApi extends BaseAPI {
|
|
|
3249
3444
|
/**
|
|
3250
3445
|
* Returns the current build manifest containing buildId-to-tableName mappings for all materialized sources in the package.
|
|
3251
3446
|
* @summary Get the build manifest for a package
|
|
3252
|
-
* @param {string}
|
|
3447
|
+
* @param {string} environmentName Name of the environment
|
|
3253
3448
|
* @param {string} packageName Name of the package
|
|
3254
3449
|
* @param {*} [options] Override http request option.
|
|
3255
3450
|
* @throws {RequiredError}
|
|
3256
3451
|
* @memberof ManifestsApi
|
|
3257
3452
|
*/
|
|
3258
|
-
getManifest(
|
|
3453
|
+
getManifest(environmentName: string, packageName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<BuildManifest, any, {}>>;
|
|
3259
3454
|
/**
|
|
3260
3455
|
* 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.
|
|
3261
3456
|
* @summary Perform an action on the package manifest
|
|
3262
|
-
* @param {string}
|
|
3457
|
+
* @param {string} environmentName Name of the environment
|
|
3263
3458
|
* @param {string} packageName Name of the package
|
|
3264
3459
|
* @param {ManifestActionActionEnum} action Action to perform on the manifest
|
|
3265
3460
|
* @param {*} [options] Override http request option.
|
|
3266
3461
|
* @throws {RequiredError}
|
|
3267
3462
|
* @memberof ManifestsApi
|
|
3268
3463
|
*/
|
|
3269
|
-
manifestAction(
|
|
3464
|
+
manifestAction(environmentName: string, packageName: string, action: ManifestActionActionEnum, options?: RawAxiosRequestConfig): Promise< AxiosResponse<BuildManifest, any, {}>>;
|
|
3270
3465
|
}
|
|
3271
3466
|
/**
|
|
3272
3467
|
* @export
|
|
@@ -3283,55 +3478,55 @@ export declare const MaterializationsApiAxiosParamCreator: (configuration?: Conf
|
|
|
3283
3478
|
/**
|
|
3284
3479
|
* 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.
|
|
3285
3480
|
* @summary Create a materialization
|
|
3286
|
-
* @param {string}
|
|
3481
|
+
* @param {string} environmentName Name of the environment
|
|
3287
3482
|
* @param {string} packageName Name of the package
|
|
3288
3483
|
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
3289
3484
|
* @param {*} [options] Override http request option.
|
|
3290
3485
|
* @throws {RequiredError}
|
|
3291
3486
|
*/
|
|
3292
|
-
createMaterialization: (
|
|
3487
|
+
createMaterialization: (environmentName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3293
3488
|
/**
|
|
3294
3489
|
* Deletes a terminal (SUCCESS, FAILED, or CANCELLED) materialization record.
|
|
3295
3490
|
* @summary Delete a materialization
|
|
3296
|
-
* @param {string}
|
|
3491
|
+
* @param {string} environmentName Name of the environment
|
|
3297
3492
|
* @param {string} packageName Name of the package
|
|
3298
3493
|
* @param {string} materializationId ID of the materialization
|
|
3299
3494
|
* @param {*} [options] Override http request option.
|
|
3300
3495
|
* @throws {RequiredError}
|
|
3301
3496
|
*/
|
|
3302
|
-
deleteMaterialization: (
|
|
3497
|
+
deleteMaterialization: (environmentName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3303
3498
|
/**
|
|
3304
3499
|
*
|
|
3305
3500
|
* @summary Get a specific materialization
|
|
3306
|
-
* @param {string}
|
|
3501
|
+
* @param {string} environmentName Name of the environment
|
|
3307
3502
|
* @param {string} packageName Name of the package
|
|
3308
3503
|
* @param {string} materializationId ID of the materialization
|
|
3309
3504
|
* @param {*} [options] Override http request option.
|
|
3310
3505
|
* @throws {RequiredError}
|
|
3311
3506
|
*/
|
|
3312
|
-
getMaterialization: (
|
|
3507
|
+
getMaterialization: (environmentName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3313
3508
|
/**
|
|
3314
3509
|
* Returns the materialization history for the package, ordered by most recent first.
|
|
3315
3510
|
* @summary List materializations for a package
|
|
3316
|
-
* @param {string}
|
|
3511
|
+
* @param {string} environmentName Name of the environment
|
|
3317
3512
|
* @param {string} packageName Name of the package
|
|
3318
3513
|
* @param {number} [limit] Maximum number of materializations to return
|
|
3319
3514
|
* @param {number} [offset] Number of materializations to skip
|
|
3320
3515
|
* @param {*} [options] Override http request option.
|
|
3321
3516
|
* @throws {RequiredError}
|
|
3322
3517
|
*/
|
|
3323
|
-
listMaterializations: (
|
|
3518
|
+
listMaterializations: (environmentName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3324
3519
|
/**
|
|
3325
3520
|
* 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.
|
|
3326
3521
|
* @summary Perform an action on a materialization
|
|
3327
|
-
* @param {string}
|
|
3522
|
+
* @param {string} environmentName Name of the environment
|
|
3328
3523
|
* @param {string} packageName Name of the package
|
|
3329
3524
|
* @param {string} materializationId ID of the materialization
|
|
3330
3525
|
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
3331
3526
|
* @param {*} [options] Override http request option.
|
|
3332
3527
|
* @throws {RequiredError}
|
|
3333
3528
|
*/
|
|
3334
|
-
materializationAction: (
|
|
3529
|
+
materializationAction: (environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3335
3530
|
};
|
|
3336
3531
|
/**
|
|
3337
3532
|
* MaterializationsApi - functional programming interface
|
|
@@ -3341,55 +3536,55 @@ export declare const MaterializationsApiFp: (configuration?: Configuration) => {
|
|
|
3341
3536
|
/**
|
|
3342
3537
|
* 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.
|
|
3343
3538
|
* @summary Create a materialization
|
|
3344
|
-
* @param {string}
|
|
3539
|
+
* @param {string} environmentName Name of the environment
|
|
3345
3540
|
* @param {string} packageName Name of the package
|
|
3346
3541
|
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
3347
3542
|
* @param {*} [options] Override http request option.
|
|
3348
3543
|
* @throws {RequiredError}
|
|
3349
3544
|
*/
|
|
3350
|
-
createMaterialization(
|
|
3545
|
+
createMaterialization(environmentName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Materialization>>;
|
|
3351
3546
|
/**
|
|
3352
3547
|
* Deletes a terminal (SUCCESS, FAILED, or CANCELLED) materialization record.
|
|
3353
3548
|
* @summary Delete a materialization
|
|
3354
|
-
* @param {string}
|
|
3549
|
+
* @param {string} environmentName Name of the environment
|
|
3355
3550
|
* @param {string} packageName Name of the package
|
|
3356
3551
|
* @param {string} materializationId ID of the materialization
|
|
3357
3552
|
* @param {*} [options] Override http request option.
|
|
3358
3553
|
* @throws {RequiredError}
|
|
3359
3554
|
*/
|
|
3360
|
-
deleteMaterialization(
|
|
3555
|
+
deleteMaterialization(environmentName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3361
3556
|
/**
|
|
3362
3557
|
*
|
|
3363
3558
|
* @summary Get a specific materialization
|
|
3364
|
-
* @param {string}
|
|
3559
|
+
* @param {string} environmentName Name of the environment
|
|
3365
3560
|
* @param {string} packageName Name of the package
|
|
3366
3561
|
* @param {string} materializationId ID of the materialization
|
|
3367
3562
|
* @param {*} [options] Override http request option.
|
|
3368
3563
|
* @throws {RequiredError}
|
|
3369
3564
|
*/
|
|
3370
|
-
getMaterialization(
|
|
3565
|
+
getMaterialization(environmentName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Materialization>>;
|
|
3371
3566
|
/**
|
|
3372
3567
|
* Returns the materialization history for the package, ordered by most recent first.
|
|
3373
3568
|
* @summary List materializations for a package
|
|
3374
|
-
* @param {string}
|
|
3569
|
+
* @param {string} environmentName Name of the environment
|
|
3375
3570
|
* @param {string} packageName Name of the package
|
|
3376
3571
|
* @param {number} [limit] Maximum number of materializations to return
|
|
3377
3572
|
* @param {number} [offset] Number of materializations to skip
|
|
3378
3573
|
* @param {*} [options] Override http request option.
|
|
3379
3574
|
* @throws {RequiredError}
|
|
3380
3575
|
*/
|
|
3381
|
-
listMaterializations(
|
|
3576
|
+
listMaterializations(environmentName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Materialization>>>;
|
|
3382
3577
|
/**
|
|
3383
3578
|
* 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.
|
|
3384
3579
|
* @summary Perform an action on a materialization
|
|
3385
|
-
* @param {string}
|
|
3580
|
+
* @param {string} environmentName Name of the environment
|
|
3386
3581
|
* @param {string} packageName Name of the package
|
|
3387
3582
|
* @param {string} materializationId ID of the materialization
|
|
3388
3583
|
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
3389
3584
|
* @param {*} [options] Override http request option.
|
|
3390
3585
|
* @throws {RequiredError}
|
|
3391
3586
|
*/
|
|
3392
|
-
materializationAction(
|
|
3587
|
+
materializationAction(environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Materialization>>;
|
|
3393
3588
|
};
|
|
3394
3589
|
/**
|
|
3395
3590
|
* MaterializationsApi - factory interface
|
|
@@ -3399,55 +3594,55 @@ export declare const MaterializationsApiFactory: (configuration?: Configuration,
|
|
|
3399
3594
|
/**
|
|
3400
3595
|
* 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.
|
|
3401
3596
|
* @summary Create a materialization
|
|
3402
|
-
* @param {string}
|
|
3597
|
+
* @param {string} environmentName Name of the environment
|
|
3403
3598
|
* @param {string} packageName Name of the package
|
|
3404
3599
|
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
3405
3600
|
* @param {*} [options] Override http request option.
|
|
3406
3601
|
* @throws {RequiredError}
|
|
3407
3602
|
*/
|
|
3408
|
-
createMaterialization(
|
|
3603
|
+
createMaterialization(environmentName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig): AxiosPromise<Materialization>;
|
|
3409
3604
|
/**
|
|
3410
3605
|
* Deletes a terminal (SUCCESS, FAILED, or CANCELLED) materialization record.
|
|
3411
3606
|
* @summary Delete a materialization
|
|
3412
|
-
* @param {string}
|
|
3607
|
+
* @param {string} environmentName Name of the environment
|
|
3413
3608
|
* @param {string} packageName Name of the package
|
|
3414
3609
|
* @param {string} materializationId ID of the materialization
|
|
3415
3610
|
* @param {*} [options] Override http request option.
|
|
3416
3611
|
* @throws {RequiredError}
|
|
3417
3612
|
*/
|
|
3418
|
-
deleteMaterialization(
|
|
3613
|
+
deleteMaterialization(environmentName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3419
3614
|
/**
|
|
3420
3615
|
*
|
|
3421
3616
|
* @summary Get a specific materialization
|
|
3422
|
-
* @param {string}
|
|
3617
|
+
* @param {string} environmentName Name of the environment
|
|
3423
3618
|
* @param {string} packageName Name of the package
|
|
3424
3619
|
* @param {string} materializationId ID of the materialization
|
|
3425
3620
|
* @param {*} [options] Override http request option.
|
|
3426
3621
|
* @throws {RequiredError}
|
|
3427
3622
|
*/
|
|
3428
|
-
getMaterialization(
|
|
3623
|
+
getMaterialization(environmentName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): AxiosPromise<Materialization>;
|
|
3429
3624
|
/**
|
|
3430
3625
|
* Returns the materialization history for the package, ordered by most recent first.
|
|
3431
3626
|
* @summary List materializations for a package
|
|
3432
|
-
* @param {string}
|
|
3627
|
+
* @param {string} environmentName Name of the environment
|
|
3433
3628
|
* @param {string} packageName Name of the package
|
|
3434
3629
|
* @param {number} [limit] Maximum number of materializations to return
|
|
3435
3630
|
* @param {number} [offset] Number of materializations to skip
|
|
3436
3631
|
* @param {*} [options] Override http request option.
|
|
3437
3632
|
* @throws {RequiredError}
|
|
3438
3633
|
*/
|
|
3439
|
-
listMaterializations(
|
|
3634
|
+
listMaterializations(environmentName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Materialization>>;
|
|
3440
3635
|
/**
|
|
3441
3636
|
* 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.
|
|
3442
3637
|
* @summary Perform an action on a materialization
|
|
3443
|
-
* @param {string}
|
|
3638
|
+
* @param {string} environmentName Name of the environment
|
|
3444
3639
|
* @param {string} packageName Name of the package
|
|
3445
3640
|
* @param {string} materializationId ID of the materialization
|
|
3446
3641
|
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
3447
3642
|
* @param {*} [options] Override http request option.
|
|
3448
3643
|
* @throws {RequiredError}
|
|
3449
3644
|
*/
|
|
3450
|
-
materializationAction(
|
|
3645
|
+
materializationAction(environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig): AxiosPromise<Materialization>;
|
|
3451
3646
|
};
|
|
3452
3647
|
/**
|
|
3453
3648
|
* MaterializationsApi - object-oriented interface
|
|
@@ -3459,40 +3654,40 @@ export declare class MaterializationsApi extends BaseAPI {
|
|
|
3459
3654
|
/**
|
|
3460
3655
|
* 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.
|
|
3461
3656
|
* @summary Create a materialization
|
|
3462
|
-
* @param {string}
|
|
3657
|
+
* @param {string} environmentName Name of the environment
|
|
3463
3658
|
* @param {string} packageName Name of the package
|
|
3464
3659
|
* @param {CreateMaterializationRequest} [createMaterializationRequest]
|
|
3465
3660
|
* @param {*} [options] Override http request option.
|
|
3466
3661
|
* @throws {RequiredError}
|
|
3467
3662
|
* @memberof MaterializationsApi
|
|
3468
3663
|
*/
|
|
3469
|
-
createMaterialization(
|
|
3664
|
+
createMaterialization(environmentName: string, packageName: string, createMaterializationRequest?: CreateMaterializationRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Materialization, any, {}>>;
|
|
3470
3665
|
/**
|
|
3471
3666
|
* Deletes a terminal (SUCCESS, FAILED, or CANCELLED) materialization record.
|
|
3472
3667
|
* @summary Delete a materialization
|
|
3473
|
-
* @param {string}
|
|
3668
|
+
* @param {string} environmentName Name of the environment
|
|
3474
3669
|
* @param {string} packageName Name of the package
|
|
3475
3670
|
* @param {string} materializationId ID of the materialization
|
|
3476
3671
|
* @param {*} [options] Override http request option.
|
|
3477
3672
|
* @throws {RequiredError}
|
|
3478
3673
|
* @memberof MaterializationsApi
|
|
3479
3674
|
*/
|
|
3480
|
-
deleteMaterialization(
|
|
3675
|
+
deleteMaterialization(environmentName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<void, any, {}>>;
|
|
3481
3676
|
/**
|
|
3482
3677
|
*
|
|
3483
3678
|
* @summary Get a specific materialization
|
|
3484
|
-
* @param {string}
|
|
3679
|
+
* @param {string} environmentName Name of the environment
|
|
3485
3680
|
* @param {string} packageName Name of the package
|
|
3486
3681
|
* @param {string} materializationId ID of the materialization
|
|
3487
3682
|
* @param {*} [options] Override http request option.
|
|
3488
3683
|
* @throws {RequiredError}
|
|
3489
3684
|
* @memberof MaterializationsApi
|
|
3490
3685
|
*/
|
|
3491
|
-
getMaterialization(
|
|
3686
|
+
getMaterialization(environmentName: string, packageName: string, materializationId: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Materialization, any, {}>>;
|
|
3492
3687
|
/**
|
|
3493
3688
|
* Returns the materialization history for the package, ordered by most recent first.
|
|
3494
3689
|
* @summary List materializations for a package
|
|
3495
|
-
* @param {string}
|
|
3690
|
+
* @param {string} environmentName Name of the environment
|
|
3496
3691
|
* @param {string} packageName Name of the package
|
|
3497
3692
|
* @param {number} [limit] Maximum number of materializations to return
|
|
3498
3693
|
* @param {number} [offset] Number of materializations to skip
|
|
@@ -3500,11 +3695,11 @@ export declare class MaterializationsApi extends BaseAPI {
|
|
|
3500
3695
|
* @throws {RequiredError}
|
|
3501
3696
|
* @memberof MaterializationsApi
|
|
3502
3697
|
*/
|
|
3503
|
-
listMaterializations(
|
|
3698
|
+
listMaterializations(environmentName: string, packageName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Materialization[], any, {}>>;
|
|
3504
3699
|
/**
|
|
3505
3700
|
* 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.
|
|
3506
3701
|
* @summary Perform an action on a materialization
|
|
3507
|
-
* @param {string}
|
|
3702
|
+
* @param {string} environmentName Name of the environment
|
|
3508
3703
|
* @param {string} packageName Name of the package
|
|
3509
3704
|
* @param {string} materializationId ID of the materialization
|
|
3510
3705
|
* @param {MaterializationActionActionEnum} action Action to perform on the materialization
|
|
@@ -3512,7 +3707,7 @@ export declare class MaterializationsApi extends BaseAPI {
|
|
|
3512
3707
|
* @throws {RequiredError}
|
|
3513
3708
|
* @memberof MaterializationsApi
|
|
3514
3709
|
*/
|
|
3515
|
-
materializationAction(
|
|
3710
|
+
materializationAction(environmentName: string, packageName: string, materializationId: string, action: MaterializationActionActionEnum, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Materialization, any, {}>>;
|
|
3516
3711
|
}
|
|
3517
3712
|
/**
|
|
3518
3713
|
* @export
|
|
@@ -3530,46 +3725,46 @@ export declare const ModelsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
3530
3725
|
/**
|
|
3531
3726
|
* Compiles Malloy source code in the context of a specific model file. The submitted source is appended to the full model content, giving it access to all sources, imports, and queries defined in the model. Relative imports resolve correctly against sibling model files. Returns compilation status and any problems (errors or warnings) found.
|
|
3532
3727
|
* @summary Compile Malloy source code
|
|
3533
|
-
* @param {string}
|
|
3728
|
+
* @param {string} environmentName Name of the environment
|
|
3534
3729
|
* @param {string} packageName Name of the package
|
|
3535
3730
|
* @param {string} path Path to the model within the package (used to resolve relative imports)
|
|
3536
3731
|
* @param {CompileRequest} compileRequest
|
|
3537
3732
|
* @param {*} [options] Override http request option.
|
|
3538
3733
|
* @throws {RequiredError}
|
|
3539
3734
|
*/
|
|
3540
|
-
compileModelSource: (
|
|
3735
|
+
compileModelSource: (environmentName: string, packageName: string, path: string, compileRequest: CompileRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3541
3736
|
/**
|
|
3542
3737
|
* Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
|
|
3543
3738
|
* @summary Execute Malloy query
|
|
3544
|
-
* @param {string}
|
|
3739
|
+
* @param {string} environmentName Name of the environment
|
|
3545
3740
|
* @param {string} packageName Name of the package
|
|
3546
3741
|
* @param {string} path Path to the model within the package
|
|
3547
3742
|
* @param {QueryRequest} queryRequest
|
|
3548
3743
|
* @param {*} [options] Override http request option.
|
|
3549
3744
|
* @throws {RequiredError}
|
|
3550
3745
|
*/
|
|
3551
|
-
executeQueryModel: (
|
|
3746
|
+
executeQueryModel: (environmentName: string, packageName: string, path: string, queryRequest: QueryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3552
3747
|
/**
|
|
3553
3748
|
* Retrieves a compiled Malloy model with its source information, queries, and metadata. The model is compiled using the specified version of the Malloy compiler. This endpoint provides access to the model\'s structure, sources, and named queries for use in applications.
|
|
3554
3749
|
* @summary Get compiled Malloy model
|
|
3555
|
-
* @param {string}
|
|
3750
|
+
* @param {string} environmentName Name of the environment
|
|
3556
3751
|
* @param {string} packageName Name of the package
|
|
3557
3752
|
* @param {string} path Path to the model within the package
|
|
3558
3753
|
* @param {string} [versionId] Version identifier for the package
|
|
3559
3754
|
* @param {*} [options] Override http request option.
|
|
3560
3755
|
* @throws {RequiredError}
|
|
3561
3756
|
*/
|
|
3562
|
-
getModel: (
|
|
3757
|
+
getModel: (environmentName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3563
3758
|
/**
|
|
3564
3759
|
* Retrieves a list of all Malloy models within the specified package. Each model entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available models and checking their status.
|
|
3565
3760
|
* @summary List package models
|
|
3566
|
-
* @param {string}
|
|
3761
|
+
* @param {string} environmentName Name of the environment
|
|
3567
3762
|
* @param {string} packageName Name of the package
|
|
3568
3763
|
* @param {string} [versionId] Version identifier for the package
|
|
3569
3764
|
* @param {*} [options] Override http request option.
|
|
3570
3765
|
* @throws {RequiredError}
|
|
3571
3766
|
*/
|
|
3572
|
-
listModels: (
|
|
3767
|
+
listModels: (environmentName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3573
3768
|
};
|
|
3574
3769
|
/**
|
|
3575
3770
|
* ModelsApi - functional programming interface
|
|
@@ -3579,46 +3774,46 @@ export declare const ModelsApiFp: (configuration?: Configuration) => {
|
|
|
3579
3774
|
/**
|
|
3580
3775
|
* Compiles Malloy source code in the context of a specific model file. The submitted source is appended to the full model content, giving it access to all sources, imports, and queries defined in the model. Relative imports resolve correctly against sibling model files. Returns compilation status and any problems (errors or warnings) found.
|
|
3581
3776
|
* @summary Compile Malloy source code
|
|
3582
|
-
* @param {string}
|
|
3777
|
+
* @param {string} environmentName Name of the environment
|
|
3583
3778
|
* @param {string} packageName Name of the package
|
|
3584
3779
|
* @param {string} path Path to the model within the package (used to resolve relative imports)
|
|
3585
3780
|
* @param {CompileRequest} compileRequest
|
|
3586
3781
|
* @param {*} [options] Override http request option.
|
|
3587
3782
|
* @throws {RequiredError}
|
|
3588
3783
|
*/
|
|
3589
|
-
compileModelSource(
|
|
3784
|
+
compileModelSource(environmentName: string, packageName: string, path: string, compileRequest: CompileRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompileResult>>;
|
|
3590
3785
|
/**
|
|
3591
3786
|
* Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
|
|
3592
3787
|
* @summary Execute Malloy query
|
|
3593
|
-
* @param {string}
|
|
3788
|
+
* @param {string} environmentName Name of the environment
|
|
3594
3789
|
* @param {string} packageName Name of the package
|
|
3595
3790
|
* @param {string} path Path to the model within the package
|
|
3596
3791
|
* @param {QueryRequest} queryRequest
|
|
3597
3792
|
* @param {*} [options] Override http request option.
|
|
3598
3793
|
* @throws {RequiredError}
|
|
3599
3794
|
*/
|
|
3600
|
-
executeQueryModel(
|
|
3795
|
+
executeQueryModel(environmentName: string, packageName: string, path: string, queryRequest: QueryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryResult>>;
|
|
3601
3796
|
/**
|
|
3602
3797
|
* Retrieves a compiled Malloy model with its source information, queries, and metadata. The model is compiled using the specified version of the Malloy compiler. This endpoint provides access to the model\'s structure, sources, and named queries for use in applications.
|
|
3603
3798
|
* @summary Get compiled Malloy model
|
|
3604
|
-
* @param {string}
|
|
3799
|
+
* @param {string} environmentName Name of the environment
|
|
3605
3800
|
* @param {string} packageName Name of the package
|
|
3606
3801
|
* @param {string} path Path to the model within the package
|
|
3607
3802
|
* @param {string} [versionId] Version identifier for the package
|
|
3608
3803
|
* @param {*} [options] Override http request option.
|
|
3609
3804
|
* @throws {RequiredError}
|
|
3610
3805
|
*/
|
|
3611
|
-
getModel(
|
|
3806
|
+
getModel(environmentName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompiledModel>>;
|
|
3612
3807
|
/**
|
|
3613
3808
|
* Retrieves a list of all Malloy models within the specified package. Each model entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available models and checking their status.
|
|
3614
3809
|
* @summary List package models
|
|
3615
|
-
* @param {string}
|
|
3810
|
+
* @param {string} environmentName Name of the environment
|
|
3616
3811
|
* @param {string} packageName Name of the package
|
|
3617
3812
|
* @param {string} [versionId] Version identifier for the package
|
|
3618
3813
|
* @param {*} [options] Override http request option.
|
|
3619
3814
|
* @throws {RequiredError}
|
|
3620
3815
|
*/
|
|
3621
|
-
listModels(
|
|
3816
|
+
listModels(environmentName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Model>>>;
|
|
3622
3817
|
};
|
|
3623
3818
|
/**
|
|
3624
3819
|
* ModelsApi - factory interface
|
|
@@ -3628,46 +3823,46 @@ export declare const ModelsApiFactory: (configuration?: Configuration, basePath?
|
|
|
3628
3823
|
/**
|
|
3629
3824
|
* Compiles Malloy source code in the context of a specific model file. The submitted source is appended to the full model content, giving it access to all sources, imports, and queries defined in the model. Relative imports resolve correctly against sibling model files. Returns compilation status and any problems (errors or warnings) found.
|
|
3630
3825
|
* @summary Compile Malloy source code
|
|
3631
|
-
* @param {string}
|
|
3826
|
+
* @param {string} environmentName Name of the environment
|
|
3632
3827
|
* @param {string} packageName Name of the package
|
|
3633
3828
|
* @param {string} path Path to the model within the package (used to resolve relative imports)
|
|
3634
3829
|
* @param {CompileRequest} compileRequest
|
|
3635
3830
|
* @param {*} [options] Override http request option.
|
|
3636
3831
|
* @throws {RequiredError}
|
|
3637
3832
|
*/
|
|
3638
|
-
compileModelSource(
|
|
3833
|
+
compileModelSource(environmentName: string, packageName: string, path: string, compileRequest: CompileRequest, options?: RawAxiosRequestConfig): AxiosPromise<CompileResult>;
|
|
3639
3834
|
/**
|
|
3640
3835
|
* Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
|
|
3641
3836
|
* @summary Execute Malloy query
|
|
3642
|
-
* @param {string}
|
|
3837
|
+
* @param {string} environmentName Name of the environment
|
|
3643
3838
|
* @param {string} packageName Name of the package
|
|
3644
3839
|
* @param {string} path Path to the model within the package
|
|
3645
3840
|
* @param {QueryRequest} queryRequest
|
|
3646
3841
|
* @param {*} [options] Override http request option.
|
|
3647
3842
|
* @throws {RequiredError}
|
|
3648
3843
|
*/
|
|
3649
|
-
executeQueryModel(
|
|
3844
|
+
executeQueryModel(environmentName: string, packageName: string, path: string, queryRequest: QueryRequest, options?: RawAxiosRequestConfig): AxiosPromise<QueryResult>;
|
|
3650
3845
|
/**
|
|
3651
3846
|
* Retrieves a compiled Malloy model with its source information, queries, and metadata. The model is compiled using the specified version of the Malloy compiler. This endpoint provides access to the model\'s structure, sources, and named queries for use in applications.
|
|
3652
3847
|
* @summary Get compiled Malloy model
|
|
3653
|
-
* @param {string}
|
|
3848
|
+
* @param {string} environmentName Name of the environment
|
|
3654
3849
|
* @param {string} packageName Name of the package
|
|
3655
3850
|
* @param {string} path Path to the model within the package
|
|
3656
3851
|
* @param {string} [versionId] Version identifier for the package
|
|
3657
3852
|
* @param {*} [options] Override http request option.
|
|
3658
3853
|
* @throws {RequiredError}
|
|
3659
3854
|
*/
|
|
3660
|
-
getModel(
|
|
3855
|
+
getModel(environmentName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<CompiledModel>;
|
|
3661
3856
|
/**
|
|
3662
3857
|
* Retrieves a list of all Malloy models within the specified package. Each model entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available models and checking their status.
|
|
3663
3858
|
* @summary List package models
|
|
3664
|
-
* @param {string}
|
|
3859
|
+
* @param {string} environmentName Name of the environment
|
|
3665
3860
|
* @param {string} packageName Name of the package
|
|
3666
3861
|
* @param {string} [versionId] Version identifier for the package
|
|
3667
3862
|
* @param {*} [options] Override http request option.
|
|
3668
3863
|
* @throws {RequiredError}
|
|
3669
3864
|
*/
|
|
3670
|
-
listModels(
|
|
3865
|
+
listModels(environmentName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Model>>;
|
|
3671
3866
|
};
|
|
3672
3867
|
/**
|
|
3673
3868
|
* ModelsApi - object-oriented interface
|
|
@@ -3679,7 +3874,7 @@ export declare class ModelsApi extends BaseAPI {
|
|
|
3679
3874
|
/**
|
|
3680
3875
|
* Compiles Malloy source code in the context of a specific model file. The submitted source is appended to the full model content, giving it access to all sources, imports, and queries defined in the model. Relative imports resolve correctly against sibling model files. Returns compilation status and any problems (errors or warnings) found.
|
|
3681
3876
|
* @summary Compile Malloy source code
|
|
3682
|
-
* @param {string}
|
|
3877
|
+
* @param {string} environmentName Name of the environment
|
|
3683
3878
|
* @param {string} packageName Name of the package
|
|
3684
3879
|
* @param {string} path Path to the model within the package (used to resolve relative imports)
|
|
3685
3880
|
* @param {CompileRequest} compileRequest
|
|
@@ -3687,11 +3882,11 @@ export declare class ModelsApi extends BaseAPI {
|
|
|
3687
3882
|
* @throws {RequiredError}
|
|
3688
3883
|
* @memberof ModelsApi
|
|
3689
3884
|
*/
|
|
3690
|
-
compileModelSource(
|
|
3885
|
+
compileModelSource(environmentName: string, packageName: string, path: string, compileRequest: CompileRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<CompileResult, any, {}>>;
|
|
3691
3886
|
/**
|
|
3692
3887
|
* Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
|
|
3693
3888
|
* @summary Execute Malloy query
|
|
3694
|
-
* @param {string}
|
|
3889
|
+
* @param {string} environmentName Name of the environment
|
|
3695
3890
|
* @param {string} packageName Name of the package
|
|
3696
3891
|
* @param {string} path Path to the model within the package
|
|
3697
3892
|
* @param {QueryRequest} queryRequest
|
|
@@ -3699,11 +3894,11 @@ export declare class ModelsApi extends BaseAPI {
|
|
|
3699
3894
|
* @throws {RequiredError}
|
|
3700
3895
|
* @memberof ModelsApi
|
|
3701
3896
|
*/
|
|
3702
|
-
executeQueryModel(
|
|
3897
|
+
executeQueryModel(environmentName: string, packageName: string, path: string, queryRequest: QueryRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<QueryResult, any, {}>>;
|
|
3703
3898
|
/**
|
|
3704
3899
|
* Retrieves a compiled Malloy model with its source information, queries, and metadata. The model is compiled using the specified version of the Malloy compiler. This endpoint provides access to the model\'s structure, sources, and named queries for use in applications.
|
|
3705
3900
|
* @summary Get compiled Malloy model
|
|
3706
|
-
* @param {string}
|
|
3901
|
+
* @param {string} environmentName Name of the environment
|
|
3707
3902
|
* @param {string} packageName Name of the package
|
|
3708
3903
|
* @param {string} path Path to the model within the package
|
|
3709
3904
|
* @param {string} [versionId] Version identifier for the package
|
|
@@ -3711,18 +3906,18 @@ export declare class ModelsApi extends BaseAPI {
|
|
|
3711
3906
|
* @throws {RequiredError}
|
|
3712
3907
|
* @memberof ModelsApi
|
|
3713
3908
|
*/
|
|
3714
|
-
getModel(
|
|
3909
|
+
getModel(environmentName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<CompiledModel, any, {}>>;
|
|
3715
3910
|
/**
|
|
3716
3911
|
* Retrieves a list of all Malloy models within the specified package. Each model entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available models and checking their status.
|
|
3717
3912
|
* @summary List package models
|
|
3718
|
-
* @param {string}
|
|
3913
|
+
* @param {string} environmentName Name of the environment
|
|
3719
3914
|
* @param {string} packageName Name of the package
|
|
3720
3915
|
* @param {string} [versionId] Version identifier for the package
|
|
3721
3916
|
* @param {*} [options] Override http request option.
|
|
3722
3917
|
* @throws {RequiredError}
|
|
3723
3918
|
* @memberof ModelsApi
|
|
3724
3919
|
*/
|
|
3725
|
-
listModels(
|
|
3920
|
+
listModels(environmentName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Model[], any, {}>>;
|
|
3726
3921
|
}
|
|
3727
3922
|
/**
|
|
3728
3923
|
* NotebooksApi - axios parameter creator
|
|
@@ -3732,7 +3927,7 @@ export declare const NotebooksApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3732
3927
|
/**
|
|
3733
3928
|
* Executes a specific cell in a Malloy notebook by index. For code cells, this compiles and runs the Malloy code, returning query results and any new sources defined. For markdown cells, this simply returns the cell content.
|
|
3734
3929
|
* @summary Execute a specific notebook cell
|
|
3735
|
-
* @param {string}
|
|
3930
|
+
* @param {string} environmentName Name of the environment
|
|
3736
3931
|
* @param {string} packageName Name of the package
|
|
3737
3932
|
* @param {string} path Path to notebook within the package
|
|
3738
3933
|
* @param {number} cellIndex Index of the cell to execute (0-based)
|
|
@@ -3742,28 +3937,28 @@ export declare const NotebooksApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3742
3937
|
* @param {*} [options] Override http request option.
|
|
3743
3938
|
* @throws {RequiredError}
|
|
3744
3939
|
*/
|
|
3745
|
-
executeNotebookCell: (
|
|
3940
|
+
executeNotebookCell: (environmentName: string, packageName: string, path: string, cellIndex: number, versionId?: string, filterParams?: string, bypassFilters?: ExecuteNotebookCellBypassFiltersEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3746
3941
|
/**
|
|
3747
3942
|
* Retrieves a Malloy notebook with its raw cell contents (markdown and code). Cell execution should be done separately via the execute-notebook-cell endpoint.
|
|
3748
3943
|
* @summary Get Malloy notebook cells
|
|
3749
|
-
* @param {string}
|
|
3944
|
+
* @param {string} environmentName Name of the environment
|
|
3750
3945
|
* @param {string} packageName Name of the package
|
|
3751
3946
|
* @param {string} path Path to notebook within the package.
|
|
3752
3947
|
* @param {string} [versionId] Version identifier for the package
|
|
3753
3948
|
* @param {*} [options] Override http request option.
|
|
3754
3949
|
* @throws {RequiredError}
|
|
3755
3950
|
*/
|
|
3756
|
-
getNotebook: (
|
|
3951
|
+
getNotebook: (environmentName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3757
3952
|
/**
|
|
3758
3953
|
* Retrieves a list of all Malloy notebooks within the specified package. Each notebook entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available notebooks and checking their status.
|
|
3759
3954
|
* @summary List package notebooks
|
|
3760
|
-
* @param {string}
|
|
3955
|
+
* @param {string} environmentName Name of the environment
|
|
3761
3956
|
* @param {string} packageName Name of the package
|
|
3762
3957
|
* @param {string} [versionId] Version identifier for the package
|
|
3763
3958
|
* @param {*} [options] Override http request option.
|
|
3764
3959
|
* @throws {RequiredError}
|
|
3765
3960
|
*/
|
|
3766
|
-
listNotebooks: (
|
|
3961
|
+
listNotebooks: (environmentName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3767
3962
|
};
|
|
3768
3963
|
/**
|
|
3769
3964
|
* NotebooksApi - functional programming interface
|
|
@@ -3773,7 +3968,7 @@ export declare const NotebooksApiFp: (configuration?: Configuration) => {
|
|
|
3773
3968
|
/**
|
|
3774
3969
|
* Executes a specific cell in a Malloy notebook by index. For code cells, this compiles and runs the Malloy code, returning query results and any new sources defined. For markdown cells, this simply returns the cell content.
|
|
3775
3970
|
* @summary Execute a specific notebook cell
|
|
3776
|
-
* @param {string}
|
|
3971
|
+
* @param {string} environmentName Name of the environment
|
|
3777
3972
|
* @param {string} packageName Name of the package
|
|
3778
3973
|
* @param {string} path Path to notebook within the package
|
|
3779
3974
|
* @param {number} cellIndex Index of the cell to execute (0-based)
|
|
@@ -3783,28 +3978,28 @@ export declare const NotebooksApiFp: (configuration?: Configuration) => {
|
|
|
3783
3978
|
* @param {*} [options] Override http request option.
|
|
3784
3979
|
* @throws {RequiredError}
|
|
3785
3980
|
*/
|
|
3786
|
-
executeNotebookCell(
|
|
3981
|
+
executeNotebookCell(environmentName: string, packageName: string, path: string, cellIndex: number, versionId?: string, filterParams?: string, bypassFilters?: ExecuteNotebookCellBypassFiltersEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotebookCellResult>>;
|
|
3787
3982
|
/**
|
|
3788
3983
|
* Retrieves a Malloy notebook with its raw cell contents (markdown and code). Cell execution should be done separately via the execute-notebook-cell endpoint.
|
|
3789
3984
|
* @summary Get Malloy notebook cells
|
|
3790
|
-
* @param {string}
|
|
3985
|
+
* @param {string} environmentName Name of the environment
|
|
3791
3986
|
* @param {string} packageName Name of the package
|
|
3792
3987
|
* @param {string} path Path to notebook within the package.
|
|
3793
3988
|
* @param {string} [versionId] Version identifier for the package
|
|
3794
3989
|
* @param {*} [options] Override http request option.
|
|
3795
3990
|
* @throws {RequiredError}
|
|
3796
3991
|
*/
|
|
3797
|
-
getNotebook(
|
|
3992
|
+
getNotebook(environmentName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RawNotebook>>;
|
|
3798
3993
|
/**
|
|
3799
3994
|
* Retrieves a list of all Malloy notebooks within the specified package. Each notebook entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available notebooks and checking their status.
|
|
3800
3995
|
* @summary List package notebooks
|
|
3801
|
-
* @param {string}
|
|
3996
|
+
* @param {string} environmentName Name of the environment
|
|
3802
3997
|
* @param {string} packageName Name of the package
|
|
3803
3998
|
* @param {string} [versionId] Version identifier for the package
|
|
3804
3999
|
* @param {*} [options] Override http request option.
|
|
3805
4000
|
* @throws {RequiredError}
|
|
3806
4001
|
*/
|
|
3807
|
-
listNotebooks(
|
|
4002
|
+
listNotebooks(environmentName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Notebook>>>;
|
|
3808
4003
|
};
|
|
3809
4004
|
/**
|
|
3810
4005
|
* NotebooksApi - factory interface
|
|
@@ -3814,7 +4009,7 @@ export declare const NotebooksApiFactory: (configuration?: Configuration, basePa
|
|
|
3814
4009
|
/**
|
|
3815
4010
|
* Executes a specific cell in a Malloy notebook by index. For code cells, this compiles and runs the Malloy code, returning query results and any new sources defined. For markdown cells, this simply returns the cell content.
|
|
3816
4011
|
* @summary Execute a specific notebook cell
|
|
3817
|
-
* @param {string}
|
|
4012
|
+
* @param {string} environmentName Name of the environment
|
|
3818
4013
|
* @param {string} packageName Name of the package
|
|
3819
4014
|
* @param {string} path Path to notebook within the package
|
|
3820
4015
|
* @param {number} cellIndex Index of the cell to execute (0-based)
|
|
@@ -3824,28 +4019,28 @@ export declare const NotebooksApiFactory: (configuration?: Configuration, basePa
|
|
|
3824
4019
|
* @param {*} [options] Override http request option.
|
|
3825
4020
|
* @throws {RequiredError}
|
|
3826
4021
|
*/
|
|
3827
|
-
executeNotebookCell(
|
|
4022
|
+
executeNotebookCell(environmentName: string, packageName: string, path: string, cellIndex: number, versionId?: string, filterParams?: string, bypassFilters?: ExecuteNotebookCellBypassFiltersEnum, options?: RawAxiosRequestConfig): AxiosPromise<NotebookCellResult>;
|
|
3828
4023
|
/**
|
|
3829
4024
|
* Retrieves a Malloy notebook with its raw cell contents (markdown and code). Cell execution should be done separately via the execute-notebook-cell endpoint.
|
|
3830
4025
|
* @summary Get Malloy notebook cells
|
|
3831
|
-
* @param {string}
|
|
4026
|
+
* @param {string} environmentName Name of the environment
|
|
3832
4027
|
* @param {string} packageName Name of the package
|
|
3833
4028
|
* @param {string} path Path to notebook within the package.
|
|
3834
4029
|
* @param {string} [versionId] Version identifier for the package
|
|
3835
4030
|
* @param {*} [options] Override http request option.
|
|
3836
4031
|
* @throws {RequiredError}
|
|
3837
4032
|
*/
|
|
3838
|
-
getNotebook(
|
|
4033
|
+
getNotebook(environmentName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<RawNotebook>;
|
|
3839
4034
|
/**
|
|
3840
4035
|
* Retrieves a list of all Malloy notebooks within the specified package. Each notebook entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available notebooks and checking their status.
|
|
3841
4036
|
* @summary List package notebooks
|
|
3842
|
-
* @param {string}
|
|
4037
|
+
* @param {string} environmentName Name of the environment
|
|
3843
4038
|
* @param {string} packageName Name of the package
|
|
3844
4039
|
* @param {string} [versionId] Version identifier for the package
|
|
3845
4040
|
* @param {*} [options] Override http request option.
|
|
3846
4041
|
* @throws {RequiredError}
|
|
3847
4042
|
*/
|
|
3848
|
-
listNotebooks(
|
|
4043
|
+
listNotebooks(environmentName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Notebook>>;
|
|
3849
4044
|
};
|
|
3850
4045
|
/**
|
|
3851
4046
|
* NotebooksApi - object-oriented interface
|
|
@@ -3857,7 +4052,7 @@ export declare class NotebooksApi extends BaseAPI {
|
|
|
3857
4052
|
/**
|
|
3858
4053
|
* Executes a specific cell in a Malloy notebook by index. For code cells, this compiles and runs the Malloy code, returning query results and any new sources defined. For markdown cells, this simply returns the cell content.
|
|
3859
4054
|
* @summary Execute a specific notebook cell
|
|
3860
|
-
* @param {string}
|
|
4055
|
+
* @param {string} environmentName Name of the environment
|
|
3861
4056
|
* @param {string} packageName Name of the package
|
|
3862
4057
|
* @param {string} path Path to notebook within the package
|
|
3863
4058
|
* @param {number} cellIndex Index of the cell to execute (0-based)
|
|
@@ -3868,11 +4063,11 @@ export declare class NotebooksApi extends BaseAPI {
|
|
|
3868
4063
|
* @throws {RequiredError}
|
|
3869
4064
|
* @memberof NotebooksApi
|
|
3870
4065
|
*/
|
|
3871
|
-
executeNotebookCell(
|
|
4066
|
+
executeNotebookCell(environmentName: string, packageName: string, path: string, cellIndex: number, versionId?: string, filterParams?: string, bypassFilters?: ExecuteNotebookCellBypassFiltersEnum, options?: RawAxiosRequestConfig): Promise< AxiosResponse<NotebookCellResult, any, {}>>;
|
|
3872
4067
|
/**
|
|
3873
4068
|
* Retrieves a Malloy notebook with its raw cell contents (markdown and code). Cell execution should be done separately via the execute-notebook-cell endpoint.
|
|
3874
4069
|
* @summary Get Malloy notebook cells
|
|
3875
|
-
* @param {string}
|
|
4070
|
+
* @param {string} environmentName Name of the environment
|
|
3876
4071
|
* @param {string} packageName Name of the package
|
|
3877
4072
|
* @param {string} path Path to notebook within the package.
|
|
3878
4073
|
* @param {string} [versionId] Version identifier for the package
|
|
@@ -3880,18 +4075,18 @@ export declare class NotebooksApi extends BaseAPI {
|
|
|
3880
4075
|
* @throws {RequiredError}
|
|
3881
4076
|
* @memberof NotebooksApi
|
|
3882
4077
|
*/
|
|
3883
|
-
getNotebook(
|
|
4078
|
+
getNotebook(environmentName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<RawNotebook, any, {}>>;
|
|
3884
4079
|
/**
|
|
3885
4080
|
* Retrieves a list of all Malloy notebooks within the specified package. Each notebook entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available notebooks and checking their status.
|
|
3886
4081
|
* @summary List package notebooks
|
|
3887
|
-
* @param {string}
|
|
4082
|
+
* @param {string} environmentName Name of the environment
|
|
3888
4083
|
* @param {string} packageName Name of the package
|
|
3889
4084
|
* @param {string} [versionId] Version identifier for the package
|
|
3890
4085
|
* @param {*} [options] Override http request option.
|
|
3891
4086
|
* @throws {RequiredError}
|
|
3892
4087
|
* @memberof NotebooksApi
|
|
3893
4088
|
*/
|
|
3894
|
-
listNotebooks(
|
|
4089
|
+
listNotebooks(environmentName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Notebook[], any, {}>>;
|
|
3895
4090
|
}
|
|
3896
4091
|
/**
|
|
3897
4092
|
* @export
|
|
@@ -3907,53 +4102,53 @@ export type ExecuteNotebookCellBypassFiltersEnum = typeof ExecuteNotebookCellByp
|
|
|
3907
4102
|
*/
|
|
3908
4103
|
export declare const PackagesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3909
4104
|
/**
|
|
3910
|
-
* Creates a new Malloy package within the specified
|
|
4105
|
+
* Creates a new Malloy package within the specified environment. A package serves as a container for models, notebooks, embedded databases, and other resources. The package will be initialized with the provided metadata and can immediately accept content.
|
|
3911
4106
|
* @summary Create a new package
|
|
3912
|
-
* @param {string}
|
|
4107
|
+
* @param {string} environmentName Name of the environment
|
|
3913
4108
|
* @param {Package} _package
|
|
3914
4109
|
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
3915
4110
|
* @param {*} [options] Override http request option.
|
|
3916
4111
|
* @throws {RequiredError}
|
|
3917
4112
|
*/
|
|
3918
|
-
createPackage: (
|
|
4113
|
+
createPackage: (environmentName: string, _package: Package, autoLoadManifest?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3919
4114
|
/**
|
|
3920
4115
|
* 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.
|
|
3921
4116
|
* @summary Delete a package
|
|
3922
|
-
* @param {string}
|
|
4117
|
+
* @param {string} environmentName Name of the environment
|
|
3923
4118
|
* @param {string} packageName Name of the package
|
|
3924
4119
|
* @param {*} [options] Override http request option.
|
|
3925
4120
|
* @throws {RequiredError}
|
|
3926
4121
|
*/
|
|
3927
|
-
deletePackage: (
|
|
4122
|
+
deletePackage: (environmentName: string, packageName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3928
4123
|
/**
|
|
3929
4124
|
* Retrieves detailed information about a specific package, including its models, notebooks, databases, and metadata. The reload parameter can be used to refresh the package state from disk before returning the information. The versionId parameter allows access to specific package versions.
|
|
3930
4125
|
* @summary Get package details and metadata
|
|
3931
|
-
* @param {string}
|
|
4126
|
+
* @param {string} environmentName Name of the environment
|
|
3932
4127
|
* @param {string} packageName Package name
|
|
3933
4128
|
* @param {string} [versionId] Version identifier for the package
|
|
3934
4129
|
* @param {boolean} [reload] Load / reload the package before returning result
|
|
3935
4130
|
* @param {*} [options] Override http request option.
|
|
3936
4131
|
* @throws {RequiredError}
|
|
3937
4132
|
*/
|
|
3938
|
-
getPackage: (
|
|
4133
|
+
getPackage: (environmentName: string, packageName: string, versionId?: string, reload?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3939
4134
|
/**
|
|
3940
|
-
* Retrieves a list of all Malloy packages within the specified
|
|
3941
|
-
* @summary List
|
|
3942
|
-
* @param {string}
|
|
4135
|
+
* Retrieves a list of all Malloy packages within the specified environment. Each package contains models, notebooks, databases, and other resources. This endpoint is useful for discovering available packages and their basic metadata.
|
|
4136
|
+
* @summary List environment packages
|
|
4137
|
+
* @param {string} environmentName Name of the environment
|
|
3943
4138
|
* @param {*} [options] Override http request option.
|
|
3944
4139
|
* @throws {RequiredError}
|
|
3945
4140
|
*/
|
|
3946
|
-
listPackages: (
|
|
4141
|
+
listPackages: (environmentName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3947
4142
|
/**
|
|
3948
4143
|
* Updates the configuration and metadata of an existing package. This allows you to modify package settings, update the description, change the location, or update other package-level properties. The package must exist and be accessible.
|
|
3949
4144
|
* @summary Update package configuration
|
|
3950
|
-
* @param {string}
|
|
4145
|
+
* @param {string} environmentName Name of the environment
|
|
3951
4146
|
* @param {string} packageName Name of the package
|
|
3952
4147
|
* @param {Package} _package
|
|
3953
4148
|
* @param {*} [options] Override http request option.
|
|
3954
4149
|
* @throws {RequiredError}
|
|
3955
4150
|
*/
|
|
3956
|
-
updatePackage: (
|
|
4151
|
+
updatePackage: (environmentName: string, packageName: string, _package: Package, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3957
4152
|
};
|
|
3958
4153
|
/**
|
|
3959
4154
|
* PackagesApi - functional programming interface
|
|
@@ -3961,53 +4156,53 @@ export declare const PackagesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
3961
4156
|
*/
|
|
3962
4157
|
export declare const PackagesApiFp: (configuration?: Configuration) => {
|
|
3963
4158
|
/**
|
|
3964
|
-
* Creates a new Malloy package within the specified
|
|
4159
|
+
* Creates a new Malloy package within the specified environment. A package serves as a container for models, notebooks, embedded databases, and other resources. The package will be initialized with the provided metadata and can immediately accept content.
|
|
3965
4160
|
* @summary Create a new package
|
|
3966
|
-
* @param {string}
|
|
4161
|
+
* @param {string} environmentName Name of the environment
|
|
3967
4162
|
* @param {Package} _package
|
|
3968
4163
|
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
3969
4164
|
* @param {*} [options] Override http request option.
|
|
3970
4165
|
* @throws {RequiredError}
|
|
3971
4166
|
*/
|
|
3972
|
-
createPackage(
|
|
4167
|
+
createPackage(environmentName: string, _package: Package, autoLoadManifest?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
3973
4168
|
/**
|
|
3974
4169
|
* 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.
|
|
3975
4170
|
* @summary Delete a package
|
|
3976
|
-
* @param {string}
|
|
4171
|
+
* @param {string} environmentName Name of the environment
|
|
3977
4172
|
* @param {string} packageName Name of the package
|
|
3978
4173
|
* @param {*} [options] Override http request option.
|
|
3979
4174
|
* @throws {RequiredError}
|
|
3980
4175
|
*/
|
|
3981
|
-
deletePackage(
|
|
4176
|
+
deletePackage(environmentName: string, packageName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
3982
4177
|
/**
|
|
3983
4178
|
* Retrieves detailed information about a specific package, including its models, notebooks, databases, and metadata. The reload parameter can be used to refresh the package state from disk before returning the information. The versionId parameter allows access to specific package versions.
|
|
3984
4179
|
* @summary Get package details and metadata
|
|
3985
|
-
* @param {string}
|
|
4180
|
+
* @param {string} environmentName Name of the environment
|
|
3986
4181
|
* @param {string} packageName Package name
|
|
3987
4182
|
* @param {string} [versionId] Version identifier for the package
|
|
3988
4183
|
* @param {boolean} [reload] Load / reload the package before returning result
|
|
3989
4184
|
* @param {*} [options] Override http request option.
|
|
3990
4185
|
* @throws {RequiredError}
|
|
3991
4186
|
*/
|
|
3992
|
-
getPackage(
|
|
4187
|
+
getPackage(environmentName: string, packageName: string, versionId?: string, reload?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
3993
4188
|
/**
|
|
3994
|
-
* Retrieves a list of all Malloy packages within the specified
|
|
3995
|
-
* @summary List
|
|
3996
|
-
* @param {string}
|
|
4189
|
+
* Retrieves a list of all Malloy packages within the specified environment. Each package contains models, notebooks, databases, and other resources. This endpoint is useful for discovering available packages and their basic metadata.
|
|
4190
|
+
* @summary List environment packages
|
|
4191
|
+
* @param {string} environmentName Name of the environment
|
|
3997
4192
|
* @param {*} [options] Override http request option.
|
|
3998
4193
|
* @throws {RequiredError}
|
|
3999
4194
|
*/
|
|
4000
|
-
listPackages(
|
|
4195
|
+
listPackages(environmentName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Package>>>;
|
|
4001
4196
|
/**
|
|
4002
4197
|
* Updates the configuration and metadata of an existing package. This allows you to modify package settings, update the description, change the location, or update other package-level properties. The package must exist and be accessible.
|
|
4003
4198
|
* @summary Update package configuration
|
|
4004
|
-
* @param {string}
|
|
4199
|
+
* @param {string} environmentName Name of the environment
|
|
4005
4200
|
* @param {string} packageName Name of the package
|
|
4006
4201
|
* @param {Package} _package
|
|
4007
4202
|
* @param {*} [options] Override http request option.
|
|
4008
4203
|
* @throws {RequiredError}
|
|
4009
4204
|
*/
|
|
4010
|
-
updatePackage(
|
|
4205
|
+
updatePackage(environmentName: string, packageName: string, _package: Package, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
4011
4206
|
};
|
|
4012
4207
|
/**
|
|
4013
4208
|
* PackagesApi - factory interface
|
|
@@ -4015,53 +4210,53 @@ export declare const PackagesApiFp: (configuration?: Configuration) => {
|
|
|
4015
4210
|
*/
|
|
4016
4211
|
export declare const PackagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4017
4212
|
/**
|
|
4018
|
-
* Creates a new Malloy package within the specified
|
|
4213
|
+
* Creates a new Malloy package within the specified environment. A package serves as a container for models, notebooks, embedded databases, and other resources. The package will be initialized with the provided metadata and can immediately accept content.
|
|
4019
4214
|
* @summary Create a new package
|
|
4020
|
-
* @param {string}
|
|
4215
|
+
* @param {string} environmentName Name of the environment
|
|
4021
4216
|
* @param {Package} _package
|
|
4022
4217
|
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
4023
4218
|
* @param {*} [options] Override http request option.
|
|
4024
4219
|
* @throws {RequiredError}
|
|
4025
4220
|
*/
|
|
4026
|
-
createPackage(
|
|
4221
|
+
createPackage(environmentName: string, _package: Package, autoLoadManifest?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
4027
4222
|
/**
|
|
4028
4223
|
* 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.
|
|
4029
4224
|
* @summary Delete a package
|
|
4030
|
-
* @param {string}
|
|
4225
|
+
* @param {string} environmentName Name of the environment
|
|
4031
4226
|
* @param {string} packageName Name of the package
|
|
4032
4227
|
* @param {*} [options] Override http request option.
|
|
4033
4228
|
* @throws {RequiredError}
|
|
4034
4229
|
*/
|
|
4035
|
-
deletePackage(
|
|
4230
|
+
deletePackage(environmentName: string, packageName: string, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
4036
4231
|
/**
|
|
4037
4232
|
* Retrieves detailed information about a specific package, including its models, notebooks, databases, and metadata. The reload parameter can be used to refresh the package state from disk before returning the information. The versionId parameter allows access to specific package versions.
|
|
4038
4233
|
* @summary Get package details and metadata
|
|
4039
|
-
* @param {string}
|
|
4234
|
+
* @param {string} environmentName Name of the environment
|
|
4040
4235
|
* @param {string} packageName Package name
|
|
4041
4236
|
* @param {string} [versionId] Version identifier for the package
|
|
4042
4237
|
* @param {boolean} [reload] Load / reload the package before returning result
|
|
4043
4238
|
* @param {*} [options] Override http request option.
|
|
4044
4239
|
* @throws {RequiredError}
|
|
4045
4240
|
*/
|
|
4046
|
-
getPackage(
|
|
4241
|
+
getPackage(environmentName: string, packageName: string, versionId?: string, reload?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
4047
4242
|
/**
|
|
4048
|
-
* Retrieves a list of all Malloy packages within the specified
|
|
4049
|
-
* @summary List
|
|
4050
|
-
* @param {string}
|
|
4243
|
+
* Retrieves a list of all Malloy packages within the specified environment. Each package contains models, notebooks, databases, and other resources. This endpoint is useful for discovering available packages and their basic metadata.
|
|
4244
|
+
* @summary List environment packages
|
|
4245
|
+
* @param {string} environmentName Name of the environment
|
|
4051
4246
|
* @param {*} [options] Override http request option.
|
|
4052
4247
|
* @throws {RequiredError}
|
|
4053
4248
|
*/
|
|
4054
|
-
listPackages(
|
|
4249
|
+
listPackages(environmentName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Package>>;
|
|
4055
4250
|
/**
|
|
4056
4251
|
* Updates the configuration and metadata of an existing package. This allows you to modify package settings, update the description, change the location, or update other package-level properties. The package must exist and be accessible.
|
|
4057
4252
|
* @summary Update package configuration
|
|
4058
|
-
* @param {string}
|
|
4253
|
+
* @param {string} environmentName Name of the environment
|
|
4059
4254
|
* @param {string} packageName Name of the package
|
|
4060
4255
|
* @param {Package} _package
|
|
4061
4256
|
* @param {*} [options] Override http request option.
|
|
4062
4257
|
* @throws {RequiredError}
|
|
4063
4258
|
*/
|
|
4064
|
-
updatePackage(
|
|
4259
|
+
updatePackage(environmentName: string, packageName: string, _package: Package, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
4065
4260
|
};
|
|
4066
4261
|
/**
|
|
4067
4262
|
* PackagesApi - object-oriented interface
|
|
@@ -4071,30 +4266,30 @@ export declare const PackagesApiFactory: (configuration?: Configuration, basePat
|
|
|
4071
4266
|
*/
|
|
4072
4267
|
export declare class PackagesApi extends BaseAPI {
|
|
4073
4268
|
/**
|
|
4074
|
-
* Creates a new Malloy package within the specified
|
|
4269
|
+
* Creates a new Malloy package within the specified environment. A package serves as a container for models, notebooks, embedded databases, and other resources. The package will be initialized with the provided metadata and can immediately accept content.
|
|
4075
4270
|
* @summary Create a new package
|
|
4076
|
-
* @param {string}
|
|
4271
|
+
* @param {string} environmentName Name of the environment
|
|
4077
4272
|
* @param {Package} _package
|
|
4078
4273
|
* @param {boolean} [autoLoadManifest] When true, automatically loads any existing build manifest for the package so materialized table references resolve immediately. Defaults to false.
|
|
4079
4274
|
* @param {*} [options] Override http request option.
|
|
4080
4275
|
* @throws {RequiredError}
|
|
4081
4276
|
* @memberof PackagesApi
|
|
4082
4277
|
*/
|
|
4083
|
-
createPackage(
|
|
4278
|
+
createPackage(environmentName: string, _package: Package, autoLoadManifest?: boolean, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Package, any, {}>>;
|
|
4084
4279
|
/**
|
|
4085
4280
|
* 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
4281
|
* @summary Delete a package
|
|
4087
|
-
* @param {string}
|
|
4282
|
+
* @param {string} environmentName Name of the environment
|
|
4088
4283
|
* @param {string} packageName Name of the package
|
|
4089
4284
|
* @param {*} [options] Override http request option.
|
|
4090
4285
|
* @throws {RequiredError}
|
|
4091
4286
|
* @memberof PackagesApi
|
|
4092
4287
|
*/
|
|
4093
|
-
deletePackage(
|
|
4288
|
+
deletePackage(environmentName: string, packageName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Package, any, {}>>;
|
|
4094
4289
|
/**
|
|
4095
4290
|
* Retrieves detailed information about a specific package, including its models, notebooks, databases, and metadata. The reload parameter can be used to refresh the package state from disk before returning the information. The versionId parameter allows access to specific package versions.
|
|
4096
4291
|
* @summary Get package details and metadata
|
|
4097
|
-
* @param {string}
|
|
4292
|
+
* @param {string} environmentName Name of the environment
|
|
4098
4293
|
* @param {string} packageName Package name
|
|
4099
4294
|
* @param {string} [versionId] Version identifier for the package
|
|
4100
4295
|
* @param {boolean} [reload] Load / reload the package before returning result
|
|
@@ -4102,222 +4297,27 @@ export declare class PackagesApi extends BaseAPI {
|
|
|
4102
4297
|
* @throws {RequiredError}
|
|
4103
4298
|
* @memberof PackagesApi
|
|
4104
4299
|
*/
|
|
4105
|
-
getPackage(
|
|
4300
|
+
getPackage(environmentName: string, packageName: string, versionId?: string, reload?: boolean, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Package, any, {}>>;
|
|
4106
4301
|
/**
|
|
4107
|
-
* Retrieves a list of all Malloy packages within the specified
|
|
4108
|
-
* @summary List
|
|
4109
|
-
* @param {string}
|
|
4302
|
+
* Retrieves a list of all Malloy packages within the specified environment. Each package contains models, notebooks, databases, and other resources. This endpoint is useful for discovering available packages and their basic metadata.
|
|
4303
|
+
* @summary List environment packages
|
|
4304
|
+
* @param {string} environmentName Name of the environment
|
|
4110
4305
|
* @param {*} [options] Override http request option.
|
|
4111
4306
|
* @throws {RequiredError}
|
|
4112
4307
|
* @memberof PackagesApi
|
|
4113
4308
|
*/
|
|
4114
|
-
listPackages(
|
|
4309
|
+
listPackages(environmentName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Package[], any, {}>>;
|
|
4115
4310
|
/**
|
|
4116
4311
|
* Updates the configuration and metadata of an existing package. This allows you to modify package settings, update the description, change the location, or update other package-level properties. The package must exist and be accessible.
|
|
4117
4312
|
* @summary Update package configuration
|
|
4118
|
-
* @param {string}
|
|
4313
|
+
* @param {string} environmentName Name of the environment
|
|
4119
4314
|
* @param {string} packageName Name of the package
|
|
4120
4315
|
* @param {Package} _package
|
|
4121
4316
|
* @param {*} [options] Override http request option.
|
|
4122
4317
|
* @throws {RequiredError}
|
|
4123
4318
|
* @memberof PackagesApi
|
|
4124
4319
|
*/
|
|
4125
|
-
updatePackage(
|
|
4126
|
-
}
|
|
4127
|
-
/**
|
|
4128
|
-
* ProjectsApi - axios parameter creator
|
|
4129
|
-
* @export
|
|
4130
|
-
*/
|
|
4131
|
-
export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4132
|
-
/**
|
|
4133
|
-
* Creates a new Malloy project with the specified configuration. A project serves as a container for packages, connections, and other resources. The project will be initialized with the provided metadata and can immediately accept packages and connections.
|
|
4134
|
-
* @summary Create a new project
|
|
4135
|
-
* @param {Project} project
|
|
4136
|
-
* @param {*} [options] Override http request option.
|
|
4137
|
-
* @throws {RequiredError}
|
|
4138
|
-
*/
|
|
4139
|
-
createProject: (project: Project, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4140
|
-
/**
|
|
4141
|
-
* Permanently deletes a project and all its associated resources including packages, connections, and metadata. This operation cannot be undone, so use with caution. The project must exist and be accessible for deletion.
|
|
4142
|
-
* @summary Delete a project
|
|
4143
|
-
* @param {string} projectName Name of the project
|
|
4144
|
-
* @param {*} [options] Override http request option.
|
|
4145
|
-
* @throws {RequiredError}
|
|
4146
|
-
*/
|
|
4147
|
-
deleteProject: (projectName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4148
|
-
/**
|
|
4149
|
-
* Retrieves detailed information about a specific project, including its packages, connections, configuration, and metadata. The reload parameter can be used to refresh the project state from disk before returning the information.
|
|
4150
|
-
* @summary Get project details and metadata
|
|
4151
|
-
* @param {string} projectName Name of the project
|
|
4152
|
-
* @param {boolean} [reload] Load / reload the project before returning result
|
|
4153
|
-
* @param {*} [options] Override http request option.
|
|
4154
|
-
* @throws {RequiredError}
|
|
4155
|
-
*/
|
|
4156
|
-
getProject: (projectName: string, reload?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4157
|
-
/**
|
|
4158
|
-
* Retrieves a list of all projects currently hosted on this Malloy Publisher server. Each project contains metadata about its packages, connections, and configuration. This endpoint is typically used to discover available projects and their basic information.
|
|
4159
|
-
* @summary List all available projects
|
|
4160
|
-
* @param {*} [options] Override http request option.
|
|
4161
|
-
* @throws {RequiredError}
|
|
4162
|
-
*/
|
|
4163
|
-
listProjects: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4164
|
-
/**
|
|
4165
|
-
* Updates the configuration and metadata of an existing project. This allows you to modify project settings, update the README, change the location, or update other project-level properties. The project must exist and be accessible.
|
|
4166
|
-
* @summary Update project configuration
|
|
4167
|
-
* @param {string} projectName Name of the project
|
|
4168
|
-
* @param {Project} project
|
|
4169
|
-
* @param {*} [options] Override http request option.
|
|
4170
|
-
* @throws {RequiredError}
|
|
4171
|
-
*/
|
|
4172
|
-
updateProject: (projectName: string, project: Project, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4173
|
-
};
|
|
4174
|
-
/**
|
|
4175
|
-
* ProjectsApi - functional programming interface
|
|
4176
|
-
* @export
|
|
4177
|
-
*/
|
|
4178
|
-
export declare const ProjectsApiFp: (configuration?: Configuration) => {
|
|
4179
|
-
/**
|
|
4180
|
-
* Creates a new Malloy project with the specified configuration. A project serves as a container for packages, connections, and other resources. The project will be initialized with the provided metadata and can immediately accept packages and connections.
|
|
4181
|
-
* @summary Create a new project
|
|
4182
|
-
* @param {Project} project
|
|
4183
|
-
* @param {*} [options] Override http request option.
|
|
4184
|
-
* @throws {RequiredError}
|
|
4185
|
-
*/
|
|
4186
|
-
createProject(project: Project, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>>;
|
|
4187
|
-
/**
|
|
4188
|
-
* Permanently deletes a project and all its associated resources including packages, connections, and metadata. This operation cannot be undone, so use with caution. The project must exist and be accessible for deletion.
|
|
4189
|
-
* @summary Delete a project
|
|
4190
|
-
* @param {string} projectName Name of the project
|
|
4191
|
-
* @param {*} [options] Override http request option.
|
|
4192
|
-
* @throws {RequiredError}
|
|
4193
|
-
*/
|
|
4194
|
-
deleteProject(projectName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>>;
|
|
4195
|
-
/**
|
|
4196
|
-
* Retrieves detailed information about a specific project, including its packages, connections, configuration, and metadata. The reload parameter can be used to refresh the project state from disk before returning the information.
|
|
4197
|
-
* @summary Get project details and metadata
|
|
4198
|
-
* @param {string} projectName Name of the project
|
|
4199
|
-
* @param {boolean} [reload] Load / reload the project before returning result
|
|
4200
|
-
* @param {*} [options] Override http request option.
|
|
4201
|
-
* @throws {RequiredError}
|
|
4202
|
-
*/
|
|
4203
|
-
getProject(projectName: string, reload?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>>;
|
|
4204
|
-
/**
|
|
4205
|
-
* Retrieves a list of all projects currently hosted on this Malloy Publisher server. Each project contains metadata about its packages, connections, and configuration. This endpoint is typically used to discover available projects and their basic information.
|
|
4206
|
-
* @summary List all available projects
|
|
4207
|
-
* @param {*} [options] Override http request option.
|
|
4208
|
-
* @throws {RequiredError}
|
|
4209
|
-
*/
|
|
4210
|
-
listProjects(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Project>>>;
|
|
4211
|
-
/**
|
|
4212
|
-
* Updates the configuration and metadata of an existing project. This allows you to modify project settings, update the README, change the location, or update other project-level properties. The project must exist and be accessible.
|
|
4213
|
-
* @summary Update project configuration
|
|
4214
|
-
* @param {string} projectName Name of the project
|
|
4215
|
-
* @param {Project} project
|
|
4216
|
-
* @param {*} [options] Override http request option.
|
|
4217
|
-
* @throws {RequiredError}
|
|
4218
|
-
*/
|
|
4219
|
-
updateProject(projectName: string, project: Project, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>>;
|
|
4220
|
-
};
|
|
4221
|
-
/**
|
|
4222
|
-
* ProjectsApi - factory interface
|
|
4223
|
-
* @export
|
|
4224
|
-
*/
|
|
4225
|
-
export declare const ProjectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4226
|
-
/**
|
|
4227
|
-
* Creates a new Malloy project with the specified configuration. A project serves as a container for packages, connections, and other resources. The project will be initialized with the provided metadata and can immediately accept packages and connections.
|
|
4228
|
-
* @summary Create a new project
|
|
4229
|
-
* @param {Project} project
|
|
4230
|
-
* @param {*} [options] Override http request option.
|
|
4231
|
-
* @throws {RequiredError}
|
|
4232
|
-
*/
|
|
4233
|
-
createProject(project: Project, options?: RawAxiosRequestConfig): AxiosPromise<Project>;
|
|
4234
|
-
/**
|
|
4235
|
-
* Permanently deletes a project and all its associated resources including packages, connections, and metadata. This operation cannot be undone, so use with caution. The project must exist and be accessible for deletion.
|
|
4236
|
-
* @summary Delete a project
|
|
4237
|
-
* @param {string} projectName Name of the project
|
|
4238
|
-
* @param {*} [options] Override http request option.
|
|
4239
|
-
* @throws {RequiredError}
|
|
4240
|
-
*/
|
|
4241
|
-
deleteProject(projectName: string, options?: RawAxiosRequestConfig): AxiosPromise<Project>;
|
|
4242
|
-
/**
|
|
4243
|
-
* Retrieves detailed information about a specific project, including its packages, connections, configuration, and metadata. The reload parameter can be used to refresh the project state from disk before returning the information.
|
|
4244
|
-
* @summary Get project details and metadata
|
|
4245
|
-
* @param {string} projectName Name of the project
|
|
4246
|
-
* @param {boolean} [reload] Load / reload the project before returning result
|
|
4247
|
-
* @param {*} [options] Override http request option.
|
|
4248
|
-
* @throws {RequiredError}
|
|
4249
|
-
*/
|
|
4250
|
-
getProject(projectName: string, reload?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Project>;
|
|
4251
|
-
/**
|
|
4252
|
-
* Retrieves a list of all projects currently hosted on this Malloy Publisher server. Each project contains metadata about its packages, connections, and configuration. This endpoint is typically used to discover available projects and their basic information.
|
|
4253
|
-
* @summary List all available projects
|
|
4254
|
-
* @param {*} [options] Override http request option.
|
|
4255
|
-
* @throws {RequiredError}
|
|
4256
|
-
*/
|
|
4257
|
-
listProjects(options?: RawAxiosRequestConfig): AxiosPromise<Array<Project>>;
|
|
4258
|
-
/**
|
|
4259
|
-
* Updates the configuration and metadata of an existing project. This allows you to modify project settings, update the README, change the location, or update other project-level properties. The project must exist and be accessible.
|
|
4260
|
-
* @summary Update project configuration
|
|
4261
|
-
* @param {string} projectName Name of the project
|
|
4262
|
-
* @param {Project} project
|
|
4263
|
-
* @param {*} [options] Override http request option.
|
|
4264
|
-
* @throws {RequiredError}
|
|
4265
|
-
*/
|
|
4266
|
-
updateProject(projectName: string, project: Project, options?: RawAxiosRequestConfig): AxiosPromise<Project>;
|
|
4267
|
-
};
|
|
4268
|
-
/**
|
|
4269
|
-
* ProjectsApi - object-oriented interface
|
|
4270
|
-
* @export
|
|
4271
|
-
* @class ProjectsApi
|
|
4272
|
-
* @extends {BaseAPI}
|
|
4273
|
-
*/
|
|
4274
|
-
export declare class ProjectsApi extends BaseAPI {
|
|
4275
|
-
/**
|
|
4276
|
-
* Creates a new Malloy project with the specified configuration. A project serves as a container for packages, connections, and other resources. The project will be initialized with the provided metadata and can immediately accept packages and connections.
|
|
4277
|
-
* @summary Create a new project
|
|
4278
|
-
* @param {Project} project
|
|
4279
|
-
* @param {*} [options] Override http request option.
|
|
4280
|
-
* @throws {RequiredError}
|
|
4281
|
-
* @memberof ProjectsApi
|
|
4282
|
-
*/
|
|
4283
|
-
createProject(project: Project, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Project, any, {}>>;
|
|
4284
|
-
/**
|
|
4285
|
-
* Permanently deletes a project and all its associated resources including packages, connections, and metadata. This operation cannot be undone, so use with caution. The project must exist and be accessible for deletion.
|
|
4286
|
-
* @summary Delete a project
|
|
4287
|
-
* @param {string} projectName Name of the project
|
|
4288
|
-
* @param {*} [options] Override http request option.
|
|
4289
|
-
* @throws {RequiredError}
|
|
4290
|
-
* @memberof ProjectsApi
|
|
4291
|
-
*/
|
|
4292
|
-
deleteProject(projectName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Project, any, {}>>;
|
|
4293
|
-
/**
|
|
4294
|
-
* Retrieves detailed information about a specific project, including its packages, connections, configuration, and metadata. The reload parameter can be used to refresh the project state from disk before returning the information.
|
|
4295
|
-
* @summary Get project details and metadata
|
|
4296
|
-
* @param {string} projectName Name of the project
|
|
4297
|
-
* @param {boolean} [reload] Load / reload the project before returning result
|
|
4298
|
-
* @param {*} [options] Override http request option.
|
|
4299
|
-
* @throws {RequiredError}
|
|
4300
|
-
* @memberof ProjectsApi
|
|
4301
|
-
*/
|
|
4302
|
-
getProject(projectName: string, reload?: boolean, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Project, any, {}>>;
|
|
4303
|
-
/**
|
|
4304
|
-
* Retrieves a list of all projects currently hosted on this Malloy Publisher server. Each project contains metadata about its packages, connections, and configuration. This endpoint is typically used to discover available projects and their basic information.
|
|
4305
|
-
* @summary List all available projects
|
|
4306
|
-
* @param {*} [options] Override http request option.
|
|
4307
|
-
* @throws {RequiredError}
|
|
4308
|
-
* @memberof ProjectsApi
|
|
4309
|
-
*/
|
|
4310
|
-
listProjects(options?: RawAxiosRequestConfig): Promise< AxiosResponse<Project[], any, {}>>;
|
|
4311
|
-
/**
|
|
4312
|
-
* Updates the configuration and metadata of an existing project. This allows you to modify project settings, update the README, change the location, or update other project-level properties. The project must exist and be accessible.
|
|
4313
|
-
* @summary Update project configuration
|
|
4314
|
-
* @param {string} projectName Name of the project
|
|
4315
|
-
* @param {Project} project
|
|
4316
|
-
* @param {*} [options] Override http request option.
|
|
4317
|
-
* @throws {RequiredError}
|
|
4318
|
-
* @memberof ProjectsApi
|
|
4319
|
-
*/
|
|
4320
|
-
updateProject(projectName: string, project: Project, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Project, any, {}>>;
|
|
4320
|
+
updatePackage(environmentName: string, packageName: string, _package: Package, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Package, any, {}>>;
|
|
4321
4321
|
}
|
|
4322
4322
|
/**
|
|
4323
4323
|
* PublisherApi - axios parameter creator
|
|
@@ -4325,7 +4325,7 @@ export declare class ProjectsApi extends BaseAPI {
|
|
|
4325
4325
|
*/
|
|
4326
4326
|
export declare const PublisherApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4327
4327
|
/**
|
|
4328
|
-
* Returns the current status of the Malloy Publisher server, including initialization state, available
|
|
4328
|
+
* Returns the current status of the Malloy Publisher server, including initialization state, available environments, and server timestamp. This endpoint is useful for health checks and monitoring server availability.
|
|
4329
4329
|
* @summary Get server status and health information
|
|
4330
4330
|
* @param {*} [options] Override http request option.
|
|
4331
4331
|
* @throws {RequiredError}
|
|
@@ -4338,7 +4338,7 @@ export declare const PublisherApiAxiosParamCreator: (configuration?: Configurati
|
|
|
4338
4338
|
*/
|
|
4339
4339
|
export declare const PublisherApiFp: (configuration?: Configuration) => {
|
|
4340
4340
|
/**
|
|
4341
|
-
* Returns the current status of the Malloy Publisher server, including initialization state, available
|
|
4341
|
+
* Returns the current status of the Malloy Publisher server, including initialization state, available environments, and server timestamp. This endpoint is useful for health checks and monitoring server availability.
|
|
4342
4342
|
* @summary Get server status and health information
|
|
4343
4343
|
* @param {*} [options] Override http request option.
|
|
4344
4344
|
* @throws {RequiredError}
|
|
@@ -4351,7 +4351,7 @@ export declare const PublisherApiFp: (configuration?: Configuration) => {
|
|
|
4351
4351
|
*/
|
|
4352
4352
|
export declare const PublisherApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4353
4353
|
/**
|
|
4354
|
-
* Returns the current status of the Malloy Publisher server, including initialization state, available
|
|
4354
|
+
* Returns the current status of the Malloy Publisher server, including initialization state, available environments, and server timestamp. This endpoint is useful for health checks and monitoring server availability.
|
|
4355
4355
|
* @summary Get server status and health information
|
|
4356
4356
|
* @param {*} [options] Override http request option.
|
|
4357
4357
|
* @throws {RequiredError}
|
|
@@ -4366,7 +4366,7 @@ export declare const PublisherApiFactory: (configuration?: Configuration, basePa
|
|
|
4366
4366
|
*/
|
|
4367
4367
|
export declare class PublisherApi extends BaseAPI {
|
|
4368
4368
|
/**
|
|
4369
|
-
* Returns the current status of the Malloy Publisher server, including initialization state, available
|
|
4369
|
+
* Returns the current status of the Malloy Publisher server, including initialization state, available environments, and server timestamp. This endpoint is useful for health checks and monitoring server availability.
|
|
4370
4370
|
* @summary Get server status and health information
|
|
4371
4371
|
* @param {*} [options] Override http request option.
|
|
4372
4372
|
* @throws {RequiredError}
|
|
@@ -4380,14 +4380,14 @@ export declare class PublisherApi extends BaseAPI {
|
|
|
4380
4380
|
*/
|
|
4381
4381
|
export declare const WatchModeApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4382
4382
|
/**
|
|
4383
|
-
* Retrieves the current status of the file watching system. This includes whether watch mode is enabled, which
|
|
4383
|
+
* Retrieves the current status of the file watching system. This includes whether watch mode is enabled, which environment is being watched, and the path being monitored. Useful for monitoring the development workflow and ensuring file changes are being detected.
|
|
4384
4384
|
* @summary Get watch mode status
|
|
4385
4385
|
* @param {*} [options] Override http request option.
|
|
4386
4386
|
* @throws {RequiredError}
|
|
4387
4387
|
*/
|
|
4388
4388
|
getWatchStatus: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4389
4389
|
/**
|
|
4390
|
-
* Initiates file watching for the specified
|
|
4390
|
+
* Initiates file watching for the specified environment. This enables real-time monitoring of file changes within the environment directory, allowing for automatic reloading and updates during development. Only one environment can be watched at a time.
|
|
4391
4391
|
* @summary Start file watching
|
|
4392
4392
|
* @param {StartWatchRequest} startWatchRequest
|
|
4393
4393
|
* @param {*} [options] Override http request option.
|
|
@@ -4395,7 +4395,7 @@ export declare const WatchModeApiAxiosParamCreator: (configuration?: Configurati
|
|
|
4395
4395
|
*/
|
|
4396
4396
|
startWatching: (startWatchRequest: StartWatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4397
4397
|
/**
|
|
4398
|
-
* Stops the current file watching session. This disables real-time monitoring of file changes and releases system resources. Use this when development is complete or when switching to a different
|
|
4398
|
+
* Stops the current file watching session. This disables real-time monitoring of file changes and releases system resources. Use this when development is complete or when switching to a different environment.
|
|
4399
4399
|
* @summary Stop file watching
|
|
4400
4400
|
* @param {*} [options] Override http request option.
|
|
4401
4401
|
* @throws {RequiredError}
|
|
@@ -4408,14 +4408,14 @@ export declare const WatchModeApiAxiosParamCreator: (configuration?: Configurati
|
|
|
4408
4408
|
*/
|
|
4409
4409
|
export declare const WatchModeApiFp: (configuration?: Configuration) => {
|
|
4410
4410
|
/**
|
|
4411
|
-
* Retrieves the current status of the file watching system. This includes whether watch mode is enabled, which
|
|
4411
|
+
* Retrieves the current status of the file watching system. This includes whether watch mode is enabled, which environment is being watched, and the path being monitored. Useful for monitoring the development workflow and ensuring file changes are being detected.
|
|
4412
4412
|
* @summary Get watch mode status
|
|
4413
4413
|
* @param {*} [options] Override http request option.
|
|
4414
4414
|
* @throws {RequiredError}
|
|
4415
4415
|
*/
|
|
4416
4416
|
getWatchStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchStatus>>;
|
|
4417
4417
|
/**
|
|
4418
|
-
* Initiates file watching for the specified
|
|
4418
|
+
* Initiates file watching for the specified environment. This enables real-time monitoring of file changes within the environment directory, allowing for automatic reloading and updates during development. Only one environment can be watched at a time.
|
|
4419
4419
|
* @summary Start file watching
|
|
4420
4420
|
* @param {StartWatchRequest} startWatchRequest
|
|
4421
4421
|
* @param {*} [options] Override http request option.
|
|
@@ -4423,7 +4423,7 @@ export declare const WatchModeApiFp: (configuration?: Configuration) => {
|
|
|
4423
4423
|
*/
|
|
4424
4424
|
startWatching(startWatchRequest: StartWatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4425
4425
|
/**
|
|
4426
|
-
* Stops the current file watching session. This disables real-time monitoring of file changes and releases system resources. Use this when development is complete or when switching to a different
|
|
4426
|
+
* Stops the current file watching session. This disables real-time monitoring of file changes and releases system resources. Use this when development is complete or when switching to a different environment.
|
|
4427
4427
|
* @summary Stop file watching
|
|
4428
4428
|
* @param {*} [options] Override http request option.
|
|
4429
4429
|
* @throws {RequiredError}
|
|
@@ -4436,14 +4436,14 @@ export declare const WatchModeApiFp: (configuration?: Configuration) => {
|
|
|
4436
4436
|
*/
|
|
4437
4437
|
export declare const WatchModeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4438
4438
|
/**
|
|
4439
|
-
* Retrieves the current status of the file watching system. This includes whether watch mode is enabled, which
|
|
4439
|
+
* Retrieves the current status of the file watching system. This includes whether watch mode is enabled, which environment is being watched, and the path being monitored. Useful for monitoring the development workflow and ensuring file changes are being detected.
|
|
4440
4440
|
* @summary Get watch mode status
|
|
4441
4441
|
* @param {*} [options] Override http request option.
|
|
4442
4442
|
* @throws {RequiredError}
|
|
4443
4443
|
*/
|
|
4444
4444
|
getWatchStatus(options?: RawAxiosRequestConfig): AxiosPromise<WatchStatus>;
|
|
4445
4445
|
/**
|
|
4446
|
-
* Initiates file watching for the specified
|
|
4446
|
+
* Initiates file watching for the specified environment. This enables real-time monitoring of file changes within the environment directory, allowing for automatic reloading and updates during development. Only one environment can be watched at a time.
|
|
4447
4447
|
* @summary Start file watching
|
|
4448
4448
|
* @param {StartWatchRequest} startWatchRequest
|
|
4449
4449
|
* @param {*} [options] Override http request option.
|
|
@@ -4451,7 +4451,7 @@ export declare const WatchModeApiFactory: (configuration?: Configuration, basePa
|
|
|
4451
4451
|
*/
|
|
4452
4452
|
startWatching(startWatchRequest: StartWatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4453
4453
|
/**
|
|
4454
|
-
* Stops the current file watching session. This disables real-time monitoring of file changes and releases system resources. Use this when development is complete or when switching to a different
|
|
4454
|
+
* Stops the current file watching session. This disables real-time monitoring of file changes and releases system resources. Use this when development is complete or when switching to a different environment.
|
|
4455
4455
|
* @summary Stop file watching
|
|
4456
4456
|
* @param {*} [options] Override http request option.
|
|
4457
4457
|
* @throws {RequiredError}
|
|
@@ -4466,7 +4466,7 @@ export declare const WatchModeApiFactory: (configuration?: Configuration, basePa
|
|
|
4466
4466
|
*/
|
|
4467
4467
|
export declare class WatchModeApi extends BaseAPI {
|
|
4468
4468
|
/**
|
|
4469
|
-
* Retrieves the current status of the file watching system. This includes whether watch mode is enabled, which
|
|
4469
|
+
* Retrieves the current status of the file watching system. This includes whether watch mode is enabled, which environment is being watched, and the path being monitored. Useful for monitoring the development workflow and ensuring file changes are being detected.
|
|
4470
4470
|
* @summary Get watch mode status
|
|
4471
4471
|
* @param {*} [options] Override http request option.
|
|
4472
4472
|
* @throws {RequiredError}
|
|
@@ -4474,7 +4474,7 @@ export declare class WatchModeApi extends BaseAPI {
|
|
|
4474
4474
|
*/
|
|
4475
4475
|
getWatchStatus(options?: RawAxiosRequestConfig): Promise< AxiosResponse<WatchStatus, any, {}>>;
|
|
4476
4476
|
/**
|
|
4477
|
-
* Initiates file watching for the specified
|
|
4477
|
+
* Initiates file watching for the specified environment. This enables real-time monitoring of file changes within the environment directory, allowing for automatic reloading and updates during development. Only one environment can be watched at a time.
|
|
4478
4478
|
* @summary Start file watching
|
|
4479
4479
|
* @param {StartWatchRequest} startWatchRequest
|
|
4480
4480
|
* @param {*} [options] Override http request option.
|
|
@@ -4483,7 +4483,7 @@ export declare class WatchModeApi extends BaseAPI {
|
|
|
4483
4483
|
*/
|
|
4484
4484
|
startWatching(startWatchRequest: StartWatchRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<void, any, {}>>;
|
|
4485
4485
|
/**
|
|
4486
|
-
* Stops the current file watching session. This disables real-time monitoring of file changes and releases system resources. Use this when development is complete or when switching to a different
|
|
4486
|
+
* Stops the current file watching session. This disables real-time monitoring of file changes and releases system resources. Use this when development is complete or when switching to a different environment.
|
|
4487
4487
|
* @summary Stop file watching
|
|
4488
4488
|
* @param {*} [options] Override http request option.
|
|
4489
4489
|
* @throws {RequiredError}
|