@gooddata/api-client-tiger 11.35.0-alpha.6 → 11.35.0-alpha.7
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/esm/__version.d.ts +1 -1
- package/esm/__version.js +1 -1
- package/esm/api-client-tiger.d.ts +1204 -495
- package/esm/endpoints/genAI/index.d.ts +2 -2
- package/esm/endpoints/genAI/index.js +4 -2
- package/esm/gd-tiger-model/TigerTypes.d.ts +2 -1
- package/esm/generated/afm-rest-api/api.d.ts +674 -16
- package/esm/generated/afm-rest-api/api.js +672 -2
- package/esm/generated/ai-json-api/api.d.ts +94 -0
- package/esm/generated/ai-json-api/api.js +84 -0
- package/esm/generated/automation-json-api/api.d.ts +31 -1
- package/esm/generated/export-json-api/api.d.ts +31 -1
- package/esm/generated/metadata-json-api/api.d.ts +1786 -447
- package/esm/generated/metadata-json-api/api.js +1433 -280
- package/esm/generated/scan-json-api/api.d.ts +1 -1
- package/esm/index.d.ts +2 -3
- package/esm/index.js +1 -1
- package/package.json +4 -4
|
@@ -80,6 +80,25 @@ export interface ActiveObjectIdentification {
|
|
|
80
80
|
*/
|
|
81
81
|
'workspaceId': string;
|
|
82
82
|
}
|
|
83
|
+
/**
|
|
84
|
+
* Request to add a data source to an AI Lake Database instance
|
|
85
|
+
*/
|
|
86
|
+
export interface AddDatabaseDataSourceRequest {
|
|
87
|
+
/**
|
|
88
|
+
* Identifier for the new data source in metadata-api. Must be unique within the organization.
|
|
89
|
+
*/
|
|
90
|
+
'dataSourceId': string;
|
|
91
|
+
/**
|
|
92
|
+
* Display name for the new data source in metadata-api. Defaults to dataSourceId when omitted.
|
|
93
|
+
*/
|
|
94
|
+
'dataSourceName'?: string;
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* Newly created data source association for an AI Lake Database instance
|
|
98
|
+
*/
|
|
99
|
+
export interface AddDatabaseDataSourceResponse {
|
|
100
|
+
'dataSource': DataSourceInfo;
|
|
101
|
+
}
|
|
83
102
|
/**
|
|
84
103
|
* Any information related to cancellation.
|
|
85
104
|
*/
|
|
@@ -815,6 +834,20 @@ export interface ClusteringResult {
|
|
|
815
834
|
'xcoord': Array<number>;
|
|
816
835
|
'ycoord': Array<number>;
|
|
817
836
|
}
|
|
837
|
+
/**
|
|
838
|
+
* Single column projection override: applies `function(column)` to a source column.
|
|
839
|
+
*/
|
|
840
|
+
export interface ColumnExpression {
|
|
841
|
+
/**
|
|
842
|
+
* StarRocks transform applied to a source column when projecting it through the generated CREATE PIPE ... AS INSERT statement.
|
|
843
|
+
*/
|
|
844
|
+
'function': ColumnExpressionFunctionEnum;
|
|
845
|
+
/**
|
|
846
|
+
* Source column produced by parquet schema inference (after columnOverrides).
|
|
847
|
+
*/
|
|
848
|
+
'column': string;
|
|
849
|
+
}
|
|
850
|
+
export type ColumnExpressionFunctionEnum = 'HLL_HASH' | 'BITMAP_HASH' | 'BITMAP_HASH64' | 'TO_BITMAP';
|
|
818
851
|
/**
|
|
819
852
|
* A single column definition inferred from the parquet schema
|
|
820
853
|
*/
|
|
@@ -934,6 +967,12 @@ export interface CreatePipeTableRequest {
|
|
|
934
967
|
'aggregationOverrides'?: {
|
|
935
968
|
[key: string]: string;
|
|
936
969
|
};
|
|
970
|
+
/**
|
|
971
|
+
* Per-target-column projection overrides. Each entry emits `<function>(<column>) AS <key>` in the SELECT list of the generated CREATE PIPE ... AS INSERT; keys absent from the map are projected as-is. Required for AGGREGATE-KEY tables that include native HLL columns (StarRocks rejects raw VARBINARY into HLL columns).
|
|
972
|
+
*/
|
|
973
|
+
'columnExpressions'?: {
|
|
974
|
+
[key: string]: ColumnExpression;
|
|
975
|
+
};
|
|
937
976
|
/**
|
|
938
977
|
* How often (in seconds) the pipe polls for new files. 0 or null = use server default.
|
|
939
978
|
*/
|
|
@@ -1034,6 +1073,23 @@ export interface DataColumnLocators {
|
|
|
1034
1073
|
[key: string]: DataColumnLocator;
|
|
1035
1074
|
};
|
|
1036
1075
|
}
|
|
1076
|
+
/**
|
|
1077
|
+
* A single data source association for an AI Lake Database instance
|
|
1078
|
+
*/
|
|
1079
|
+
export interface DataSourceInfo {
|
|
1080
|
+
/**
|
|
1081
|
+
* Id of the data source association record.
|
|
1082
|
+
*/
|
|
1083
|
+
'id': string;
|
|
1084
|
+
/**
|
|
1085
|
+
* Identifier of the data source in metadata-api.
|
|
1086
|
+
*/
|
|
1087
|
+
'dataSourceId': string;
|
|
1088
|
+
/**
|
|
1089
|
+
* Display name of the data source in metadata-api.
|
|
1090
|
+
*/
|
|
1091
|
+
'dataSourceName': string;
|
|
1092
|
+
}
|
|
1037
1093
|
/**
|
|
1038
1094
|
* A single AI Lake Database instance
|
|
1039
1095
|
*/
|
|
@@ -1051,13 +1107,9 @@ export interface DatabaseInstance {
|
|
|
1051
1107
|
*/
|
|
1052
1108
|
'storageIds': Array<string>;
|
|
1053
1109
|
/**
|
|
1054
|
-
*
|
|
1110
|
+
* All data source associations for this database instance.
|
|
1055
1111
|
*/
|
|
1056
|
-
'
|
|
1057
|
-
/**
|
|
1058
|
-
* Display name of the data source created in metadata-api.
|
|
1059
|
-
*/
|
|
1060
|
-
'dataSourceName'?: string;
|
|
1112
|
+
'dataSources': Array<DataSourceInfo>;
|
|
1061
1113
|
}
|
|
1062
1114
|
export interface DateAbsoluteFilter {
|
|
1063
1115
|
'using': string;
|
|
@@ -1664,6 +1716,15 @@ export interface KeyDriversResponse {
|
|
|
1664
1716
|
export interface KeyDriversResult {
|
|
1665
1717
|
'data': object;
|
|
1666
1718
|
}
|
|
1719
|
+
/**
|
|
1720
|
+
* All data source associations for an AI Lake Database instance
|
|
1721
|
+
*/
|
|
1722
|
+
export interface ListDatabaseDataSourcesResponse {
|
|
1723
|
+
/**
|
|
1724
|
+
* List of data source associations.
|
|
1725
|
+
*/
|
|
1726
|
+
'dataSources': Array<DataSourceInfo>;
|
|
1727
|
+
}
|
|
1667
1728
|
/**
|
|
1668
1729
|
* Paged response for listing AI Lake database instances
|
|
1669
1730
|
*/
|
|
@@ -1694,6 +1755,15 @@ export interface ListLlmProviderModelsResponse {
|
|
|
1694
1755
|
*/
|
|
1695
1756
|
'models': Array<LlmModel>;
|
|
1696
1757
|
}
|
|
1758
|
+
/**
|
|
1759
|
+
* Response for listing ObjectStorages registered for the organization.
|
|
1760
|
+
*/
|
|
1761
|
+
export interface ListObjectStoragesResponse {
|
|
1762
|
+
/**
|
|
1763
|
+
* Registered storages, ordered by name.
|
|
1764
|
+
*/
|
|
1765
|
+
'storages': Array<ObjectStorageInfo>;
|
|
1766
|
+
}
|
|
1697
1767
|
/**
|
|
1698
1768
|
* List of pipe tables for a database instance
|
|
1699
1769
|
*/
|
|
@@ -1977,6 +2047,29 @@ export interface ObjectReferenceGroup {
|
|
|
1977
2047
|
*/
|
|
1978
2048
|
'objects': Array<ObjectReference>;
|
|
1979
2049
|
}
|
|
2050
|
+
/**
|
|
2051
|
+
* Descriptor of a registered ObjectStorage. Provider credentials are stripped — only fields useful for identifying the storage are returned.
|
|
2052
|
+
*/
|
|
2053
|
+
export interface ObjectStorageInfo {
|
|
2054
|
+
/**
|
|
2055
|
+
* Stable identifier of the storage configuration (UUID).
|
|
2056
|
+
*/
|
|
2057
|
+
'storageId': string;
|
|
2058
|
+
/**
|
|
2059
|
+
* Human-readable name. Use this as `sourceStorageName` in CreatePipeTable, or pass `storageId` to ProvisionDatabase.storageIds.
|
|
2060
|
+
*/
|
|
2061
|
+
'name': string;
|
|
2062
|
+
/**
|
|
2063
|
+
* Provider type.
|
|
2064
|
+
*/
|
|
2065
|
+
'storageType': string;
|
|
2066
|
+
/**
|
|
2067
|
+
* Provider-specific descriptors (e.g. bucket, region, endpoint, container). Credential references (any keys ending in `_env`) are stripped server-side.
|
|
2068
|
+
*/
|
|
2069
|
+
'storageConfig': {
|
|
2070
|
+
[key: string]: string;
|
|
2071
|
+
};
|
|
2072
|
+
}
|
|
1980
2073
|
/**
|
|
1981
2074
|
* Configuration for OpenAI provider.
|
|
1982
2075
|
*/
|
|
@@ -2491,6 +2584,15 @@ export interface RelativeDateFilterRelativeDateFilter {
|
|
|
2491
2584
|
}
|
|
2492
2585
|
export type RelativeDateFilterRelativeDateFilterGranularityEnum = 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR' | 'MINUTE_OF_HOUR' | 'HOUR_OF_DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK_OF_YEAR' | 'MONTH_OF_YEAR' | 'QUARTER_OF_YEAR' | 'FISCAL_MONTH' | 'FISCAL_QUARTER' | 'FISCAL_YEAR';
|
|
2493
2586
|
export type RelativeDateFilterRelativeDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
|
|
2587
|
+
/**
|
|
2588
|
+
* Confirmation of data source removal from an AI Lake Database instance
|
|
2589
|
+
*/
|
|
2590
|
+
export interface RemoveDatabaseDataSourceResponse {
|
|
2591
|
+
/**
|
|
2592
|
+
* Identifier of the removed data source in metadata-api.
|
|
2593
|
+
*/
|
|
2594
|
+
'dataSourceId': string;
|
|
2595
|
+
}
|
|
2494
2596
|
/**
|
|
2495
2597
|
* The resolved LLM configuration, or null if none is configured.
|
|
2496
2598
|
*/
|
|
@@ -3109,6 +3211,36 @@ export interface UniqueKeyConfig {
|
|
|
3109
3211
|
*/
|
|
3110
3212
|
'columns'?: Array<string>;
|
|
3111
3213
|
}
|
|
3214
|
+
/**
|
|
3215
|
+
* Request to update the data source associated with an AI Lake Database instance
|
|
3216
|
+
*/
|
|
3217
|
+
export interface UpdateDatabaseDataSourceRequest {
|
|
3218
|
+
/**
|
|
3219
|
+
* New identifier for the data source in metadata-api. Must be unique within the organization.
|
|
3220
|
+
*/
|
|
3221
|
+
'dataSourceId': string;
|
|
3222
|
+
/**
|
|
3223
|
+
* New display name for the data source in metadata-api. Defaults to dataSourceId when omitted.
|
|
3224
|
+
*/
|
|
3225
|
+
'dataSourceName'?: string;
|
|
3226
|
+
/**
|
|
3227
|
+
* Identifier of the existing data source to replace.
|
|
3228
|
+
*/
|
|
3229
|
+
'oldDataSourceId': string;
|
|
3230
|
+
}
|
|
3231
|
+
/**
|
|
3232
|
+
* Updated data source details for an AI Lake Database instance
|
|
3233
|
+
*/
|
|
3234
|
+
export interface UpdateDatabaseDataSourceResponse {
|
|
3235
|
+
/**
|
|
3236
|
+
* New identifier of the data source in metadata-api.
|
|
3237
|
+
*/
|
|
3238
|
+
'dataSourceId': string;
|
|
3239
|
+
/**
|
|
3240
|
+
* New display name of the data source in metadata-api.
|
|
3241
|
+
*/
|
|
3242
|
+
'dataSourceName': string;
|
|
3243
|
+
}
|
|
3112
3244
|
/**
|
|
3113
3245
|
* User context with ambient UI state (view) and explicitly referenced objects.
|
|
3114
3246
|
*/
|
|
@@ -3302,6 +3434,16 @@ export interface WorkflowStatusResponseDto {
|
|
|
3302
3434
|
'error'?: string;
|
|
3303
3435
|
'currentPhase'?: string;
|
|
3304
3436
|
}
|
|
3437
|
+
/**
|
|
3438
|
+
* (BETA) Associates an additional metadata-api data source with an existing AI Lake database instance. The new data source uses the same StarRocks connection details as the primary data source.
|
|
3439
|
+
* @summary (BETA) Add a data source to an AILake Database instance
|
|
3440
|
+
* @param {string} instanceId Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
3441
|
+
* @param {AddDatabaseDataSourceRequest} addDatabaseDataSourceRequest
|
|
3442
|
+
* @param {*} [options] Override http request option.
|
|
3443
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
3444
|
+
* @throws {RequiredError}
|
|
3445
|
+
*/
|
|
3446
|
+
export declare function AILakeApiAxiosParamCreator_AddAiLakeDatabaseDataSource(instanceId: string, addDatabaseDataSourceRequest: AddDatabaseDataSourceRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
3305
3447
|
/**
|
|
3306
3448
|
* (BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed.
|
|
3307
3449
|
* @summary (BETA) Run ANALYZE TABLE for tables in a database instance
|
|
@@ -3382,6 +3524,15 @@ export declare function AILakeApiAxiosParamCreator_GetAiLakePipeTable(instanceId
|
|
|
3382
3524
|
* @throws {RequiredError}
|
|
3383
3525
|
*/
|
|
3384
3526
|
export declare function AILakeApiAxiosParamCreator_GetAiLakeServiceStatus(serviceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
3527
|
+
/**
|
|
3528
|
+
* (BETA) Returns all data source associations for the specified AI Lake database instance.
|
|
3529
|
+
* @summary (BETA) List data sources of an AILake Database instance
|
|
3530
|
+
* @param {string} instanceId Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
3531
|
+
* @param {*} [options] Override http request option.
|
|
3532
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
3533
|
+
* @throws {RequiredError}
|
|
3534
|
+
*/
|
|
3535
|
+
export declare function AILakeApiAxiosParamCreator_ListAiLakeDatabaseDataSources(instanceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
3385
3536
|
/**
|
|
3386
3537
|
* (BETA) Lists database instances in the organization\'s AI Lake. Supports paging via size and offset query parameters. Use metaInclude=page to get total count.
|
|
3387
3538
|
* @summary (BETA) List AI Lake Database instances
|
|
@@ -3393,6 +3544,14 @@ export declare function AILakeApiAxiosParamCreator_GetAiLakeServiceStatus(servic
|
|
|
3393
3544
|
* @throws {RequiredError}
|
|
3394
3545
|
*/
|
|
3395
3546
|
export declare function AILakeApiAxiosParamCreator_ListAiLakeDatabaseInstances(size?: number, offset?: number, metaInclude?: Array<string>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
3547
|
+
/**
|
|
3548
|
+
* (BETA) Lists ObjectStorages registered for the organization. Use the returned `name` as `sourceStorageName` in CreatePipeTable, or pass `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned.
|
|
3549
|
+
* @summary (BETA) List registered AI Lake ObjectStorages
|
|
3550
|
+
* @param {*} [options] Override http request option.
|
|
3551
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
3552
|
+
* @throws {RequiredError}
|
|
3553
|
+
*/
|
|
3554
|
+
export declare function AILakeApiAxiosParamCreator_ListAiLakeObjectStorages(options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
3396
3555
|
/**
|
|
3397
3556
|
* (BETA) Lists all active pipe tables in the given AI Lake database instance.
|
|
3398
3557
|
* @summary (BETA) List AI Lake pipe tables
|
|
@@ -3423,6 +3582,16 @@ export declare function AILakeApiAxiosParamCreator_ListAiLakeServices(size?: num
|
|
|
3423
3582
|
* @throws {RequiredError}
|
|
3424
3583
|
*/
|
|
3425
3584
|
export declare function AILakeApiAxiosParamCreator_ProvisionAiLakeDatabaseInstance(provisionDatabaseInstanceRequest: ProvisionDatabaseInstanceRequest, operationId?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
3585
|
+
/**
|
|
3586
|
+
* (BETA) Removes a data source association from an AI Lake database instance and deletes the corresponding data source from metadata-api. Fails if removing the data source would leave the instance with no data sources.
|
|
3587
|
+
* @summary (BETA) Remove a data source from an AILake Database instance
|
|
3588
|
+
* @param {string} instanceId Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
3589
|
+
* @param {string} dataSourceId Identifier of the data source to remove.
|
|
3590
|
+
* @param {*} [options] Override http request option.
|
|
3591
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
3592
|
+
* @throws {RequiredError}
|
|
3593
|
+
*/
|
|
3594
|
+
export declare function AILakeApiAxiosParamCreator_RemoveAiLakeDatabaseDataSource(instanceId: string, dataSourceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
3426
3595
|
/**
|
|
3427
3596
|
* (BETA) Runs a specific AI Lake service command.
|
|
3428
3597
|
* @summary (BETA) Run an AI Lake services command
|
|
@@ -3435,6 +3604,27 @@ export declare function AILakeApiAxiosParamCreator_ProvisionAiLakeDatabaseInstan
|
|
|
3435
3604
|
* @throws {RequiredError}
|
|
3436
3605
|
*/
|
|
3437
3606
|
export declare function AILakeApiAxiosParamCreator_RunAiLakeServiceCommand(serviceId: string, commandName: string, runServiceCommandRequest: RunServiceCommandRequest, operationId?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
3607
|
+
/**
|
|
3608
|
+
* (BETA) Updates the data source ID and name for an existing AI Lake database instance without deleting the underlying database. Use this to recover from a wrong data source ID provisioned on an existing database instance.
|
|
3609
|
+
* @summary (BETA) Update the data source of an AILake Database instance
|
|
3610
|
+
* @param {string} instanceId Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
3611
|
+
* @param {UpdateDatabaseDataSourceRequest} updateDatabaseDataSourceRequest
|
|
3612
|
+
* @param {*} [options] Override http request option.
|
|
3613
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
3614
|
+
* @throws {RequiredError}
|
|
3615
|
+
*/
|
|
3616
|
+
export declare function AILakeApiAxiosParamCreator_UpdateAiLakeDatabaseDataSource(instanceId: string, updateDatabaseDataSourceRequest: UpdateDatabaseDataSourceRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
3617
|
+
/**
|
|
3618
|
+
* (BETA) Associates an additional metadata-api data source with an existing AI Lake database instance. The new data source uses the same StarRocks connection details as the primary data source.
|
|
3619
|
+
* @summary (BETA) Add a data source to an AILake Database instance
|
|
3620
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
3621
|
+
* @param {string} basePath Base path.
|
|
3622
|
+
* @param {AILakeApiAddAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
3623
|
+
* @param {*} [options] Override http request option.
|
|
3624
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
3625
|
+
* @throws {RequiredError}
|
|
3626
|
+
*/
|
|
3627
|
+
export declare function AILakeApi_AddAiLakeDatabaseDataSource(axios: AxiosInstance, basePath: string, requestParameters: AILakeApiAddAiLakeDatabaseDataSourceRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AddDatabaseDataSourceResponse>;
|
|
3438
3628
|
/**
|
|
3439
3629
|
* (BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed.
|
|
3440
3630
|
* @summary (BETA) Run ANALYZE TABLE for tables in a database instance
|
|
@@ -3523,6 +3713,17 @@ export declare function AILakeApi_GetAiLakePipeTable(axios: AxiosInstance, baseP
|
|
|
3523
3713
|
* @throws {RequiredError}
|
|
3524
3714
|
*/
|
|
3525
3715
|
export declare function AILakeApi_GetAiLakeServiceStatus(axios: AxiosInstance, basePath: string, requestParameters: AILakeApiGetAiLakeServiceStatusRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<GetServiceStatusResponse>;
|
|
3716
|
+
/**
|
|
3717
|
+
* (BETA) Returns all data source associations for the specified AI Lake database instance.
|
|
3718
|
+
* @summary (BETA) List data sources of an AILake Database instance
|
|
3719
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
3720
|
+
* @param {string} basePath Base path.
|
|
3721
|
+
* @param {AILakeApiListAiLakeDatabaseDataSourcesRequest} requestParameters Request parameters.
|
|
3722
|
+
* @param {*} [options] Override http request option.
|
|
3723
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
3724
|
+
* @throws {RequiredError}
|
|
3725
|
+
*/
|
|
3726
|
+
export declare function AILakeApi_ListAiLakeDatabaseDataSources(axios: AxiosInstance, basePath: string, requestParameters: AILakeApiListAiLakeDatabaseDataSourcesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ListDatabaseDataSourcesResponse>;
|
|
3526
3727
|
/**
|
|
3527
3728
|
* (BETA) Lists database instances in the organization\'s AI Lake. Supports paging via size and offset query parameters. Use metaInclude=page to get total count.
|
|
3528
3729
|
* @summary (BETA) List AI Lake Database instances
|
|
@@ -3534,6 +3735,16 @@ export declare function AILakeApi_GetAiLakeServiceStatus(axios: AxiosInstance, b
|
|
|
3534
3735
|
* @throws {RequiredError}
|
|
3535
3736
|
*/
|
|
3536
3737
|
export declare function AILakeApi_ListAiLakeDatabaseInstances(axios: AxiosInstance, basePath: string, requestParameters: AILakeApiListAiLakeDatabaseInstancesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ListDatabaseInstancesResponse>;
|
|
3738
|
+
/**
|
|
3739
|
+
* (BETA) Lists ObjectStorages registered for the organization. Use the returned `name` as `sourceStorageName` in CreatePipeTable, or pass `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned.
|
|
3740
|
+
* @summary (BETA) List registered AI Lake ObjectStorages
|
|
3741
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
3742
|
+
* @param {string} basePath Base path.
|
|
3743
|
+
* @param {*} [options] Override http request option.
|
|
3744
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
3745
|
+
* @throws {RequiredError}
|
|
3746
|
+
*/
|
|
3747
|
+
export declare function AILakeApi_ListAiLakeObjectStorages(axios: AxiosInstance, basePath: string, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ListObjectStoragesResponse>;
|
|
3537
3748
|
/**
|
|
3538
3749
|
* (BETA) Lists all active pipe tables in the given AI Lake database instance.
|
|
3539
3750
|
* @summary (BETA) List AI Lake pipe tables
|
|
@@ -3567,6 +3778,17 @@ export declare function AILakeApi_ListAiLakeServices(axios: AxiosInstance, baseP
|
|
|
3567
3778
|
* @throws {RequiredError}
|
|
3568
3779
|
*/
|
|
3569
3780
|
export declare function AILakeApi_ProvisionAiLakeDatabaseInstance(axios: AxiosInstance, basePath: string, requestParameters: AILakeApiProvisionAiLakeDatabaseInstanceRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<object>;
|
|
3781
|
+
/**
|
|
3782
|
+
* (BETA) Removes a data source association from an AI Lake database instance and deletes the corresponding data source from metadata-api. Fails if removing the data source would leave the instance with no data sources.
|
|
3783
|
+
* @summary (BETA) Remove a data source from an AILake Database instance
|
|
3784
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
3785
|
+
* @param {string} basePath Base path.
|
|
3786
|
+
* @param {AILakeApiRemoveAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
3787
|
+
* @param {*} [options] Override http request option.
|
|
3788
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
3789
|
+
* @throws {RequiredError}
|
|
3790
|
+
*/
|
|
3791
|
+
export declare function AILakeApi_RemoveAiLakeDatabaseDataSource(axios: AxiosInstance, basePath: string, requestParameters: AILakeApiRemoveAiLakeDatabaseDataSourceRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<RemoveDatabaseDataSourceResponse>;
|
|
3570
3792
|
/**
|
|
3571
3793
|
* (BETA) Runs a specific AI Lake service command.
|
|
3572
3794
|
* @summary (BETA) Run an AI Lake services command
|
|
@@ -3578,12 +3800,32 @@ export declare function AILakeApi_ProvisionAiLakeDatabaseInstance(axios: AxiosIn
|
|
|
3578
3800
|
* @throws {RequiredError}
|
|
3579
3801
|
*/
|
|
3580
3802
|
export declare function AILakeApi_RunAiLakeServiceCommand(axios: AxiosInstance, basePath: string, requestParameters: AILakeApiRunAiLakeServiceCommandRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<object>;
|
|
3803
|
+
/**
|
|
3804
|
+
* (BETA) Updates the data source ID and name for an existing AI Lake database instance without deleting the underlying database. Use this to recover from a wrong data source ID provisioned on an existing database instance.
|
|
3805
|
+
* @summary (BETA) Update the data source of an AILake Database instance
|
|
3806
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
3807
|
+
* @param {string} basePath Base path.
|
|
3808
|
+
* @param {AILakeApiUpdateAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
3809
|
+
* @param {*} [options] Override http request option.
|
|
3810
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
3811
|
+
* @throws {RequiredError}
|
|
3812
|
+
*/
|
|
3813
|
+
export declare function AILakeApi_UpdateAiLakeDatabaseDataSource(axios: AxiosInstance, basePath: string, requestParameters: AILakeApiUpdateAiLakeDatabaseDataSourceRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<UpdateDatabaseDataSourceResponse>;
|
|
3581
3814
|
/**
|
|
3582
3815
|
* AILakeApi - interface
|
|
3583
3816
|
* @export
|
|
3584
3817
|
* @interface AILakeApi
|
|
3585
3818
|
*/
|
|
3586
3819
|
export interface AILakeApiInterface {
|
|
3820
|
+
/**
|
|
3821
|
+
* (BETA) Associates an additional metadata-api data source with an existing AI Lake database instance. The new data source uses the same StarRocks connection details as the primary data source.
|
|
3822
|
+
* @summary (BETA) Add a data source to an AILake Database instance
|
|
3823
|
+
* @param {AILakeApiAddAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
3824
|
+
* @param {*} [options] Override http request option.
|
|
3825
|
+
* @throws {RequiredError}
|
|
3826
|
+
* @memberof AILakeApiInterface
|
|
3827
|
+
*/
|
|
3828
|
+
addAiLakeDatabaseDataSource(requestParameters: AILakeApiAddAiLakeDatabaseDataSourceRequest, options?: AxiosRequestConfig): AxiosPromise<AddDatabaseDataSourceResponse>;
|
|
3587
3829
|
/**
|
|
3588
3830
|
* (BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed.
|
|
3589
3831
|
* @summary (BETA) Run ANALYZE TABLE for tables in a database instance
|
|
@@ -3656,6 +3898,15 @@ export interface AILakeApiInterface {
|
|
|
3656
3898
|
* @memberof AILakeApiInterface
|
|
3657
3899
|
*/
|
|
3658
3900
|
getAiLakeServiceStatus(requestParameters: AILakeApiGetAiLakeServiceStatusRequest, options?: AxiosRequestConfig): AxiosPromise<GetServiceStatusResponse>;
|
|
3901
|
+
/**
|
|
3902
|
+
* (BETA) Returns all data source associations for the specified AI Lake database instance.
|
|
3903
|
+
* @summary (BETA) List data sources of an AILake Database instance
|
|
3904
|
+
* @param {AILakeApiListAiLakeDatabaseDataSourcesRequest} requestParameters Request parameters.
|
|
3905
|
+
* @param {*} [options] Override http request option.
|
|
3906
|
+
* @throws {RequiredError}
|
|
3907
|
+
* @memberof AILakeApiInterface
|
|
3908
|
+
*/
|
|
3909
|
+
listAiLakeDatabaseDataSources(requestParameters: AILakeApiListAiLakeDatabaseDataSourcesRequest, options?: AxiosRequestConfig): AxiosPromise<ListDatabaseDataSourcesResponse>;
|
|
3659
3910
|
/**
|
|
3660
3911
|
* (BETA) Lists database instances in the organization\'s AI Lake. Supports paging via size and offset query parameters. Use metaInclude=page to get total count.
|
|
3661
3912
|
* @summary (BETA) List AI Lake Database instances
|
|
@@ -3665,6 +3916,14 @@ export interface AILakeApiInterface {
|
|
|
3665
3916
|
* @memberof AILakeApiInterface
|
|
3666
3917
|
*/
|
|
3667
3918
|
listAiLakeDatabaseInstances(requestParameters: AILakeApiListAiLakeDatabaseInstancesRequest, options?: AxiosRequestConfig): AxiosPromise<ListDatabaseInstancesResponse>;
|
|
3919
|
+
/**
|
|
3920
|
+
* (BETA) Lists ObjectStorages registered for the organization. Use the returned `name` as `sourceStorageName` in CreatePipeTable, or pass `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned.
|
|
3921
|
+
* @summary (BETA) List registered AI Lake ObjectStorages
|
|
3922
|
+
* @param {*} [options] Override http request option.
|
|
3923
|
+
* @throws {RequiredError}
|
|
3924
|
+
* @memberof AILakeApiInterface
|
|
3925
|
+
*/
|
|
3926
|
+
listAiLakeObjectStorages(options?: AxiosRequestConfig): AxiosPromise<ListObjectStoragesResponse>;
|
|
3668
3927
|
/**
|
|
3669
3928
|
* (BETA) Lists all active pipe tables in the given AI Lake database instance.
|
|
3670
3929
|
* @summary (BETA) List AI Lake pipe tables
|
|
@@ -3692,6 +3951,15 @@ export interface AILakeApiInterface {
|
|
|
3692
3951
|
* @memberof AILakeApiInterface
|
|
3693
3952
|
*/
|
|
3694
3953
|
provisionAiLakeDatabaseInstance(requestParameters: AILakeApiProvisionAiLakeDatabaseInstanceRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
3954
|
+
/**
|
|
3955
|
+
* (BETA) Removes a data source association from an AI Lake database instance and deletes the corresponding data source from metadata-api. Fails if removing the data source would leave the instance with no data sources.
|
|
3956
|
+
* @summary (BETA) Remove a data source from an AILake Database instance
|
|
3957
|
+
* @param {AILakeApiRemoveAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
3958
|
+
* @param {*} [options] Override http request option.
|
|
3959
|
+
* @throws {RequiredError}
|
|
3960
|
+
* @memberof AILakeApiInterface
|
|
3961
|
+
*/
|
|
3962
|
+
removeAiLakeDatabaseDataSource(requestParameters: AILakeApiRemoveAiLakeDatabaseDataSourceRequest, options?: AxiosRequestConfig): AxiosPromise<RemoveDatabaseDataSourceResponse>;
|
|
3695
3963
|
/**
|
|
3696
3964
|
* (BETA) Runs a specific AI Lake service command.
|
|
3697
3965
|
* @summary (BETA) Run an AI Lake services command
|
|
@@ -3701,6 +3969,34 @@ export interface AILakeApiInterface {
|
|
|
3701
3969
|
* @memberof AILakeApiInterface
|
|
3702
3970
|
*/
|
|
3703
3971
|
runAiLakeServiceCommand(requestParameters: AILakeApiRunAiLakeServiceCommandRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
3972
|
+
/**
|
|
3973
|
+
* (BETA) Updates the data source ID and name for an existing AI Lake database instance without deleting the underlying database. Use this to recover from a wrong data source ID provisioned on an existing database instance.
|
|
3974
|
+
* @summary (BETA) Update the data source of an AILake Database instance
|
|
3975
|
+
* @param {AILakeApiUpdateAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
3976
|
+
* @param {*} [options] Override http request option.
|
|
3977
|
+
* @throws {RequiredError}
|
|
3978
|
+
* @memberof AILakeApiInterface
|
|
3979
|
+
*/
|
|
3980
|
+
updateAiLakeDatabaseDataSource(requestParameters: AILakeApiUpdateAiLakeDatabaseDataSourceRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateDatabaseDataSourceResponse>;
|
|
3981
|
+
}
|
|
3982
|
+
/**
|
|
3983
|
+
* Request parameters for addAiLakeDatabaseDataSource operation in AILakeApi.
|
|
3984
|
+
* @export
|
|
3985
|
+
* @interface AILakeApiAddAiLakeDatabaseDataSourceRequest
|
|
3986
|
+
*/
|
|
3987
|
+
export interface AILakeApiAddAiLakeDatabaseDataSourceRequest {
|
|
3988
|
+
/**
|
|
3989
|
+
* Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
3990
|
+
* @type {string}
|
|
3991
|
+
* @memberof AILakeApiAddAiLakeDatabaseDataSource
|
|
3992
|
+
*/
|
|
3993
|
+
readonly instanceId: string;
|
|
3994
|
+
/**
|
|
3995
|
+
*
|
|
3996
|
+
* @type {AddDatabaseDataSourceRequest}
|
|
3997
|
+
* @memberof AILakeApiAddAiLakeDatabaseDataSource
|
|
3998
|
+
*/
|
|
3999
|
+
readonly addDatabaseDataSourceRequest: AddDatabaseDataSourceRequest;
|
|
3704
4000
|
}
|
|
3705
4001
|
/**
|
|
3706
4002
|
* Request parameters for analyzeStatistics operation in AILakeApi.
|
|
@@ -3854,6 +4150,19 @@ export interface AILakeApiGetAiLakeServiceStatusRequest {
|
|
|
3854
4150
|
*/
|
|
3855
4151
|
readonly serviceId: string;
|
|
3856
4152
|
}
|
|
4153
|
+
/**
|
|
4154
|
+
* Request parameters for listAiLakeDatabaseDataSources operation in AILakeApi.
|
|
4155
|
+
* @export
|
|
4156
|
+
* @interface AILakeApiListAiLakeDatabaseDataSourcesRequest
|
|
4157
|
+
*/
|
|
4158
|
+
export interface AILakeApiListAiLakeDatabaseDataSourcesRequest {
|
|
4159
|
+
/**
|
|
4160
|
+
* Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
4161
|
+
* @type {string}
|
|
4162
|
+
* @memberof AILakeApiListAiLakeDatabaseDataSources
|
|
4163
|
+
*/
|
|
4164
|
+
readonly instanceId: string;
|
|
4165
|
+
}
|
|
3857
4166
|
/**
|
|
3858
4167
|
* Request parameters for listAiLakeDatabaseInstances operation in AILakeApi.
|
|
3859
4168
|
* @export
|
|
@@ -3936,6 +4245,25 @@ export interface AILakeApiProvisionAiLakeDatabaseInstanceRequest {
|
|
|
3936
4245
|
*/
|
|
3937
4246
|
readonly operationId?: string;
|
|
3938
4247
|
}
|
|
4248
|
+
/**
|
|
4249
|
+
* Request parameters for removeAiLakeDatabaseDataSource operation in AILakeApi.
|
|
4250
|
+
* @export
|
|
4251
|
+
* @interface AILakeApiRemoveAiLakeDatabaseDataSourceRequest
|
|
4252
|
+
*/
|
|
4253
|
+
export interface AILakeApiRemoveAiLakeDatabaseDataSourceRequest {
|
|
4254
|
+
/**
|
|
4255
|
+
* Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
4256
|
+
* @type {string}
|
|
4257
|
+
* @memberof AILakeApiRemoveAiLakeDatabaseDataSource
|
|
4258
|
+
*/
|
|
4259
|
+
readonly instanceId: string;
|
|
4260
|
+
/**
|
|
4261
|
+
* Identifier of the data source to remove.
|
|
4262
|
+
* @type {string}
|
|
4263
|
+
* @memberof AILakeApiRemoveAiLakeDatabaseDataSource
|
|
4264
|
+
*/
|
|
4265
|
+
readonly dataSourceId: string;
|
|
4266
|
+
}
|
|
3939
4267
|
/**
|
|
3940
4268
|
* Request parameters for runAiLakeServiceCommand operation in AILakeApi.
|
|
3941
4269
|
* @export
|
|
@@ -3967,6 +4295,25 @@ export interface AILakeApiRunAiLakeServiceCommandRequest {
|
|
|
3967
4295
|
*/
|
|
3968
4296
|
readonly operationId?: string;
|
|
3969
4297
|
}
|
|
4298
|
+
/**
|
|
4299
|
+
* Request parameters for updateAiLakeDatabaseDataSource operation in AILakeApi.
|
|
4300
|
+
* @export
|
|
4301
|
+
* @interface AILakeApiUpdateAiLakeDatabaseDataSourceRequest
|
|
4302
|
+
*/
|
|
4303
|
+
export interface AILakeApiUpdateAiLakeDatabaseDataSourceRequest {
|
|
4304
|
+
/**
|
|
4305
|
+
* Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
4306
|
+
* @type {string}
|
|
4307
|
+
* @memberof AILakeApiUpdateAiLakeDatabaseDataSource
|
|
4308
|
+
*/
|
|
4309
|
+
readonly instanceId: string;
|
|
4310
|
+
/**
|
|
4311
|
+
*
|
|
4312
|
+
* @type {UpdateDatabaseDataSourceRequest}
|
|
4313
|
+
* @memberof AILakeApiUpdateAiLakeDatabaseDataSource
|
|
4314
|
+
*/
|
|
4315
|
+
readonly updateDatabaseDataSourceRequest: UpdateDatabaseDataSourceRequest;
|
|
4316
|
+
}
|
|
3970
4317
|
/**
|
|
3971
4318
|
* AILakeApi - object-oriented interface
|
|
3972
4319
|
* @export
|
|
@@ -3974,6 +4321,15 @@ export interface AILakeApiRunAiLakeServiceCommandRequest {
|
|
|
3974
4321
|
* @extends {BaseAPI}
|
|
3975
4322
|
*/
|
|
3976
4323
|
export declare class AILakeApi extends BaseAPI implements AILakeApiInterface {
|
|
4324
|
+
/**
|
|
4325
|
+
* (BETA) Associates an additional metadata-api data source with an existing AI Lake database instance. The new data source uses the same StarRocks connection details as the primary data source.
|
|
4326
|
+
* @summary (BETA) Add a data source to an AILake Database instance
|
|
4327
|
+
* @param {AILakeApiAddAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
4328
|
+
* @param {*} [options] Override http request option.
|
|
4329
|
+
* @throws {RequiredError}
|
|
4330
|
+
* @memberof AILakeApi
|
|
4331
|
+
*/
|
|
4332
|
+
addAiLakeDatabaseDataSource(requestParameters: AILakeApiAddAiLakeDatabaseDataSourceRequest, options?: AxiosRequestConfig): AxiosPromise<AddDatabaseDataSourceResponse>;
|
|
3977
4333
|
/**
|
|
3978
4334
|
* (BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed.
|
|
3979
4335
|
* @summary (BETA) Run ANALYZE TABLE for tables in a database instance
|
|
@@ -4046,6 +4402,15 @@ export declare class AILakeApi extends BaseAPI implements AILakeApiInterface {
|
|
|
4046
4402
|
* @memberof AILakeApi
|
|
4047
4403
|
*/
|
|
4048
4404
|
getAiLakeServiceStatus(requestParameters: AILakeApiGetAiLakeServiceStatusRequest, options?: AxiosRequestConfig): AxiosPromise<GetServiceStatusResponse>;
|
|
4405
|
+
/**
|
|
4406
|
+
* (BETA) Returns all data source associations for the specified AI Lake database instance.
|
|
4407
|
+
* @summary (BETA) List data sources of an AILake Database instance
|
|
4408
|
+
* @param {AILakeApiListAiLakeDatabaseDataSourcesRequest} requestParameters Request parameters.
|
|
4409
|
+
* @param {*} [options] Override http request option.
|
|
4410
|
+
* @throws {RequiredError}
|
|
4411
|
+
* @memberof AILakeApi
|
|
4412
|
+
*/
|
|
4413
|
+
listAiLakeDatabaseDataSources(requestParameters: AILakeApiListAiLakeDatabaseDataSourcesRequest, options?: AxiosRequestConfig): AxiosPromise<ListDatabaseDataSourcesResponse>;
|
|
4049
4414
|
/**
|
|
4050
4415
|
* (BETA) Lists database instances in the organization\'s AI Lake. Supports paging via size and offset query parameters. Use metaInclude=page to get total count.
|
|
4051
4416
|
* @summary (BETA) List AI Lake Database instances
|
|
@@ -4055,6 +4420,14 @@ export declare class AILakeApi extends BaseAPI implements AILakeApiInterface {
|
|
|
4055
4420
|
* @memberof AILakeApi
|
|
4056
4421
|
*/
|
|
4057
4422
|
listAiLakeDatabaseInstances(requestParameters?: AILakeApiListAiLakeDatabaseInstancesRequest, options?: AxiosRequestConfig): AxiosPromise<ListDatabaseInstancesResponse>;
|
|
4423
|
+
/**
|
|
4424
|
+
* (BETA) Lists ObjectStorages registered for the organization. Use the returned `name` as `sourceStorageName` in CreatePipeTable, or pass `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned.
|
|
4425
|
+
* @summary (BETA) List registered AI Lake ObjectStorages
|
|
4426
|
+
* @param {*} [options] Override http request option.
|
|
4427
|
+
* @throws {RequiredError}
|
|
4428
|
+
* @memberof AILakeApi
|
|
4429
|
+
*/
|
|
4430
|
+
listAiLakeObjectStorages(options?: AxiosRequestConfig): AxiosPromise<ListObjectStoragesResponse>;
|
|
4058
4431
|
/**
|
|
4059
4432
|
* (BETA) Lists all active pipe tables in the given AI Lake database instance.
|
|
4060
4433
|
* @summary (BETA) List AI Lake pipe tables
|
|
@@ -4082,6 +4455,15 @@ export declare class AILakeApi extends BaseAPI implements AILakeApiInterface {
|
|
|
4082
4455
|
* @memberof AILakeApi
|
|
4083
4456
|
*/
|
|
4084
4457
|
provisionAiLakeDatabaseInstance(requestParameters: AILakeApiProvisionAiLakeDatabaseInstanceRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
4458
|
+
/**
|
|
4459
|
+
* (BETA) Removes a data source association from an AI Lake database instance and deletes the corresponding data source from metadata-api. Fails if removing the data source would leave the instance with no data sources.
|
|
4460
|
+
* @summary (BETA) Remove a data source from an AILake Database instance
|
|
4461
|
+
* @param {AILakeApiRemoveAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
4462
|
+
* @param {*} [options] Override http request option.
|
|
4463
|
+
* @throws {RequiredError}
|
|
4464
|
+
* @memberof AILakeApi
|
|
4465
|
+
*/
|
|
4466
|
+
removeAiLakeDatabaseDataSource(requestParameters: AILakeApiRemoveAiLakeDatabaseDataSourceRequest, options?: AxiosRequestConfig): AxiosPromise<RemoveDatabaseDataSourceResponse>;
|
|
4085
4467
|
/**
|
|
4086
4468
|
* (BETA) Runs a specific AI Lake service command.
|
|
4087
4469
|
* @summary (BETA) Run an AI Lake services command
|
|
@@ -4091,7 +4473,26 @@ export declare class AILakeApi extends BaseAPI implements AILakeApiInterface {
|
|
|
4091
4473
|
* @memberof AILakeApi
|
|
4092
4474
|
*/
|
|
4093
4475
|
runAiLakeServiceCommand(requestParameters: AILakeApiRunAiLakeServiceCommandRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
4476
|
+
/**
|
|
4477
|
+
* (BETA) Updates the data source ID and name for an existing AI Lake database instance without deleting the underlying database. Use this to recover from a wrong data source ID provisioned on an existing database instance.
|
|
4478
|
+
* @summary (BETA) Update the data source of an AILake Database instance
|
|
4479
|
+
* @param {AILakeApiUpdateAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
4480
|
+
* @param {*} [options] Override http request option.
|
|
4481
|
+
* @throws {RequiredError}
|
|
4482
|
+
* @memberof AILakeApi
|
|
4483
|
+
*/
|
|
4484
|
+
updateAiLakeDatabaseDataSource(requestParameters: AILakeApiUpdateAiLakeDatabaseDataSourceRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateDatabaseDataSourceResponse>;
|
|
4094
4485
|
}
|
|
4486
|
+
/**
|
|
4487
|
+
* (BETA) Associates an additional metadata-api data source with an existing AI Lake database instance. The new data source uses the same StarRocks connection details as the primary data source.
|
|
4488
|
+
* @summary (BETA) Add a data source to an AILake Database instance
|
|
4489
|
+
* @param {string} instanceId Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
4490
|
+
* @param {AddDatabaseDataSourceRequest} addDatabaseDataSourceRequest
|
|
4491
|
+
* @param {*} [options] Override http request option.
|
|
4492
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
4493
|
+
* @throws {RequiredError}
|
|
4494
|
+
*/
|
|
4495
|
+
export declare function AILakeDatabasesApiAxiosParamCreator_AddAiLakeDatabaseDataSource(instanceId: string, addDatabaseDataSourceRequest: AddDatabaseDataSourceRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4095
4496
|
/**
|
|
4096
4497
|
* (BETA) Deletes an existing database in the organization\'s AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.
|
|
4097
4498
|
* @summary (BETA) Delete an existing AILake Database instance
|
|
@@ -4111,6 +4512,15 @@ export declare function AILakeDatabasesApiAxiosParamCreator_DeprovisionAiLakeDat
|
|
|
4111
4512
|
* @throws {RequiredError}
|
|
4112
4513
|
*/
|
|
4113
4514
|
export declare function AILakeDatabasesApiAxiosParamCreator_GetAiLakeDatabaseInstance(instanceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4515
|
+
/**
|
|
4516
|
+
* (BETA) Returns all data source associations for the specified AI Lake database instance.
|
|
4517
|
+
* @summary (BETA) List data sources of an AILake Database instance
|
|
4518
|
+
* @param {string} instanceId Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
4519
|
+
* @param {*} [options] Override http request option.
|
|
4520
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
4521
|
+
* @throws {RequiredError}
|
|
4522
|
+
*/
|
|
4523
|
+
export declare function AILakeDatabasesApiAxiosParamCreator_ListAiLakeDatabaseDataSources(instanceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4114
4524
|
/**
|
|
4115
4525
|
* (BETA) Lists database instances in the organization\'s AI Lake. Supports paging via size and offset query parameters. Use metaInclude=page to get total count.
|
|
4116
4526
|
* @summary (BETA) List AI Lake Database instances
|
|
@@ -4122,6 +4532,14 @@ export declare function AILakeDatabasesApiAxiosParamCreator_GetAiLakeDatabaseIns
|
|
|
4122
4532
|
* @throws {RequiredError}
|
|
4123
4533
|
*/
|
|
4124
4534
|
export declare function AILakeDatabasesApiAxiosParamCreator_ListAiLakeDatabaseInstances(size?: number, offset?: number, metaInclude?: Array<string>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4535
|
+
/**
|
|
4536
|
+
* (BETA) Lists ObjectStorages registered for the organization. Use the returned `name` as `sourceStorageName` in CreatePipeTable, or pass `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned.
|
|
4537
|
+
* @summary (BETA) List registered AI Lake ObjectStorages
|
|
4538
|
+
* @param {*} [options] Override http request option.
|
|
4539
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
4540
|
+
* @throws {RequiredError}
|
|
4541
|
+
*/
|
|
4542
|
+
export declare function AILakeDatabasesApiAxiosParamCreator_ListAiLakeObjectStorages(options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4125
4543
|
/**
|
|
4126
4544
|
* (BETA) Creates a new database in the organization\'s AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.
|
|
4127
4545
|
* @summary (BETA) Create a new AILake Database instance
|
|
@@ -4132,6 +4550,37 @@ export declare function AILakeDatabasesApiAxiosParamCreator_ListAiLakeDatabaseIn
|
|
|
4132
4550
|
* @throws {RequiredError}
|
|
4133
4551
|
*/
|
|
4134
4552
|
export declare function AILakeDatabasesApiAxiosParamCreator_ProvisionAiLakeDatabaseInstance(provisionDatabaseInstanceRequest: ProvisionDatabaseInstanceRequest, operationId?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4553
|
+
/**
|
|
4554
|
+
* (BETA) Removes a data source association from an AI Lake database instance and deletes the corresponding data source from metadata-api. Fails if removing the data source would leave the instance with no data sources.
|
|
4555
|
+
* @summary (BETA) Remove a data source from an AILake Database instance
|
|
4556
|
+
* @param {string} instanceId Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
4557
|
+
* @param {string} dataSourceId Identifier of the data source to remove.
|
|
4558
|
+
* @param {*} [options] Override http request option.
|
|
4559
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
4560
|
+
* @throws {RequiredError}
|
|
4561
|
+
*/
|
|
4562
|
+
export declare function AILakeDatabasesApiAxiosParamCreator_RemoveAiLakeDatabaseDataSource(instanceId: string, dataSourceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4563
|
+
/**
|
|
4564
|
+
* (BETA) Updates the data source ID and name for an existing AI Lake database instance without deleting the underlying database. Use this to recover from a wrong data source ID provisioned on an existing database instance.
|
|
4565
|
+
* @summary (BETA) Update the data source of an AILake Database instance
|
|
4566
|
+
* @param {string} instanceId Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
4567
|
+
* @param {UpdateDatabaseDataSourceRequest} updateDatabaseDataSourceRequest
|
|
4568
|
+
* @param {*} [options] Override http request option.
|
|
4569
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
4570
|
+
* @throws {RequiredError}
|
|
4571
|
+
*/
|
|
4572
|
+
export declare function AILakeDatabasesApiAxiosParamCreator_UpdateAiLakeDatabaseDataSource(instanceId: string, updateDatabaseDataSourceRequest: UpdateDatabaseDataSourceRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4573
|
+
/**
|
|
4574
|
+
* (BETA) Associates an additional metadata-api data source with an existing AI Lake database instance. The new data source uses the same StarRocks connection details as the primary data source.
|
|
4575
|
+
* @summary (BETA) Add a data source to an AILake Database instance
|
|
4576
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
4577
|
+
* @param {string} basePath Base path.
|
|
4578
|
+
* @param {AILakeDatabasesApiAddAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
4579
|
+
* @param {*} [options] Override http request option.
|
|
4580
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
4581
|
+
* @throws {RequiredError}
|
|
4582
|
+
*/
|
|
4583
|
+
export declare function AILakeDatabasesApi_AddAiLakeDatabaseDataSource(axios: AxiosInstance, basePath: string, requestParameters: AILakeDatabasesApiAddAiLakeDatabaseDataSourceRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AddDatabaseDataSourceResponse>;
|
|
4135
4584
|
/**
|
|
4136
4585
|
* (BETA) Deletes an existing database in the organization\'s AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.
|
|
4137
4586
|
* @summary (BETA) Delete an existing AILake Database instance
|
|
@@ -4154,6 +4603,17 @@ export declare function AILakeDatabasesApi_DeprovisionAiLakeDatabaseInstance(axi
|
|
|
4154
4603
|
* @throws {RequiredError}
|
|
4155
4604
|
*/
|
|
4156
4605
|
export declare function AILakeDatabasesApi_GetAiLakeDatabaseInstance(axios: AxiosInstance, basePath: string, requestParameters: AILakeDatabasesApiGetAiLakeDatabaseInstanceRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<DatabaseInstance>;
|
|
4606
|
+
/**
|
|
4607
|
+
* (BETA) Returns all data source associations for the specified AI Lake database instance.
|
|
4608
|
+
* @summary (BETA) List data sources of an AILake Database instance
|
|
4609
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
4610
|
+
* @param {string} basePath Base path.
|
|
4611
|
+
* @param {AILakeDatabasesApiListAiLakeDatabaseDataSourcesRequest} requestParameters Request parameters.
|
|
4612
|
+
* @param {*} [options] Override http request option.
|
|
4613
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
4614
|
+
* @throws {RequiredError}
|
|
4615
|
+
*/
|
|
4616
|
+
export declare function AILakeDatabasesApi_ListAiLakeDatabaseDataSources(axios: AxiosInstance, basePath: string, requestParameters: AILakeDatabasesApiListAiLakeDatabaseDataSourcesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ListDatabaseDataSourcesResponse>;
|
|
4157
4617
|
/**
|
|
4158
4618
|
* (BETA) Lists database instances in the organization\'s AI Lake. Supports paging via size and offset query parameters. Use metaInclude=page to get total count.
|
|
4159
4619
|
* @summary (BETA) List AI Lake Database instances
|
|
@@ -4165,6 +4625,16 @@ export declare function AILakeDatabasesApi_GetAiLakeDatabaseInstance(axios: Axio
|
|
|
4165
4625
|
* @throws {RequiredError}
|
|
4166
4626
|
*/
|
|
4167
4627
|
export declare function AILakeDatabasesApi_ListAiLakeDatabaseInstances(axios: AxiosInstance, basePath: string, requestParameters: AILakeDatabasesApiListAiLakeDatabaseInstancesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ListDatabaseInstancesResponse>;
|
|
4628
|
+
/**
|
|
4629
|
+
* (BETA) Lists ObjectStorages registered for the organization. Use the returned `name` as `sourceStorageName` in CreatePipeTable, or pass `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned.
|
|
4630
|
+
* @summary (BETA) List registered AI Lake ObjectStorages
|
|
4631
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
4632
|
+
* @param {string} basePath Base path.
|
|
4633
|
+
* @param {*} [options] Override http request option.
|
|
4634
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
4635
|
+
* @throws {RequiredError}
|
|
4636
|
+
*/
|
|
4637
|
+
export declare function AILakeDatabasesApi_ListAiLakeObjectStorages(axios: AxiosInstance, basePath: string, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ListObjectStoragesResponse>;
|
|
4168
4638
|
/**
|
|
4169
4639
|
* (BETA) Creates a new database in the organization\'s AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.
|
|
4170
4640
|
* @summary (BETA) Create a new AILake Database instance
|
|
@@ -4176,12 +4646,43 @@ export declare function AILakeDatabasesApi_ListAiLakeDatabaseInstances(axios: Ax
|
|
|
4176
4646
|
* @throws {RequiredError}
|
|
4177
4647
|
*/
|
|
4178
4648
|
export declare function AILakeDatabasesApi_ProvisionAiLakeDatabaseInstance(axios: AxiosInstance, basePath: string, requestParameters: AILakeDatabasesApiProvisionAiLakeDatabaseInstanceRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<object>;
|
|
4649
|
+
/**
|
|
4650
|
+
* (BETA) Removes a data source association from an AI Lake database instance and deletes the corresponding data source from metadata-api. Fails if removing the data source would leave the instance with no data sources.
|
|
4651
|
+
* @summary (BETA) Remove a data source from an AILake Database instance
|
|
4652
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
4653
|
+
* @param {string} basePath Base path.
|
|
4654
|
+
* @param {AILakeDatabasesApiRemoveAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
4655
|
+
* @param {*} [options] Override http request option.
|
|
4656
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
4657
|
+
* @throws {RequiredError}
|
|
4658
|
+
*/
|
|
4659
|
+
export declare function AILakeDatabasesApi_RemoveAiLakeDatabaseDataSource(axios: AxiosInstance, basePath: string, requestParameters: AILakeDatabasesApiRemoveAiLakeDatabaseDataSourceRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<RemoveDatabaseDataSourceResponse>;
|
|
4660
|
+
/**
|
|
4661
|
+
* (BETA) Updates the data source ID and name for an existing AI Lake database instance without deleting the underlying database. Use this to recover from a wrong data source ID provisioned on an existing database instance.
|
|
4662
|
+
* @summary (BETA) Update the data source of an AILake Database instance
|
|
4663
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
4664
|
+
* @param {string} basePath Base path.
|
|
4665
|
+
* @param {AILakeDatabasesApiUpdateAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
4666
|
+
* @param {*} [options] Override http request option.
|
|
4667
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
4668
|
+
* @throws {RequiredError}
|
|
4669
|
+
*/
|
|
4670
|
+
export declare function AILakeDatabasesApi_UpdateAiLakeDatabaseDataSource(axios: AxiosInstance, basePath: string, requestParameters: AILakeDatabasesApiUpdateAiLakeDatabaseDataSourceRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<UpdateDatabaseDataSourceResponse>;
|
|
4179
4671
|
/**
|
|
4180
4672
|
* AILakeDatabasesApi - interface
|
|
4181
4673
|
* @export
|
|
4182
4674
|
* @interface AILakeDatabasesApi
|
|
4183
4675
|
*/
|
|
4184
4676
|
export interface AILakeDatabasesApiInterface {
|
|
4677
|
+
/**
|
|
4678
|
+
* (BETA) Associates an additional metadata-api data source with an existing AI Lake database instance. The new data source uses the same StarRocks connection details as the primary data source.
|
|
4679
|
+
* @summary (BETA) Add a data source to an AILake Database instance
|
|
4680
|
+
* @param {AILakeDatabasesApiAddAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
4681
|
+
* @param {*} [options] Override http request option.
|
|
4682
|
+
* @throws {RequiredError}
|
|
4683
|
+
* @memberof AILakeDatabasesApiInterface
|
|
4684
|
+
*/
|
|
4685
|
+
addAiLakeDatabaseDataSource(requestParameters: AILakeDatabasesApiAddAiLakeDatabaseDataSourceRequest, options?: AxiosRequestConfig): AxiosPromise<AddDatabaseDataSourceResponse>;
|
|
4185
4686
|
/**
|
|
4186
4687
|
* (BETA) Deletes an existing database in the organization\'s AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.
|
|
4187
4688
|
* @summary (BETA) Delete an existing AILake Database instance
|
|
@@ -4200,6 +4701,15 @@ export interface AILakeDatabasesApiInterface {
|
|
|
4200
4701
|
* @memberof AILakeDatabasesApiInterface
|
|
4201
4702
|
*/
|
|
4202
4703
|
getAiLakeDatabaseInstance(requestParameters: AILakeDatabasesApiGetAiLakeDatabaseInstanceRequest, options?: AxiosRequestConfig): AxiosPromise<DatabaseInstance>;
|
|
4704
|
+
/**
|
|
4705
|
+
* (BETA) Returns all data source associations for the specified AI Lake database instance.
|
|
4706
|
+
* @summary (BETA) List data sources of an AILake Database instance
|
|
4707
|
+
* @param {AILakeDatabasesApiListAiLakeDatabaseDataSourcesRequest} requestParameters Request parameters.
|
|
4708
|
+
* @param {*} [options] Override http request option.
|
|
4709
|
+
* @throws {RequiredError}
|
|
4710
|
+
* @memberof AILakeDatabasesApiInterface
|
|
4711
|
+
*/
|
|
4712
|
+
listAiLakeDatabaseDataSources(requestParameters: AILakeDatabasesApiListAiLakeDatabaseDataSourcesRequest, options?: AxiosRequestConfig): AxiosPromise<ListDatabaseDataSourcesResponse>;
|
|
4203
4713
|
/**
|
|
4204
4714
|
* (BETA) Lists database instances in the organization\'s AI Lake. Supports paging via size and offset query parameters. Use metaInclude=page to get total count.
|
|
4205
4715
|
* @summary (BETA) List AI Lake Database instances
|
|
@@ -4209,6 +4719,14 @@ export interface AILakeDatabasesApiInterface {
|
|
|
4209
4719
|
* @memberof AILakeDatabasesApiInterface
|
|
4210
4720
|
*/
|
|
4211
4721
|
listAiLakeDatabaseInstances(requestParameters: AILakeDatabasesApiListAiLakeDatabaseInstancesRequest, options?: AxiosRequestConfig): AxiosPromise<ListDatabaseInstancesResponse>;
|
|
4722
|
+
/**
|
|
4723
|
+
* (BETA) Lists ObjectStorages registered for the organization. Use the returned `name` as `sourceStorageName` in CreatePipeTable, or pass `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned.
|
|
4724
|
+
* @summary (BETA) List registered AI Lake ObjectStorages
|
|
4725
|
+
* @param {*} [options] Override http request option.
|
|
4726
|
+
* @throws {RequiredError}
|
|
4727
|
+
* @memberof AILakeDatabasesApiInterface
|
|
4728
|
+
*/
|
|
4729
|
+
listAiLakeObjectStorages(options?: AxiosRequestConfig): AxiosPromise<ListObjectStoragesResponse>;
|
|
4212
4730
|
/**
|
|
4213
4731
|
* (BETA) Creates a new database in the organization\'s AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.
|
|
4214
4732
|
* @summary (BETA) Create a new AILake Database instance
|
|
@@ -4218,6 +4736,43 @@ export interface AILakeDatabasesApiInterface {
|
|
|
4218
4736
|
* @memberof AILakeDatabasesApiInterface
|
|
4219
4737
|
*/
|
|
4220
4738
|
provisionAiLakeDatabaseInstance(requestParameters: AILakeDatabasesApiProvisionAiLakeDatabaseInstanceRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
4739
|
+
/**
|
|
4740
|
+
* (BETA) Removes a data source association from an AI Lake database instance and deletes the corresponding data source from metadata-api. Fails if removing the data source would leave the instance with no data sources.
|
|
4741
|
+
* @summary (BETA) Remove a data source from an AILake Database instance
|
|
4742
|
+
* @param {AILakeDatabasesApiRemoveAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
4743
|
+
* @param {*} [options] Override http request option.
|
|
4744
|
+
* @throws {RequiredError}
|
|
4745
|
+
* @memberof AILakeDatabasesApiInterface
|
|
4746
|
+
*/
|
|
4747
|
+
removeAiLakeDatabaseDataSource(requestParameters: AILakeDatabasesApiRemoveAiLakeDatabaseDataSourceRequest, options?: AxiosRequestConfig): AxiosPromise<RemoveDatabaseDataSourceResponse>;
|
|
4748
|
+
/**
|
|
4749
|
+
* (BETA) Updates the data source ID and name for an existing AI Lake database instance without deleting the underlying database. Use this to recover from a wrong data source ID provisioned on an existing database instance.
|
|
4750
|
+
* @summary (BETA) Update the data source of an AILake Database instance
|
|
4751
|
+
* @param {AILakeDatabasesApiUpdateAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
4752
|
+
* @param {*} [options] Override http request option.
|
|
4753
|
+
* @throws {RequiredError}
|
|
4754
|
+
* @memberof AILakeDatabasesApiInterface
|
|
4755
|
+
*/
|
|
4756
|
+
updateAiLakeDatabaseDataSource(requestParameters: AILakeDatabasesApiUpdateAiLakeDatabaseDataSourceRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateDatabaseDataSourceResponse>;
|
|
4757
|
+
}
|
|
4758
|
+
/**
|
|
4759
|
+
* Request parameters for addAiLakeDatabaseDataSource operation in AILakeDatabasesApi.
|
|
4760
|
+
* @export
|
|
4761
|
+
* @interface AILakeDatabasesApiAddAiLakeDatabaseDataSourceRequest
|
|
4762
|
+
*/
|
|
4763
|
+
export interface AILakeDatabasesApiAddAiLakeDatabaseDataSourceRequest {
|
|
4764
|
+
/**
|
|
4765
|
+
* Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
4766
|
+
* @type {string}
|
|
4767
|
+
* @memberof AILakeDatabasesApiAddAiLakeDatabaseDataSource
|
|
4768
|
+
*/
|
|
4769
|
+
readonly instanceId: string;
|
|
4770
|
+
/**
|
|
4771
|
+
*
|
|
4772
|
+
* @type {AddDatabaseDataSourceRequest}
|
|
4773
|
+
* @memberof AILakeDatabasesApiAddAiLakeDatabaseDataSource
|
|
4774
|
+
*/
|
|
4775
|
+
readonly addDatabaseDataSourceRequest: AddDatabaseDataSourceRequest;
|
|
4221
4776
|
}
|
|
4222
4777
|
/**
|
|
4223
4778
|
* Request parameters for deprovisionAiLakeDatabaseInstance operation in AILakeDatabasesApi.
|
|
@@ -4251,6 +4806,19 @@ export interface AILakeDatabasesApiGetAiLakeDatabaseInstanceRequest {
|
|
|
4251
4806
|
*/
|
|
4252
4807
|
readonly instanceId: string;
|
|
4253
4808
|
}
|
|
4809
|
+
/**
|
|
4810
|
+
* Request parameters for listAiLakeDatabaseDataSources operation in AILakeDatabasesApi.
|
|
4811
|
+
* @export
|
|
4812
|
+
* @interface AILakeDatabasesApiListAiLakeDatabaseDataSourcesRequest
|
|
4813
|
+
*/
|
|
4814
|
+
export interface AILakeDatabasesApiListAiLakeDatabaseDataSourcesRequest {
|
|
4815
|
+
/**
|
|
4816
|
+
* Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
4817
|
+
* @type {string}
|
|
4818
|
+
* @memberof AILakeDatabasesApiListAiLakeDatabaseDataSources
|
|
4819
|
+
*/
|
|
4820
|
+
readonly instanceId: string;
|
|
4821
|
+
}
|
|
4254
4822
|
/**
|
|
4255
4823
|
* Request parameters for listAiLakeDatabaseInstances operation in AILakeDatabasesApi.
|
|
4256
4824
|
* @export
|
|
@@ -4295,6 +4863,44 @@ export interface AILakeDatabasesApiProvisionAiLakeDatabaseInstanceRequest {
|
|
|
4295
4863
|
*/
|
|
4296
4864
|
readonly operationId?: string;
|
|
4297
4865
|
}
|
|
4866
|
+
/**
|
|
4867
|
+
* Request parameters for removeAiLakeDatabaseDataSource operation in AILakeDatabasesApi.
|
|
4868
|
+
* @export
|
|
4869
|
+
* @interface AILakeDatabasesApiRemoveAiLakeDatabaseDataSourceRequest
|
|
4870
|
+
*/
|
|
4871
|
+
export interface AILakeDatabasesApiRemoveAiLakeDatabaseDataSourceRequest {
|
|
4872
|
+
/**
|
|
4873
|
+
* Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
4874
|
+
* @type {string}
|
|
4875
|
+
* @memberof AILakeDatabasesApiRemoveAiLakeDatabaseDataSource
|
|
4876
|
+
*/
|
|
4877
|
+
readonly instanceId: string;
|
|
4878
|
+
/**
|
|
4879
|
+
* Identifier of the data source to remove.
|
|
4880
|
+
* @type {string}
|
|
4881
|
+
* @memberof AILakeDatabasesApiRemoveAiLakeDatabaseDataSource
|
|
4882
|
+
*/
|
|
4883
|
+
readonly dataSourceId: string;
|
|
4884
|
+
}
|
|
4885
|
+
/**
|
|
4886
|
+
* Request parameters for updateAiLakeDatabaseDataSource operation in AILakeDatabasesApi.
|
|
4887
|
+
* @export
|
|
4888
|
+
* @interface AILakeDatabasesApiUpdateAiLakeDatabaseDataSourceRequest
|
|
4889
|
+
*/
|
|
4890
|
+
export interface AILakeDatabasesApiUpdateAiLakeDatabaseDataSourceRequest {
|
|
4891
|
+
/**
|
|
4892
|
+
* Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
4893
|
+
* @type {string}
|
|
4894
|
+
* @memberof AILakeDatabasesApiUpdateAiLakeDatabaseDataSource
|
|
4895
|
+
*/
|
|
4896
|
+
readonly instanceId: string;
|
|
4897
|
+
/**
|
|
4898
|
+
*
|
|
4899
|
+
* @type {UpdateDatabaseDataSourceRequest}
|
|
4900
|
+
* @memberof AILakeDatabasesApiUpdateAiLakeDatabaseDataSource
|
|
4901
|
+
*/
|
|
4902
|
+
readonly updateDatabaseDataSourceRequest: UpdateDatabaseDataSourceRequest;
|
|
4903
|
+
}
|
|
4298
4904
|
/**
|
|
4299
4905
|
* AILakeDatabasesApi - object-oriented interface
|
|
4300
4906
|
* @export
|
|
@@ -4302,6 +4908,15 @@ export interface AILakeDatabasesApiProvisionAiLakeDatabaseInstanceRequest {
|
|
|
4302
4908
|
* @extends {BaseAPI}
|
|
4303
4909
|
*/
|
|
4304
4910
|
export declare class AILakeDatabasesApi extends BaseAPI implements AILakeDatabasesApiInterface {
|
|
4911
|
+
/**
|
|
4912
|
+
* (BETA) Associates an additional metadata-api data source with an existing AI Lake database instance. The new data source uses the same StarRocks connection details as the primary data source.
|
|
4913
|
+
* @summary (BETA) Add a data source to an AILake Database instance
|
|
4914
|
+
* @param {AILakeDatabasesApiAddAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
4915
|
+
* @param {*} [options] Override http request option.
|
|
4916
|
+
* @throws {RequiredError}
|
|
4917
|
+
* @memberof AILakeDatabasesApi
|
|
4918
|
+
*/
|
|
4919
|
+
addAiLakeDatabaseDataSource(requestParameters: AILakeDatabasesApiAddAiLakeDatabaseDataSourceRequest, options?: AxiosRequestConfig): AxiosPromise<AddDatabaseDataSourceResponse>;
|
|
4305
4920
|
/**
|
|
4306
4921
|
* (BETA) Deletes an existing database in the organization\'s AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.
|
|
4307
4922
|
* @summary (BETA) Delete an existing AILake Database instance
|
|
@@ -4320,6 +4935,15 @@ export declare class AILakeDatabasesApi extends BaseAPI implements AILakeDatabas
|
|
|
4320
4935
|
* @memberof AILakeDatabasesApi
|
|
4321
4936
|
*/
|
|
4322
4937
|
getAiLakeDatabaseInstance(requestParameters: AILakeDatabasesApiGetAiLakeDatabaseInstanceRequest, options?: AxiosRequestConfig): AxiosPromise<DatabaseInstance>;
|
|
4938
|
+
/**
|
|
4939
|
+
* (BETA) Returns all data source associations for the specified AI Lake database instance.
|
|
4940
|
+
* @summary (BETA) List data sources of an AILake Database instance
|
|
4941
|
+
* @param {AILakeDatabasesApiListAiLakeDatabaseDataSourcesRequest} requestParameters Request parameters.
|
|
4942
|
+
* @param {*} [options] Override http request option.
|
|
4943
|
+
* @throws {RequiredError}
|
|
4944
|
+
* @memberof AILakeDatabasesApi
|
|
4945
|
+
*/
|
|
4946
|
+
listAiLakeDatabaseDataSources(requestParameters: AILakeDatabasesApiListAiLakeDatabaseDataSourcesRequest, options?: AxiosRequestConfig): AxiosPromise<ListDatabaseDataSourcesResponse>;
|
|
4323
4947
|
/**
|
|
4324
4948
|
* (BETA) Lists database instances in the organization\'s AI Lake. Supports paging via size and offset query parameters. Use metaInclude=page to get total count.
|
|
4325
4949
|
* @summary (BETA) List AI Lake Database instances
|
|
@@ -4329,6 +4953,14 @@ export declare class AILakeDatabasesApi extends BaseAPI implements AILakeDatabas
|
|
|
4329
4953
|
* @memberof AILakeDatabasesApi
|
|
4330
4954
|
*/
|
|
4331
4955
|
listAiLakeDatabaseInstances(requestParameters?: AILakeDatabasesApiListAiLakeDatabaseInstancesRequest, options?: AxiosRequestConfig): AxiosPromise<ListDatabaseInstancesResponse>;
|
|
4956
|
+
/**
|
|
4957
|
+
* (BETA) Lists ObjectStorages registered for the organization. Use the returned `name` as `sourceStorageName` in CreatePipeTable, or pass `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned.
|
|
4958
|
+
* @summary (BETA) List registered AI Lake ObjectStorages
|
|
4959
|
+
* @param {*} [options] Override http request option.
|
|
4960
|
+
* @throws {RequiredError}
|
|
4961
|
+
* @memberof AILakeDatabasesApi
|
|
4962
|
+
*/
|
|
4963
|
+
listAiLakeObjectStorages(options?: AxiosRequestConfig): AxiosPromise<ListObjectStoragesResponse>;
|
|
4332
4964
|
/**
|
|
4333
4965
|
* (BETA) Creates a new database in the organization\'s AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.
|
|
4334
4966
|
* @summary (BETA) Create a new AILake Database instance
|
|
@@ -4338,6 +4970,24 @@ export declare class AILakeDatabasesApi extends BaseAPI implements AILakeDatabas
|
|
|
4338
4970
|
* @memberof AILakeDatabasesApi
|
|
4339
4971
|
*/
|
|
4340
4972
|
provisionAiLakeDatabaseInstance(requestParameters: AILakeDatabasesApiProvisionAiLakeDatabaseInstanceRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
4973
|
+
/**
|
|
4974
|
+
* (BETA) Removes a data source association from an AI Lake database instance and deletes the corresponding data source from metadata-api. Fails if removing the data source would leave the instance with no data sources.
|
|
4975
|
+
* @summary (BETA) Remove a data source from an AILake Database instance
|
|
4976
|
+
* @param {AILakeDatabasesApiRemoveAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
4977
|
+
* @param {*} [options] Override http request option.
|
|
4978
|
+
* @throws {RequiredError}
|
|
4979
|
+
* @memberof AILakeDatabasesApi
|
|
4980
|
+
*/
|
|
4981
|
+
removeAiLakeDatabaseDataSource(requestParameters: AILakeDatabasesApiRemoveAiLakeDatabaseDataSourceRequest, options?: AxiosRequestConfig): AxiosPromise<RemoveDatabaseDataSourceResponse>;
|
|
4982
|
+
/**
|
|
4983
|
+
* (BETA) Updates the data source ID and name for an existing AI Lake database instance without deleting the underlying database. Use this to recover from a wrong data source ID provisioned on an existing database instance.
|
|
4984
|
+
* @summary (BETA) Update the data source of an AILake Database instance
|
|
4985
|
+
* @param {AILakeDatabasesApiUpdateAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
4986
|
+
* @param {*} [options] Override http request option.
|
|
4987
|
+
* @throws {RequiredError}
|
|
4988
|
+
* @memberof AILakeDatabasesApi
|
|
4989
|
+
*/
|
|
4990
|
+
updateAiLakeDatabaseDataSource(requestParameters: AILakeDatabasesApiUpdateAiLakeDatabaseDataSourceRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateDatabaseDataSourceResponse>;
|
|
4341
4991
|
}
|
|
4342
4992
|
/**
|
|
4343
4993
|
* (BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed.
|
|
@@ -5119,12 +5769,12 @@ export declare function ActionsApiAxiosParamCreator_CreatedBy(workspaceId: strin
|
|
|
5119
5769
|
* @summary AFM explain resource.
|
|
5120
5770
|
* @param {string} workspaceId Workspace identifier
|
|
5121
5771
|
* @param {AfmExecution} afmExecution
|
|
5122
|
-
* @param {'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL'} [explainType] Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request
|
|
5772
|
+
* @param {'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT'} [explainType] Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request `GIT` - Git properties of current build
|
|
5123
5773
|
* @param {*} [options] Override http request option.
|
|
5124
5774
|
* @param {Configuration} [configuration] Optional configuration.
|
|
5125
5775
|
* @throws {RequiredError}
|
|
5126
5776
|
*/
|
|
5127
|
-
export declare function ActionsApiAxiosParamCreator_ExplainAFM(workspaceId: string, afmExecution: AfmExecution, explainType?: 'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL', options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
5777
|
+
export declare function ActionsApiAxiosParamCreator_ExplainAFM(workspaceId: string, afmExecution: AfmExecution, explainType?: 'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT', options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
5128
5778
|
/**
|
|
5129
5779
|
* (BETA) Computes forecasted data points from the provided execution result and parameters.
|
|
5130
5780
|
* @summary (BETA) Smart functions - Forecast
|
|
@@ -5969,6 +6619,7 @@ export interface ActionsApiInterface {
|
|
|
5969
6619
|
* @summary (EXPERIMENTAL) Smart functions - Anomaly Detection
|
|
5970
6620
|
* @param {ActionsApiAnomalyDetectionRequest} requestParameters Request parameters.
|
|
5971
6621
|
* @param {*} [options] Override http request option.
|
|
6622
|
+
* @deprecated
|
|
5972
6623
|
* @throws {RequiredError}
|
|
5973
6624
|
* @memberof ActionsApiInterface
|
|
5974
6625
|
*/
|
|
@@ -5978,6 +6629,7 @@ export interface ActionsApiInterface {
|
|
|
5978
6629
|
* @summary (EXPERIMENTAL) Smart functions - Anomaly Detection Result
|
|
5979
6630
|
* @param {ActionsApiAnomalyDetectionResultRequest} requestParameters Request parameters.
|
|
5980
6631
|
* @param {*} [options] Override http request option.
|
|
6632
|
+
* @deprecated
|
|
5981
6633
|
* @throws {RequiredError}
|
|
5982
6634
|
* @memberof ActionsApiInterface
|
|
5983
6635
|
*/
|
|
@@ -6803,11 +7455,11 @@ export interface ActionsApiExplainAFMRequest {
|
|
|
6803
7455
|
*/
|
|
6804
7456
|
readonly afmExecution: AfmExecution;
|
|
6805
7457
|
/**
|
|
6806
|
-
* Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request
|
|
6807
|
-
* @type {'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL'}
|
|
7458
|
+
* Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request `GIT` - Git properties of current build
|
|
7459
|
+
* @type {'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT'}
|
|
6808
7460
|
* @memberof ActionsApiExplainAFM
|
|
6809
7461
|
*/
|
|
6810
|
-
readonly explainType?: 'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL';
|
|
7462
|
+
readonly explainType?: 'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT';
|
|
6811
7463
|
}
|
|
6812
7464
|
/**
|
|
6813
7465
|
* Request parameters for forecast operation in ActionsApi.
|
|
@@ -7403,6 +8055,7 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
7403
8055
|
* @summary (EXPERIMENTAL) Smart functions - Anomaly Detection
|
|
7404
8056
|
* @param {ActionsApiAnomalyDetectionRequest} requestParameters Request parameters.
|
|
7405
8057
|
* @param {*} [options] Override http request option.
|
|
8058
|
+
* @deprecated
|
|
7406
8059
|
* @throws {RequiredError}
|
|
7407
8060
|
* @memberof ActionsApi
|
|
7408
8061
|
*/
|
|
@@ -7412,6 +8065,7 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
7412
8065
|
* @summary (EXPERIMENTAL) Smart functions - Anomaly Detection Result
|
|
7413
8066
|
* @param {ActionsApiAnomalyDetectionResultRequest} requestParameters Request parameters.
|
|
7414
8067
|
* @param {*} [options] Override http request option.
|
|
8068
|
+
* @deprecated
|
|
7415
8069
|
* @throws {RequiredError}
|
|
7416
8070
|
* @memberof ActionsApi
|
|
7417
8071
|
*/
|
|
@@ -7871,12 +8525,12 @@ export declare function ComputationApiAxiosParamCreator_ComputeValidObjects(work
|
|
|
7871
8525
|
* @summary AFM explain resource.
|
|
7872
8526
|
* @param {string} workspaceId Workspace identifier
|
|
7873
8527
|
* @param {AfmExecution} afmExecution
|
|
7874
|
-
* @param {'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL'} [explainType] Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request
|
|
8528
|
+
* @param {'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT'} [explainType] Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request `GIT` - Git properties of current build
|
|
7875
8529
|
* @param {*} [options] Override http request option.
|
|
7876
8530
|
* @param {Configuration} [configuration] Optional configuration.
|
|
7877
8531
|
* @throws {RequiredError}
|
|
7878
8532
|
*/
|
|
7879
|
-
export declare function ComputationApiAxiosParamCreator_ExplainAFM(workspaceId: string, afmExecution: AfmExecution, explainType?: 'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL', options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
8533
|
+
export declare function ComputationApiAxiosParamCreator_ExplainAFM(workspaceId: string, afmExecution: AfmExecution, explainType?: 'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT', options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
7880
8534
|
/**
|
|
7881
8535
|
* (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
|
|
7882
8536
|
* @summary (EXPERIMENTAL) Compute key driver analysis
|
|
@@ -8498,11 +9152,11 @@ export interface ComputationApiExplainAFMRequest {
|
|
|
8498
9152
|
*/
|
|
8499
9153
|
readonly afmExecution: AfmExecution;
|
|
8500
9154
|
/**
|
|
8501
|
-
* Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request
|
|
8502
|
-
* @type {'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL'}
|
|
9155
|
+
* Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request `GIT` - Git properties of current build
|
|
9156
|
+
* @type {'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT'}
|
|
8503
9157
|
* @memberof ComputationApiExplainAFM
|
|
8504
9158
|
*/
|
|
8505
|
-
readonly explainType?: 'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL';
|
|
9159
|
+
readonly explainType?: 'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT';
|
|
8506
9160
|
}
|
|
8507
9161
|
/**
|
|
8508
9162
|
* Request parameters for keyDriverAnalysis operation in ComputationApi.
|
|
@@ -9498,6 +10152,7 @@ export interface SmartFunctionsApiInterface {
|
|
|
9498
10152
|
* @summary (EXPERIMENTAL) Smart functions - Anomaly Detection
|
|
9499
10153
|
* @param {SmartFunctionsApiAnomalyDetectionRequest} requestParameters Request parameters.
|
|
9500
10154
|
* @param {*} [options] Override http request option.
|
|
10155
|
+
* @deprecated
|
|
9501
10156
|
* @throws {RequiredError}
|
|
9502
10157
|
* @memberof SmartFunctionsApiInterface
|
|
9503
10158
|
*/
|
|
@@ -9507,6 +10162,7 @@ export interface SmartFunctionsApiInterface {
|
|
|
9507
10162
|
* @summary (EXPERIMENTAL) Smart functions - Anomaly Detection Result
|
|
9508
10163
|
* @param {SmartFunctionsApiAnomalyDetectionResultRequest} requestParameters Request parameters.
|
|
9509
10164
|
* @param {*} [options] Override http request option.
|
|
10165
|
+
* @deprecated
|
|
9510
10166
|
* @throws {RequiredError}
|
|
9511
10167
|
* @memberof SmartFunctionsApiInterface
|
|
9512
10168
|
*/
|
|
@@ -10287,6 +10943,7 @@ export declare class SmartFunctionsApi extends BaseAPI implements SmartFunctions
|
|
|
10287
10943
|
* @summary (EXPERIMENTAL) Smart functions - Anomaly Detection
|
|
10288
10944
|
* @param {SmartFunctionsApiAnomalyDetectionRequest} requestParameters Request parameters.
|
|
10289
10945
|
* @param {*} [options] Override http request option.
|
|
10946
|
+
* @deprecated
|
|
10290
10947
|
* @throws {RequiredError}
|
|
10291
10948
|
* @memberof SmartFunctionsApi
|
|
10292
10949
|
*/
|
|
@@ -10296,6 +10953,7 @@ export declare class SmartFunctionsApi extends BaseAPI implements SmartFunctions
|
|
|
10296
10953
|
* @summary (EXPERIMENTAL) Smart functions - Anomaly Detection Result
|
|
10297
10954
|
* @param {SmartFunctionsApiAnomalyDetectionResultRequest} requestParameters Request parameters.
|
|
10298
10955
|
* @param {*} [options] Override http request option.
|
|
10956
|
+
* @deprecated
|
|
10299
10957
|
* @throws {RequiredError}
|
|
10300
10958
|
* @memberof SmartFunctionsApi
|
|
10301
10959
|
*/
|