kb-cloud-client-typescript 2.4.0-alpha.123 → 2.4.0-alpha.124

package/src/adminapi/models/clickhouse-partition-space.ts

@@ -0,0 +1,96 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ClickhousePartitionSpace
+ */
+export interface ClickhousePartitionSpace {
+    /**
+     * Database name.
+     * @type {string}
+     * @memberof ClickhousePartitionSpace
+     */
+    'database'?: string;
+    /**
+     * Table name.
+     * @type {string}
+     * @memberof ClickhousePartitionSpace
+     */
+    'table'?: string;
+    /**
+     * partition_id from system.parts.
+     * @type {string}
+     * @memberof ClickhousePartitionSpace
+     */
+    'partitionId'?: string;
+    /**
+     * Human-readable partition expression.
+     * @type {string}
+     * @memberof ClickhousePartitionSpace
+     */
+    'partition'?: string;
+    /**
+     * Sum of rows across hosts.
+     * @type {number}
+     * @memberof ClickhousePartitionSpace
+     */
+    'rows'?: number;
+    /**
+     * Physical bytes_on_disk across hosts.
+     * @type {number}
+     * @memberof ClickhousePartitionSpace
+     */
+    'bytesOnDisk'?: number;
+    /**
+     * Sum of data_compressed_bytes.
+     * @type {number}
+     * @memberof ClickhousePartitionSpace
+     */
+    'dataCompressedBytes'?: number;
+    /**
+     * Sum of data_uncompressed_bytes.
+     * @type {number}
+     * @memberof ClickhousePartitionSpace
+     */
+    'dataUncompressedBytes'?: number;
+    /**
+     * Active part count across hosts.
+     * @type {number}
+     * @memberof ClickhousePartitionSpace
+     */
+    'activeParts'?: number;
+    /**
+     * Number of hosts that own this partition.
+     * @type {number}
+     * @memberof ClickhousePartitionSpace
+     */
+    'hosts'?: number;
+    /**
+     * Minimum min_date in the partition.
+     * @type {string}
+     * @memberof ClickhousePartitionSpace
+     */
+    'minDate'?: string;
+    /**
+     * Maximum max_date in the partition.
+     * @type {string}
+     * @memberof ClickhousePartitionSpace
+     */
+    'maxDate'?: string;
+}
+

package/src/adminapi/models/clickhouse-query-pattern.ts

@@ -0,0 +1,96 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ClickhouseQueryPattern
+ */
+export interface ClickhouseQueryPattern {
+    /**
+     * normalized_query_hash as a string.
+     * @type {string}
+     * @memberof ClickhouseQueryPattern
+     */
+    'normalizedQueryHash'?: string;
+    /**
+     * One representative query text for the pattern, with string and numeric literals and comments masked as ?.
+     * @type {string}
+     * @memberof ClickhouseQueryPattern
+     */
+    'sampleQuery'?: string;
+    /**
+     * Number of executions of the pattern.
+     * @type {number}
+     * @memberof ClickhouseQueryPattern
+     */
+    'calls'?: number;
+    /**
+     * Sum of query_duration_ms across all executions.
+     * @type {number}
+     * @memberof ClickhouseQueryPattern
+     */
+    'totalDurationMs'?: number;
+    /**
+     * Average query_duration_ms.
+     * @type {number}
+     * @memberof ClickhouseQueryPattern
+     */
+    'meanDurationMs'?: number;
+    /**
+     * Maximum query_duration_ms.
+     * @type {number}
+     * @memberof ClickhouseQueryPattern
+     */
+    'maxDurationMs'?: number;
+    /**
+     * Sum of read_rows.
+     * @type {number}
+     * @memberof ClickhouseQueryPattern
+     */
+    'readRows'?: number;
+    /**
+     * Sum of memory_usage in bytes.
+     * @type {number}
+     * @memberof ClickhouseQueryPattern
+     */
+    'memoryUsageBytes'?: number;
+    /**
+     * Executions that ended with ExceptionWhileProcessing.
+     * @type {number}
+     * @memberof ClickhouseQueryPattern
+     */
+    'failureCount'?: number;
+    /**
+     * Executions whose duration is at least 1000 ms.
+     * @type {number}
+     * @memberof ClickhouseQueryPattern
+     */
+    'slowCallCount'?: number;
+    /**
+     * First event_time in RFC3339 UTC.
+     * @type {string}
+     * @memberof ClickhouseQueryPattern
+     */
+    'firstSeen'?: string;
+    /**
+     * Last event_time in RFC3339 UTC.
+     * @type {string}
+     * @memberof ClickhouseQueryPattern
+     */
+    'lastSeen'?: string;
+}
+

