@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
|
@@ -5,6 +5,56 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, toPathString, creat
|
|
|
5
5
|
// @ts-ignore
|
|
6
6
|
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from './base.js';
|
|
7
7
|
// AILakeApi FP - AILakeApiAxiosParamCreator
|
|
8
|
+
/**
|
|
9
|
+
* (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.
|
|
10
|
+
* @summary (BETA) Add a data source to an AILake Database instance
|
|
11
|
+
* @param {string} instanceId Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
12
|
+
* @param {AddDatabaseDataSourceRequest} addDatabaseDataSourceRequest
|
|
13
|
+
* @param {*} [options] Override http request option.
|
|
14
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
15
|
+
* @throws {RequiredError}
|
|
16
|
+
*/
|
|
17
|
+
export async function AILakeApiAxiosParamCreator_AddAiLakeDatabaseDataSource(instanceId, addDatabaseDataSourceRequest, options = {}, configuration) {
|
|
18
|
+
// verify required parameter 'instanceId' is not null or undefined
|
|
19
|
+
assertParamExists('addAiLakeDatabaseDataSource', 'instanceId', instanceId);
|
|
20
|
+
// verify required parameter 'addDatabaseDataSourceRequest' is not null or undefined
|
|
21
|
+
assertParamExists('addAiLakeDatabaseDataSource', 'addDatabaseDataSourceRequest', addDatabaseDataSourceRequest);
|
|
22
|
+
const localVarPath = `/api/v1/ailake/database/instances/{instanceId}/dataSources`
|
|
23
|
+
.replace(`{${"instanceId"}}`, encodeURIComponent(String(instanceId)));
|
|
24
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
26
|
+
let baseOptions;
|
|
27
|
+
if (configuration) {
|
|
28
|
+
baseOptions = configuration.baseOptions;
|
|
29
|
+
}
|
|
30
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
31
|
+
const localVarHeaderParameter = {};
|
|
32
|
+
const localVarQueryParameter = {};
|
|
33
|
+
const consumes = [
|
|
34
|
+
'application/json'
|
|
35
|
+
];
|
|
36
|
+
// use application/json if present, otherwise fallback to the first one
|
|
37
|
+
localVarHeaderParameter['Content-Type'] = consumes.includes('application/json')
|
|
38
|
+
? 'application/json'
|
|
39
|
+
: consumes[0];
|
|
40
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
41
|
+
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
|
|
42
|
+
localVarRequestOptions.headers = {
|
|
43
|
+
...localVarHeaderParameter,
|
|
44
|
+
...headersFromBaseOptions,
|
|
45
|
+
...options.headers,
|
|
46
|
+
};
|
|
47
|
+
const needsSerialization = typeof addDatabaseDataSourceRequest !== "string" ||
|
|
48
|
+
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
49
|
+
localVarRequestOptions.data = needsSerialization
|
|
50
|
+
? JSON.stringify(addDatabaseDataSourceRequest !== undefined ? addDatabaseDataSourceRequest : {})
|
|
51
|
+
: addDatabaseDataSourceRequest || "";
|
|
52
|
+
return {
|
|
53
|
+
url: toPathString(localVarUrlObj),
|
|
54
|
+
options: localVarRequestOptions,
|
|
55
|
+
};
|
|
56
|
+
}
|
|
57
|
+
// AILakeApi FP - AILakeApiAxiosParamCreator
|
|
8
58
|
/**
|
|
9
59
|
* (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.
|
|
10
60
|
* @summary (BETA) Run ANALYZE TABLE for tables in a database instance
|
|
@@ -339,6 +389,41 @@ export async function AILakeApiAxiosParamCreator_GetAiLakeServiceStatus(serviceI
|
|
|
339
389
|
};
|
|
340
390
|
}
|
|
341
391
|
// AILakeApi FP - AILakeApiAxiosParamCreator
|
|
392
|
+
/**
|
|
393
|
+
* (BETA) Returns all data source associations for the specified AI Lake database instance.
|
|
394
|
+
* @summary (BETA) List data sources of an AILake Database instance
|
|
395
|
+
* @param {string} instanceId Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
396
|
+
* @param {*} [options] Override http request option.
|
|
397
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
398
|
+
* @throws {RequiredError}
|
|
399
|
+
*/
|
|
400
|
+
export async function AILakeApiAxiosParamCreator_ListAiLakeDatabaseDataSources(instanceId, options = {}, configuration) {
|
|
401
|
+
// verify required parameter 'instanceId' is not null or undefined
|
|
402
|
+
assertParamExists('listAiLakeDatabaseDataSources', 'instanceId', instanceId);
|
|
403
|
+
const localVarPath = `/api/v1/ailake/database/instances/{instanceId}/dataSources`
|
|
404
|
+
.replace(`{${"instanceId"}}`, encodeURIComponent(String(instanceId)));
|
|
405
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
406
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
407
|
+
let baseOptions;
|
|
408
|
+
if (configuration) {
|
|
409
|
+
baseOptions = configuration.baseOptions;
|
|
410
|
+
}
|
|
411
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
412
|
+
const localVarHeaderParameter = {};
|
|
413
|
+
const localVarQueryParameter = {};
|
|
414
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
415
|
+
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
|
|
416
|
+
localVarRequestOptions.headers = {
|
|
417
|
+
...localVarHeaderParameter,
|
|
418
|
+
...headersFromBaseOptions,
|
|
419
|
+
...options.headers,
|
|
420
|
+
};
|
|
421
|
+
return {
|
|
422
|
+
url: toPathString(localVarUrlObj),
|
|
423
|
+
options: localVarRequestOptions,
|
|
424
|
+
};
|
|
425
|
+
}
|
|
426
|
+
// AILakeApi FP - AILakeApiAxiosParamCreator
|
|
342
427
|
/**
|
|
343
428
|
* (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.
|
|
344
429
|
* @summary (BETA) List AI Lake Database instances
|
|
@@ -382,6 +467,37 @@ export async function AILakeApiAxiosParamCreator_ListAiLakeDatabaseInstances(siz
|
|
|
382
467
|
};
|
|
383
468
|
}
|
|
384
469
|
// AILakeApi FP - AILakeApiAxiosParamCreator
|
|
470
|
+
/**
|
|
471
|
+
* (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.
|
|
472
|
+
* @summary (BETA) List registered AI Lake ObjectStorages
|
|
473
|
+
* @param {*} [options] Override http request option.
|
|
474
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
475
|
+
* @throws {RequiredError}
|
|
476
|
+
*/
|
|
477
|
+
export async function AILakeApiAxiosParamCreator_ListAiLakeObjectStorages(options = {}, configuration) {
|
|
478
|
+
const localVarPath = `/api/v1/ailake/object-storages`;
|
|
479
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
480
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
481
|
+
let baseOptions;
|
|
482
|
+
if (configuration) {
|
|
483
|
+
baseOptions = configuration.baseOptions;
|
|
484
|
+
}
|
|
485
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
486
|
+
const localVarHeaderParameter = {};
|
|
487
|
+
const localVarQueryParameter = {};
|
|
488
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
489
|
+
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
|
|
490
|
+
localVarRequestOptions.headers = {
|
|
491
|
+
...localVarHeaderParameter,
|
|
492
|
+
...headersFromBaseOptions,
|
|
493
|
+
...options.headers,
|
|
494
|
+
};
|
|
495
|
+
return {
|
|
496
|
+
url: toPathString(localVarUrlObj),
|
|
497
|
+
options: localVarRequestOptions,
|
|
498
|
+
};
|
|
499
|
+
}
|
|
500
|
+
// AILakeApi FP - AILakeApiAxiosParamCreator
|
|
385
501
|
/**
|
|
386
502
|
* (BETA) Lists all active pipe tables in the given AI Lake database instance.
|
|
387
503
|
* @summary (BETA) List AI Lake pipe tables
|
|
@@ -510,6 +626,45 @@ export async function AILakeApiAxiosParamCreator_ProvisionAiLakeDatabaseInstance
|
|
|
510
626
|
};
|
|
511
627
|
}
|
|
512
628
|
// AILakeApi FP - AILakeApiAxiosParamCreator
|
|
629
|
+
/**
|
|
630
|
+
* (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.
|
|
631
|
+
* @summary (BETA) Remove a data source from an AILake Database instance
|
|
632
|
+
* @param {string} instanceId Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
633
|
+
* @param {string} dataSourceId Identifier of the data source to remove.
|
|
634
|
+
* @param {*} [options] Override http request option.
|
|
635
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
636
|
+
* @throws {RequiredError}
|
|
637
|
+
*/
|
|
638
|
+
export async function AILakeApiAxiosParamCreator_RemoveAiLakeDatabaseDataSource(instanceId, dataSourceId, options = {}, configuration) {
|
|
639
|
+
// verify required parameter 'instanceId' is not null or undefined
|
|
640
|
+
assertParamExists('removeAiLakeDatabaseDataSource', 'instanceId', instanceId);
|
|
641
|
+
// verify required parameter 'dataSourceId' is not null or undefined
|
|
642
|
+
assertParamExists('removeAiLakeDatabaseDataSource', 'dataSourceId', dataSourceId);
|
|
643
|
+
const localVarPath = `/api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId}`
|
|
644
|
+
.replace(`{${"instanceId"}}`, encodeURIComponent(String(instanceId)))
|
|
645
|
+
.replace(`{${"dataSourceId"}}`, encodeURIComponent(String(dataSourceId)));
|
|
646
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
647
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
648
|
+
let baseOptions;
|
|
649
|
+
if (configuration) {
|
|
650
|
+
baseOptions = configuration.baseOptions;
|
|
651
|
+
}
|
|
652
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
653
|
+
const localVarHeaderParameter = {};
|
|
654
|
+
const localVarQueryParameter = {};
|
|
655
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
656
|
+
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
|
|
657
|
+
localVarRequestOptions.headers = {
|
|
658
|
+
...localVarHeaderParameter,
|
|
659
|
+
...headersFromBaseOptions,
|
|
660
|
+
...options.headers,
|
|
661
|
+
};
|
|
662
|
+
return {
|
|
663
|
+
url: toPathString(localVarUrlObj),
|
|
664
|
+
options: localVarRequestOptions,
|
|
665
|
+
};
|
|
666
|
+
}
|
|
667
|
+
// AILakeApi FP - AILakeApiAxiosParamCreator
|
|
513
668
|
/**
|
|
514
669
|
* (BETA) Runs a specific AI Lake service command.
|
|
515
670
|
* @summary (BETA) Run an AI Lake services command
|
|
@@ -567,6 +722,71 @@ export async function AILakeApiAxiosParamCreator_RunAiLakeServiceCommand(service
|
|
|
567
722
|
options: localVarRequestOptions,
|
|
568
723
|
};
|
|
569
724
|
}
|
|
725
|
+
// AILakeApi FP - AILakeApiAxiosParamCreator
|
|
726
|
+
/**
|
|
727
|
+
* (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.
|
|
728
|
+
* @summary (BETA) Update the data source of an AILake Database instance
|
|
729
|
+
* @param {string} instanceId Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
730
|
+
* @param {UpdateDatabaseDataSourceRequest} updateDatabaseDataSourceRequest
|
|
731
|
+
* @param {*} [options] Override http request option.
|
|
732
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
733
|
+
* @throws {RequiredError}
|
|
734
|
+
*/
|
|
735
|
+
export async function AILakeApiAxiosParamCreator_UpdateAiLakeDatabaseDataSource(instanceId, updateDatabaseDataSourceRequest, options = {}, configuration) {
|
|
736
|
+
// verify required parameter 'instanceId' is not null or undefined
|
|
737
|
+
assertParamExists('updateAiLakeDatabaseDataSource', 'instanceId', instanceId);
|
|
738
|
+
// verify required parameter 'updateDatabaseDataSourceRequest' is not null or undefined
|
|
739
|
+
assertParamExists('updateAiLakeDatabaseDataSource', 'updateDatabaseDataSourceRequest', updateDatabaseDataSourceRequest);
|
|
740
|
+
const localVarPath = `/api/v1/ailake/database/instances/{instanceId}/dataSource`
|
|
741
|
+
.replace(`{${"instanceId"}}`, encodeURIComponent(String(instanceId)));
|
|
742
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
743
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
744
|
+
let baseOptions;
|
|
745
|
+
if (configuration) {
|
|
746
|
+
baseOptions = configuration.baseOptions;
|
|
747
|
+
}
|
|
748
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options };
|
|
749
|
+
const localVarHeaderParameter = {};
|
|
750
|
+
const localVarQueryParameter = {};
|
|
751
|
+
const consumes = [
|
|
752
|
+
'application/json'
|
|
753
|
+
];
|
|
754
|
+
// use application/json if present, otherwise fallback to the first one
|
|
755
|
+
localVarHeaderParameter['Content-Type'] = consumes.includes('application/json')
|
|
756
|
+
? 'application/json'
|
|
757
|
+
: consumes[0];
|
|
758
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
759
|
+
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
|
|
760
|
+
localVarRequestOptions.headers = {
|
|
761
|
+
...localVarHeaderParameter,
|
|
762
|
+
...headersFromBaseOptions,
|
|
763
|
+
...options.headers,
|
|
764
|
+
};
|
|
765
|
+
const needsSerialization = typeof updateDatabaseDataSourceRequest !== "string" ||
|
|
766
|
+
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
767
|
+
localVarRequestOptions.data = needsSerialization
|
|
768
|
+
? JSON.stringify(updateDatabaseDataSourceRequest !== undefined ? updateDatabaseDataSourceRequest : {})
|
|
769
|
+
: updateDatabaseDataSourceRequest || "";
|
|
770
|
+
return {
|
|
771
|
+
url: toPathString(localVarUrlObj),
|
|
772
|
+
options: localVarRequestOptions,
|
|
773
|
+
};
|
|
774
|
+
}
|
|
775
|
+
// AILakeApi Api FP
|
|
776
|
+
/**
|
|
777
|
+
* (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.
|
|
778
|
+
* @summary (BETA) Add a data source to an AILake Database instance
|
|
779
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
780
|
+
* @param {string} basePath Base path.
|
|
781
|
+
* @param {AILakeApiAddAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
782
|
+
* @param {*} [options] Override http request option.
|
|
783
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
784
|
+
* @throws {RequiredError}
|
|
785
|
+
*/
|
|
786
|
+
export async function AILakeApi_AddAiLakeDatabaseDataSource(axios, basePath, requestParameters, options, configuration) {
|
|
787
|
+
const localVarAxiosArgs = await AILakeApiAxiosParamCreator_AddAiLakeDatabaseDataSource(requestParameters.instanceId, requestParameters.addDatabaseDataSourceRequest, options || {}, configuration);
|
|
788
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
789
|
+
}
|
|
570
790
|
// AILakeApi Api FP
|
|
571
791
|
/**
|
|
572
792
|
* (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.
|
|
@@ -688,6 +908,21 @@ export async function AILakeApi_GetAiLakeServiceStatus(axios, basePath, requestP
|
|
|
688
908
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
689
909
|
}
|
|
690
910
|
// AILakeApi Api FP
|
|
911
|
+
/**
|
|
912
|
+
* (BETA) Returns all data source associations for the specified AI Lake database instance.
|
|
913
|
+
* @summary (BETA) List data sources of an AILake Database instance
|
|
914
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
915
|
+
* @param {string} basePath Base path.
|
|
916
|
+
* @param {AILakeApiListAiLakeDatabaseDataSourcesRequest} requestParameters Request parameters.
|
|
917
|
+
* @param {*} [options] Override http request option.
|
|
918
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
919
|
+
* @throws {RequiredError}
|
|
920
|
+
*/
|
|
921
|
+
export async function AILakeApi_ListAiLakeDatabaseDataSources(axios, basePath, requestParameters, options, configuration) {
|
|
922
|
+
const localVarAxiosArgs = await AILakeApiAxiosParamCreator_ListAiLakeDatabaseDataSources(requestParameters.instanceId, options || {}, configuration);
|
|
923
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
924
|
+
}
|
|
925
|
+
// AILakeApi Api FP
|
|
691
926
|
/**
|
|
692
927
|
* (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.
|
|
693
928
|
* @summary (BETA) List AI Lake Database instances
|
|
@@ -703,6 +938,20 @@ export async function AILakeApi_ListAiLakeDatabaseInstances(axios, basePath, req
|
|
|
703
938
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
704
939
|
}
|
|
705
940
|
// AILakeApi Api FP
|
|
941
|
+
/**
|
|
942
|
+
* (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.
|
|
943
|
+
* @summary (BETA) List registered AI Lake ObjectStorages
|
|
944
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
945
|
+
* @param {string} basePath Base path.
|
|
946
|
+
* @param {*} [options] Override http request option.
|
|
947
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
948
|
+
* @throws {RequiredError}
|
|
949
|
+
*/
|
|
950
|
+
export async function AILakeApi_ListAiLakeObjectStorages(axios, basePath, options, configuration) {
|
|
951
|
+
const localVarAxiosArgs = await AILakeApiAxiosParamCreator_ListAiLakeObjectStorages(options || {}, configuration);
|
|
952
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
953
|
+
}
|
|
954
|
+
// AILakeApi Api FP
|
|
706
955
|
/**
|
|
707
956
|
* (BETA) Lists all active pipe tables in the given AI Lake database instance.
|
|
708
957
|
* @summary (BETA) List AI Lake pipe tables
|
|
@@ -748,6 +997,21 @@ export async function AILakeApi_ProvisionAiLakeDatabaseInstance(axios, basePath,
|
|
|
748
997
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
749
998
|
}
|
|
750
999
|
// AILakeApi Api FP
|
|
1000
|
+
/**
|
|
1001
|
+
* (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.
|
|
1002
|
+
* @summary (BETA) Remove a data source from an AILake Database instance
|
|
1003
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1004
|
+
* @param {string} basePath Base path.
|
|
1005
|
+
* @param {AILakeApiRemoveAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
1006
|
+
* @param {*} [options] Override http request option.
|
|
1007
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1008
|
+
* @throws {RequiredError}
|
|
1009
|
+
*/
|
|
1010
|
+
export async function AILakeApi_RemoveAiLakeDatabaseDataSource(axios, basePath, requestParameters, options, configuration) {
|
|
1011
|
+
const localVarAxiosArgs = await AILakeApiAxiosParamCreator_RemoveAiLakeDatabaseDataSource(requestParameters.instanceId, requestParameters.dataSourceId, options || {}, configuration);
|
|
1012
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
1013
|
+
}
|
|
1014
|
+
// AILakeApi Api FP
|
|
751
1015
|
/**
|
|
752
1016
|
* (BETA) Runs a specific AI Lake service command.
|
|
753
1017
|
* @summary (BETA) Run an AI Lake services command
|
|
@@ -762,6 +1026,21 @@ export async function AILakeApi_RunAiLakeServiceCommand(axios, basePath, request
|
|
|
762
1026
|
const localVarAxiosArgs = await AILakeApiAxiosParamCreator_RunAiLakeServiceCommand(requestParameters.serviceId, requestParameters.commandName, requestParameters.runServiceCommandRequest, requestParameters.operationId, options || {}, configuration);
|
|
763
1027
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
764
1028
|
}
|
|
1029
|
+
// AILakeApi Api FP
|
|
1030
|
+
/**
|
|
1031
|
+
* (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.
|
|
1032
|
+
* @summary (BETA) Update the data source of an AILake Database instance
|
|
1033
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1034
|
+
* @param {string} basePath Base path.
|
|
1035
|
+
* @param {AILakeApiUpdateAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
1036
|
+
* @param {*} [options] Override http request option.
|
|
1037
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1038
|
+
* @throws {RequiredError}
|
|
1039
|
+
*/
|
|
1040
|
+
export async function AILakeApi_UpdateAiLakeDatabaseDataSource(axios, basePath, requestParameters, options, configuration) {
|
|
1041
|
+
const localVarAxiosArgs = await AILakeApiAxiosParamCreator_UpdateAiLakeDatabaseDataSource(requestParameters.instanceId, requestParameters.updateDatabaseDataSourceRequest, options || {}, configuration);
|
|
1042
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
1043
|
+
}
|
|
765
1044
|
/**
|
|
766
1045
|
* AILakeApi - object-oriented interface
|
|
767
1046
|
* @export
|
|
@@ -769,6 +1048,17 @@ export async function AILakeApi_RunAiLakeServiceCommand(axios, basePath, request
|
|
|
769
1048
|
* @extends {BaseAPI}
|
|
770
1049
|
*/
|
|
771
1050
|
export class AILakeApi extends BaseAPI {
|
|
1051
|
+
/**
|
|
1052
|
+
* (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.
|
|
1053
|
+
* @summary (BETA) Add a data source to an AILake Database instance
|
|
1054
|
+
* @param {AILakeApiAddAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
1055
|
+
* @param {*} [options] Override http request option.
|
|
1056
|
+
* @throws {RequiredError}
|
|
1057
|
+
* @memberof AILakeApi
|
|
1058
|
+
*/
|
|
1059
|
+
addAiLakeDatabaseDataSource(requestParameters, options) {
|
|
1060
|
+
return AILakeApi_AddAiLakeDatabaseDataSource(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
1061
|
+
}
|
|
772
1062
|
/**
|
|
773
1063
|
* (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.
|
|
774
1064
|
* @summary (BETA) Run ANALYZE TABLE for tables in a database instance
|
|
@@ -857,6 +1147,17 @@ export class AILakeApi extends BaseAPI {
|
|
|
857
1147
|
getAiLakeServiceStatus(requestParameters, options) {
|
|
858
1148
|
return AILakeApi_GetAiLakeServiceStatus(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
859
1149
|
}
|
|
1150
|
+
/**
|
|
1151
|
+
* (BETA) Returns all data source associations for the specified AI Lake database instance.
|
|
1152
|
+
* @summary (BETA) List data sources of an AILake Database instance
|
|
1153
|
+
* @param {AILakeApiListAiLakeDatabaseDataSourcesRequest} requestParameters Request parameters.
|
|
1154
|
+
* @param {*} [options] Override http request option.
|
|
1155
|
+
* @throws {RequiredError}
|
|
1156
|
+
* @memberof AILakeApi
|
|
1157
|
+
*/
|
|
1158
|
+
listAiLakeDatabaseDataSources(requestParameters, options) {
|
|
1159
|
+
return AILakeApi_ListAiLakeDatabaseDataSources(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
1160
|
+
}
|
|
860
1161
|
/**
|
|
861
1162
|
* (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.
|
|
862
1163
|
* @summary (BETA) List AI Lake Database instances
|
|
@@ -868,6 +1169,16 @@ export class AILakeApi extends BaseAPI {
|
|
|
868
1169
|
listAiLakeDatabaseInstances(requestParameters = {}, options) {
|
|
869
1170
|
return AILakeApi_ListAiLakeDatabaseInstances(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
870
1171
|
}
|
|
1172
|
+
/**
|
|
1173
|
+
* (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.
|
|
1174
|
+
* @summary (BETA) List registered AI Lake ObjectStorages
|
|
1175
|
+
* @param {*} [options] Override http request option.
|
|
1176
|
+
* @throws {RequiredError}
|
|
1177
|
+
* @memberof AILakeApi
|
|
1178
|
+
*/
|
|
1179
|
+
listAiLakeObjectStorages(options) {
|
|
1180
|
+
return AILakeApi_ListAiLakeObjectStorages(this.axios, this.basePath, options, this.configuration);
|
|
1181
|
+
}
|
|
871
1182
|
/**
|
|
872
1183
|
* (BETA) Lists all active pipe tables in the given AI Lake database instance.
|
|
873
1184
|
* @summary (BETA) List AI Lake pipe tables
|
|
@@ -901,6 +1212,17 @@ export class AILakeApi extends BaseAPI {
|
|
|
901
1212
|
provisionAiLakeDatabaseInstance(requestParameters, options) {
|
|
902
1213
|
return AILakeApi_ProvisionAiLakeDatabaseInstance(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
903
1214
|
}
|
|
1215
|
+
/**
|
|
1216
|
+
* (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.
|
|
1217
|
+
* @summary (BETA) Remove a data source from an AILake Database instance
|
|
1218
|
+
* @param {AILakeApiRemoveAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
1219
|
+
* @param {*} [options] Override http request option.
|
|
1220
|
+
* @throws {RequiredError}
|
|
1221
|
+
* @memberof AILakeApi
|
|
1222
|
+
*/
|
|
1223
|
+
removeAiLakeDatabaseDataSource(requestParameters, options) {
|
|
1224
|
+
return AILakeApi_RemoveAiLakeDatabaseDataSource(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
1225
|
+
}
|
|
904
1226
|
/**
|
|
905
1227
|
* (BETA) Runs a specific AI Lake service command.
|
|
906
1228
|
* @summary (BETA) Run an AI Lake services command
|
|
@@ -912,6 +1234,67 @@ export class AILakeApi extends BaseAPI {
|
|
|
912
1234
|
runAiLakeServiceCommand(requestParameters, options) {
|
|
913
1235
|
return AILakeApi_RunAiLakeServiceCommand(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
914
1236
|
}
|
|
1237
|
+
/**
|
|
1238
|
+
* (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.
|
|
1239
|
+
* @summary (BETA) Update the data source of an AILake Database instance
|
|
1240
|
+
* @param {AILakeApiUpdateAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
1241
|
+
* @param {*} [options] Override http request option.
|
|
1242
|
+
* @throws {RequiredError}
|
|
1243
|
+
* @memberof AILakeApi
|
|
1244
|
+
*/
|
|
1245
|
+
updateAiLakeDatabaseDataSource(requestParameters, options) {
|
|
1246
|
+
return AILakeApi_UpdateAiLakeDatabaseDataSource(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
1247
|
+
}
|
|
1248
|
+
}
|
|
1249
|
+
// AILakeDatabasesApi FP - AILakeDatabasesApiAxiosParamCreator
|
|
1250
|
+
/**
|
|
1251
|
+
* (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.
|
|
1252
|
+
* @summary (BETA) Add a data source to an AILake Database instance
|
|
1253
|
+
* @param {string} instanceId Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
1254
|
+
* @param {AddDatabaseDataSourceRequest} addDatabaseDataSourceRequest
|
|
1255
|
+
* @param {*} [options] Override http request option.
|
|
1256
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1257
|
+
* @throws {RequiredError}
|
|
1258
|
+
*/
|
|
1259
|
+
export async function AILakeDatabasesApiAxiosParamCreator_AddAiLakeDatabaseDataSource(instanceId, addDatabaseDataSourceRequest, options = {}, configuration) {
|
|
1260
|
+
// verify required parameter 'instanceId' is not null or undefined
|
|
1261
|
+
assertParamExists('addAiLakeDatabaseDataSource', 'instanceId', instanceId);
|
|
1262
|
+
// verify required parameter 'addDatabaseDataSourceRequest' is not null or undefined
|
|
1263
|
+
assertParamExists('addAiLakeDatabaseDataSource', 'addDatabaseDataSourceRequest', addDatabaseDataSourceRequest);
|
|
1264
|
+
const localVarPath = `/api/v1/ailake/database/instances/{instanceId}/dataSources`
|
|
1265
|
+
.replace(`{${"instanceId"}}`, encodeURIComponent(String(instanceId)));
|
|
1266
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1267
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1268
|
+
let baseOptions;
|
|
1269
|
+
if (configuration) {
|
|
1270
|
+
baseOptions = configuration.baseOptions;
|
|
1271
|
+
}
|
|
1272
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
1273
|
+
const localVarHeaderParameter = {};
|
|
1274
|
+
const localVarQueryParameter = {};
|
|
1275
|
+
const consumes = [
|
|
1276
|
+
'application/json'
|
|
1277
|
+
];
|
|
1278
|
+
// use application/json if present, otherwise fallback to the first one
|
|
1279
|
+
localVarHeaderParameter['Content-Type'] = consumes.includes('application/json')
|
|
1280
|
+
? 'application/json'
|
|
1281
|
+
: consumes[0];
|
|
1282
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1283
|
+
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
|
|
1284
|
+
localVarRequestOptions.headers = {
|
|
1285
|
+
...localVarHeaderParameter,
|
|
1286
|
+
...headersFromBaseOptions,
|
|
1287
|
+
...options.headers,
|
|
1288
|
+
};
|
|
1289
|
+
const needsSerialization = typeof addDatabaseDataSourceRequest !== "string" ||
|
|
1290
|
+
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
1291
|
+
localVarRequestOptions.data = needsSerialization
|
|
1292
|
+
? JSON.stringify(addDatabaseDataSourceRequest !== undefined ? addDatabaseDataSourceRequest : {})
|
|
1293
|
+
: addDatabaseDataSourceRequest || "";
|
|
1294
|
+
return {
|
|
1295
|
+
url: toPathString(localVarUrlObj),
|
|
1296
|
+
options: localVarRequestOptions,
|
|
1297
|
+
};
|
|
915
1298
|
}
|
|
916
1299
|
// AILakeDatabasesApi FP - AILakeDatabasesApiAxiosParamCreator
|
|
917
1300
|
/**
|
|
@@ -988,6 +1371,41 @@ export async function AILakeDatabasesApiAxiosParamCreator_GetAiLakeDatabaseInsta
|
|
|
988
1371
|
};
|
|
989
1372
|
}
|
|
990
1373
|
// AILakeDatabasesApi FP - AILakeDatabasesApiAxiosParamCreator
|
|
1374
|
+
/**
|
|
1375
|
+
* (BETA) Returns all data source associations for the specified AI Lake database instance.
|
|
1376
|
+
* @summary (BETA) List data sources of an AILake Database instance
|
|
1377
|
+
* @param {string} instanceId Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
1378
|
+
* @param {*} [options] Override http request option.
|
|
1379
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1380
|
+
* @throws {RequiredError}
|
|
1381
|
+
*/
|
|
1382
|
+
export async function AILakeDatabasesApiAxiosParamCreator_ListAiLakeDatabaseDataSources(instanceId, options = {}, configuration) {
|
|
1383
|
+
// verify required parameter 'instanceId' is not null or undefined
|
|
1384
|
+
assertParamExists('listAiLakeDatabaseDataSources', 'instanceId', instanceId);
|
|
1385
|
+
const localVarPath = `/api/v1/ailake/database/instances/{instanceId}/dataSources`
|
|
1386
|
+
.replace(`{${"instanceId"}}`, encodeURIComponent(String(instanceId)));
|
|
1387
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1388
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1389
|
+
let baseOptions;
|
|
1390
|
+
if (configuration) {
|
|
1391
|
+
baseOptions = configuration.baseOptions;
|
|
1392
|
+
}
|
|
1393
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1394
|
+
const localVarHeaderParameter = {};
|
|
1395
|
+
const localVarQueryParameter = {};
|
|
1396
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1397
|
+
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
|
|
1398
|
+
localVarRequestOptions.headers = {
|
|
1399
|
+
...localVarHeaderParameter,
|
|
1400
|
+
...headersFromBaseOptions,
|
|
1401
|
+
...options.headers,
|
|
1402
|
+
};
|
|
1403
|
+
return {
|
|
1404
|
+
url: toPathString(localVarUrlObj),
|
|
1405
|
+
options: localVarRequestOptions,
|
|
1406
|
+
};
|
|
1407
|
+
}
|
|
1408
|
+
// AILakeDatabasesApi FP - AILakeDatabasesApiAxiosParamCreator
|
|
991
1409
|
/**
|
|
992
1410
|
* (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.
|
|
993
1411
|
* @summary (BETA) List AI Lake Database instances
|
|
@@ -1031,6 +1449,37 @@ export async function AILakeDatabasesApiAxiosParamCreator_ListAiLakeDatabaseInst
|
|
|
1031
1449
|
};
|
|
1032
1450
|
}
|
|
1033
1451
|
// AILakeDatabasesApi FP - AILakeDatabasesApiAxiosParamCreator
|
|
1452
|
+
/**
|
|
1453
|
+
* (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.
|
|
1454
|
+
* @summary (BETA) List registered AI Lake ObjectStorages
|
|
1455
|
+
* @param {*} [options] Override http request option.
|
|
1456
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1457
|
+
* @throws {RequiredError}
|
|
1458
|
+
*/
|
|
1459
|
+
export async function AILakeDatabasesApiAxiosParamCreator_ListAiLakeObjectStorages(options = {}, configuration) {
|
|
1460
|
+
const localVarPath = `/api/v1/ailake/object-storages`;
|
|
1461
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1462
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1463
|
+
let baseOptions;
|
|
1464
|
+
if (configuration) {
|
|
1465
|
+
baseOptions = configuration.baseOptions;
|
|
1466
|
+
}
|
|
1467
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1468
|
+
const localVarHeaderParameter = {};
|
|
1469
|
+
const localVarQueryParameter = {};
|
|
1470
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1471
|
+
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
|
|
1472
|
+
localVarRequestOptions.headers = {
|
|
1473
|
+
...localVarHeaderParameter,
|
|
1474
|
+
...headersFromBaseOptions,
|
|
1475
|
+
...options.headers,
|
|
1476
|
+
};
|
|
1477
|
+
return {
|
|
1478
|
+
url: toPathString(localVarUrlObj),
|
|
1479
|
+
options: localVarRequestOptions,
|
|
1480
|
+
};
|
|
1481
|
+
}
|
|
1482
|
+
// AILakeDatabasesApi FP - AILakeDatabasesApiAxiosParamCreator
|
|
1034
1483
|
/**
|
|
1035
1484
|
* (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.
|
|
1036
1485
|
* @summary (BETA) Create a new AILake Database instance
|
|
@@ -1080,6 +1529,110 @@ export async function AILakeDatabasesApiAxiosParamCreator_ProvisionAiLakeDatabas
|
|
|
1080
1529
|
options: localVarRequestOptions,
|
|
1081
1530
|
};
|
|
1082
1531
|
}
|
|
1532
|
+
// AILakeDatabasesApi FP - AILakeDatabasesApiAxiosParamCreator
|
|
1533
|
+
/**
|
|
1534
|
+
* (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.
|
|
1535
|
+
* @summary (BETA) Remove a data source from an AILake Database instance
|
|
1536
|
+
* @param {string} instanceId Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
1537
|
+
* @param {string} dataSourceId Identifier of the data source to remove.
|
|
1538
|
+
* @param {*} [options] Override http request option.
|
|
1539
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1540
|
+
* @throws {RequiredError}
|
|
1541
|
+
*/
|
|
1542
|
+
export async function AILakeDatabasesApiAxiosParamCreator_RemoveAiLakeDatabaseDataSource(instanceId, dataSourceId, options = {}, configuration) {
|
|
1543
|
+
// verify required parameter 'instanceId' is not null or undefined
|
|
1544
|
+
assertParamExists('removeAiLakeDatabaseDataSource', 'instanceId', instanceId);
|
|
1545
|
+
// verify required parameter 'dataSourceId' is not null or undefined
|
|
1546
|
+
assertParamExists('removeAiLakeDatabaseDataSource', 'dataSourceId', dataSourceId);
|
|
1547
|
+
const localVarPath = `/api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId}`
|
|
1548
|
+
.replace(`{${"instanceId"}}`, encodeURIComponent(String(instanceId)))
|
|
1549
|
+
.replace(`{${"dataSourceId"}}`, encodeURIComponent(String(dataSourceId)));
|
|
1550
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1551
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1552
|
+
let baseOptions;
|
|
1553
|
+
if (configuration) {
|
|
1554
|
+
baseOptions = configuration.baseOptions;
|
|
1555
|
+
}
|
|
1556
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
1557
|
+
const localVarHeaderParameter = {};
|
|
1558
|
+
const localVarQueryParameter = {};
|
|
1559
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1560
|
+
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
|
|
1561
|
+
localVarRequestOptions.headers = {
|
|
1562
|
+
...localVarHeaderParameter,
|
|
1563
|
+
...headersFromBaseOptions,
|
|
1564
|
+
...options.headers,
|
|
1565
|
+
};
|
|
1566
|
+
return {
|
|
1567
|
+
url: toPathString(localVarUrlObj),
|
|
1568
|
+
options: localVarRequestOptions,
|
|
1569
|
+
};
|
|
1570
|
+
}
|
|
1571
|
+
// AILakeDatabasesApi FP - AILakeDatabasesApiAxiosParamCreator
|
|
1572
|
+
/**
|
|
1573
|
+
* (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.
|
|
1574
|
+
* @summary (BETA) Update the data source of an AILake Database instance
|
|
1575
|
+
* @param {string} instanceId Database instance identifier. Accepts the database name (preferred) or UUID.
|
|
1576
|
+
* @param {UpdateDatabaseDataSourceRequest} updateDatabaseDataSourceRequest
|
|
1577
|
+
* @param {*} [options] Override http request option.
|
|
1578
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1579
|
+
* @throws {RequiredError}
|
|
1580
|
+
*/
|
|
1581
|
+
export async function AILakeDatabasesApiAxiosParamCreator_UpdateAiLakeDatabaseDataSource(instanceId, updateDatabaseDataSourceRequest, options = {}, configuration) {
|
|
1582
|
+
// verify required parameter 'instanceId' is not null or undefined
|
|
1583
|
+
assertParamExists('updateAiLakeDatabaseDataSource', 'instanceId', instanceId);
|
|
1584
|
+
// verify required parameter 'updateDatabaseDataSourceRequest' is not null or undefined
|
|
1585
|
+
assertParamExists('updateAiLakeDatabaseDataSource', 'updateDatabaseDataSourceRequest', updateDatabaseDataSourceRequest);
|
|
1586
|
+
const localVarPath = `/api/v1/ailake/database/instances/{instanceId}/dataSource`
|
|
1587
|
+
.replace(`{${"instanceId"}}`, encodeURIComponent(String(instanceId)));
|
|
1588
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1589
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1590
|
+
let baseOptions;
|
|
1591
|
+
if (configuration) {
|
|
1592
|
+
baseOptions = configuration.baseOptions;
|
|
1593
|
+
}
|
|
1594
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options };
|
|
1595
|
+
const localVarHeaderParameter = {};
|
|
1596
|
+
const localVarQueryParameter = {};
|
|
1597
|
+
const consumes = [
|
|
1598
|
+
'application/json'
|
|
1599
|
+
];
|
|
1600
|
+
// use application/json if present, otherwise fallback to the first one
|
|
1601
|
+
localVarHeaderParameter['Content-Type'] = consumes.includes('application/json')
|
|
1602
|
+
? 'application/json'
|
|
1603
|
+
: consumes[0];
|
|
1604
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1605
|
+
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
|
|
1606
|
+
localVarRequestOptions.headers = {
|
|
1607
|
+
...localVarHeaderParameter,
|
|
1608
|
+
...headersFromBaseOptions,
|
|
1609
|
+
...options.headers,
|
|
1610
|
+
};
|
|
1611
|
+
const needsSerialization = typeof updateDatabaseDataSourceRequest !== "string" ||
|
|
1612
|
+
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
1613
|
+
localVarRequestOptions.data = needsSerialization
|
|
1614
|
+
? JSON.stringify(updateDatabaseDataSourceRequest !== undefined ? updateDatabaseDataSourceRequest : {})
|
|
1615
|
+
: updateDatabaseDataSourceRequest || "";
|
|
1616
|
+
return {
|
|
1617
|
+
url: toPathString(localVarUrlObj),
|
|
1618
|
+
options: localVarRequestOptions,
|
|
1619
|
+
};
|
|
1620
|
+
}
|
|
1621
|
+
// AILakeDatabasesApi Api FP
|
|
1622
|
+
/**
|
|
1623
|
+
* (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.
|
|
1624
|
+
* @summary (BETA) Add a data source to an AILake Database instance
|
|
1625
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1626
|
+
* @param {string} basePath Base path.
|
|
1627
|
+
* @param {AILakeDatabasesApiAddAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
1628
|
+
* @param {*} [options] Override http request option.
|
|
1629
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1630
|
+
* @throws {RequiredError}
|
|
1631
|
+
*/
|
|
1632
|
+
export async function AILakeDatabasesApi_AddAiLakeDatabaseDataSource(axios, basePath, requestParameters, options, configuration) {
|
|
1633
|
+
const localVarAxiosArgs = await AILakeDatabasesApiAxiosParamCreator_AddAiLakeDatabaseDataSource(requestParameters.instanceId, requestParameters.addDatabaseDataSourceRequest, options || {}, configuration);
|
|
1634
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
1635
|
+
}
|
|
1083
1636
|
// AILakeDatabasesApi Api FP
|
|
1084
1637
|
/**
|
|
1085
1638
|
* (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.
|
|
@@ -1111,6 +1664,21 @@ export async function AILakeDatabasesApi_GetAiLakeDatabaseInstance(axios, basePa
|
|
|
1111
1664
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
1112
1665
|
}
|
|
1113
1666
|
// AILakeDatabasesApi Api FP
|
|
1667
|
+
/**
|
|
1668
|
+
* (BETA) Returns all data source associations for the specified AI Lake database instance.
|
|
1669
|
+
* @summary (BETA) List data sources of an AILake Database instance
|
|
1670
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1671
|
+
* @param {string} basePath Base path.
|
|
1672
|
+
* @param {AILakeDatabasesApiListAiLakeDatabaseDataSourcesRequest} requestParameters Request parameters.
|
|
1673
|
+
* @param {*} [options] Override http request option.
|
|
1674
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1675
|
+
* @throws {RequiredError}
|
|
1676
|
+
*/
|
|
1677
|
+
export async function AILakeDatabasesApi_ListAiLakeDatabaseDataSources(axios, basePath, requestParameters, options, configuration) {
|
|
1678
|
+
const localVarAxiosArgs = await AILakeDatabasesApiAxiosParamCreator_ListAiLakeDatabaseDataSources(requestParameters.instanceId, options || {}, configuration);
|
|
1679
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
1680
|
+
}
|
|
1681
|
+
// AILakeDatabasesApi Api FP
|
|
1114
1682
|
/**
|
|
1115
1683
|
* (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.
|
|
1116
1684
|
* @summary (BETA) List AI Lake Database instances
|
|
@@ -1126,6 +1694,20 @@ export async function AILakeDatabasesApi_ListAiLakeDatabaseInstances(axios, base
|
|
|
1126
1694
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
1127
1695
|
}
|
|
1128
1696
|
// AILakeDatabasesApi Api FP
|
|
1697
|
+
/**
|
|
1698
|
+
* (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.
|
|
1699
|
+
* @summary (BETA) List registered AI Lake ObjectStorages
|
|
1700
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1701
|
+
* @param {string} basePath Base path.
|
|
1702
|
+
* @param {*} [options] Override http request option.
|
|
1703
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1704
|
+
* @throws {RequiredError}
|
|
1705
|
+
*/
|
|
1706
|
+
export async function AILakeDatabasesApi_ListAiLakeObjectStorages(axios, basePath, options, configuration) {
|
|
1707
|
+
const localVarAxiosArgs = await AILakeDatabasesApiAxiosParamCreator_ListAiLakeObjectStorages(options || {}, configuration);
|
|
1708
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
1709
|
+
}
|
|
1710
|
+
// AILakeDatabasesApi Api FP
|
|
1129
1711
|
/**
|
|
1130
1712
|
* (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.
|
|
1131
1713
|
* @summary (BETA) Create a new AILake Database instance
|
|
@@ -1140,6 +1722,36 @@ export async function AILakeDatabasesApi_ProvisionAiLakeDatabaseInstance(axios,
|
|
|
1140
1722
|
const localVarAxiosArgs = await AILakeDatabasesApiAxiosParamCreator_ProvisionAiLakeDatabaseInstance(requestParameters.provisionDatabaseInstanceRequest, requestParameters.operationId, options || {}, configuration);
|
|
1141
1723
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
1142
1724
|
}
|
|
1725
|
+
// AILakeDatabasesApi Api FP
|
|
1726
|
+
/**
|
|
1727
|
+
* (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.
|
|
1728
|
+
* @summary (BETA) Remove a data source from an AILake Database instance
|
|
1729
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1730
|
+
* @param {string} basePath Base path.
|
|
1731
|
+
* @param {AILakeDatabasesApiRemoveAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
1732
|
+
* @param {*} [options] Override http request option.
|
|
1733
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1734
|
+
* @throws {RequiredError}
|
|
1735
|
+
*/
|
|
1736
|
+
export async function AILakeDatabasesApi_RemoveAiLakeDatabaseDataSource(axios, basePath, requestParameters, options, configuration) {
|
|
1737
|
+
const localVarAxiosArgs = await AILakeDatabasesApiAxiosParamCreator_RemoveAiLakeDatabaseDataSource(requestParameters.instanceId, requestParameters.dataSourceId, options || {}, configuration);
|
|
1738
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
1739
|
+
}
|
|
1740
|
+
// AILakeDatabasesApi Api FP
|
|
1741
|
+
/**
|
|
1742
|
+
* (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.
|
|
1743
|
+
* @summary (BETA) Update the data source of an AILake Database instance
|
|
1744
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1745
|
+
* @param {string} basePath Base path.
|
|
1746
|
+
* @param {AILakeDatabasesApiUpdateAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
1747
|
+
* @param {*} [options] Override http request option.
|
|
1748
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1749
|
+
* @throws {RequiredError}
|
|
1750
|
+
*/
|
|
1751
|
+
export async function AILakeDatabasesApi_UpdateAiLakeDatabaseDataSource(axios, basePath, requestParameters, options, configuration) {
|
|
1752
|
+
const localVarAxiosArgs = await AILakeDatabasesApiAxiosParamCreator_UpdateAiLakeDatabaseDataSource(requestParameters.instanceId, requestParameters.updateDatabaseDataSourceRequest, options || {}, configuration);
|
|
1753
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
1754
|
+
}
|
|
1143
1755
|
/**
|
|
1144
1756
|
* AILakeDatabasesApi - object-oriented interface
|
|
1145
1757
|
* @export
|
|
@@ -1147,6 +1759,17 @@ export async function AILakeDatabasesApi_ProvisionAiLakeDatabaseInstance(axios,
|
|
|
1147
1759
|
* @extends {BaseAPI}
|
|
1148
1760
|
*/
|
|
1149
1761
|
export class AILakeDatabasesApi extends BaseAPI {
|
|
1762
|
+
/**
|
|
1763
|
+
* (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.
|
|
1764
|
+
* @summary (BETA) Add a data source to an AILake Database instance
|
|
1765
|
+
* @param {AILakeDatabasesApiAddAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
1766
|
+
* @param {*} [options] Override http request option.
|
|
1767
|
+
* @throws {RequiredError}
|
|
1768
|
+
* @memberof AILakeDatabasesApi
|
|
1769
|
+
*/
|
|
1770
|
+
addAiLakeDatabaseDataSource(requestParameters, options) {
|
|
1771
|
+
return AILakeDatabasesApi_AddAiLakeDatabaseDataSource(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
1772
|
+
}
|
|
1150
1773
|
/**
|
|
1151
1774
|
* (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.
|
|
1152
1775
|
* @summary (BETA) Delete an existing AILake Database instance
|
|
@@ -1169,6 +1792,17 @@ export class AILakeDatabasesApi extends BaseAPI {
|
|
|
1169
1792
|
getAiLakeDatabaseInstance(requestParameters, options) {
|
|
1170
1793
|
return AILakeDatabasesApi_GetAiLakeDatabaseInstance(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
1171
1794
|
}
|
|
1795
|
+
/**
|
|
1796
|
+
* (BETA) Returns all data source associations for the specified AI Lake database instance.
|
|
1797
|
+
* @summary (BETA) List data sources of an AILake Database instance
|
|
1798
|
+
* @param {AILakeDatabasesApiListAiLakeDatabaseDataSourcesRequest} requestParameters Request parameters.
|
|
1799
|
+
* @param {*} [options] Override http request option.
|
|
1800
|
+
* @throws {RequiredError}
|
|
1801
|
+
* @memberof AILakeDatabasesApi
|
|
1802
|
+
*/
|
|
1803
|
+
listAiLakeDatabaseDataSources(requestParameters, options) {
|
|
1804
|
+
return AILakeDatabasesApi_ListAiLakeDatabaseDataSources(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
1805
|
+
}
|
|
1172
1806
|
/**
|
|
1173
1807
|
* (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.
|
|
1174
1808
|
* @summary (BETA) List AI Lake Database instances
|
|
@@ -1180,6 +1814,16 @@ export class AILakeDatabasesApi extends BaseAPI {
|
|
|
1180
1814
|
listAiLakeDatabaseInstances(requestParameters = {}, options) {
|
|
1181
1815
|
return AILakeDatabasesApi_ListAiLakeDatabaseInstances(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
1182
1816
|
}
|
|
1817
|
+
/**
|
|
1818
|
+
* (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.
|
|
1819
|
+
* @summary (BETA) List registered AI Lake ObjectStorages
|
|
1820
|
+
* @param {*} [options] Override http request option.
|
|
1821
|
+
* @throws {RequiredError}
|
|
1822
|
+
* @memberof AILakeDatabasesApi
|
|
1823
|
+
*/
|
|
1824
|
+
listAiLakeObjectStorages(options) {
|
|
1825
|
+
return AILakeDatabasesApi_ListAiLakeObjectStorages(this.axios, this.basePath, options, this.configuration);
|
|
1826
|
+
}
|
|
1183
1827
|
/**
|
|
1184
1828
|
* (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.
|
|
1185
1829
|
* @summary (BETA) Create a new AILake Database instance
|
|
@@ -1191,6 +1835,28 @@ export class AILakeDatabasesApi extends BaseAPI {
|
|
|
1191
1835
|
provisionAiLakeDatabaseInstance(requestParameters, options) {
|
|
1192
1836
|
return AILakeDatabasesApi_ProvisionAiLakeDatabaseInstance(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
1193
1837
|
}
|
|
1838
|
+
/**
|
|
1839
|
+
* (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.
|
|
1840
|
+
* @summary (BETA) Remove a data source from an AILake Database instance
|
|
1841
|
+
* @param {AILakeDatabasesApiRemoveAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
1842
|
+
* @param {*} [options] Override http request option.
|
|
1843
|
+
* @throws {RequiredError}
|
|
1844
|
+
* @memberof AILakeDatabasesApi
|
|
1845
|
+
*/
|
|
1846
|
+
removeAiLakeDatabaseDataSource(requestParameters, options) {
|
|
1847
|
+
return AILakeDatabasesApi_RemoveAiLakeDatabaseDataSource(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
1848
|
+
}
|
|
1849
|
+
/**
|
|
1850
|
+
* (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.
|
|
1851
|
+
* @summary (BETA) Update the data source of an AILake Database instance
|
|
1852
|
+
* @param {AILakeDatabasesApiUpdateAiLakeDatabaseDataSourceRequest} requestParameters Request parameters.
|
|
1853
|
+
* @param {*} [options] Override http request option.
|
|
1854
|
+
* @throws {RequiredError}
|
|
1855
|
+
* @memberof AILakeDatabasesApi
|
|
1856
|
+
*/
|
|
1857
|
+
updateAiLakeDatabaseDataSource(requestParameters, options) {
|
|
1858
|
+
return AILakeDatabasesApi_UpdateAiLakeDatabaseDataSource(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
1859
|
+
}
|
|
1194
1860
|
}
|
|
1195
1861
|
// AILakePipeTablesApi FP - AILakePipeTablesApiAxiosParamCreator
|
|
1196
1862
|
/**
|
|
@@ -2777,7 +3443,7 @@ export async function ActionsApiAxiosParamCreator_CreatedBy(workspaceId, options
|
|
|
2777
3443
|
* @summary AFM explain resource.
|
|
2778
3444
|
* @param {string} workspaceId Workspace identifier
|
|
2779
3445
|
* @param {AfmExecution} afmExecution
|
|
2780
|
-
* @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
|
|
3446
|
+
* @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
|
|
2781
3447
|
* @param {*} [options] Override http request option.
|
|
2782
3448
|
* @param {Configuration} [configuration] Optional configuration.
|
|
2783
3449
|
* @throws {RequiredError}
|
|
@@ -4778,6 +5444,7 @@ export class ActionsApi extends BaseAPI {
|
|
|
4778
5444
|
* @summary (EXPERIMENTAL) Smart functions - Anomaly Detection
|
|
4779
5445
|
* @param {ActionsApiAnomalyDetectionRequest} requestParameters Request parameters.
|
|
4780
5446
|
* @param {*} [options] Override http request option.
|
|
5447
|
+
* @deprecated
|
|
4781
5448
|
* @throws {RequiredError}
|
|
4782
5449
|
* @memberof ActionsApi
|
|
4783
5450
|
*/
|
|
@@ -4789,6 +5456,7 @@ export class ActionsApi extends BaseAPI {
|
|
|
4789
5456
|
* @summary (EXPERIMENTAL) Smart functions - Anomaly Detection Result
|
|
4790
5457
|
* @param {ActionsApiAnomalyDetectionResultRequest} requestParameters Request parameters.
|
|
4791
5458
|
* @param {*} [options] Override http request option.
|
|
5459
|
+
* @deprecated
|
|
4792
5460
|
* @throws {RequiredError}
|
|
4793
5461
|
* @memberof ActionsApi
|
|
4794
5462
|
*/
|
|
@@ -5657,7 +6325,7 @@ export async function ComputationApiAxiosParamCreator_ComputeValidObjects(worksp
|
|
|
5657
6325
|
* @summary AFM explain resource.
|
|
5658
6326
|
* @param {string} workspaceId Workspace identifier
|
|
5659
6327
|
* @param {AfmExecution} afmExecution
|
|
5660
|
-
* @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
|
|
6328
|
+
* @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
|
|
5661
6329
|
* @param {*} [options] Override http request option.
|
|
5662
6330
|
* @param {Configuration} [configuration] Optional configuration.
|
|
5663
6331
|
* @throws {RequiredError}
|
|
@@ -8193,6 +8861,7 @@ export class SmartFunctionsApi extends BaseAPI {
|
|
|
8193
8861
|
* @summary (EXPERIMENTAL) Smart functions - Anomaly Detection
|
|
8194
8862
|
* @param {SmartFunctionsApiAnomalyDetectionRequest} requestParameters Request parameters.
|
|
8195
8863
|
* @param {*} [options] Override http request option.
|
|
8864
|
+
* @deprecated
|
|
8196
8865
|
* @throws {RequiredError}
|
|
8197
8866
|
* @memberof SmartFunctionsApi
|
|
8198
8867
|
*/
|
|
@@ -8204,6 +8873,7 @@ export class SmartFunctionsApi extends BaseAPI {
|
|
|
8204
8873
|
* @summary (EXPERIMENTAL) Smart functions - Anomaly Detection Result
|
|
8205
8874
|
* @param {SmartFunctionsApiAnomalyDetectionResultRequest} requestParameters Request parameters.
|
|
8206
8875
|
* @param {*} [options] Override http request option.
|
|
8876
|
+
* @deprecated
|
|
8207
8877
|
* @throws {RequiredError}
|
|
8208
8878
|
* @memberof SmartFunctionsApi
|
|
8209
8879
|
*/
|