@lightdash/cli 0.2395.0 → 0.2396.0

package/dist/handlers/sql.d.ts

@@ -0,0 +1,9 @@
+type SqlHandlerOptions = {
+    output: string;
+    limit?: number;
+    pageSize?: number;
+    verbose?: boolean;
+};
+export declare const sqlHandler: (sql: string, options: SqlHandlerOptions) => Promise<void>;
+export {};
+//# sourceMappingURL=sql.d.ts.map

package/dist/handlers/sql.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sql.d.ts","sourceRoot":"","sources":["../../src/handlers/sql.ts"],"names":[],"mappings":"AAYA,KAAK,iBAAiB,GAAG;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AA0FF,eAAO,MAAM,UAAU,QACd,MAAM,WACF,iBAAiB,KAC3B,OAAO,CAAC,IAAI,CAiEd,CAAC"}

package/dist/handlers/sql.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sqlHandler = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@lightdash/common");
+const fs_1 = require("fs");
+const config_1 = require("../config");
+const globalState_1 = tslib_1.__importDefault(require("../globalState"));
+const styles = tslib_1.__importStar(require("../styles"));
+const apiClient_1 = require("./dbt/apiClient");
+const DEFAULT_PAGE_SIZE = 500;
+const POLL_INTERVAL_MS = 500;
+/**
+ * Convert ResultRow array to CSV string
+ */
+function resultsToCsv(columns, rows) {
+    // Escape CSV value: wrap in quotes if contains comma, quote, or newline
+    const escapeValue = (value) => {
+        if (value === null || value === undefined) {
+            return '';
+        }
+        const str = String(value);
+        if (str.includes(',') || str.includes('"') || str.includes('\n')) {
+            return `"${str.replace(/"/g, '""')}"`;
+        }
+        return str;
+    };
+    const header = columns.map(escapeValue).join(',');
+    const dataRows = rows.map((row) => columns.map((col) => escapeValue(row[col]?.value?.raw)).join(','));
+    return [header, ...dataRows].join('\n');
+}
+/**
+ * Fetch query results once
+ */
+async function fetchQueryResults(projectUuid, queryUuid, pageSize) {
+    const url = `/api/v2/projects/${projectUuid}/query/${queryUuid}?pageSize=${pageSize}`;
+    return (0, apiClient_1.lightdashApi)({
+        method: 'GET',
+        url,
+        body: undefined,
+    });
+}
+/**
+ * Sleep for a given duration
+ */
+function sleep(ms) {
+    return new Promise((resolve) => {
+        setTimeout(resolve, ms);
+    });
+}
+/**
+ * Poll for query results until status is READY or ERROR
+ */
+async function pollQueryResults(projectUuid, queryUuid, pageSize) {
+    const poll = async () => {
+        const result = await fetchQueryResults(projectUuid, queryUuid, pageSize);
+        globalState_1.default.debug(`> Query status: ${result.status}`);
+        if (result.status === common_1.QueryHistoryStatus.READY) {
+            return result;
+        }
+        if (result.status === common_1.QueryHistoryStatus.ERROR) {
+            return result;
+        }
+        if (result.status === common_1.QueryHistoryStatus.CANCELLED) {
+            throw new Error('Query was cancelled');
+        }
+        // Still pending, wait and poll again
+        await sleep(POLL_INTERVAL_MS);
+        return poll();
+    };
+    return poll();
+}
+const sqlHandler = async (sql, options) => {
+    globalState_1.default.setVerbose(options.verbose ?? false);
+    const config = await (0, config_1.getConfig)();
+    const projectUuid = config.context?.project;
+    if (!projectUuid) {
+        throw new Error(`No project selected. Run 'lightdash config set-project' first.`);
+    }
+    globalState_1.default.debug(`> Running SQL query against project: ${projectUuid}`);
+    globalState_1.default.debug(`> SQL: ${sql}`);
+    const pageSize = options.pageSize ?? DEFAULT_PAGE_SIZE;
+    // Submit the query
+    const spinner = globalState_1.default.startSpinner('Submitting SQL query...');
+    const submitResult = await (0, apiClient_1.lightdashApi)({
+        method: 'POST',
+        url: `/api/v2/projects/${projectUuid}/query/sql`,
+        body: JSON.stringify({
+            sql,
+            limit: options.limit,
+            context: 'cli',
+        }),
+    });
+    globalState_1.default.debug(`> Query UUID: ${submitResult.queryUuid}`);
+    spinner.text = 'Waiting for query results...';
+    // Poll for results
+    const result = await pollQueryResults(projectUuid, submitResult.queryUuid, pageSize);
+    if (result.status === common_1.QueryHistoryStatus.ERROR) {
+        spinner.fail('Query failed');
+        throw new Error(result.error ?? 'Query execution failed');
+    }
+    if (result.status !== common_1.QueryHistoryStatus.READY) {
+        spinner.fail('Unexpected query status');
+        throw new Error(`Unexpected query status: ${result.status}`);
+    }
+    // Extract column names from the columns metadata
+    const columns = Object.keys(result.columns);
+    const rowCount = result.rows.length;
+    spinner.text = `Writing ${rowCount} rows to ${options.output}...`;
+    // Convert to CSV and write to file
+    const csv = resultsToCsv(columns, result.rows);
+    await fs_1.promises.writeFile(options.output, csv, 'utf8');
+    spinner.succeed(`${styles.success('Success!')} Wrote ${rowCount} rows to ${options.output}`);
+};
+exports.sqlHandler = sqlHandler;

package/dist/index.js

@@ -21,6 +21,7 @@ const login_1 = require("./handlers/login");
 const preview_1 = require("./handlers/preview");
 const renameHandler_1 = require("./handlers/renameHandler");
 const setProject_1 = require("./handlers/setProject");
+const sql_1 = require("./handlers/sql");
 const validate_1 = require("./handlers/validate");
 const styles = tslib_1.__importStar(require("./styles"));
 // Trigger CLI tests
@@ -423,6 +424,15 @@ ${styles.bold('Examples:')}
     .option('--verbose', 'Show detailed output', false)
     .option('-f, --format <format>', 'Output format: cli (default) or json (SARIF format)', 'cli')
     .action(lint_1.lintHandler);
+commander_1.program
+    .command('sql')
+    .description('Run raw SQL query against the warehouse using project credentials')
+    .argument('<query>', 'SQL query to execute')
+    .requiredOption('-o, --output <file>', 'Output file path for CSV results')
+    .option('--limit <number>', 'Maximum rows to return from query', parseIntArgument)
+    .option('--page-size <number>', 'Number of rows per page (default: 500, max: 5000)', parseIntArgument)
+    .option('--verbose', 'Show detailed output', false)
+    .action(sql_1.sqlHandler);
 const errorHandler = (err) => {
     // Use error message with fallback for safety
     const errorMessage = (0, common_1.getErrorMessage)(err) || 'An unexpected error occurred';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/cli",
-  "version": "0.2395.0",
+  "version": "0.2396.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -38,8 +38,8 @@
     "unique-names-generator": "^4.7.1",
     "uuid": "^11.0.3",
     "yaml": "^2.7.0",
-    "@lightdash/common": "0.2395.0",
-    "@lightdash/warehouses": "0.2395.0"
+    "@lightdash/common": "0.2396.0",
+    "@lightdash/warehouses": "0.2396.0"
   },
   "description": "Lightdash CLI tool",
   "devDependencies": {