kb-cloud-client-typescript 2.4.0-alpha.122 → 2.4.0-alpha.124
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/adminapi/apis/diagnostics-api.d.ts +423 -0
- package/dist/adminapi/apis/diagnostics-api.d.ts.map +1 -1
- package/dist/adminapi/apis/diagnostics-api.js +435 -0
- package/dist/adminapi/apis/diagnostics-api.js.map +1 -1
- package/dist/adminapi/models/clickhouse-cluster-health-summary.d.ts +91 -0
- package/dist/adminapi/models/clickhouse-cluster-health-summary.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-cluster-health-summary.js +16 -0
- package/dist/adminapi/models/clickhouse-cluster-health-summary.js.map +1 -0
- package/dist/adminapi/models/clickhouse-cluster-health.d.ts +71 -0
- package/dist/adminapi/models/clickhouse-cluster-health.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-cluster-health.js +16 -0
- package/dist/adminapi/models/clickhouse-cluster-health.js.map +1 -0
- package/dist/adminapi/models/clickhouse-cluster-node.d.ts +109 -0
- package/dist/adminapi/models/clickhouse-cluster-node.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-cluster-node.js +16 -0
- package/dist/adminapi/models/clickhouse-cluster-node.js.map +1 -0
- package/dist/adminapi/models/clickhouse-disk-usage.d.ts +61 -0
- package/dist/adminapi/models/clickhouse-disk-usage.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-disk-usage.js +16 -0
- package/dist/adminapi/models/clickhouse-disk-usage.js.map +1 -0
- package/dist/adminapi/models/clickhouse-failed-query.d.ts +85 -0
- package/dist/adminapi/models/clickhouse-failed-query.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-failed-query.js +16 -0
- package/dist/adminapi/models/clickhouse-failed-query.js.map +1 -0
- package/dist/adminapi/models/clickhouse-merge.d.ts +97 -0
- package/dist/adminapi/models/clickhouse-merge.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-merge.js +16 -0
- package/dist/adminapi/models/clickhouse-merge.js.map +1 -0
- package/dist/adminapi/models/clickhouse-mutation.d.ts +79 -0
- package/dist/adminapi/models/clickhouse-mutation.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-mutation.js +16 -0
- package/dist/adminapi/models/clickhouse-mutation.js.map +1 -0
- package/dist/adminapi/models/clickhouse-partition-space.d.ts +91 -0
- package/dist/adminapi/models/clickhouse-partition-space.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-partition-space.js +16 -0
- package/dist/adminapi/models/clickhouse-partition-space.js.map +1 -0
- package/dist/adminapi/models/clickhouse-query-pattern.d.ts +91 -0
- package/dist/adminapi/models/clickhouse-query-pattern.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-query-pattern.js +16 -0
- package/dist/adminapi/models/clickhouse-query-pattern.js.map +1 -0
- package/dist/adminapi/models/clickhouse-replica-health.d.ts +157 -0
- package/dist/adminapi/models/clickhouse-replica-health.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-replica-health.js +16 -0
- package/dist/adminapi/models/clickhouse-replica-health.js.map +1 -0
- package/dist/adminapi/models/clickhouse-session-list.d.ts +45 -0
- package/dist/adminapi/models/clickhouse-session-list.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-session-list.js +16 -0
- package/dist/adminapi/models/clickhouse-session-list.js.map +1 -0
- package/dist/adminapi/models/clickhouse-session.d.ts +139 -0
- package/dist/adminapi/models/clickhouse-session.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-session.js +16 -0
- package/dist/adminapi/models/clickhouse-session.js.map +1 -0
- package/dist/adminapi/models/clickhouse-slow-query.d.ts +139 -0
- package/dist/adminapi/models/clickhouse-slow-query.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-slow-query.js +16 -0
- package/dist/adminapi/models/clickhouse-slow-query.js.map +1 -0
- package/dist/adminapi/models/clickhouse-source.d.ts +43 -0
- package/dist/adminapi/models/clickhouse-source.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-source.js +16 -0
- package/dist/adminapi/models/clickhouse-source.js.map +1 -0
- package/dist/adminapi/models/clickhouse-space-analysis.d.ts +79 -0
- package/dist/adminapi/models/clickhouse-space-analysis.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-space-analysis.js +16 -0
- package/dist/adminapi/models/clickhouse-space-analysis.js.map +1 -0
- package/dist/adminapi/models/clickhouse-space-summary.d.ts +97 -0
- package/dist/adminapi/models/clickhouse-space-summary.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-space-summary.js +16 -0
- package/dist/adminapi/models/clickhouse-space-summary.js.map +1 -0
- package/dist/adminapi/models/clickhouse-sqlanalysis-range.d.ts +43 -0
- package/dist/adminapi/models/clickhouse-sqlanalysis-range.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-sqlanalysis-range.js +16 -0
- package/dist/adminapi/models/clickhouse-sqlanalysis-range.js.map +1 -0
- package/dist/adminapi/models/clickhouse-sqlanalysis.d.ts +85 -0
- package/dist/adminapi/models/clickhouse-sqlanalysis.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-sqlanalysis.js +16 -0
- package/dist/adminapi/models/clickhouse-sqlanalysis.js.map +1 -0
- package/dist/adminapi/models/clickhouse-sqlsummary.d.ts +43 -0
- package/dist/adminapi/models/clickhouse-sqlsummary.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-sqlsummary.js +16 -0
- package/dist/adminapi/models/clickhouse-sqlsummary.js.map +1 -0
- package/dist/adminapi/models/clickhouse-table-space.d.ts +104 -0
- package/dist/adminapi/models/clickhouse-table-space.d.ts.map +1 -0
- package/dist/adminapi/models/clickhouse-table-space.js +16 -0
- package/dist/adminapi/models/clickhouse-table-space.js.map +1 -0
- package/dist/adminapi/models/index.d.ts +20 -0
- package/dist/adminapi/models/index.d.ts.map +1 -1
- package/dist/adminapi/models/index.js +20 -0
- package/dist/adminapi/models/index.js.map +1 -1
- package/dist/openapi/apis/diagnostics-api.d.ts +423 -0
- package/dist/openapi/apis/diagnostics-api.d.ts.map +1 -1
- package/dist/openapi/apis/diagnostics-api.js +435 -0
- package/dist/openapi/apis/diagnostics-api.js.map +1 -1
- package/dist/openapi/models/clickhouse-cluster-health-summary.d.ts +91 -0
- package/dist/openapi/models/clickhouse-cluster-health-summary.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-cluster-health-summary.js +16 -0
- package/dist/openapi/models/clickhouse-cluster-health-summary.js.map +1 -0
- package/dist/openapi/models/clickhouse-cluster-health.d.ts +71 -0
- package/dist/openapi/models/clickhouse-cluster-health.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-cluster-health.js +16 -0
- package/dist/openapi/models/clickhouse-cluster-health.js.map +1 -0
- package/dist/openapi/models/clickhouse-cluster-node.d.ts +109 -0
- package/dist/openapi/models/clickhouse-cluster-node.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-cluster-node.js +16 -0
- package/dist/openapi/models/clickhouse-cluster-node.js.map +1 -0
- package/dist/openapi/models/clickhouse-disk-usage.d.ts +61 -0
- package/dist/openapi/models/clickhouse-disk-usage.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-disk-usage.js +16 -0
- package/dist/openapi/models/clickhouse-disk-usage.js.map +1 -0
- package/dist/openapi/models/clickhouse-failed-query.d.ts +85 -0
- package/dist/openapi/models/clickhouse-failed-query.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-failed-query.js +16 -0
- package/dist/openapi/models/clickhouse-failed-query.js.map +1 -0
- package/dist/openapi/models/clickhouse-merge.d.ts +97 -0
- package/dist/openapi/models/clickhouse-merge.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-merge.js +16 -0
- package/dist/openapi/models/clickhouse-merge.js.map +1 -0
- package/dist/openapi/models/clickhouse-mutation.d.ts +79 -0
- package/dist/openapi/models/clickhouse-mutation.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-mutation.js +16 -0
- package/dist/openapi/models/clickhouse-mutation.js.map +1 -0
- package/dist/openapi/models/clickhouse-partition-space.d.ts +91 -0
- package/dist/openapi/models/clickhouse-partition-space.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-partition-space.js +16 -0
- package/dist/openapi/models/clickhouse-partition-space.js.map +1 -0
- package/dist/openapi/models/clickhouse-query-pattern.d.ts +91 -0
- package/dist/openapi/models/clickhouse-query-pattern.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-query-pattern.js +16 -0
- package/dist/openapi/models/clickhouse-query-pattern.js.map +1 -0
- package/dist/openapi/models/clickhouse-replica-health.d.ts +157 -0
- package/dist/openapi/models/clickhouse-replica-health.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-replica-health.js +16 -0
- package/dist/openapi/models/clickhouse-replica-health.js.map +1 -0
- package/dist/openapi/models/clickhouse-session-list.d.ts +45 -0
- package/dist/openapi/models/clickhouse-session-list.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-session-list.js +16 -0
- package/dist/openapi/models/clickhouse-session-list.js.map +1 -0
- package/dist/openapi/models/clickhouse-session.d.ts +139 -0
- package/dist/openapi/models/clickhouse-session.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-session.js +16 -0
- package/dist/openapi/models/clickhouse-session.js.map +1 -0
- package/dist/openapi/models/clickhouse-slow-query.d.ts +139 -0
- package/dist/openapi/models/clickhouse-slow-query.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-slow-query.js +16 -0
- package/dist/openapi/models/clickhouse-slow-query.js.map +1 -0
- package/dist/openapi/models/clickhouse-source.d.ts +43 -0
- package/dist/openapi/models/clickhouse-source.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-source.js +16 -0
- package/dist/openapi/models/clickhouse-source.js.map +1 -0
- package/dist/openapi/models/clickhouse-space-analysis.d.ts +79 -0
- package/dist/openapi/models/clickhouse-space-analysis.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-space-analysis.js +16 -0
- package/dist/openapi/models/clickhouse-space-analysis.js.map +1 -0
- package/dist/openapi/models/clickhouse-space-summary.d.ts +97 -0
- package/dist/openapi/models/clickhouse-space-summary.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-space-summary.js +16 -0
- package/dist/openapi/models/clickhouse-space-summary.js.map +1 -0
- package/dist/openapi/models/clickhouse-sqlanalysis-range.d.ts +43 -0
- package/dist/openapi/models/clickhouse-sqlanalysis-range.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-sqlanalysis-range.js +16 -0
- package/dist/openapi/models/clickhouse-sqlanalysis-range.js.map +1 -0
- package/dist/openapi/models/clickhouse-sqlanalysis.d.ts +85 -0
- package/dist/openapi/models/clickhouse-sqlanalysis.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-sqlanalysis.js +16 -0
- package/dist/openapi/models/clickhouse-sqlanalysis.js.map +1 -0
- package/dist/openapi/models/clickhouse-sqlsummary.d.ts +43 -0
- package/dist/openapi/models/clickhouse-sqlsummary.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-sqlsummary.js +16 -0
- package/dist/openapi/models/clickhouse-sqlsummary.js.map +1 -0
- package/dist/openapi/models/clickhouse-table-space.d.ts +104 -0
- package/dist/openapi/models/clickhouse-table-space.d.ts.map +1 -0
- package/dist/openapi/models/clickhouse-table-space.js +16 -0
- package/dist/openapi/models/clickhouse-table-space.js.map +1 -0
- package/dist/openapi/models/index.d.ts +20 -0
- package/dist/openapi/models/index.d.ts.map +1 -1
- package/dist/openapi/models/index.js +20 -0
- package/dist/openapi/models/index.js.map +1 -1
- package/package.json +1 -1
- package/src/adminapi/.openapi-generator/FILES +20 -0
- package/src/adminapi/apis/diagnostics-api.ts +746 -10
- package/src/adminapi/models/clickhouse-cluster-health-summary.ts +96 -0
- package/src/adminapi/models/clickhouse-cluster-health.ts +84 -0
- package/src/adminapi/models/clickhouse-cluster-node.ts +114 -0
- package/src/adminapi/models/clickhouse-disk-usage.ts +66 -0
- package/src/adminapi/models/clickhouse-failed-query.ts +90 -0
- package/src/adminapi/models/clickhouse-merge.ts +102 -0
- package/src/adminapi/models/clickhouse-mutation.ts +84 -0
- package/src/adminapi/models/clickhouse-partition-space.ts +96 -0
- package/src/adminapi/models/clickhouse-query-pattern.ts +96 -0
- package/src/adminapi/models/clickhouse-replica-health.ts +162 -0
- package/src/adminapi/models/clickhouse-session-list.ts +54 -0
- package/src/adminapi/models/clickhouse-session.ts +144 -0
- package/src/adminapi/models/clickhouse-slow-query.ts +144 -0
- package/src/adminapi/models/clickhouse-source.ts +48 -0
- package/src/adminapi/models/clickhouse-space-analysis.ts +96 -0
- package/src/adminapi/models/clickhouse-space-summary.ts +102 -0
- package/src/adminapi/models/clickhouse-sqlanalysis-range.ts +48 -0
- package/src/adminapi/models/clickhouse-sqlanalysis.ts +102 -0
- package/src/adminapi/models/clickhouse-sqlsummary.ts +48 -0
- package/src/adminapi/models/clickhouse-table-space.ts +111 -0
- package/src/adminapi/models/index.ts +20 -0
- package/src/adminapi.yaml +1158 -0
- package/src/openapi/.openapi-generator/FILES +20 -0
- package/src/openapi/apis/diagnostics-api.ts +746 -10
- package/src/openapi/models/clickhouse-cluster-health-summary.ts +96 -0
- package/src/openapi/models/clickhouse-cluster-health.ts +84 -0
- package/src/openapi/models/clickhouse-cluster-node.ts +114 -0
- package/src/openapi/models/clickhouse-disk-usage.ts +66 -0
- package/src/openapi/models/clickhouse-failed-query.ts +90 -0
- package/src/openapi/models/clickhouse-merge.ts +102 -0
- package/src/openapi/models/clickhouse-mutation.ts +84 -0
- package/src/openapi/models/clickhouse-partition-space.ts +96 -0
- package/src/openapi/models/clickhouse-query-pattern.ts +96 -0
- package/src/openapi/models/clickhouse-replica-health.ts +162 -0
- package/src/openapi/models/clickhouse-session-list.ts +54 -0
- package/src/openapi/models/clickhouse-session.ts +144 -0
- package/src/openapi/models/clickhouse-slow-query.ts +144 -0
- package/src/openapi/models/clickhouse-source.ts +48 -0
- package/src/openapi/models/clickhouse-space-analysis.ts +96 -0
- package/src/openapi/models/clickhouse-space-summary.ts +102 -0
- package/src/openapi/models/clickhouse-sqlanalysis-range.ts +48 -0
- package/src/openapi/models/clickhouse-sqlanalysis.ts +102 -0
- package/src/openapi/models/clickhouse-sqlsummary.ts +48 -0
- package/src/openapi/models/clickhouse-table-space.ts +111 -0
- package/src/openapi/models/index.ts +20 -0
- package/src/openapi.yaml +1158 -0
|
@@ -153,6 +153,156 @@ const DiagnosticsApiAxiosParamCreator = function (configuration) {
|
|
|
153
153
|
options: localVarRequestOptions,
|
|
154
154
|
};
|
|
155
155
|
},
|
|
156
|
+
/**
|
|
157
|
+
* Analyze system.replicas and system.clusters. Returns replication delay, Keeper queue backlog, readonly/session-expired replicas and shard/replica topology with per-node connection errors. Replica rows are collected through clusterAllReplicas, while the topology is read from the connected node\'s system.clusters view.
|
|
158
|
+
* @summary Get ClickHouse replica and cluster health
|
|
159
|
+
* @param {string} orgName Organization name
|
|
160
|
+
* @param {string} clusterName Cluster name
|
|
161
|
+
* @param {*} [options] Override http request option.
|
|
162
|
+
* @throws {RequiredError}
|
|
163
|
+
*/
|
|
164
|
+
getDiagnosticsClickhouseClusterHealth: async (orgName, clusterName, options = {}) => {
|
|
165
|
+
// verify required parameter 'orgName' is not null or undefined
|
|
166
|
+
(0, common_1.assertParamExists)('getDiagnosticsClickhouseClusterHealth', 'orgName', orgName);
|
|
167
|
+
// verify required parameter 'clusterName' is not null or undefined
|
|
168
|
+
(0, common_1.assertParamExists)('getDiagnosticsClickhouseClusterHealth', 'clusterName', clusterName);
|
|
169
|
+
const localVarPath = `/admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/clickhouse/clusterHealth`
|
|
170
|
+
.replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
|
|
171
|
+
.replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)));
|
|
172
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
173
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
174
|
+
let baseOptions;
|
|
175
|
+
if (configuration) {
|
|
176
|
+
baseOptions = configuration.baseOptions;
|
|
177
|
+
}
|
|
178
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
179
|
+
const localVarHeaderParameter = {};
|
|
180
|
+
const localVarQueryParameter = {};
|
|
181
|
+
// authentication BearerToken required
|
|
182
|
+
// http bearer authentication required
|
|
183
|
+
await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
184
|
+
// authentication DigestAuth required
|
|
185
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
186
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
187
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
188
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
189
|
+
return {
|
|
190
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
191
|
+
options: localVarRequestOptions,
|
|
192
|
+
};
|
|
193
|
+
},
|
|
194
|
+
/**
|
|
195
|
+
* Analyze system.query_log for the selected range. Only initial queries (is_initial_query = 1) are counted so distributed child queries are not double counted. Returns the slowest queries by query_duration_ms, query patterns grouped by normalized_query_hash, and failed queries (ExceptionWhileProcessing) with exception_code. When log_queries is disabled or system.query_log is missing, the endpoint returns status=unavailable together with guidance instead of failing.
|
|
196
|
+
* @summary Get ClickHouse SQL analysis
|
|
197
|
+
* @param {string} orgName Organization name
|
|
198
|
+
* @param {string} clusterName Cluster name
|
|
199
|
+
* @param {string} [range] Time range based on query_log event_time. Defaults to 24h. Allowed values: 1h, 6h, 24h, 7d.
|
|
200
|
+
* @param {number} [limit] Maximum number of entries per list. Defaults to 20 and is capped at 200.
|
|
201
|
+
* @param {string} [orderBy] Pattern ordering metric. Defaults to totalDuration. Allowed values: totalDuration, meanDuration, maxDuration, calls, memory, readRows, failures.
|
|
202
|
+
* @param {string} [database] Filter by current_database. Omit or empty = all databases.
|
|
203
|
+
* @param {string} [user] Filter by ClickHouse user. Omit or empty = all users.
|
|
204
|
+
* @param {*} [options] Override http request option.
|
|
205
|
+
* @throws {RequiredError}
|
|
206
|
+
*/
|
|
207
|
+
getDiagnosticsClickhouseSQLAnalysis: async (orgName, clusterName, range, limit, orderBy, database, user, options = {}) => {
|
|
208
|
+
// verify required parameter 'orgName' is not null or undefined
|
|
209
|
+
(0, common_1.assertParamExists)('getDiagnosticsClickhouseSQLAnalysis', 'orgName', orgName);
|
|
210
|
+
// verify required parameter 'clusterName' is not null or undefined
|
|
211
|
+
(0, common_1.assertParamExists)('getDiagnosticsClickhouseSQLAnalysis', 'clusterName', clusterName);
|
|
212
|
+
const localVarPath = `/admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/clickhouse/sqlAnalysis`
|
|
213
|
+
.replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
|
|
214
|
+
.replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)));
|
|
215
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
216
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
217
|
+
let baseOptions;
|
|
218
|
+
if (configuration) {
|
|
219
|
+
baseOptions = configuration.baseOptions;
|
|
220
|
+
}
|
|
221
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
222
|
+
const localVarHeaderParameter = {};
|
|
223
|
+
const localVarQueryParameter = {};
|
|
224
|
+
// authentication BearerToken required
|
|
225
|
+
// http bearer authentication required
|
|
226
|
+
await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
227
|
+
// authentication DigestAuth required
|
|
228
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
229
|
+
if (range !== undefined) {
|
|
230
|
+
localVarQueryParameter['range'] = range;
|
|
231
|
+
}
|
|
232
|
+
if (limit !== undefined) {
|
|
233
|
+
localVarQueryParameter['limit'] = limit;
|
|
234
|
+
}
|
|
235
|
+
if (orderBy !== undefined) {
|
|
236
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
237
|
+
}
|
|
238
|
+
if (database !== undefined) {
|
|
239
|
+
localVarQueryParameter['database'] = database;
|
|
240
|
+
}
|
|
241
|
+
if (user !== undefined) {
|
|
242
|
+
localVarQueryParameter['user'] = user;
|
|
243
|
+
}
|
|
244
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
245
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
246
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
247
|
+
return {
|
|
248
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
249
|
+
options: localVarRequestOptions,
|
|
250
|
+
};
|
|
251
|
+
},
|
|
252
|
+
/**
|
|
253
|
+
* Analyze system.parts, system.merges and system.mutations across the cluster. Returns table and partition level disk usage, compression efficiency, per-disk and per-host distribution, part explosion risk (parts_to_delay_insert / parts_to_throw_insert), running merges and unfinished mutations.
|
|
254
|
+
* @summary Get ClickHouse space analysis
|
|
255
|
+
* @param {string} orgName Organization name
|
|
256
|
+
* @param {string} clusterName Cluster name
|
|
257
|
+
* @param {string} [database] Filter by database. Omit or empty = all databases.
|
|
258
|
+
* @param {number} [tableLimit] Maximum number of top tables. Defaults to 20 and is capped at 200.
|
|
259
|
+
* @param {number} [partitionLimit] Maximum number of top partitions. Defaults to 20 and is capped at 200.
|
|
260
|
+
* @param {number} [mergeLimit] Maximum number of merges and unfinished mutations. Defaults to 20 and is capped at 200.
|
|
261
|
+
* @param {*} [options] Override http request option.
|
|
262
|
+
* @throws {RequiredError}
|
|
263
|
+
*/
|
|
264
|
+
getDiagnosticsClickhouseSpaceAnalysis: async (orgName, clusterName, database, tableLimit, partitionLimit, mergeLimit, options = {}) => {
|
|
265
|
+
// verify required parameter 'orgName' is not null or undefined
|
|
266
|
+
(0, common_1.assertParamExists)('getDiagnosticsClickhouseSpaceAnalysis', 'orgName', orgName);
|
|
267
|
+
// verify required parameter 'clusterName' is not null or undefined
|
|
268
|
+
(0, common_1.assertParamExists)('getDiagnosticsClickhouseSpaceAnalysis', 'clusterName', clusterName);
|
|
269
|
+
const localVarPath = `/admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/clickhouse/spaceAnalysis`
|
|
270
|
+
.replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
|
|
271
|
+
.replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)));
|
|
272
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
273
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
274
|
+
let baseOptions;
|
|
275
|
+
if (configuration) {
|
|
276
|
+
baseOptions = configuration.baseOptions;
|
|
277
|
+
}
|
|
278
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
279
|
+
const localVarHeaderParameter = {};
|
|
280
|
+
const localVarQueryParameter = {};
|
|
281
|
+
// authentication BearerToken required
|
|
282
|
+
// http bearer authentication required
|
|
283
|
+
await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
284
|
+
// authentication DigestAuth required
|
|
285
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
286
|
+
if (database !== undefined) {
|
|
287
|
+
localVarQueryParameter['database'] = database;
|
|
288
|
+
}
|
|
289
|
+
if (tableLimit !== undefined) {
|
|
290
|
+
localVarQueryParameter['tableLimit'] = tableLimit;
|
|
291
|
+
}
|
|
292
|
+
if (partitionLimit !== undefined) {
|
|
293
|
+
localVarQueryParameter['partitionLimit'] = partitionLimit;
|
|
294
|
+
}
|
|
295
|
+
if (mergeLimit !== undefined) {
|
|
296
|
+
localVarQueryParameter['mergeLimit'] = mergeLimit;
|
|
297
|
+
}
|
|
298
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
299
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
300
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
301
|
+
return {
|
|
302
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
303
|
+
options: localVarRequestOptions,
|
|
304
|
+
};
|
|
305
|
+
},
|
|
156
306
|
/**
|
|
157
307
|
* Get a read-only Dameng SQL analysis snapshot from V$SYSTEM_LONG_EXEC_SQLS (long-running SQL) and V$SYSTEM_LARGE_MEM_SQLS (high-memory SQL). The response does not expose execution plans or remediation actions.
|
|
158
308
|
* @summary Get Dameng SQL analysis
|
|
@@ -1211,6 +1361,98 @@ const DiagnosticsApiAxiosParamCreator = function (configuration) {
|
|
|
1211
1361
|
options: localVarRequestOptions,
|
|
1212
1362
|
};
|
|
1213
1363
|
},
|
|
1364
|
+
/**
|
|
1365
|
+
* Terminate a running query by query_id. In cluster mode KILL QUERY ON CLUSTER is used so the initial query and its remote sub-queries are terminated together; otherwise KILL QUERY runs on the connected node.
|
|
1366
|
+
* @summary Kill a ClickHouse query
|
|
1367
|
+
* @param {string} orgName Organization name
|
|
1368
|
+
* @param {string} clusterName Cluster name
|
|
1369
|
+
* @param {string} queryId ClickHouse query_id to terminate.
|
|
1370
|
+
* @param {*} [options] Override http request option.
|
|
1371
|
+
* @throws {RequiredError}
|
|
1372
|
+
*/
|
|
1373
|
+
killDiagnosticsClickhouseQuery: async (orgName, clusterName, queryId, options = {}) => {
|
|
1374
|
+
// verify required parameter 'orgName' is not null or undefined
|
|
1375
|
+
(0, common_1.assertParamExists)('killDiagnosticsClickhouseQuery', 'orgName', orgName);
|
|
1376
|
+
// verify required parameter 'clusterName' is not null or undefined
|
|
1377
|
+
(0, common_1.assertParamExists)('killDiagnosticsClickhouseQuery', 'clusterName', clusterName);
|
|
1378
|
+
// verify required parameter 'queryId' is not null or undefined
|
|
1379
|
+
(0, common_1.assertParamExists)('killDiagnosticsClickhouseQuery', 'queryId', queryId);
|
|
1380
|
+
const localVarPath = `/admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/clickhouse/sessions/{queryId}`
|
|
1381
|
+
.replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
|
|
1382
|
+
.replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)))
|
|
1383
|
+
.replace(`{${"queryId"}}`, encodeURIComponent(String(queryId)));
|
|
1384
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1385
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1386
|
+
let baseOptions;
|
|
1387
|
+
if (configuration) {
|
|
1388
|
+
baseOptions = configuration.baseOptions;
|
|
1389
|
+
}
|
|
1390
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
1391
|
+
const localVarHeaderParameter = {};
|
|
1392
|
+
const localVarQueryParameter = {};
|
|
1393
|
+
// authentication BearerToken required
|
|
1394
|
+
// http bearer authentication required
|
|
1395
|
+
await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
1396
|
+
// authentication DigestAuth required
|
|
1397
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1398
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1399
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1400
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1401
|
+
return {
|
|
1402
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1403
|
+
options: localVarRequestOptions,
|
|
1404
|
+
};
|
|
1405
|
+
},
|
|
1406
|
+
/**
|
|
1407
|
+
* List active queries from system.processes across every shard and replica via clusterAllReplicas. Returns elapsed time, current and peak memory usage, read/write progress and the server host for each query so long-running or memory-heavy queries can be located quickly. The diagnostics query itself is excluded from the result.
|
|
1408
|
+
* @summary List active ClickHouse queries
|
|
1409
|
+
* @param {string} orgName Organization name
|
|
1410
|
+
* @param {string} clusterName Cluster name
|
|
1411
|
+
* @param {number} [limit] Maximum number of queries to return. Defaults to 100 and is capped at 1000.
|
|
1412
|
+
* @param {string} [orderBy] Sort metric. Defaults to elapsed. Allowed values: elapsed, memoryUsage, memoryUsageRatio, peakMemoryUsage, readRows, readBytes.
|
|
1413
|
+
* @param {string} [database] Filter by current database. Omit or empty = all databases.
|
|
1414
|
+
* @param {*} [options] Override http request option.
|
|
1415
|
+
* @throws {RequiredError}
|
|
1416
|
+
*/
|
|
1417
|
+
listDiagnosticsClickhouseSessions: async (orgName, clusterName, limit, orderBy, database, options = {}) => {
|
|
1418
|
+
// verify required parameter 'orgName' is not null or undefined
|
|
1419
|
+
(0, common_1.assertParamExists)('listDiagnosticsClickhouseSessions', 'orgName', orgName);
|
|
1420
|
+
// verify required parameter 'clusterName' is not null or undefined
|
|
1421
|
+
(0, common_1.assertParamExists)('listDiagnosticsClickhouseSessions', 'clusterName', clusterName);
|
|
1422
|
+
const localVarPath = `/admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/clickhouse/sessions`
|
|
1423
|
+
.replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
|
|
1424
|
+
.replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)));
|
|
1425
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1426
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1427
|
+
let baseOptions;
|
|
1428
|
+
if (configuration) {
|
|
1429
|
+
baseOptions = configuration.baseOptions;
|
|
1430
|
+
}
|
|
1431
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1432
|
+
const localVarHeaderParameter = {};
|
|
1433
|
+
const localVarQueryParameter = {};
|
|
1434
|
+
// authentication BearerToken required
|
|
1435
|
+
// http bearer authentication required
|
|
1436
|
+
await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
1437
|
+
// authentication DigestAuth required
|
|
1438
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1439
|
+
if (limit !== undefined) {
|
|
1440
|
+
localVarQueryParameter['limit'] = limit;
|
|
1441
|
+
}
|
|
1442
|
+
if (orderBy !== undefined) {
|
|
1443
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
1444
|
+
}
|
|
1445
|
+
if (database !== undefined) {
|
|
1446
|
+
localVarQueryParameter['database'] = database;
|
|
1447
|
+
}
|
|
1448
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1449
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1450
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1451
|
+
return {
|
|
1452
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1453
|
+
options: localVarRequestOptions,
|
|
1454
|
+
};
|
|
1455
|
+
},
|
|
1214
1456
|
/**
|
|
1215
1457
|
* List Dameng sessions from V$SESSIONS with lock status from V$LOCK. Returns session ID, user, state, client IP, transaction ID, lock status, SQL text, schema, duration, and more.
|
|
1216
1458
|
* @summary List Dameng sessions
|
|
@@ -1528,6 +1770,60 @@ const DiagnosticsApiFp = function (configuration) {
|
|
|
1528
1770
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DiagnosticsApi.explainDiagnosticsPostgresqlSQLFingerprint']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1529
1771
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1530
1772
|
},
|
|
1773
|
+
/**
|
|
1774
|
+
* Analyze system.replicas and system.clusters. Returns replication delay, Keeper queue backlog, readonly/session-expired replicas and shard/replica topology with per-node connection errors. Replica rows are collected through clusterAllReplicas, while the topology is read from the connected node\'s system.clusters view.
|
|
1775
|
+
* @summary Get ClickHouse replica and cluster health
|
|
1776
|
+
* @param {string} orgName Organization name
|
|
1777
|
+
* @param {string} clusterName Cluster name
|
|
1778
|
+
* @param {*} [options] Override http request option.
|
|
1779
|
+
* @throws {RequiredError}
|
|
1780
|
+
*/
|
|
1781
|
+
async getDiagnosticsClickhouseClusterHealth(orgName, clusterName, options) {
|
|
1782
|
+
var _a, _b, _c;
|
|
1783
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getDiagnosticsClickhouseClusterHealth(orgName, clusterName, options);
|
|
1784
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1785
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DiagnosticsApi.getDiagnosticsClickhouseClusterHealth']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1786
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1787
|
+
},
|
|
1788
|
+
/**
|
|
1789
|
+
* Analyze system.query_log for the selected range. Only initial queries (is_initial_query = 1) are counted so distributed child queries are not double counted. Returns the slowest queries by query_duration_ms, query patterns grouped by normalized_query_hash, and failed queries (ExceptionWhileProcessing) with exception_code. When log_queries is disabled or system.query_log is missing, the endpoint returns status=unavailable together with guidance instead of failing.
|
|
1790
|
+
* @summary Get ClickHouse SQL analysis
|
|
1791
|
+
* @param {string} orgName Organization name
|
|
1792
|
+
* @param {string} clusterName Cluster name
|
|
1793
|
+
* @param {string} [range] Time range based on query_log event_time. Defaults to 24h. Allowed values: 1h, 6h, 24h, 7d.
|
|
1794
|
+
* @param {number} [limit] Maximum number of entries per list. Defaults to 20 and is capped at 200.
|
|
1795
|
+
* @param {string} [orderBy] Pattern ordering metric. Defaults to totalDuration. Allowed values: totalDuration, meanDuration, maxDuration, calls, memory, readRows, failures.
|
|
1796
|
+
* @param {string} [database] Filter by current_database. Omit or empty = all databases.
|
|
1797
|
+
* @param {string} [user] Filter by ClickHouse user. Omit or empty = all users.
|
|
1798
|
+
* @param {*} [options] Override http request option.
|
|
1799
|
+
* @throws {RequiredError}
|
|
1800
|
+
*/
|
|
1801
|
+
async getDiagnosticsClickhouseSQLAnalysis(orgName, clusterName, range, limit, orderBy, database, user, options) {
|
|
1802
|
+
var _a, _b, _c;
|
|
1803
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getDiagnosticsClickhouseSQLAnalysis(orgName, clusterName, range, limit, orderBy, database, user, options);
|
|
1804
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1805
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DiagnosticsApi.getDiagnosticsClickhouseSQLAnalysis']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1806
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1807
|
+
},
|
|
1808
|
+
/**
|
|
1809
|
+
* Analyze system.parts, system.merges and system.mutations across the cluster. Returns table and partition level disk usage, compression efficiency, per-disk and per-host distribution, part explosion risk (parts_to_delay_insert / parts_to_throw_insert), running merges and unfinished mutations.
|
|
1810
|
+
* @summary Get ClickHouse space analysis
|
|
1811
|
+
* @param {string} orgName Organization name
|
|
1812
|
+
* @param {string} clusterName Cluster name
|
|
1813
|
+
* @param {string} [database] Filter by database. Omit or empty = all databases.
|
|
1814
|
+
* @param {number} [tableLimit] Maximum number of top tables. Defaults to 20 and is capped at 200.
|
|
1815
|
+
* @param {number} [partitionLimit] Maximum number of top partitions. Defaults to 20 and is capped at 200.
|
|
1816
|
+
* @param {number} [mergeLimit] Maximum number of merges and unfinished mutations. Defaults to 20 and is capped at 200.
|
|
1817
|
+
* @param {*} [options] Override http request option.
|
|
1818
|
+
* @throws {RequiredError}
|
|
1819
|
+
*/
|
|
1820
|
+
async getDiagnosticsClickhouseSpaceAnalysis(orgName, clusterName, database, tableLimit, partitionLimit, mergeLimit, options) {
|
|
1821
|
+
var _a, _b, _c;
|
|
1822
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getDiagnosticsClickhouseSpaceAnalysis(orgName, clusterName, database, tableLimit, partitionLimit, mergeLimit, options);
|
|
1823
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1824
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DiagnosticsApi.getDiagnosticsClickhouseSpaceAnalysis']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1825
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1826
|
+
},
|
|
1531
1827
|
/**
|
|
1532
1828
|
* Get a read-only Dameng SQL analysis snapshot from V$SYSTEM_LONG_EXEC_SQLS (long-running SQL) and V$SYSTEM_LARGE_MEM_SQLS (high-memory SQL). The response does not expose execution plans or remediation actions.
|
|
1533
1829
|
* @summary Get Dameng SQL analysis
|
|
@@ -1917,6 +2213,40 @@ const DiagnosticsApiFp = function (configuration) {
|
|
|
1917
2213
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DiagnosticsApi.getDiagnosticsPostgresqlSpaceAnalysis']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1918
2214
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1919
2215
|
},
|
|
2216
|
+
/**
|
|
2217
|
+
* Terminate a running query by query_id. In cluster mode KILL QUERY ON CLUSTER is used so the initial query and its remote sub-queries are terminated together; otherwise KILL QUERY runs on the connected node.
|
|
2218
|
+
* @summary Kill a ClickHouse query
|
|
2219
|
+
* @param {string} orgName Organization name
|
|
2220
|
+
* @param {string} clusterName Cluster name
|
|
2221
|
+
* @param {string} queryId ClickHouse query_id to terminate.
|
|
2222
|
+
* @param {*} [options] Override http request option.
|
|
2223
|
+
* @throws {RequiredError}
|
|
2224
|
+
*/
|
|
2225
|
+
async killDiagnosticsClickhouseQuery(orgName, clusterName, queryId, options) {
|
|
2226
|
+
var _a, _b, _c;
|
|
2227
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.killDiagnosticsClickhouseQuery(orgName, clusterName, queryId, options);
|
|
2228
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2229
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DiagnosticsApi.killDiagnosticsClickhouseQuery']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2230
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2231
|
+
},
|
|
2232
|
+
/**
|
|
2233
|
+
* List active queries from system.processes across every shard and replica via clusterAllReplicas. Returns elapsed time, current and peak memory usage, read/write progress and the server host for each query so long-running or memory-heavy queries can be located quickly. The diagnostics query itself is excluded from the result.
|
|
2234
|
+
* @summary List active ClickHouse queries
|
|
2235
|
+
* @param {string} orgName Organization name
|
|
2236
|
+
* @param {string} clusterName Cluster name
|
|
2237
|
+
* @param {number} [limit] Maximum number of queries to return. Defaults to 100 and is capped at 1000.
|
|
2238
|
+
* @param {string} [orderBy] Sort metric. Defaults to elapsed. Allowed values: elapsed, memoryUsage, memoryUsageRatio, peakMemoryUsage, readRows, readBytes.
|
|
2239
|
+
* @param {string} [database] Filter by current database. Omit or empty = all databases.
|
|
2240
|
+
* @param {*} [options] Override http request option.
|
|
2241
|
+
* @throws {RequiredError}
|
|
2242
|
+
*/
|
|
2243
|
+
async listDiagnosticsClickhouseSessions(orgName, clusterName, limit, orderBy, database, options) {
|
|
2244
|
+
var _a, _b, _c;
|
|
2245
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listDiagnosticsClickhouseSessions(orgName, clusterName, limit, orderBy, database, options);
|
|
2246
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2247
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DiagnosticsApi.listDiagnosticsClickhouseSessions']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2248
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2249
|
+
},
|
|
1920
2250
|
/**
|
|
1921
2251
|
* List Dameng sessions from V$SESSIONS with lock status from V$LOCK. Returns session ID, user, state, client IP, transaction ID, lock status, SQL text, schema, duration, and more.
|
|
1922
2252
|
* @summary List Dameng sessions
|
|
@@ -2047,6 +2377,36 @@ const DiagnosticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2047
2377
|
explainDiagnosticsPostgresqlSQLFingerprint(requestParameters, options) {
|
|
2048
2378
|
return localVarFp.explainDiagnosticsPostgresqlSQLFingerprint(requestParameters.orgName, requestParameters.clusterName, requestParameters.queryID, requestParameters.database, requestParameters.user, requestParameters.topLevel, requestParameters.fingerprint, options).then((request) => request(axios, basePath));
|
|
2049
2379
|
},
|
|
2380
|
+
/**
|
|
2381
|
+
* Analyze system.replicas and system.clusters. Returns replication delay, Keeper queue backlog, readonly/session-expired replicas and shard/replica topology with per-node connection errors. Replica rows are collected through clusterAllReplicas, while the topology is read from the connected node\'s system.clusters view.
|
|
2382
|
+
* @summary Get ClickHouse replica and cluster health
|
|
2383
|
+
* @param {DiagnosticsApiGetDiagnosticsClickhouseClusterHealthRequest} requestParameters Request parameters.
|
|
2384
|
+
* @param {*} [options] Override http request option.
|
|
2385
|
+
* @throws {RequiredError}
|
|
2386
|
+
*/
|
|
2387
|
+
getDiagnosticsClickhouseClusterHealth(requestParameters, options) {
|
|
2388
|
+
return localVarFp.getDiagnosticsClickhouseClusterHealth(requestParameters.orgName, requestParameters.clusterName, options).then((request) => request(axios, basePath));
|
|
2389
|
+
},
|
|
2390
|
+
/**
|
|
2391
|
+
* Analyze system.query_log for the selected range. Only initial queries (is_initial_query = 1) are counted so distributed child queries are not double counted. Returns the slowest queries by query_duration_ms, query patterns grouped by normalized_query_hash, and failed queries (ExceptionWhileProcessing) with exception_code. When log_queries is disabled or system.query_log is missing, the endpoint returns status=unavailable together with guidance instead of failing.
|
|
2392
|
+
* @summary Get ClickHouse SQL analysis
|
|
2393
|
+
* @param {DiagnosticsApiGetDiagnosticsClickhouseSQLAnalysisRequest} requestParameters Request parameters.
|
|
2394
|
+
* @param {*} [options] Override http request option.
|
|
2395
|
+
* @throws {RequiredError}
|
|
2396
|
+
*/
|
|
2397
|
+
getDiagnosticsClickhouseSQLAnalysis(requestParameters, options) {
|
|
2398
|
+
return localVarFp.getDiagnosticsClickhouseSQLAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.range, requestParameters.limit, requestParameters.orderBy, requestParameters.database, requestParameters.user, options).then((request) => request(axios, basePath));
|
|
2399
|
+
},
|
|
2400
|
+
/**
|
|
2401
|
+
* Analyze system.parts, system.merges and system.mutations across the cluster. Returns table and partition level disk usage, compression efficiency, per-disk and per-host distribution, part explosion risk (parts_to_delay_insert / parts_to_throw_insert), running merges and unfinished mutations.
|
|
2402
|
+
* @summary Get ClickHouse space analysis
|
|
2403
|
+
* @param {DiagnosticsApiGetDiagnosticsClickhouseSpaceAnalysisRequest} requestParameters Request parameters.
|
|
2404
|
+
* @param {*} [options] Override http request option.
|
|
2405
|
+
* @throws {RequiredError}
|
|
2406
|
+
*/
|
|
2407
|
+
getDiagnosticsClickhouseSpaceAnalysis(requestParameters, options) {
|
|
2408
|
+
return localVarFp.getDiagnosticsClickhouseSpaceAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, requestParameters.tableLimit, requestParameters.partitionLimit, requestParameters.mergeLimit, options).then((request) => request(axios, basePath));
|
|
2409
|
+
},
|
|
2050
2410
|
/**
|
|
2051
2411
|
* Get a read-only Dameng SQL analysis snapshot from V$SYSTEM_LONG_EXEC_SQLS (long-running SQL) and V$SYSTEM_LARGE_MEM_SQLS (high-memory SQL). The response does not expose execution plans or remediation actions.
|
|
2052
2412
|
* @summary Get Dameng SQL analysis
|
|
@@ -2277,6 +2637,26 @@ const DiagnosticsApiFactory = function (configuration, basePath, axios) {
|
|
|
2277
2637
|
getDiagnosticsPostgresqlSpaceAnalysis(requestParameters, options) {
|
|
2278
2638
|
return localVarFp.getDiagnosticsPostgresqlSpaceAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.databaseName, options).then((request) => request(axios, basePath));
|
|
2279
2639
|
},
|
|
2640
|
+
/**
|
|
2641
|
+
* Terminate a running query by query_id. In cluster mode KILL QUERY ON CLUSTER is used so the initial query and its remote sub-queries are terminated together; otherwise KILL QUERY runs on the connected node.
|
|
2642
|
+
* @summary Kill a ClickHouse query
|
|
2643
|
+
* @param {DiagnosticsApiKillDiagnosticsClickhouseQueryRequest} requestParameters Request parameters.
|
|
2644
|
+
* @param {*} [options] Override http request option.
|
|
2645
|
+
* @throws {RequiredError}
|
|
2646
|
+
*/
|
|
2647
|
+
killDiagnosticsClickhouseQuery(requestParameters, options) {
|
|
2648
|
+
return localVarFp.killDiagnosticsClickhouseQuery(requestParameters.orgName, requestParameters.clusterName, requestParameters.queryId, options).then((request) => request(axios, basePath));
|
|
2649
|
+
},
|
|
2650
|
+
/**
|
|
2651
|
+
* List active queries from system.processes across every shard and replica via clusterAllReplicas. Returns elapsed time, current and peak memory usage, read/write progress and the server host for each query so long-running or memory-heavy queries can be located quickly. The diagnostics query itself is excluded from the result.
|
|
2652
|
+
* @summary List active ClickHouse queries
|
|
2653
|
+
* @param {DiagnosticsApiListDiagnosticsClickhouseSessionsRequest} requestParameters Request parameters.
|
|
2654
|
+
* @param {*} [options] Override http request option.
|
|
2655
|
+
* @throws {RequiredError}
|
|
2656
|
+
*/
|
|
2657
|
+
listDiagnosticsClickhouseSessions(requestParameters, options) {
|
|
2658
|
+
return localVarFp.listDiagnosticsClickhouseSessions(requestParameters.orgName, requestParameters.clusterName, requestParameters.limit, requestParameters.orderBy, requestParameters.database, options).then((request) => request(axios, basePath));
|
|
2659
|
+
},
|
|
2280
2660
|
/**
|
|
2281
2661
|
* List Dameng sessions from V$SESSIONS with lock status from V$LOCK. Returns session ID, user, state, client IP, transaction ID, lock status, SQL text, schema, duration, and more.
|
|
2282
2662
|
* @summary List Dameng sessions
|
|
@@ -2369,6 +2749,39 @@ class DiagnosticsApi extends base_1.BaseAPI {
|
|
|
2369
2749
|
explainDiagnosticsPostgresqlSQLFingerprint(requestParameters, options) {
|
|
2370
2750
|
return (0, exports.DiagnosticsApiFp)(this.configuration).explainDiagnosticsPostgresqlSQLFingerprint(requestParameters.orgName, requestParameters.clusterName, requestParameters.queryID, requestParameters.database, requestParameters.user, requestParameters.topLevel, requestParameters.fingerprint, options).then((request) => request(this.axios, this.basePath));
|
|
2371
2751
|
}
|
|
2752
|
+
/**
|
|
2753
|
+
* Analyze system.replicas and system.clusters. Returns replication delay, Keeper queue backlog, readonly/session-expired replicas and shard/replica topology with per-node connection errors. Replica rows are collected through clusterAllReplicas, while the topology is read from the connected node\'s system.clusters view.
|
|
2754
|
+
* @summary Get ClickHouse replica and cluster health
|
|
2755
|
+
* @param {DiagnosticsApiGetDiagnosticsClickhouseClusterHealthRequest} requestParameters Request parameters.
|
|
2756
|
+
* @param {*} [options] Override http request option.
|
|
2757
|
+
* @throws {RequiredError}
|
|
2758
|
+
* @memberof DiagnosticsApi
|
|
2759
|
+
*/
|
|
2760
|
+
getDiagnosticsClickhouseClusterHealth(requestParameters, options) {
|
|
2761
|
+
return (0, exports.DiagnosticsApiFp)(this.configuration).getDiagnosticsClickhouseClusterHealth(requestParameters.orgName, requestParameters.clusterName, options).then((request) => request(this.axios, this.basePath));
|
|
2762
|
+
}
|
|
2763
|
+
/**
|
|
2764
|
+
* Analyze system.query_log for the selected range. Only initial queries (is_initial_query = 1) are counted so distributed child queries are not double counted. Returns the slowest queries by query_duration_ms, query patterns grouped by normalized_query_hash, and failed queries (ExceptionWhileProcessing) with exception_code. When log_queries is disabled or system.query_log is missing, the endpoint returns status=unavailable together with guidance instead of failing.
|
|
2765
|
+
* @summary Get ClickHouse SQL analysis
|
|
2766
|
+
* @param {DiagnosticsApiGetDiagnosticsClickhouseSQLAnalysisRequest} requestParameters Request parameters.
|
|
2767
|
+
* @param {*} [options] Override http request option.
|
|
2768
|
+
* @throws {RequiredError}
|
|
2769
|
+
* @memberof DiagnosticsApi
|
|
2770
|
+
*/
|
|
2771
|
+
getDiagnosticsClickhouseSQLAnalysis(requestParameters, options) {
|
|
2772
|
+
return (0, exports.DiagnosticsApiFp)(this.configuration).getDiagnosticsClickhouseSQLAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.range, requestParameters.limit, requestParameters.orderBy, requestParameters.database, requestParameters.user, options).then((request) => request(this.axios, this.basePath));
|
|
2773
|
+
}
|
|
2774
|
+
/**
|
|
2775
|
+
* Analyze system.parts, system.merges and system.mutations across the cluster. Returns table and partition level disk usage, compression efficiency, per-disk and per-host distribution, part explosion risk (parts_to_delay_insert / parts_to_throw_insert), running merges and unfinished mutations.
|
|
2776
|
+
* @summary Get ClickHouse space analysis
|
|
2777
|
+
* @param {DiagnosticsApiGetDiagnosticsClickhouseSpaceAnalysisRequest} requestParameters Request parameters.
|
|
2778
|
+
* @param {*} [options] Override http request option.
|
|
2779
|
+
* @throws {RequiredError}
|
|
2780
|
+
* @memberof DiagnosticsApi
|
|
2781
|
+
*/
|
|
2782
|
+
getDiagnosticsClickhouseSpaceAnalysis(requestParameters, options) {
|
|
2783
|
+
return (0, exports.DiagnosticsApiFp)(this.configuration).getDiagnosticsClickhouseSpaceAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, requestParameters.tableLimit, requestParameters.partitionLimit, requestParameters.mergeLimit, options).then((request) => request(this.axios, this.basePath));
|
|
2784
|
+
}
|
|
2372
2785
|
/**
|
|
2373
2786
|
* Get a read-only Dameng SQL analysis snapshot from V$SYSTEM_LONG_EXEC_SQLS (long-running SQL) and V$SYSTEM_LARGE_MEM_SQLS (high-memory SQL). The response does not expose execution plans or remediation actions.
|
|
2374
2787
|
* @summary Get Dameng SQL analysis
|
|
@@ -2622,6 +3035,28 @@ class DiagnosticsApi extends base_1.BaseAPI {
|
|
|
2622
3035
|
getDiagnosticsPostgresqlSpaceAnalysis(requestParameters, options) {
|
|
2623
3036
|
return (0, exports.DiagnosticsApiFp)(this.configuration).getDiagnosticsPostgresqlSpaceAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.databaseName, options).then((request) => request(this.axios, this.basePath));
|
|
2624
3037
|
}
|
|
3038
|
+
/**
|
|
3039
|
+
* Terminate a running query by query_id. In cluster mode KILL QUERY ON CLUSTER is used so the initial query and its remote sub-queries are terminated together; otherwise KILL QUERY runs on the connected node.
|
|
3040
|
+
* @summary Kill a ClickHouse query
|
|
3041
|
+
* @param {DiagnosticsApiKillDiagnosticsClickhouseQueryRequest} requestParameters Request parameters.
|
|
3042
|
+
* @param {*} [options] Override http request option.
|
|
3043
|
+
* @throws {RequiredError}
|
|
3044
|
+
* @memberof DiagnosticsApi
|
|
3045
|
+
*/
|
|
3046
|
+
killDiagnosticsClickhouseQuery(requestParameters, options) {
|
|
3047
|
+
return (0, exports.DiagnosticsApiFp)(this.configuration).killDiagnosticsClickhouseQuery(requestParameters.orgName, requestParameters.clusterName, requestParameters.queryId, options).then((request) => request(this.axios, this.basePath));
|
|
3048
|
+
}
|
|
3049
|
+
/**
|
|
3050
|
+
* List active queries from system.processes across every shard and replica via clusterAllReplicas. Returns elapsed time, current and peak memory usage, read/write progress and the server host for each query so long-running or memory-heavy queries can be located quickly. The diagnostics query itself is excluded from the result.
|
|
3051
|
+
* @summary List active ClickHouse queries
|
|
3052
|
+
* @param {DiagnosticsApiListDiagnosticsClickhouseSessionsRequest} requestParameters Request parameters.
|
|
3053
|
+
* @param {*} [options] Override http request option.
|
|
3054
|
+
* @throws {RequiredError}
|
|
3055
|
+
* @memberof DiagnosticsApi
|
|
3056
|
+
*/
|
|
3057
|
+
listDiagnosticsClickhouseSessions(requestParameters, options) {
|
|
3058
|
+
return (0, exports.DiagnosticsApiFp)(this.configuration).listDiagnosticsClickhouseSessions(requestParameters.orgName, requestParameters.clusterName, requestParameters.limit, requestParameters.orderBy, requestParameters.database, options).then((request) => request(this.axios, this.basePath));
|
|
3059
|
+
}
|
|
2625
3060
|
/**
|
|
2626
3061
|
* List Dameng sessions from V$SESSIONS with lock status from V$LOCK. Returns session ID, user, state, client IP, transaction ID, lock status, SQL text, schema, duration, and more.
|
|
2627
3062
|
* @summary List Dameng sessions
|