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
|
@@ -12,6 +12,10 @@
|
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import type { ClickhouseClusterHealth } from '../models';
|
|
16
|
+
import type { ClickhouseSQLAnalysis } from '../models';
|
|
17
|
+
import type { ClickhouseSessionList } from '../models';
|
|
18
|
+
import type { ClickhouseSpaceAnalysis } from '../models';
|
|
15
19
|
import type { DamengLockAnalysis } from '../models';
|
|
16
20
|
import type { DamengSQLAnalysis } from '../models';
|
|
17
21
|
import type { DamengSessionDetail } from '../models';
|
|
@@ -73,6 +77,42 @@ export declare const DiagnosticsApiAxiosParamCreator: (configuration?: Configura
|
|
|
73
77
|
* @throws {RequiredError}
|
|
74
78
|
*/
|
|
75
79
|
explainDiagnosticsPostgresqlSQLFingerprint: (orgName: string, clusterName: string, queryID: string, database: string, user: string, topLevel: boolean, fingerprint?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
80
|
+
/**
|
|
81
|
+
* 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.
|
|
82
|
+
* @summary Get ClickHouse replica and cluster health
|
|
83
|
+
* @param {string} orgName Organization name
|
|
84
|
+
* @param {string} clusterName Cluster name
|
|
85
|
+
* @param {*} [options] Override http request option.
|
|
86
|
+
* @throws {RequiredError}
|
|
87
|
+
*/
|
|
88
|
+
getDiagnosticsClickhouseClusterHealth: (orgName: string, clusterName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
89
|
+
/**
|
|
90
|
+
* 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.
|
|
91
|
+
* @summary Get ClickHouse SQL analysis
|
|
92
|
+
* @param {string} orgName Organization name
|
|
93
|
+
* @param {string} clusterName Cluster name
|
|
94
|
+
* @param {string} [range] Time range based on query_log event_time. Defaults to 24h. Allowed values: 1h, 6h, 24h, 7d.
|
|
95
|
+
* @param {number} [limit] Maximum number of entries per list. Defaults to 20 and is capped at 200.
|
|
96
|
+
* @param {string} [orderBy] Pattern ordering metric. Defaults to totalDuration. Allowed values: totalDuration, meanDuration, maxDuration, calls, memory, readRows, failures.
|
|
97
|
+
* @param {string} [database] Filter by current_database. Omit or empty = all databases.
|
|
98
|
+
* @param {string} [user] Filter by ClickHouse user. Omit or empty = all users.
|
|
99
|
+
* @param {*} [options] Override http request option.
|
|
100
|
+
* @throws {RequiredError}
|
|
101
|
+
*/
|
|
102
|
+
getDiagnosticsClickhouseSQLAnalysis: (orgName: string, clusterName: string, range?: string, limit?: number, orderBy?: string, database?: string, user?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
103
|
+
/**
|
|
104
|
+
* 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.
|
|
105
|
+
* @summary Get ClickHouse space analysis
|
|
106
|
+
* @param {string} orgName Organization name
|
|
107
|
+
* @param {string} clusterName Cluster name
|
|
108
|
+
* @param {string} [database] Filter by database. Omit or empty = all databases.
|
|
109
|
+
* @param {number} [tableLimit] Maximum number of top tables. Defaults to 20 and is capped at 200.
|
|
110
|
+
* @param {number} [partitionLimit] Maximum number of top partitions. Defaults to 20 and is capped at 200.
|
|
111
|
+
* @param {number} [mergeLimit] Maximum number of merges and unfinished mutations. Defaults to 20 and is capped at 200.
|
|
112
|
+
* @param {*} [options] Override http request option.
|
|
113
|
+
* @throws {RequiredError}
|
|
114
|
+
*/
|
|
115
|
+
getDiagnosticsClickhouseSpaceAnalysis: (orgName: string, clusterName: string, database?: string, tableLimit?: number, partitionLimit?: number, mergeLimit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
76
116
|
/**
|
|
77
117
|
* 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.
|
|
78
118
|
* @summary Get Dameng SQL analysis
|
|
@@ -324,6 +364,28 @@ export declare const DiagnosticsApiAxiosParamCreator: (configuration?: Configura
|
|
|
324
364
|
* @throws {RequiredError}
|
|
325
365
|
*/
|
|
326
366
|
getDiagnosticsPostgresqlSpaceAnalysis: (orgName: string, clusterName: string, databaseName?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
367
|
+
/**
|
|
368
|
+
* 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.
|
|
369
|
+
* @summary Kill a ClickHouse query
|
|
370
|
+
* @param {string} orgName Organization name
|
|
371
|
+
* @param {string} clusterName Cluster name
|
|
372
|
+
* @param {string} queryId ClickHouse query_id to terminate.
|
|
373
|
+
* @param {*} [options] Override http request option.
|
|
374
|
+
* @throws {RequiredError}
|
|
375
|
+
*/
|
|
376
|
+
killDiagnosticsClickhouseQuery: (orgName: string, clusterName: string, queryId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
377
|
+
/**
|
|
378
|
+
* 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.
|
|
379
|
+
* @summary List active ClickHouse queries
|
|
380
|
+
* @param {string} orgName Organization name
|
|
381
|
+
* @param {string} clusterName Cluster name
|
|
382
|
+
* @param {number} [limit] Maximum number of queries to return. Defaults to 100 and is capped at 1000.
|
|
383
|
+
* @param {string} [orderBy] Sort metric. Defaults to elapsed. Allowed values: elapsed, memoryUsage, memoryUsageRatio, peakMemoryUsage, readRows, readBytes.
|
|
384
|
+
* @param {string} [database] Filter by current database. Omit or empty = all databases.
|
|
385
|
+
* @param {*} [options] Override http request option.
|
|
386
|
+
* @throws {RequiredError}
|
|
387
|
+
*/
|
|
388
|
+
listDiagnosticsClickhouseSessions: (orgName: string, clusterName: string, limit?: number, orderBy?: string, database?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
327
389
|
/**
|
|
328
390
|
* 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.
|
|
329
391
|
* @summary List Dameng sessions
|
|
@@ -421,6 +483,42 @@ export declare const DiagnosticsApiFp: (configuration?: Configuration) => {
|
|
|
421
483
|
* @throws {RequiredError}
|
|
422
484
|
*/
|
|
423
485
|
explainDiagnosticsPostgresqlSQLFingerprint(orgName: string, clusterName: string, queryID: string, database: string, user: string, topLevel: boolean, fingerprint?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostgresqlSQLFingerprintExplainResponse>>;
|
|
486
|
+
/**
|
|
487
|
+
* 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.
|
|
488
|
+
* @summary Get ClickHouse replica and cluster health
|
|
489
|
+
* @param {string} orgName Organization name
|
|
490
|
+
* @param {string} clusterName Cluster name
|
|
491
|
+
* @param {*} [options] Override http request option.
|
|
492
|
+
* @throws {RequiredError}
|
|
493
|
+
*/
|
|
494
|
+
getDiagnosticsClickhouseClusterHealth(orgName: string, clusterName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClickhouseClusterHealth>>;
|
|
495
|
+
/**
|
|
496
|
+
* 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.
|
|
497
|
+
* @summary Get ClickHouse SQL analysis
|
|
498
|
+
* @param {string} orgName Organization name
|
|
499
|
+
* @param {string} clusterName Cluster name
|
|
500
|
+
* @param {string} [range] Time range based on query_log event_time. Defaults to 24h. Allowed values: 1h, 6h, 24h, 7d.
|
|
501
|
+
* @param {number} [limit] Maximum number of entries per list. Defaults to 20 and is capped at 200.
|
|
502
|
+
* @param {string} [orderBy] Pattern ordering metric. Defaults to totalDuration. Allowed values: totalDuration, meanDuration, maxDuration, calls, memory, readRows, failures.
|
|
503
|
+
* @param {string} [database] Filter by current_database. Omit or empty = all databases.
|
|
504
|
+
* @param {string} [user] Filter by ClickHouse user. Omit or empty = all users.
|
|
505
|
+
* @param {*} [options] Override http request option.
|
|
506
|
+
* @throws {RequiredError}
|
|
507
|
+
*/
|
|
508
|
+
getDiagnosticsClickhouseSQLAnalysis(orgName: string, clusterName: string, range?: string, limit?: number, orderBy?: string, database?: string, user?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClickhouseSQLAnalysis>>;
|
|
509
|
+
/**
|
|
510
|
+
* 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.
|
|
511
|
+
* @summary Get ClickHouse space analysis
|
|
512
|
+
* @param {string} orgName Organization name
|
|
513
|
+
* @param {string} clusterName Cluster name
|
|
514
|
+
* @param {string} [database] Filter by database. Omit or empty = all databases.
|
|
515
|
+
* @param {number} [tableLimit] Maximum number of top tables. Defaults to 20 and is capped at 200.
|
|
516
|
+
* @param {number} [partitionLimit] Maximum number of top partitions. Defaults to 20 and is capped at 200.
|
|
517
|
+
* @param {number} [mergeLimit] Maximum number of merges and unfinished mutations. Defaults to 20 and is capped at 200.
|
|
518
|
+
* @param {*} [options] Override http request option.
|
|
519
|
+
* @throws {RequiredError}
|
|
520
|
+
*/
|
|
521
|
+
getDiagnosticsClickhouseSpaceAnalysis(orgName: string, clusterName: string, database?: string, tableLimit?: number, partitionLimit?: number, mergeLimit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClickhouseSpaceAnalysis>>;
|
|
424
522
|
/**
|
|
425
523
|
* 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.
|
|
426
524
|
* @summary Get Dameng SQL analysis
|
|
@@ -672,6 +770,28 @@ export declare const DiagnosticsApiFp: (configuration?: Configuration) => {
|
|
|
672
770
|
* @throws {RequiredError}
|
|
673
771
|
*/
|
|
674
772
|
getDiagnosticsPostgresqlSpaceAnalysis(orgName: string, clusterName: string, databaseName?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostgresqlSpaceAnalysis>>;
|
|
773
|
+
/**
|
|
774
|
+
* 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.
|
|
775
|
+
* @summary Kill a ClickHouse query
|
|
776
|
+
* @param {string} orgName Organization name
|
|
777
|
+
* @param {string} clusterName Cluster name
|
|
778
|
+
* @param {string} queryId ClickHouse query_id to terminate.
|
|
779
|
+
* @param {*} [options] Override http request option.
|
|
780
|
+
* @throws {RequiredError}
|
|
781
|
+
*/
|
|
782
|
+
killDiagnosticsClickhouseQuery(orgName: string, clusterName: string, queryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
783
|
+
/**
|
|
784
|
+
* 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.
|
|
785
|
+
* @summary List active ClickHouse queries
|
|
786
|
+
* @param {string} orgName Organization name
|
|
787
|
+
* @param {string} clusterName Cluster name
|
|
788
|
+
* @param {number} [limit] Maximum number of queries to return. Defaults to 100 and is capped at 1000.
|
|
789
|
+
* @param {string} [orderBy] Sort metric. Defaults to elapsed. Allowed values: elapsed, memoryUsage, memoryUsageRatio, peakMemoryUsage, readRows, readBytes.
|
|
790
|
+
* @param {string} [database] Filter by current database. Omit or empty = all databases.
|
|
791
|
+
* @param {*} [options] Override http request option.
|
|
792
|
+
* @throws {RequiredError}
|
|
793
|
+
*/
|
|
794
|
+
listDiagnosticsClickhouseSessions(orgName: string, clusterName: string, limit?: number, orderBy?: string, database?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClickhouseSessionList>>;
|
|
675
795
|
/**
|
|
676
796
|
* 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.
|
|
677
797
|
* @summary List Dameng sessions
|
|
@@ -758,6 +878,30 @@ export declare const DiagnosticsApiFactory: (configuration?: Configuration, base
|
|
|
758
878
|
* @throws {RequiredError}
|
|
759
879
|
*/
|
|
760
880
|
explainDiagnosticsPostgresqlSQLFingerprint(requestParameters: DiagnosticsApiExplainDiagnosticsPostgresqlSQLFingerprintRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostgresqlSQLFingerprintExplainResponse>;
|
|
881
|
+
/**
|
|
882
|
+
* 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.
|
|
883
|
+
* @summary Get ClickHouse replica and cluster health
|
|
884
|
+
* @param {DiagnosticsApiGetDiagnosticsClickhouseClusterHealthRequest} requestParameters Request parameters.
|
|
885
|
+
* @param {*} [options] Override http request option.
|
|
886
|
+
* @throws {RequiredError}
|
|
887
|
+
*/
|
|
888
|
+
getDiagnosticsClickhouseClusterHealth(requestParameters: DiagnosticsApiGetDiagnosticsClickhouseClusterHealthRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClickhouseClusterHealth>;
|
|
889
|
+
/**
|
|
890
|
+
* 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.
|
|
891
|
+
* @summary Get ClickHouse SQL analysis
|
|
892
|
+
* @param {DiagnosticsApiGetDiagnosticsClickhouseSQLAnalysisRequest} requestParameters Request parameters.
|
|
893
|
+
* @param {*} [options] Override http request option.
|
|
894
|
+
* @throws {RequiredError}
|
|
895
|
+
*/
|
|
896
|
+
getDiagnosticsClickhouseSQLAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsClickhouseSQLAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClickhouseSQLAnalysis>;
|
|
897
|
+
/**
|
|
898
|
+
* 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.
|
|
899
|
+
* @summary Get ClickHouse space analysis
|
|
900
|
+
* @param {DiagnosticsApiGetDiagnosticsClickhouseSpaceAnalysisRequest} requestParameters Request parameters.
|
|
901
|
+
* @param {*} [options] Override http request option.
|
|
902
|
+
* @throws {RequiredError}
|
|
903
|
+
*/
|
|
904
|
+
getDiagnosticsClickhouseSpaceAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsClickhouseSpaceAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClickhouseSpaceAnalysis>;
|
|
761
905
|
/**
|
|
762
906
|
* 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.
|
|
763
907
|
* @summary Get Dameng SQL analysis
|
|
@@ -942,6 +1086,22 @@ export declare const DiagnosticsApiFactory: (configuration?: Configuration, base
|
|
|
942
1086
|
* @throws {RequiredError}
|
|
943
1087
|
*/
|
|
944
1088
|
getDiagnosticsPostgresqlSpaceAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostgresqlSpaceAnalysis>;
|
|
1089
|
+
/**
|
|
1090
|
+
* 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.
|
|
1091
|
+
* @summary Kill a ClickHouse query
|
|
1092
|
+
* @param {DiagnosticsApiKillDiagnosticsClickhouseQueryRequest} requestParameters Request parameters.
|
|
1093
|
+
* @param {*} [options] Override http request option.
|
|
1094
|
+
* @throws {RequiredError}
|
|
1095
|
+
*/
|
|
1096
|
+
killDiagnosticsClickhouseQuery(requestParameters: DiagnosticsApiKillDiagnosticsClickhouseQueryRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1097
|
+
/**
|
|
1098
|
+
* 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.
|
|
1099
|
+
* @summary List active ClickHouse queries
|
|
1100
|
+
* @param {DiagnosticsApiListDiagnosticsClickhouseSessionsRequest} requestParameters Request parameters.
|
|
1101
|
+
* @param {*} [options] Override http request option.
|
|
1102
|
+
* @throws {RequiredError}
|
|
1103
|
+
*/
|
|
1104
|
+
listDiagnosticsClickhouseSessions(requestParameters: DiagnosticsApiListDiagnosticsClickhouseSessionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClickhouseSessionList>;
|
|
945
1105
|
/**
|
|
946
1106
|
* 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.
|
|
947
1107
|
* @summary List Dameng sessions
|
|
@@ -1015,6 +1175,33 @@ export interface DiagnosticsApiInterface {
|
|
|
1015
1175
|
* @memberof DiagnosticsApiInterface
|
|
1016
1176
|
*/
|
|
1017
1177
|
explainDiagnosticsPostgresqlSQLFingerprint(requestParameters: DiagnosticsApiExplainDiagnosticsPostgresqlSQLFingerprintRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostgresqlSQLFingerprintExplainResponse>;
|
|
1178
|
+
/**
|
|
1179
|
+
* 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.
|
|
1180
|
+
* @summary Get ClickHouse replica and cluster health
|
|
1181
|
+
* @param {DiagnosticsApiGetDiagnosticsClickhouseClusterHealthRequest} requestParameters Request parameters.
|
|
1182
|
+
* @param {*} [options] Override http request option.
|
|
1183
|
+
* @throws {RequiredError}
|
|
1184
|
+
* @memberof DiagnosticsApiInterface
|
|
1185
|
+
*/
|
|
1186
|
+
getDiagnosticsClickhouseClusterHealth(requestParameters: DiagnosticsApiGetDiagnosticsClickhouseClusterHealthRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClickhouseClusterHealth>;
|
|
1187
|
+
/**
|
|
1188
|
+
* 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.
|
|
1189
|
+
* @summary Get ClickHouse SQL analysis
|
|
1190
|
+
* @param {DiagnosticsApiGetDiagnosticsClickhouseSQLAnalysisRequest} requestParameters Request parameters.
|
|
1191
|
+
* @param {*} [options] Override http request option.
|
|
1192
|
+
* @throws {RequiredError}
|
|
1193
|
+
* @memberof DiagnosticsApiInterface
|
|
1194
|
+
*/
|
|
1195
|
+
getDiagnosticsClickhouseSQLAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsClickhouseSQLAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClickhouseSQLAnalysis>;
|
|
1196
|
+
/**
|
|
1197
|
+
* 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.
|
|
1198
|
+
* @summary Get ClickHouse space analysis
|
|
1199
|
+
* @param {DiagnosticsApiGetDiagnosticsClickhouseSpaceAnalysisRequest} requestParameters Request parameters.
|
|
1200
|
+
* @param {*} [options] Override http request option.
|
|
1201
|
+
* @throws {RequiredError}
|
|
1202
|
+
* @memberof DiagnosticsApiInterface
|
|
1203
|
+
*/
|
|
1204
|
+
getDiagnosticsClickhouseSpaceAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsClickhouseSpaceAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClickhouseSpaceAnalysis>;
|
|
1018
1205
|
/**
|
|
1019
1206
|
* 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.
|
|
1020
1207
|
* @summary Get Dameng SQL analysis
|
|
@@ -1222,6 +1409,24 @@ export interface DiagnosticsApiInterface {
|
|
|
1222
1409
|
* @memberof DiagnosticsApiInterface
|
|
1223
1410
|
*/
|
|
1224
1411
|
getDiagnosticsPostgresqlSpaceAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostgresqlSpaceAnalysis>;
|
|
1412
|
+
/**
|
|
1413
|
+
* 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.
|
|
1414
|
+
* @summary Kill a ClickHouse query
|
|
1415
|
+
* @param {DiagnosticsApiKillDiagnosticsClickhouseQueryRequest} requestParameters Request parameters.
|
|
1416
|
+
* @param {*} [options] Override http request option.
|
|
1417
|
+
* @throws {RequiredError}
|
|
1418
|
+
* @memberof DiagnosticsApiInterface
|
|
1419
|
+
*/
|
|
1420
|
+
killDiagnosticsClickhouseQuery(requestParameters: DiagnosticsApiKillDiagnosticsClickhouseQueryRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1421
|
+
/**
|
|
1422
|
+
* 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.
|
|
1423
|
+
* @summary List active ClickHouse queries
|
|
1424
|
+
* @param {DiagnosticsApiListDiagnosticsClickhouseSessionsRequest} requestParameters Request parameters.
|
|
1425
|
+
* @param {*} [options] Override http request option.
|
|
1426
|
+
* @throws {RequiredError}
|
|
1427
|
+
* @memberof DiagnosticsApiInterface
|
|
1428
|
+
*/
|
|
1429
|
+
listDiagnosticsClickhouseSessions(requestParameters: DiagnosticsApiListDiagnosticsClickhouseSessionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClickhouseSessionList>;
|
|
1225
1430
|
/**
|
|
1226
1431
|
* 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.
|
|
1227
1432
|
* @summary List Dameng sessions
|
|
@@ -1369,6 +1574,117 @@ export interface DiagnosticsApiExplainDiagnosticsPostgresqlSQLFingerprintRequest
|
|
|
1369
1574
|
*/
|
|
1370
1575
|
readonly fingerprint?: string;
|
|
1371
1576
|
}
|
|
1577
|
+
/**
|
|
1578
|
+
* Request parameters for getDiagnosticsClickhouseClusterHealth operation in DiagnosticsApi.
|
|
1579
|
+
* @export
|
|
1580
|
+
* @interface DiagnosticsApiGetDiagnosticsClickhouseClusterHealthRequest
|
|
1581
|
+
*/
|
|
1582
|
+
export interface DiagnosticsApiGetDiagnosticsClickhouseClusterHealthRequest {
|
|
1583
|
+
/**
|
|
1584
|
+
* Organization name
|
|
1585
|
+
* @type {string}
|
|
1586
|
+
* @memberof DiagnosticsApiGetDiagnosticsClickhouseClusterHealth
|
|
1587
|
+
*/
|
|
1588
|
+
readonly orgName: string;
|
|
1589
|
+
/**
|
|
1590
|
+
* Cluster name
|
|
1591
|
+
* @type {string}
|
|
1592
|
+
* @memberof DiagnosticsApiGetDiagnosticsClickhouseClusterHealth
|
|
1593
|
+
*/
|
|
1594
|
+
readonly clusterName: string;
|
|
1595
|
+
}
|
|
1596
|
+
/**
|
|
1597
|
+
* Request parameters for getDiagnosticsClickhouseSQLAnalysis operation in DiagnosticsApi.
|
|
1598
|
+
* @export
|
|
1599
|
+
* @interface DiagnosticsApiGetDiagnosticsClickhouseSQLAnalysisRequest
|
|
1600
|
+
*/
|
|
1601
|
+
export interface DiagnosticsApiGetDiagnosticsClickhouseSQLAnalysisRequest {
|
|
1602
|
+
/**
|
|
1603
|
+
* Organization name
|
|
1604
|
+
* @type {string}
|
|
1605
|
+
* @memberof DiagnosticsApiGetDiagnosticsClickhouseSQLAnalysis
|
|
1606
|
+
*/
|
|
1607
|
+
readonly orgName: string;
|
|
1608
|
+
/**
|
|
1609
|
+
* Cluster name
|
|
1610
|
+
* @type {string}
|
|
1611
|
+
* @memberof DiagnosticsApiGetDiagnosticsClickhouseSQLAnalysis
|
|
1612
|
+
*/
|
|
1613
|
+
readonly clusterName: string;
|
|
1614
|
+
/**
|
|
1615
|
+
* Time range based on query_log event_time. Defaults to 24h. Allowed values: 1h, 6h, 24h, 7d.
|
|
1616
|
+
* @type {string}
|
|
1617
|
+
* @memberof DiagnosticsApiGetDiagnosticsClickhouseSQLAnalysis
|
|
1618
|
+
*/
|
|
1619
|
+
readonly range?: string;
|
|
1620
|
+
/**
|
|
1621
|
+
* Maximum number of entries per list. Defaults to 20 and is capped at 200.
|
|
1622
|
+
* @type {number}
|
|
1623
|
+
* @memberof DiagnosticsApiGetDiagnosticsClickhouseSQLAnalysis
|
|
1624
|
+
*/
|
|
1625
|
+
readonly limit?: number;
|
|
1626
|
+
/**
|
|
1627
|
+
* Pattern ordering metric. Defaults to totalDuration. Allowed values: totalDuration, meanDuration, maxDuration, calls, memory, readRows, failures.
|
|
1628
|
+
* @type {string}
|
|
1629
|
+
* @memberof DiagnosticsApiGetDiagnosticsClickhouseSQLAnalysis
|
|
1630
|
+
*/
|
|
1631
|
+
readonly orderBy?: string;
|
|
1632
|
+
/**
|
|
1633
|
+
* Filter by current_database. Omit or empty = all databases.
|
|
1634
|
+
* @type {string}
|
|
1635
|
+
* @memberof DiagnosticsApiGetDiagnosticsClickhouseSQLAnalysis
|
|
1636
|
+
*/
|
|
1637
|
+
readonly database?: string;
|
|
1638
|
+
/**
|
|
1639
|
+
* Filter by ClickHouse user. Omit or empty = all users.
|
|
1640
|
+
* @type {string}
|
|
1641
|
+
* @memberof DiagnosticsApiGetDiagnosticsClickhouseSQLAnalysis
|
|
1642
|
+
*/
|
|
1643
|
+
readonly user?: string;
|
|
1644
|
+
}
|
|
1645
|
+
/**
|
|
1646
|
+
* Request parameters for getDiagnosticsClickhouseSpaceAnalysis operation in DiagnosticsApi.
|
|
1647
|
+
* @export
|
|
1648
|
+
* @interface DiagnosticsApiGetDiagnosticsClickhouseSpaceAnalysisRequest
|
|
1649
|
+
*/
|
|
1650
|
+
export interface DiagnosticsApiGetDiagnosticsClickhouseSpaceAnalysisRequest {
|
|
1651
|
+
/**
|
|
1652
|
+
* Organization name
|
|
1653
|
+
* @type {string}
|
|
1654
|
+
* @memberof DiagnosticsApiGetDiagnosticsClickhouseSpaceAnalysis
|
|
1655
|
+
*/
|
|
1656
|
+
readonly orgName: string;
|
|
1657
|
+
/**
|
|
1658
|
+
* Cluster name
|
|
1659
|
+
* @type {string}
|
|
1660
|
+
* @memberof DiagnosticsApiGetDiagnosticsClickhouseSpaceAnalysis
|
|
1661
|
+
*/
|
|
1662
|
+
readonly clusterName: string;
|
|
1663
|
+
/**
|
|
1664
|
+
* Filter by database. Omit or empty = all databases.
|
|
1665
|
+
* @type {string}
|
|
1666
|
+
* @memberof DiagnosticsApiGetDiagnosticsClickhouseSpaceAnalysis
|
|
1667
|
+
*/
|
|
1668
|
+
readonly database?: string;
|
|
1669
|
+
/**
|
|
1670
|
+
* Maximum number of top tables. Defaults to 20 and is capped at 200.
|
|
1671
|
+
* @type {number}
|
|
1672
|
+
* @memberof DiagnosticsApiGetDiagnosticsClickhouseSpaceAnalysis
|
|
1673
|
+
*/
|
|
1674
|
+
readonly tableLimit?: number;
|
|
1675
|
+
/**
|
|
1676
|
+
* Maximum number of top partitions. Defaults to 20 and is capped at 200.
|
|
1677
|
+
* @type {number}
|
|
1678
|
+
* @memberof DiagnosticsApiGetDiagnosticsClickhouseSpaceAnalysis
|
|
1679
|
+
*/
|
|
1680
|
+
readonly partitionLimit?: number;
|
|
1681
|
+
/**
|
|
1682
|
+
* Maximum number of merges and unfinished mutations. Defaults to 20 and is capped at 200.
|
|
1683
|
+
* @type {number}
|
|
1684
|
+
* @memberof DiagnosticsApiGetDiagnosticsClickhouseSpaceAnalysis
|
|
1685
|
+
*/
|
|
1686
|
+
readonly mergeLimit?: number;
|
|
1687
|
+
}
|
|
1372
1688
|
/**
|
|
1373
1689
|
* Request parameters for getDiagnosticsDamengSQLAnalysis operation in DiagnosticsApi.
|
|
1374
1690
|
* @export
|
|
@@ -2070,6 +2386,68 @@ export interface DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysisRequest {
|
|
|
2070
2386
|
*/
|
|
2071
2387
|
readonly databaseName?: string;
|
|
2072
2388
|
}
|
|
2389
|
+
/**
|
|
2390
|
+
* Request parameters for killDiagnosticsClickhouseQuery operation in DiagnosticsApi.
|
|
2391
|
+
* @export
|
|
2392
|
+
* @interface DiagnosticsApiKillDiagnosticsClickhouseQueryRequest
|
|
2393
|
+
*/
|
|
2394
|
+
export interface DiagnosticsApiKillDiagnosticsClickhouseQueryRequest {
|
|
2395
|
+
/**
|
|
2396
|
+
* Organization name
|
|
2397
|
+
* @type {string}
|
|
2398
|
+
* @memberof DiagnosticsApiKillDiagnosticsClickhouseQuery
|
|
2399
|
+
*/
|
|
2400
|
+
readonly orgName: string;
|
|
2401
|
+
/**
|
|
2402
|
+
* Cluster name
|
|
2403
|
+
* @type {string}
|
|
2404
|
+
* @memberof DiagnosticsApiKillDiagnosticsClickhouseQuery
|
|
2405
|
+
*/
|
|
2406
|
+
readonly clusterName: string;
|
|
2407
|
+
/**
|
|
2408
|
+
* ClickHouse query_id to terminate.
|
|
2409
|
+
* @type {string}
|
|
2410
|
+
* @memberof DiagnosticsApiKillDiagnosticsClickhouseQuery
|
|
2411
|
+
*/
|
|
2412
|
+
readonly queryId: string;
|
|
2413
|
+
}
|
|
2414
|
+
/**
|
|
2415
|
+
* Request parameters for listDiagnosticsClickhouseSessions operation in DiagnosticsApi.
|
|
2416
|
+
* @export
|
|
2417
|
+
* @interface DiagnosticsApiListDiagnosticsClickhouseSessionsRequest
|
|
2418
|
+
*/
|
|
2419
|
+
export interface DiagnosticsApiListDiagnosticsClickhouseSessionsRequest {
|
|
2420
|
+
/**
|
|
2421
|
+
* Organization name
|
|
2422
|
+
* @type {string}
|
|
2423
|
+
* @memberof DiagnosticsApiListDiagnosticsClickhouseSessions
|
|
2424
|
+
*/
|
|
2425
|
+
readonly orgName: string;
|
|
2426
|
+
/**
|
|
2427
|
+
* Cluster name
|
|
2428
|
+
* @type {string}
|
|
2429
|
+
* @memberof DiagnosticsApiListDiagnosticsClickhouseSessions
|
|
2430
|
+
*/
|
|
2431
|
+
readonly clusterName: string;
|
|
2432
|
+
/**
|
|
2433
|
+
* Maximum number of queries to return. Defaults to 100 and is capped at 1000.
|
|
2434
|
+
* @type {number}
|
|
2435
|
+
* @memberof DiagnosticsApiListDiagnosticsClickhouseSessions
|
|
2436
|
+
*/
|
|
2437
|
+
readonly limit?: number;
|
|
2438
|
+
/**
|
|
2439
|
+
* Sort metric. Defaults to elapsed. Allowed values: elapsed, memoryUsage, memoryUsageRatio, peakMemoryUsage, readRows, readBytes.
|
|
2440
|
+
* @type {string}
|
|
2441
|
+
* @memberof DiagnosticsApiListDiagnosticsClickhouseSessions
|
|
2442
|
+
*/
|
|
2443
|
+
readonly orderBy?: string;
|
|
2444
|
+
/**
|
|
2445
|
+
* Filter by current database. Omit or empty = all databases.
|
|
2446
|
+
* @type {string}
|
|
2447
|
+
* @memberof DiagnosticsApiListDiagnosticsClickhouseSessions
|
|
2448
|
+
*/
|
|
2449
|
+
readonly database?: string;
|
|
2450
|
+
}
|
|
2073
2451
|
/**
|
|
2074
2452
|
* Request parameters for listDiagnosticsDamengSessions operation in DiagnosticsApi.
|
|
2075
2453
|
* @export
|
|
@@ -2269,6 +2647,33 @@ export declare class DiagnosticsApi extends BaseAPI implements DiagnosticsApiInt
|
|
|
2269
2647
|
* @memberof DiagnosticsApi
|
|
2270
2648
|
*/
|
|
2271
2649
|
explainDiagnosticsPostgresqlSQLFingerprint(requestParameters: DiagnosticsApiExplainDiagnosticsPostgresqlSQLFingerprintRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PostgresqlSQLFingerprintExplainResponse, any, {}>>;
|
|
2650
|
+
/**
|
|
2651
|
+
* 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.
|
|
2652
|
+
* @summary Get ClickHouse replica and cluster health
|
|
2653
|
+
* @param {DiagnosticsApiGetDiagnosticsClickhouseClusterHealthRequest} requestParameters Request parameters.
|
|
2654
|
+
* @param {*} [options] Override http request option.
|
|
2655
|
+
* @throws {RequiredError}
|
|
2656
|
+
* @memberof DiagnosticsApi
|
|
2657
|
+
*/
|
|
2658
|
+
getDiagnosticsClickhouseClusterHealth(requestParameters: DiagnosticsApiGetDiagnosticsClickhouseClusterHealthRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ClickhouseClusterHealth, any, {}>>;
|
|
2659
|
+
/**
|
|
2660
|
+
* 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.
|
|
2661
|
+
* @summary Get ClickHouse SQL analysis
|
|
2662
|
+
* @param {DiagnosticsApiGetDiagnosticsClickhouseSQLAnalysisRequest} requestParameters Request parameters.
|
|
2663
|
+
* @param {*} [options] Override http request option.
|
|
2664
|
+
* @throws {RequiredError}
|
|
2665
|
+
* @memberof DiagnosticsApi
|
|
2666
|
+
*/
|
|
2667
|
+
getDiagnosticsClickhouseSQLAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsClickhouseSQLAnalysisRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ClickhouseSQLAnalysis, any, {}>>;
|
|
2668
|
+
/**
|
|
2669
|
+
* 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.
|
|
2670
|
+
* @summary Get ClickHouse space analysis
|
|
2671
|
+
* @param {DiagnosticsApiGetDiagnosticsClickhouseSpaceAnalysisRequest} requestParameters Request parameters.
|
|
2672
|
+
* @param {*} [options] Override http request option.
|
|
2673
|
+
* @throws {RequiredError}
|
|
2674
|
+
* @memberof DiagnosticsApi
|
|
2675
|
+
*/
|
|
2676
|
+
getDiagnosticsClickhouseSpaceAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsClickhouseSpaceAnalysisRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ClickhouseSpaceAnalysis, any, {}>>;
|
|
2272
2677
|
/**
|
|
2273
2678
|
* 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.
|
|
2274
2679
|
* @summary Get Dameng SQL analysis
|
|
@@ -2476,6 +2881,24 @@ export declare class DiagnosticsApi extends BaseAPI implements DiagnosticsApiInt
|
|
|
2476
2881
|
* @memberof DiagnosticsApi
|
|
2477
2882
|
*/
|
|
2478
2883
|
getDiagnosticsPostgresqlSpaceAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysisRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PostgresqlSpaceAnalysis, any, {}>>;
|
|
2884
|
+
/**
|
|
2885
|
+
* 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.
|
|
2886
|
+
* @summary Kill a ClickHouse query
|
|
2887
|
+
* @param {DiagnosticsApiKillDiagnosticsClickhouseQueryRequest} requestParameters Request parameters.
|
|
2888
|
+
* @param {*} [options] Override http request option.
|
|
2889
|
+
* @throws {RequiredError}
|
|
2890
|
+
* @memberof DiagnosticsApi
|
|
2891
|
+
*/
|
|
2892
|
+
killDiagnosticsClickhouseQuery(requestParameters: DiagnosticsApiKillDiagnosticsClickhouseQueryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
2893
|
+
/**
|
|
2894
|
+
* 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.
|
|
2895
|
+
* @summary List active ClickHouse queries
|
|
2896
|
+
* @param {DiagnosticsApiListDiagnosticsClickhouseSessionsRequest} requestParameters Request parameters.
|
|
2897
|
+
* @param {*} [options] Override http request option.
|
|
2898
|
+
* @throws {RequiredError}
|
|
2899
|
+
* @memberof DiagnosticsApi
|
|
2900
|
+
*/
|
|
2901
|
+
listDiagnosticsClickhouseSessions(requestParameters: DiagnosticsApiListDiagnosticsClickhouseSessionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ClickhouseSessionList, any, {}>>;
|
|
2479
2902
|
/**
|
|
2480
2903
|
* 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.
|
|
2481
2904
|
* @summary List Dameng sessions
|