package/src/adminapi/models/clickhouse-replica-health.ts

@@ -0,0 +1,162 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ClickhouseReplicaHealth
+ */
+export interface ClickhouseReplicaHealth {
+    /**
+     * Database name.
+     * @type {string}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'database'?: string;
+    /**
+     * Table name.
+     * @type {string}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'table'?: string;
+    /**
+     * ClickHouse server host that reported this replica.
+     * @type {string}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'hostName'?: string;
+    /**
+     * Replica is in readonly mode. Usually indicates Keeper or network problems.
+     * @type {boolean}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'isReadonly'?: boolean;
+    /**
+     * Keeper session expired.
+     * @type {boolean}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'isSessionExpired'?: boolean;
+    /**
+     * absolute_delay from system.replicas.
+     * @type {number}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'absoluteDelaySeconds'?: number;
+    /**
+     * replication queue size.
+     * @type {number}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'queueSize'?: number;
+    /**
+     * Number of inserts waiting in the replication queue.
+     * @type {number}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'insertsInQueue'?: number;
+    /**
+     * Number of merges waiting in the replication queue.
+     * @type {number}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'mergesInQueue'?: number;
+    /**
+     * Number of future parts.
+     * @type {number}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'futureParts'?: number;
+    /**
+     * Number of parts to check.
+     * @type {number}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'partsToCheck'?: number;
+    /**
+     * total_replicas for the table.
+     * @type {number}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'totalReplicas'?: number;
+    /**
+     * active_replicas for the table.
+     * @type {number}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'activeReplicas'?: number;
+    /**
+     * Maximum log index in Keeper.
+     * @type {number}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'logMaxIndex'?: number;
+    /**
+     * Last applied log index.
+     * @type {number}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'logPointer'?: number;
+    /**
+     * Last replication queue update time in RFC3339 UTC.
+     * @type {string}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'lastQueueUpdate'?: string;
+    /**
+     * Keeper path of the table.
+     * @type {string}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'zookeeperPath'?: string;
+    /**
+     * Replica name.
+     * @type {string}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'replicaName'?: string;
+    /**
+     * Replica path in Keeper.
+     * @type {string}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'replicaPath'?: string;
+    /**
+     * Last Keeper exception, empty when healthy.
+     * @type {string}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'zookeeperException'?: string;
+    /**
+     * Last replication queue update exception, empty when healthy.
+     * @type {string}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'lastQueueUpdateException'?: string;
+    /**
+     * normal, warning or critical.
+     * @type {string}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'risk'?: string;
+    /**
+     * Detected issue codes such as readonly, session_expired, replication_delay, queue_backlog, missing_replicas, keeper_error or queue_update_error.
+     * @type {Array<string>}
+     * @memberof ClickhouseReplicaHealth
+     */
+    'issues'?: Array<string>;
+}
+

