spindb 0.37.2 → 0.38.0

package/dist/engines/clickhouse/cli-utils.js

@@ -0,0 +1,143 @@
+/**
+ * ClickHouse CLI utilities
+ * Shared utilities for interacting with the clickhouse binary
+ */
+import { existsSync } from 'fs';
+import { join } from 'path';
+import { configManager } from '../../core/config-manager.js';
+import { paths } from '../../config/paths.js';
+import { platformService } from '../../core/platform-service.js';
+import { normalizeVersion } from './version-maps.js';
+export const CLICKHOUSE_NOT_FOUND_ERROR = 'ClickHouse binary not found. Run: spindb engines download clickhouse <version>';
+/**
+ * Validate a ClickHouse identifier (database name, table name, etc.)
+ * ClickHouse identifiers must:
+ * - Start with a letter or underscore
+ * - Contain only letters, digits, and underscores
+ * - Not be a reserved word (basic check)
+ *
+ * @param identifier - The identifier to validate
+ * @param type - Type of identifier for error messages (e.g., 'database', 'table')
+ * @returns The validated identifier
+ * @throws Error if the identifier is invalid
+ */
+export function validateClickHouseIdentifier(identifier, type = 'identifier') {
+    if (!identifier || typeof identifier !== 'string') {
+        throw new Error(`Invalid ${type}: must be a non-empty string`);
+    }
+    // ClickHouse identifier rules:
+    // - Must start with a letter (a-z, A-Z) or underscore
+    // - Can contain letters, digits, and underscores
+    // - Maximum length of 255 characters
+    const validPattern = /^[a-zA-Z_][a-zA-Z0-9_]*$/;
+    if (!validPattern.test(identifier)) {
+        throw new Error(`Invalid ${type} "${identifier}": must start with a letter or underscore ` +
+            `and contain only letters, digits, and underscores`);
+    }
+    if (identifier.length > 255) {
+        throw new Error(`Invalid ${type} "${identifier}": maximum length is 255 characters`);
+    }
+    // Basic reserved word check (ClickHouse system databases)
+    const reserved = ['system', 'information_schema'];
+    if (reserved.includes(identifier.toLowerCase())) {
+        throw new Error(`Invalid ${type} "${identifier}": "${identifier}" is a reserved system name`);
+    }
+    return identifier;
+}
+/**
+ * Escape a ClickHouse identifier for use in SQL queries
+ * Uses backticks for escaping (ClickHouse supports both backticks and double quotes)
+ *
+ * @param identifier - The identifier to escape
+ * @returns The escaped identifier wrapped in backticks
+ */
+export function escapeClickHouseIdentifier(identifier) {
+    // Replace any backticks in the identifier with escaped backticks
+    const escaped = identifier.replace(/`/g, '``');
+    return `\`${escaped}\``;
+}
+/**
+ * Get the path to the clickhouse binary
+ * Checks config cache first, then falls back to downloaded binary path
+ *
+ * @param version - Optional version to look up specific binary
+ * @returns Path to clickhouse binary, or null if not found
+ */
+export async function getClickHousePath(version) {
+    // Check config cache first
+    const cached = await configManager.getBinaryPath('clickhouse');
+    if (cached && existsSync(cached)) {
+        return cached;
+    }
+    // If version provided, look for downloaded binary
+    if (version) {
+        const { platform, arch } = platformService.getPlatformInfo();
+        const fullVersion = normalizeVersion(version);
+        const binPath = paths.getBinaryPath({
+            engine: 'clickhouse',
+            version: fullVersion,
+            platform,
+            arch,
+        });
+        const clickhousePath = join(binPath, 'bin', 'clickhouse');
+        if (existsSync(clickhousePath)) {
+            return clickhousePath;
+        }
+    }
+    return null;
+}
+/**
+ * Get the path to the clickhouse binary, throwing if not found
+ *
+ * @param version - Optional version to look up specific binary
+ * @returns Path to clickhouse binary
+ * @throws Error if binary not found
+ */
+export async function requireClickHousePath(version) {
+    const path = await getClickHousePath(version);
+    if (!path) {
+        throw new Error(CLICKHOUSE_NOT_FOUND_ERROR);
+    }
+    return path;
+}
+/**
+ * Build a clickhouse client command for executing SQL
+ *
+ * @param clickhousePath - Path to clickhouse binary
+ * @param port - Port to connect to
+ * @param database - Database to use
+ * @returns Array of command arguments
+ */
+export function buildClickHouseClientArgs(port, database) {
+    return [
+        'client',
+        '--host',
+        '127.0.0.1',
+        '--port',
+        String(port),
+        '--database',
+        database,
+    ];
+}
+/**
+ * Build clickhouse client command for executing a query
+ *
+ * @param port - Port to connect to
+ * @param database - Database to use
+ * @param query - SQL query to execute
+ * @returns Array of command arguments
+ */
+export function buildClickHouseQueryArgs(port, database, query) {
+    return [
+        'client',
+        '--host',
+        '127.0.0.1',
+        '--port',
+        String(port),
+        '--database',
+        database,
+        '--query',
+        query,
+    ];
+}
+//# sourceMappingURL=cli-utils.js.map

package/dist/engines/clickhouse/cli-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-utils.js","sourceRoot":"","sources":["../../../engines/clickhouse/cli-utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAA;AAC/B,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAC3B,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AACzD,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAA;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAEjD,MAAM,CAAC,MAAM,0BAA0B,GACrC,gFAAgF,CAAA;AAElF;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,4BAA4B,CAC1C,UAAkB,EAClB,OAAe,YAAY;IAE3B,IAAI,CAAC,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QAClD,MAAM,IAAI,KAAK,CAAC,WAAW,IAAI,8BAA8B,CAAC,CAAA;IAChE,CAAC;IAED,+BAA+B;IAC/B,sDAAsD;IACtD,iDAAiD;IACjD,qCAAqC;IACrC,MAAM,YAAY,GAAG,0BAA0B,CAAA;IAE/C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,KAAK,UAAU,4CAA4C;YACxE,mDAAmD,CACtD,CAAA;IACH,CAAC;IAED,IAAI,UAAU,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,KAAK,UAAU,qCAAqC,CACpE,CAAA;IACH,CAAC;IAED,0DAA0D;IAC1D,MAAM,QAAQ,GAAG,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAA;IACjD,IAAI,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,KAAK,UAAU,OAAO,UAAU,6BAA6B,CAC7E,CAAA;IACH,CAAC;IAED,OAAO,UAAU,CAAA;AACnB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CAAC,UAAkB;IAC3D,iEAAiE;IACjE,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IAC9C,OAAO,KAAK,OAAO,IAAI,CAAA;AACzB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,OAAgB;IAEhB,2BAA2B;IAC3B,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,YAAY,CAAC,CAAA;IAC9D,IAAI,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACjC,OAAO,MAAM,CAAA;IACf,CAAC;IAED,kDAAkD;IAClD,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,eAAe,CAAC,eAAe,EAAE,CAAA;QAC5D,MAAM,WAAW,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAA;QAC7C,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAAC;YAClC,MAAM,EAAE,YAAY;YACpB,OAAO,EAAE,WAAW;YACpB,QAAQ;YACR,IAAI;SACL,CAAC,CAAA;QACF,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,YAAY,CAAC,CAAA;QACzD,IAAI,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;YAC/B,OAAO,cAAc,CAAA;QACvB,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,OAAgB;IAC1D,MAAM,IAAI,GAAG,MAAM,iBAAiB,CAAC,OAAO,CAAC,CAAA;IAC7C,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;IAC7C,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,yBAAyB,CACvC,IAAY,EACZ,QAAgB;IAEhB,OAAO;QACL,QAAQ;QACR,QAAQ;QACR,WAAW;QACX,QAAQ;QACR,MAAM,CAAC,IAAI,CAAC;QACZ,YAAY;QACZ,QAAQ;KACT,CAAA;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,wBAAwB,CACtC,IAAY,EACZ,QAAgB,EAChB,KAAa;IAEb,OAAO;QACL,QAAQ;QACR,QAAQ;QACR,WAAW;QACX,QAAQ;QACR,MAAM,CAAC,IAAI,CAAC;QACZ,YAAY;QACZ,QAAQ;QACR,SAAS;QACT,KAAK;KACN,CAAA;AACH,CAAC"}

package/dist/engines/clickhouse/hostdb-releases.js

@@ -0,0 +1,24 @@
+/**
+ * hostdb Releases Module for ClickHouse
+ *
+ * Fetches ClickHouse binary information from the hostdb repository at
+ * https://github.com/robertjbass/hostdb
+ *
+ * ClickHouse uses YY.MM versioning (e.g., 25.12.3.21), so major version is YY.MM.
+ */
+import { createHostdbReleases } from '../../core/hostdb-releases-factory.js';
+import { CLICKHOUSE_VERSION_MAP, SUPPORTED_MAJOR_VERSIONS, getMajorVersion, } from './version-maps.js';
+import { clickhouseBinaryManager } from './binary-manager.js';
+import { Engine } from '../../types/index.js';
+const hostdbReleases = createHostdbReleases({
+    engine: Engine.ClickHouse,
+    displayName: 'ClickHouse',
+    versionMap: CLICKHOUSE_VERSION_MAP,
+    supportedMajorVersions: SUPPORTED_MAJOR_VERSIONS,
+    groupingStrategy: 'xy-format',
+    listInstalled: () => clickhouseBinaryManager.listInstalled(),
+    getMajorVersion,
+});
+export const fetchAvailableVersions = hostdbReleases.fetchAvailableVersions;
+export const getLatestVersion = hostdbReleases.getLatestVersion;
+//# sourceMappingURL=hostdb-releases.js.map

package/dist/engines/clickhouse/hostdb-releases.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hostdb-releases.js","sourceRoot":"","sources":["../../../engines/clickhouse/hostdb-releases.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAA;AACzE,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,eAAe,GAChB,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAA;AAC1D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEpC,MAAM,cAAc,GAAG,oBAAoB,CAAC;IAC1C,MAAM,EAAE,MAAM,CAAC,UAAU;IACzB,WAAW,EAAE,YAAY;IACzB,UAAU,EAAE,sBAAsB;IAClC,sBAAsB,EAAE,wBAAwB;IAChD,gBAAgB,EAAE,WAAW;IAC7B,aAAa,EAAE,GAAG,EAAE,CAAC,uBAAuB,CAAC,aAAa,EAAE;IAC5D,eAAe;CAChB,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,cAAc,CAAC,sBAAsB,CAAA;AAC3E,MAAM,CAAC,MAAM,gBAAgB,GAAG,cAAc,CAAC,gBAAgB,CAAA"}