@yugabytedb/perf-advisor-client 0.0.0-stage → 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -2
- package/dist/generated/api/anomaly/anomaly.d.ts +228 -0
- package/dist/generated/api/customer/customer.d.ts +200 -0
- package/dist/generated/api/export-config/export-config.d.ts +175 -0
- package/dist/generated/api/graph/graph.d.ts +62 -0
- package/dist/generated/api/info/info.d.ts +30 -0
- package/dist/generated/api/runtime-config/runtime-config.d.ts +80 -0
- package/dist/generated/api/schema/schema.d.ts +214 -0
- package/dist/generated/api/support-bundle/support-bundle.d.ts +167 -0
- package/dist/generated/api/universe/universe.d.ts +267 -0
- package/dist/generated/api/user/user.d.ts +134 -0
- package/dist/generated/api/workload/workload.d.ts +178 -0
- package/dist/generated/api.d.ts +11 -0
- package/dist/generated/model/activityExclusions.d.ts +25 -0
- package/dist/generated/model/activityPeriod.d.ts +20 -0
- package/dist/generated/model/aggregatedLineSettings.d.ts +22 -0
- package/dist/generated/model/aggregatedLineSettingsAggregation.d.ts +18 -0
- package/dist/generated/model/anomaly.d.ts +18 -0
- package/dist/generated/model/anomalyDetails.d.ts +18 -0
- package/dist/generated/model/anomalyDetection.d.ts +18 -0
- package/dist/generated/model/anomalyDetectionInfo.d.ts +21 -0
- package/dist/generated/model/anomalyDetectionInfoState.d.ts +21 -0
- package/dist/generated/model/anomalyEntity.d.ts +23 -0
- package/dist/generated/model/anomalyEntityLabels.d.ts +17 -0
- package/dist/generated/model/anomalyFilter.d.ts +32 -0
- package/dist/generated/model/anomalyGraph.d.ts +27 -0
- package/dist/generated/model/anomalyGroup.d.ts +18 -0
- package/dist/generated/model/anomalyGroupInfo.d.ts +21 -0
- package/dist/generated/model/anomalyGroupPagedResp.d.ts +16 -0
- package/dist/generated/model/anomalyGroupsOfType.d.ts +28 -0
- package/dist/generated/model/anomalyIndexDetails.d.ts +24 -0
- package/dist/generated/model/anomalyInfo.d.ts +46 -0
- package/dist/generated/model/anomalyPagedResp.d.ts +16 -0
- package/dist/generated/model/anomalySortBy.d.ts +23 -0
- package/dist/generated/model/anomalyType.d.ts +30 -0
- package/dist/generated/model/badRequestResponse.d.ts +16 -0
- package/dist/generated/model/clusterRef.d.ts +19 -0
- package/dist/generated/model/clusterRefClusterType.d.ts +17 -0
- package/dist/generated/model/conflictResponse.d.ts +16 -0
- package/dist/generated/model/cpuStats.d.ts +24 -0
- package/dist/generated/model/credentials.d.ts +32 -0
- package/dist/generated/model/credentialsType.d.ts +23 -0
- package/dist/generated/model/customer.d.ts +20 -0
- package/dist/generated/model/customerInfo.d.ts +14 -0
- package/dist/generated/model/customerPagedResp.d.ts +16 -0
- package/dist/generated/model/customerSpec.d.ts +32 -0
- package/dist/generated/model/database.d.ts +18 -0
- package/dist/generated/model/databaseInfo.d.ts +16 -0
- package/dist/generated/model/databasePagedResp.d.ts +16 -0
- package/dist/generated/model/databaseSchema.d.ts +18 -0
- package/dist/generated/model/databaseSchemaInfo.d.ts +14 -0
- package/dist/generated/model/databaseSchemaPagedResp.d.ts +16 -0
- package/dist/generated/model/databaseStats.d.ts +18 -0
- package/dist/generated/model/databaseStatsFilter.d.ts +27 -0
- package/dist/generated/model/databaseStatsInfo.d.ts +27 -0
- package/dist/generated/model/databaseStatsPagedResp.d.ts +19 -0
- package/dist/generated/model/databaseStatsSortBy.d.ts +24 -0
- package/dist/generated/model/databaseType.d.ts +21 -0
- package/dist/generated/model/deleteSupportBundleParams.d.ts +17 -0
- package/dist/generated/model/deleteUniverseParams.d.ts +19 -0
- package/dist/generated/model/endpoint.d.ts +19 -0
- package/dist/generated/model/error.d.ts +37 -0
- package/dist/generated/model/estimateSupportBundleSizeParams.d.ts +23 -0
- package/dist/generated/model/exportConfig.d.ts +20 -0
- package/dist/generated/model/exportConfigCheck.d.ts +18 -0
- package/dist/generated/model/exportConfigInfo.d.ts +14 -0
- package/dist/generated/model/exportConfigMetrics.d.ts +19 -0
- package/dist/generated/model/exportConfigPagedResp.d.ts +16 -0
- package/dist/generated/model/exportConfigSpec.d.ts +34 -0
- package/dist/generated/model/exportConfigValidation.d.ts +20 -0
- package/dist/generated/model/exportConfigValidationSpec.d.ts +23 -0
- package/dist/generated/model/fieldError.d.ts +16 -0
- package/dist/generated/model/forbiddenResponse.d.ts +16 -0
- package/dist/generated/model/getAnomalyGroupParams.d.ts +18 -0
- package/dist/generated/model/getQueryStatsParams.d.ts +24 -0
- package/dist/generated/model/graph.d.ts +24 -0
- package/dist/generated/model/graphAxis.d.ts +19 -0
- package/dist/generated/model/graphAxisAlias.d.ts +17 -0
- package/dist/generated/model/graphCatalogEntry.d.ts +30 -0
- package/dist/generated/model/graphFilters.d.ts +18 -0
- package/dist/generated/model/graphGroupByOption.d.ts +17 -0
- package/dist/generated/model/graphLayout.d.ts +26 -0
- package/dist/generated/model/graphQuerySpec.d.ts +35 -0
- package/dist/generated/model/graphSeries.d.ts +32 -0
- package/dist/generated/model/graphSeriesLabels.d.ts +17 -0
- package/dist/generated/model/graphSettings.d.ts +25 -0
- package/dist/generated/model/graphSettingsAggregatedValueFunction.d.ts +18 -0
- package/dist/generated/model/graphSettingsSplitMode.d.ts +17 -0
- package/dist/generated/model/graphSettingsSplitType.d.ts +18 -0
- package/dist/generated/model/graphWindow.d.ts +19 -0
- package/dist/generated/model/index.d.ts +18 -0
- package/dist/generated/model/indexColumn.d.ts +21 -0
- package/dist/generated/model/indexDefinition.d.ts +19 -0
- package/dist/generated/model/indexFilter.d.ts +28 -0
- package/dist/generated/model/indexFlags.d.ts +23 -0
- package/dist/generated/model/indexInfo.d.ts +33 -0
- package/dist/generated/model/indexPagedResp.d.ts +16 -0
- package/dist/generated/model/indexSortBy.d.ts +19 -0
- package/dist/generated/model/internalErrorResponse.d.ts +16 -0
- package/dist/generated/model/kubernetesPod.d.ts +18 -0
- package/dist/generated/model/latencyStats.d.ts +22 -0
- package/dist/generated/model/listAnomaliesParams.d.ts +38 -0
- package/dist/generated/model/listAnomalyGroupsByTypeParams.d.ts +33 -0
- package/dist/generated/model/listAnomalyGroupsParams.d.ts +36 -0
- package/dist/generated/model/listCustomerRuntimeConfigsParams.d.ts +17 -0
- package/dist/generated/model/listCustomersParams.d.ts +18 -0
- package/dist/generated/model/listDatabaseSchemasParams.d.ts +18 -0
- package/dist/generated/model/listDatabaseStatsParams.d.ts +53 -0
- package/dist/generated/model/listDatabasesParams.d.ts +23 -0
- package/dist/generated/model/listExportConfigsParams.d.ts +18 -0
- package/dist/generated/model/listIndexesParams.d.ts +33 -0
- package/dist/generated/model/listMaterializedViewsParams.d.ts +33 -0
- package/dist/generated/model/listNodeStatsParams.d.ts +44 -0
- package/dist/generated/model/listQueriesParams.d.ts +33 -0
- package/dist/generated/model/listQueryStatsParams.d.ts +59 -0
- package/dist/generated/model/listRuntimeConfigsParams.d.ts +17 -0
- package/dist/generated/model/listSupportBundlesParams.d.ts +18 -0
- package/dist/generated/model/listTableStatsParams.d.ts +37 -0
- package/dist/generated/model/listTabletStatsParams.d.ts +58 -0
- package/dist/generated/model/listUniverseNodesParams.d.ts +28 -0
- package/dist/generated/model/listUniverseRuntimeConfigsParams.d.ts +17 -0
- package/dist/generated/model/listUniversesParams.d.ts +31 -0
- package/dist/generated/model/listUsersParams.d.ts +18 -0
- package/dist/generated/model/loadStats.d.ts +24 -0
- package/dist/generated/model/materializedView.d.ts +18 -0
- package/dist/generated/model/materializedViewFilter.d.ts +26 -0
- package/dist/generated/model/materializedViewInfo.d.ts +22 -0
- package/dist/generated/model/materializedViewPagedResp.d.ts +16 -0
- package/dist/generated/model/materializedViewSortBy.d.ts +18 -0
- package/dist/generated/model/metadataRefresh.d.ts +20 -0
- package/dist/generated/model/metadataRefreshResult.d.ts +24 -0
- package/dist/generated/model/metadataRefreshResultStatus.d.ts +22 -0
- package/dist/generated/model/metadataRefreshSpec.d.ts +19 -0
- package/dist/generated/model/metadataRefreshTarget.d.ts +18 -0
- package/dist/generated/model/metricsExportEndpoint.d.ts +21 -0
- package/dist/generated/model/metricsExportEndpointProtocol.d.ts +19 -0
- package/dist/generated/model/nodeFilter.d.ts +27 -0
- package/dist/generated/model/nodePlacement.d.ts +19 -0
- package/dist/generated/model/nodeStats.d.ts +18 -0
- package/dist/generated/model/nodeStatsInfo.d.ts +23 -0
- package/dist/generated/model/nodeStatsPagedResp.d.ts +16 -0
- package/dist/generated/model/nodeStatsSortBy.d.ts +19 -0
- package/dist/generated/model/notFoundResponse.d.ts +16 -0
- package/dist/generated/model/objectLifecycle.d.ts +22 -0
- package/dist/generated/model/objectNamespace.d.ts +20 -0
- package/dist/generated/model/objectRef.d.ts +19 -0
- package/dist/generated/model/pageRequest.d.ts +31 -0
- package/dist/generated/model/pagination.d.ts +22 -0
- package/dist/generated/model/perfAdvisor.d.ts +18 -0
- package/dist/generated/model/perfAdvisorInfo.d.ts +21 -0
- package/dist/generated/model/query.d.ts +18 -0
- package/dist/generated/model/queryFilter.d.ts +29 -0
- package/dist/generated/model/queryInfo.d.ts +29 -0
- package/dist/generated/model/queryPagedResp.d.ts +16 -0
- package/dist/generated/model/queryPlan.d.ts +26 -0
- package/dist/generated/model/queryPlanExecutionTime.d.ts +20 -0
- package/dist/generated/model/queryPlanUsage.d.ts +19 -0
- package/dist/generated/model/querySortBy.d.ts +19 -0
- package/dist/generated/model/queryStats.d.ts +18 -0
- package/dist/generated/model/queryStatsFilter.d.ts +35 -0
- package/dist/generated/model/queryStatsInfo.d.ts +40 -0
- package/dist/generated/model/queryStatsPagedResp.d.ts +16 -0
- package/dist/generated/model/queryStatsSortBy.d.ts +26 -0
- package/dist/generated/model/queryType.d.ts +21 -0
- package/dist/generated/model/rcaGuideline.d.ts +17 -0
- package/dist/generated/model/rcaRecommendation.d.ts +16 -0
- package/dist/generated/model/relationType.d.ts +21 -0
- package/dist/generated/model/replicationStatus.d.ts +25 -0
- package/dist/generated/model/runtimeConfig.d.ts +20 -0
- package/dist/generated/model/runtimeConfigInfo.d.ts +23 -0
- package/dist/generated/model/runtimeConfigInfoAllowedScopesItem.d.ts +17 -0
- package/dist/generated/model/runtimeConfigInfoType.d.ts +19 -0
- package/dist/generated/model/runtimeConfigSpec.d.ts +15 -0
- package/dist/generated/model/scrapedMetricsEndpoint.d.ts +19 -0
- package/dist/generated/model/serverType.d.ts +19 -0
- package/dist/generated/model/sortDirection.d.ts +16 -0
- package/dist/generated/model/statsSummary.d.ts +22 -0
- package/dist/generated/model/storageSize.d.ts +22 -0
- package/dist/generated/model/supportBundle.d.ts +20 -0
- package/dist/generated/model/supportBundleInfo.d.ts +21 -0
- package/dist/generated/model/supportBundleInfoState.d.ts +21 -0
- package/dist/generated/model/supportBundleMetricFormat.d.ts +19 -0
- package/dist/generated/model/supportBundlePagedResp.d.ts +16 -0
- package/dist/generated/model/supportBundleSizeEstimate.d.ts +19 -0
- package/dist/generated/model/supportBundleSpec.d.ts +28 -0
- package/dist/generated/model/supportBundleSpecMetricFormat.d.ts +20 -0
- package/dist/generated/model/syncStatus.d.ts +20 -0
- package/dist/generated/model/tableColumn.d.ts +16 -0
- package/dist/generated/model/tableRef.d.ts +23 -0
- package/dist/generated/model/tableStats.d.ts +18 -0
- package/dist/generated/model/tableStatsFilter.d.ts +29 -0
- package/dist/generated/model/tableStatsInfo.d.ts +43 -0
- package/dist/generated/model/tableStatsPagedResp.d.ts +19 -0
- package/dist/generated/model/tableStatsSortBy.d.ts +19 -0
- package/dist/generated/model/tabletPlacement.d.ts +19 -0
- package/dist/generated/model/tabletRelation.d.ts +24 -0
- package/dist/generated/model/tabletStats.d.ts +18 -0
- package/dist/generated/model/tabletStatsFilter.d.ts +33 -0
- package/dist/generated/model/tabletStatsInfo.d.ts +35 -0
- package/dist/generated/model/tabletStatsPagedResp.d.ts +19 -0
- package/dist/generated/model/tabletStatsSortBy.d.ts +18 -0
- package/dist/generated/model/timeWindow.d.ts +20 -0
- package/dist/generated/model/unauthorizedResponse.d.ts +16 -0
- package/dist/generated/model/universe.d.ts +20 -0
- package/dist/generated/model/universeClusterInfo.d.ts +17 -0
- package/dist/generated/model/universeCollectionInfo.d.ts +26 -0
- package/dist/generated/model/universeDatabaseSpec.d.ts +21 -0
- package/dist/generated/model/universeFeature.d.ts +19 -0
- package/dist/generated/model/universeFeatures.d.ts +29 -0
- package/dist/generated/model/universeInfo.d.ts +38 -0
- package/dist/generated/model/universeMetricsExportSpec.d.ts +22 -0
- package/dist/generated/model/universeNode.d.ts +18 -0
- package/dist/generated/model/universeNodeInfo.d.ts +28 -0
- package/dist/generated/model/universeNodePagedResp.d.ts +16 -0
- package/dist/generated/model/universePagedResp.d.ts +16 -0
- package/dist/generated/model/universeSortBy.d.ts +21 -0
- package/dist/generated/model/universeSpec.d.ts +30 -0
- package/dist/generated/model/universeSpecCollectionMode.d.ts +22 -0
- package/dist/generated/model/universeState.d.ts +18 -0
- package/dist/generated/model/universeSyncInfo.d.ts +22 -0
- package/dist/generated/model/universeSyncStatus.d.ts +21 -0
- package/dist/generated/model/universeSyncStatusProcess.d.ts +28 -0
- package/dist/generated/model/user.d.ts +20 -0
- package/dist/generated/model/userInfo.d.ts +14 -0
- package/dist/generated/model/userPagedResp.d.ts +16 -0
- package/dist/generated/model/userSpec.d.ts +16 -0
- package/dist/generated/model/waitEvent.d.ts +20 -0
- package/dist/generated/model/waitEventFilter.d.ts +20 -0
- package/dist/generated/model/waitEventGrouping.d.ts +16 -0
- package/dist/generated/model/waitEventLoad.d.ts +22 -0
- package/dist/generated/model/ybaInfo.d.ts +17 -0
- package/dist/generated/model/ybmClusterInfo.d.ts +18 -0
- package/dist/generated/model/ybmProject.d.ts +18 -0
- package/dist/generated/model.d.ts +220 -0
- package/dist/http.d.ts +13 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +2234 -0
- package/package.json +39 -4
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Format metrics are written in: `PROMQL_JSON` - PromQL query results; `PROM_CHUNK` - Prometheus chunks, which are smaller.
|
|
14
|
+
*/
|
|
15
|
+
export type SupportBundleMetricFormat = typeof SupportBundleMetricFormat[keyof typeof SupportBundleMetricFormat];
|
|
16
|
+
export declare const SupportBundleMetricFormat: {
|
|
17
|
+
readonly PROMQL_JSON: "PROMQL_JSON";
|
|
18
|
+
readonly PROM_CHUNK: "PROM_CHUNK";
|
|
19
|
+
};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { Pagination } from './pagination';
|
|
13
|
+
import type { SupportBundle } from './supportBundle';
|
|
14
|
+
export type SupportBundlePagedResp = Pagination & {
|
|
15
|
+
entities: SupportBundle[];
|
|
16
|
+
};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Estimated size of a support bundle, before compression.
|
|
14
|
+
*/
|
|
15
|
+
export interface SupportBundleSizeEstimate {
|
|
16
|
+
readonly metadata_bytes: number;
|
|
17
|
+
/** Not set when the volume of metrics can't be read from the metric store. */
|
|
18
|
+
readonly metrics_bytes?: number;
|
|
19
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { SupportBundleSpecMetricFormat } from './supportBundleSpecMetricFormat';
|
|
13
|
+
import type { TimeWindow } from './timeWindow';
|
|
14
|
+
/**
|
|
15
|
+
* What a support bundle contains.
|
|
16
|
+
*/
|
|
17
|
+
export interface SupportBundleSpec {
|
|
18
|
+
/**
|
|
19
|
+
* Time range to collect metrics and activity for. Both `start_time` and `end_time` are
|
|
20
|
+
* required, and the start must be before the end.
|
|
21
|
+
*/
|
|
22
|
+
time_window: TimeWindow;
|
|
23
|
+
/**
|
|
24
|
+
* Format metrics are written in: `PROMQL_JSON` - PromQL query results; `PROM_CHUNK` -
|
|
25
|
+
* Prometheus chunks, which are smaller.
|
|
26
|
+
*/
|
|
27
|
+
metric_format?: SupportBundleSpecMetricFormat;
|
|
28
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Format metrics are written in: `PROMQL_JSON` - PromQL query results; `PROM_CHUNK` -
|
|
14
|
+
* Prometheus chunks, which are smaller.
|
|
15
|
+
*/
|
|
16
|
+
export type SupportBundleSpecMetricFormat = typeof SupportBundleSpecMetricFormat[keyof typeof SupportBundleSpecMetricFormat];
|
|
17
|
+
export declare const SupportBundleSpecMetricFormat: {
|
|
18
|
+
readonly PROMQL_JSON: "PROMQL_JSON";
|
|
19
|
+
readonly PROM_CHUNK: "PROM_CHUNK";
|
|
20
|
+
};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* The outcome of the latest run of a sync.
|
|
14
|
+
*/
|
|
15
|
+
export interface SyncStatus {
|
|
16
|
+
readonly succeeded?: boolean;
|
|
17
|
+
readonly sync_time?: string;
|
|
18
|
+
readonly last_successful_sync_time?: string;
|
|
19
|
+
readonly error?: string;
|
|
20
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
export interface TableColumn {
|
|
13
|
+
readonly name: string;
|
|
14
|
+
/** SQL type, for example `bigint`. */
|
|
15
|
+
readonly type?: string;
|
|
16
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* A table, or an index of it, with its namespace.
|
|
14
|
+
*/
|
|
15
|
+
export interface TableRef {
|
|
16
|
+
readonly namespace_id?: string;
|
|
17
|
+
readonly namespace_name?: string;
|
|
18
|
+
readonly schema_name?: string;
|
|
19
|
+
readonly table_id?: string;
|
|
20
|
+
readonly table_name?: string;
|
|
21
|
+
/** Set when the series is for an index of the table. */
|
|
22
|
+
readonly index_name?: string;
|
|
23
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { TableStatsInfo } from './tableStatsInfo';
|
|
13
|
+
/**
|
|
14
|
+
* A YSQL table, or a YCQL table or index, with its size.
|
|
15
|
+
*/
|
|
16
|
+
export interface TableStats {
|
|
17
|
+
info: TableStatsInfo;
|
|
18
|
+
}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { DatabaseType } from './databaseType';
|
|
13
|
+
/**
|
|
14
|
+
* Which tables' statistics to list.
|
|
15
|
+
*/
|
|
16
|
+
export interface TableStatsFilter {
|
|
17
|
+
/** Only tables of these types, `SQL` or `CQL`. Both by default. */
|
|
18
|
+
types?: DatabaseType[];
|
|
19
|
+
/** Only tables of this database or keyspace, by exact name. */
|
|
20
|
+
namespace_name?: string;
|
|
21
|
+
/** Only tables of this schema, by exact name. Only YSQL tables have schemas, so it leaves YCQL tables out. */
|
|
22
|
+
schema_name?: string;
|
|
23
|
+
/** Only tables with this exact name. */
|
|
24
|
+
table_name?: string;
|
|
25
|
+
/** Only tables whose name contains this text, ignoring case. */
|
|
26
|
+
table_name_contains?: string;
|
|
27
|
+
/** Only YCQL indexes (`true`), or only tables (`false`). `listIndexes` lists YSQL indexes, so `true` leaves YSQL tables out. */
|
|
28
|
+
index?: boolean;
|
|
29
|
+
}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { DatabaseType } from './databaseType';
|
|
13
|
+
import type { ObjectLifecycle } from './objectLifecycle';
|
|
14
|
+
import type { ObjectNamespace } from './objectNamespace';
|
|
15
|
+
import type { ReplicationStatus } from './replicationStatus';
|
|
16
|
+
import type { StorageSize } from './storageSize';
|
|
17
|
+
import type { TableColumn } from './tableColumn';
|
|
18
|
+
export interface TableStatsInfo {
|
|
19
|
+
/** `SQL` for a YSQL table, `CQL` for a YCQL table or index. */
|
|
20
|
+
type: DatabaseType;
|
|
21
|
+
/** The database and schema, or for YCQL the keyspace. */
|
|
22
|
+
namespace: ObjectNamespace;
|
|
23
|
+
readonly table_name: string;
|
|
24
|
+
/** Table OID. YSQL only. */
|
|
25
|
+
readonly table_id?: number;
|
|
26
|
+
/** Table UUID. YCQL only. */
|
|
27
|
+
readonly table_uuid?: string;
|
|
28
|
+
/** Whether this is an index. YCQL only. */
|
|
29
|
+
readonly index?: boolean;
|
|
30
|
+
/** Table state, as the YB-Master reports it, for example `RUNNING`. YCQL only. */
|
|
31
|
+
readonly state?: string;
|
|
32
|
+
/** YSQL only. */
|
|
33
|
+
readonly columns?: readonly TableColumn[];
|
|
34
|
+
/** CREATE TABLE statement. YSQL only. */
|
|
35
|
+
readonly definition?: string;
|
|
36
|
+
/** YSQL only. */
|
|
37
|
+
readonly definition_updated_time?: string;
|
|
38
|
+
/** YSQL only. */
|
|
39
|
+
readonly colocated?: boolean;
|
|
40
|
+
storage?: StorageSize;
|
|
41
|
+
replication?: ReplicationStatus;
|
|
42
|
+
lifecycle?: ObjectLifecycle;
|
|
43
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { Pagination } from './pagination';
|
|
13
|
+
import type { StatsSummary } from './statsSummary';
|
|
14
|
+
import type { TableStats } from './tableStats';
|
|
15
|
+
export type TableStatsPagedResp = Pagination & {
|
|
16
|
+
/** Set when `include_summary` is true. */
|
|
17
|
+
summary?: StatsSummary;
|
|
18
|
+
entities: TableStats[];
|
|
19
|
+
};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
export type TableStatsSortBy = typeof TableStatsSortBy[keyof typeof TableStatsSortBy];
|
|
13
|
+
export declare const TableStatsSortBy: {
|
|
14
|
+
readonly NAMESPACE_NAME: "NAMESPACE_NAME";
|
|
15
|
+
readonly SCHEMA_NAME: "SCHEMA_NAME";
|
|
16
|
+
readonly TABLE_NAME: "TABLE_NAME";
|
|
17
|
+
readonly FIRST_SEEN_TIME: "FIRST_SEEN_TIME";
|
|
18
|
+
readonly SIZE_BYTES: "SIZE_BYTES";
|
|
19
|
+
};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Which nodes hold a tablet's replicas.
|
|
14
|
+
*/
|
|
15
|
+
export interface TabletPlacement {
|
|
16
|
+
readonly leader_node?: string;
|
|
17
|
+
readonly leader_region?: string;
|
|
18
|
+
readonly follower_nodes?: readonly string[];
|
|
19
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { RelationType } from './relationType';
|
|
13
|
+
/**
|
|
14
|
+
* The table, index or materialized view a tablet stores.
|
|
15
|
+
*/
|
|
16
|
+
export interface TabletRelation {
|
|
17
|
+
/** Name of the table, index or materialized view the tablet stores. */
|
|
18
|
+
readonly name?: string;
|
|
19
|
+
type?: RelationType;
|
|
20
|
+
/** The table, or the table an index belongs to. Set for YSQL tables and their indexes only: a YCQL tablet (type `UNKNOWN`) and an index of a materialized view have their name in `name` only. */
|
|
21
|
+
readonly table_name?: string;
|
|
22
|
+
readonly index_name?: string;
|
|
23
|
+
readonly materialized_view_name?: string;
|
|
24
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { TabletStatsInfo } from './tabletStatsInfo';
|
|
13
|
+
/**
|
|
14
|
+
* A tablet, with its load and size over the requested time range.
|
|
15
|
+
*/
|
|
16
|
+
export interface TabletStats {
|
|
17
|
+
info: TabletStatsInfo;
|
|
18
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { DatabaseType } from './databaseType';
|
|
13
|
+
/**
|
|
14
|
+
* Which tablets' statistics to list.
|
|
15
|
+
*/
|
|
16
|
+
export interface TabletStatsFilter {
|
|
17
|
+
database_type?: DatabaseType;
|
|
18
|
+
/** Only tablets of this database or keyspace, by exact name. */
|
|
19
|
+
namespace_name?: string;
|
|
20
|
+
/** Only tablets of this schema, by exact name. */
|
|
21
|
+
schema_name?: string;
|
|
22
|
+
/** Only tablets of this table or index, by exact name. An index's tablets match the index's name, not its table's. */
|
|
23
|
+
table_name?: string;
|
|
24
|
+
/** Only this tablet. */
|
|
25
|
+
tablet_id?: string;
|
|
26
|
+
/** With `query_id`, only tablets the statement touched in this database. Without it, or with 0, the statement's activity in every database counts, as for YCQL and background statements, which have no database id. */
|
|
27
|
+
db_id?: number;
|
|
28
|
+
/**
|
|
29
|
+
* Only tablets this statement touched, by pg_stat_statements query id.
|
|
30
|
+
* @pattern ^-?\d+$
|
|
31
|
+
*/
|
|
32
|
+
query_id?: string;
|
|
33
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { DatabaseType } from './databaseType';
|
|
13
|
+
import type { LoadStats } from './loadStats';
|
|
14
|
+
import type { ObjectLifecycle } from './objectLifecycle';
|
|
15
|
+
import type { ObjectNamespace } from './objectNamespace';
|
|
16
|
+
import type { ReplicationStatus } from './replicationStatus';
|
|
17
|
+
import type { StorageSize } from './storageSize';
|
|
18
|
+
import type { TabletPlacement } from './tabletPlacement';
|
|
19
|
+
import type { TabletRelation } from './tabletRelation';
|
|
20
|
+
import type { WaitEventLoad } from './waitEventLoad';
|
|
21
|
+
export interface TabletStatsInfo {
|
|
22
|
+
readonly tablet_id: string;
|
|
23
|
+
database_type?: DatabaseType;
|
|
24
|
+
namespace?: ObjectNamespace;
|
|
25
|
+
relation?: TabletRelation;
|
|
26
|
+
/** Key range of the tablet. */
|
|
27
|
+
readonly partition?: string;
|
|
28
|
+
placement?: TabletPlacement;
|
|
29
|
+
replication?: ReplicationStatus;
|
|
30
|
+
load?: LoadStats;
|
|
31
|
+
storage?: StorageSize;
|
|
32
|
+
lifecycle?: ObjectLifecycle;
|
|
33
|
+
/** The load broken down by wait event type or wait event. Set when `group_events_by` is. */
|
|
34
|
+
readonly wait_events?: readonly WaitEventLoad[];
|
|
35
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { Pagination } from './pagination';
|
|
13
|
+
import type { StatsSummary } from './statsSummary';
|
|
14
|
+
import type { TabletStats } from './tabletStats';
|
|
15
|
+
export type TabletStatsPagedResp = Pagination & {
|
|
16
|
+
/** Set when `include_summary` is true. */
|
|
17
|
+
summary?: StatsSummary;
|
|
18
|
+
entities: TabletStats[];
|
|
19
|
+
};
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
export type TabletStatsSortBy = typeof TabletStatsSortBy[keyof typeof TabletStatsSortBy];
|
|
13
|
+
export declare const TabletStatsSortBy: {
|
|
14
|
+
readonly EPS: "EPS";
|
|
15
|
+
readonly SIZE_BYTES: "SIZE_BYTES";
|
|
16
|
+
readonly WAL_SIZE_BYTES: "WAL_SIZE_BYTES";
|
|
17
|
+
readonly SST_SIZE_BYTES: "SST_SIZE_BYTES";
|
|
18
|
+
};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* A period of time.
|
|
14
|
+
*/
|
|
15
|
+
export interface TimeWindow {
|
|
16
|
+
/** Start of the period. */
|
|
17
|
+
start_time?: string;
|
|
18
|
+
/** End of the period. */
|
|
19
|
+
end_time?: string;
|
|
20
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { Error } from './error';
|
|
13
|
+
/**
|
|
14
|
+
* Authentication is missing or invalid.
|
|
15
|
+
*/
|
|
16
|
+
export type UnauthorizedResponse = Error;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { UniverseInfo } from './universeInfo';
|
|
13
|
+
import type { UniverseSpec } from './universeSpec';
|
|
14
|
+
/**
|
|
15
|
+
* A universe Perf Advisor monitors. `spec` is what the caller registers; `info` is what Perf Advisor knows about the universe.
|
|
16
|
+
*/
|
|
17
|
+
export interface Universe {
|
|
18
|
+
spec: UniverseSpec;
|
|
19
|
+
info: UniverseInfo;
|
|
20
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { ClusterRef } from './clusterRef';
|
|
13
|
+
export type UniverseClusterInfo = ClusterRef & {
|
|
14
|
+
/** UUID of the YBA provider the cluster runs on. */
|
|
15
|
+
readonly provider?: string;
|
|
16
|
+
readonly replication_factor?: number;
|
|
17
|
+
};
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* What Perf Advisor has set up in the universe to collect its data.
|
|
14
|
+
*/
|
|
15
|
+
export interface UniverseCollectionInfo {
|
|
16
|
+
/**
|
|
17
|
+
* Whether Perf Advisor collects YCQL statement statistics. It enables them itself for the
|
|
18
|
+
* universes it collects from when their YugabyteDB version supports it.
|
|
19
|
+
*/
|
|
20
|
+
readonly ycql_stats_enabled?: boolean;
|
|
21
|
+
/**
|
|
22
|
+
* Whether the database user Perf Advisor connects as has the `pg_read_all_data` role, which
|
|
23
|
+
* Perf Advisor grants itself when it sets up that user.
|
|
24
|
+
*/
|
|
25
|
+
readonly pg_read_all_data_granted?: boolean;
|
|
26
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { Credentials } from './credentials';
|
|
13
|
+
/**
|
|
14
|
+
* How Perf Advisor connects to the universe's databases.
|
|
15
|
+
*/
|
|
16
|
+
export interface UniverseDatabaseSpec {
|
|
17
|
+
/** The `BASIC` credentials Perf Advisor connects with. Omitted, the stored ones are kept. */
|
|
18
|
+
credentials?: Credentials;
|
|
19
|
+
/** Whether Perf Advisor should create the database user in `credentials`. */
|
|
20
|
+
set_up_user?: boolean;
|
|
21
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Whether the universe's YugabyteDB version supports a feature, and whether it is on.
|
|
14
|
+
*/
|
|
15
|
+
export interface UniverseFeature {
|
|
16
|
+
readonly supported?: boolean;
|
|
17
|
+
/** Not set for a feature that is on whenever it is supported. */
|
|
18
|
+
readonly enabled?: boolean;
|
|
19
|
+
}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { UniverseFeature } from './universeFeature';
|
|
13
|
+
/**
|
|
14
|
+
* YugabyteDB features Perf Advisor collects data from, and their state on the universe.
|
|
15
|
+
*/
|
|
16
|
+
export interface UniverseFeatures {
|
|
17
|
+
/** Active Session History. */
|
|
18
|
+
ash?: UniverseFeature;
|
|
19
|
+
/** Plan ids in Active Session History samples. */
|
|
20
|
+
ash_plan_id?: UniverseFeature;
|
|
21
|
+
/** Query Plan Management. */
|
|
22
|
+
qpm?: UniverseFeature;
|
|
23
|
+
/** Bind variable capture in Query Plan Management. */
|
|
24
|
+
qpm_bind_variables?: UniverseFeature;
|
|
25
|
+
/** RPC statistics in `pg_stat_statements`. */
|
|
26
|
+
pgss_rpc_stats?: UniverseFeature;
|
|
27
|
+
/** DocDB metrics in `pg_stat_statements`. */
|
|
28
|
+
pgss_docdb_metrics?: UniverseFeature;
|
|
29
|
+
}
|