package/src/adminapi/models/clickhouse-session-list.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClickhouseSession } from './clickhouse-session';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClickhouseSource } from './clickhouse-source';
+
+/**
+ * 
+ * @export
+ * @interface ClickhouseSessionList
+ */
+export interface ClickhouseSessionList {
+    /**
+     * Collection time in RFC3339 UTC.
+     * @type {string}
+     * @memberof ClickhouseSessionList
+     */
+    'collectedAt': string;
+    /**
+     * Detected deployment mode (standalone or cluster). When clusterAllReplicas fails and the local node is used instead, this is reported as standalone.
+     * @type {string}
+     * @memberof ClickhouseSessionList
+     */
+    'clusterMode'?: string;
+    /**
+     * Active queries collected from system.processes, ordered by the requested metric.
+     * @type {Array<ClickhouseSession>}
+     * @memberof ClickhouseSessionList
+     */
+    'items': Array<ClickhouseSession>;
+    /**
+     * Per-source collection status. In cluster mode one entry is returned per clusterAllReplicas expression.
+     * @type {Array<ClickhouseSource>}
+     * @memberof ClickhouseSessionList
+     */
+    'sources': Array<ClickhouseSource>;
+}
+

package/src/adminapi/models/clickhouse-session.ts

@@ -0,0 +1,144 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ClickhouseSession
+ */
+export interface ClickhouseSession {
+    /**
+     * ClickHouse query_id. Use it with the KILL QUERY endpoint.
+     * @type {string}
+     * @memberof ClickhouseSession
+     */
+    'queryId': string;
+    /**
+     * query_id of the initial (distributed) query when this row is a remote sub-query.
+     * @type {string}
+     * @memberof ClickhouseSession
+     */
+    'initialQueryId'?: string;
+    /**
+     * User that started the query.
+     * @type {string}
+     * @memberof ClickhouseSession
+     */
+    'user'?: string;
+    /**
+     * Client address.
+     * @type {string}
+     * @memberof ClickhouseSession
+     */
+    'address'?: string;
+    /**
+     * Client port.
+     * @type {number}
+     * @memberof ClickhouseSession
+     */
+    'port'?: number;
+    /**
+     * Current database of the query.
+     * @type {string}
+     * @memberof ClickhouseSession
+     */
+    'database'?: string;
+    /**
+     * ClickHouse server host that reported the query.
+     * @type {string}
+     * @memberof ClickhouseSession
+     */
+    'hostName'?: string;
+    /**
+     * Seconds elapsed since the query started.
+     * @type {number}
+     * @memberof ClickhouseSession
+     */
+    'elapsedSeconds'?: number;
+    /**
+     * Rows read so far.
+     * @type {number}
+     * @memberof ClickhouseSession
+     */
+    'readRows'?: number;
+    /**
+     * Bytes read so far.
+     * @type {number}
+     * @memberof ClickhouseSession
+     */
+    'readBytes'?: number;
+    /**
+     * Rows written so far.
+     * @type {number}
+     * @memberof ClickhouseSession
+     */
+    'writtenRows'?: number;
+    /**
+     * Bytes written so far.
+     * @type {number}
+     * @memberof ClickhouseSession
+     */
+    'writtenBytes'?: number;
+    /**
+     * Current memory usage in bytes.
+     * @type {number}
+     * @memberof ClickhouseSession
+     */
+    'memoryUsageBytes'?: number;
+    /**
+     * max_memory_usage from the query Settings map (only explicitly modified settings). Zero means the query did not set a limit, so the server default applies.
+     * @type {number}
+     * @memberof ClickhouseSession
+     */
+    'memoryLimitBytes'?: number;
+    /**
+     * memory_usage / memoryLimitBytes (0-1). Zero when the query did not explicitly set max_memory_usage. Values close to 1 indicate the query is about to hit its memory limit.
+     * @type {number}
+     * @memberof ClickhouseSession
+     */
+    'memoryUsageRatio'?: number;
+    /**
+     * Peak memory usage in bytes. Zero when the server version does not expose peak_memory_usage.
+     * @type {number}
+     * @memberof ClickhouseSession
+     */
+    'peakMemoryUsageBytes'?: number;
+    /**
+     * Whether this row is the initial query rather than a remote sub-query.
+     * @type {boolean}
+     * @memberof ClickhouseSession
+     */
+    'isInitialQuery'?: boolean;
+    /**
+     * Estimated query start time in RFC3339 UTC, computed from elapsed because system.processes has no start timestamp.
+     * @type {string}
+     * @memberof ClickhouseSession
+     */
+    'queryStartTime'?: string;
+    /**
+     * Query text with string and numeric literals and comments masked as ? before returning.
+     * @type {string}
+     * @memberof ClickhouseSession
+     */
+    'query'?: string;
+    /**
+     * Single-line masked query summary suitable for list rendering.
+     * @type {string}
+     * @memberof ClickhouseSession
+     */
+    'querySummary'?: string;
+}
+

package/src/adminapi/models/clickhouse-slow-query.ts

@@ -0,0 +1,144 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ClickhouseSlowQuery
+ */
+export interface ClickhouseSlowQuery {
+    /**
+     * ClickHouse query_id.
+     * @type {string}
+     * @memberof ClickhouseSlowQuery
+     */
+    'queryId'?: string;
+    /**
+     * Initial query_id for a distributed query.
+     * @type {string}
+     * @memberof ClickhouseSlowQuery
+     */
+    'initialQueryId'?: string;
+    /**
+     * query_log type (QueryFinish or ExceptionWhileProcessing).
+     * @type {string}
+     * @memberof ClickhouseSlowQuery
+     */
+    'type'?: string;
+    /**
+     * User that ran the query.
+     * @type {string}
+     * @memberof ClickhouseSlowQuery
+     */
+    'user'?: string;
+    /**
+     * Current database at execution time.
+     * @type {string}
+     * @memberof ClickhouseSlowQuery
+     */
+    'database'?: string;
+    /**
+     * Query kind reported by ClickHouse.
+     * @type {string}
+     * @memberof ClickhouseSlowQuery
+     */
+    'queryKind'?: string;
+    /**
+     * Query text with string and numeric literals and comments masked as ?.
+     * @type {string}
+     * @memberof ClickhouseSlowQuery
+     */
+    'query'?: string;
+    /**
+     * normalized_query_hash as a string to avoid precision loss in clients.
+     * @type {string}
+     * @memberof ClickhouseSlowQuery
+     */
+    'normalizedQueryHash'?: string;
+    /**
+     * query_duration_ms.
+     * @type {number}
+     * @memberof ClickhouseSlowQuery
+     */
+    'durationMs'?: number;
+    /**
+     * Rows read by the query.
+     * @type {number}
+     * @memberof ClickhouseSlowQuery
+     */
+    'readRows'?: number;
+    /**
+     * Bytes read by the query.
+     * @type {number}
+     * @memberof ClickhouseSlowQuery
+     */
+    'readBytes'?: number;
+    /**
+     * Memory usage in bytes.
+     * @type {number}
+     * @memberof ClickhouseSlowQuery
+     */
+    'memoryUsageBytes'?: number;
+    /**
+     * Rows returned by the query.
+     * @type {number}
+     * @memberof ClickhouseSlowQuery
+     */
+    'resultRows'?: number;
+    /**
+     * Bytes returned by the query.
+     * @type {number}
+     * @memberof ClickhouseSlowQuery
+     */
+    'resultBytes'?: number;
+    /**
+     * ClickHouse exception code, zero for successful queries.
+     * @type {number}
+     * @memberof ClickhouseSlowQuery
+     */
+    'exceptionCode'?: number;
+    /**
+     * Exception text for failed queries.
+     * @type {string}
+     * @memberof ClickhouseSlowQuery
+     */
+    'exception'?: string;
+    /**
+     * query_log event time in RFC3339 UTC.
+     * @type {string}
+     * @memberof ClickhouseSlowQuery
+     */
+    'eventTime'?: string;
+    /**
+     * ClickHouse server host that ran the query.
+     * @type {string}
+     * @memberof ClickhouseSlowQuery
+     */
+    'hostName'?: string;
+    /**
+     * Client name reported by ClickHouse.
+     * @type {string}
+     * @memberof ClickhouseSlowQuery
+     */
+    'clientName'?: string;
+    /**
+     * Whether this is the initial query rather than a remote sub-query.
+     * @type {boolean}
+     * @memberof ClickhouseSlowQuery
+     */
+    'isInitialQuery'?: boolean;
+}
+