@elyracode/db-tools 0.3.1 → 0.3.2

package/README.md

@@ -10,20 +10,41 @@ elyra install npm:@elyracode/db-tools
 
 ## Configuration
 
-Set environment variables for your database connections:
+### Automatic: .env file (recommended)
 
-### MySQL
+If your project has a `.env` file (e.g. Laravel), db-tools reads it automatically. Standard key names are mapped:
+
+| .env key | Maps to | Used by |
+|----------|---------|--------|
+| `DB_HOST` | `ELYRA_MYSQL_HOST` | MySQL |
+| `DB_PORT` | `ELYRA_MYSQL_PORT` | MySQL |
+| `DB_DATABASE` | `ELYRA_MYSQL_DATABASE` | MySQL |
+| `DB_USERNAME` | `ELYRA_MYSQL_USER` | MySQL |
+| `DB_PASSWORD` | `ELYRA_MYSQL_PASSWORD` | MySQL |
+| `CLICKHOUSE_HOST` | `ELYRA_CLICKHOUSE_HOST` | ClickHouse |
+| `CLICKHOUSE_PORT` | `ELYRA_CLICKHOUSE_PORT` | ClickHouse |
+| `CLICKHOUSE_DATABASE` | `ELYRA_CLICKHOUSE_DATABASE` | ClickHouse |
+| `CLICKHOUSE_USERNAME` | `ELYRA_CLICKHOUSE_USERNAME` | ClickHouse |
+| `CLICKHOUSE_PASSWORD` | `ELYRA_CLICKHOUSE_PASSWORD` | ClickHouse |
+| `CLICKHOUSE_HTTPS` | `ELYRA_CLICKHOUSE_HTTPS` | ClickHouse |
+| `CLICKHOUSE_TIMEOUT_CONNECT` | `ELYRA_CLICKHOUSE_TIMEOUT_CONNECT` | ClickHouse |
+| `CLICKHOUSE_TIMEOUT_QUERY` | `ELYRA_CLICKHOUSE_TIMEOUT_QUERY` | ClickHouse |
+
+For a typical Laravel project, your existing `.env` already has `DB_HOST`, `DB_DATABASE`, etc. -- db-tools picks them up with zero configuration.
+
+### Manual: environment variables
+
+You can also set `ELYRA_*` env vars directly. These always take precedence over `.env` values.
 
 ```
+# MySQL
 export ELYRA_MYSQL_HOST=localhost
 export ELYRA_MYSQL_PORT=3306
 export ELYRA_MYSQL_USER=readonly_user
 export ELYRA_MYSQL_PASSWORD=secret
 export ELYRA_MYSQL_DATABASE=myapp
-```
 
-### ClickHouse
-```
+# ClickHouse
 export ELYRA_CLICKHOUSE_HOST=localhost
 export ELYRA_CLICKHOUSE_PORT=8123
 export ELYRA_CLICKHOUSE_DATABASE=mydb

package/extensions/index.ts

@@ -1,15 +1,22 @@
+import { existsSync, readFileSync } from "node:fs";
+import { join } from "node:path";
 import type { ExtensionAPI } from "@elyracode/coding-agent";
 import { createClient } from "@clickhouse/client";
 import mysql2 from "mysql2/promise";
 import { Type } from "typebox";
 
 export default function (elyra: ExtensionAPI) {
+	// ── Load .env ──
+	// Reads the project's .env file (if it exists) and maps common Laravel/Docker
+	// env var names to the ELYRA_ equivalents. Explicit ELYRA_* env vars always
+	// take precedence over .env values.
+	loadEnvFile(elyra);
+
 	// ── Configuration ──
-	// Connection details come from environment variables.
-	// MySQL: ELYRA_MYSQL_HOST, ELYRA_MYSQL_PORT, ELYRA_MYSQL_USER, ELYRA_MYSQL_PASSWORD, ELYRA_MYSQL_DATABASE
-	// ClickHouse: ELYRA_CLICKHOUSE_HOST, ELYRA_CLICKHOUSE_PORT, ELYRA_CLICKHOUSE_DATABASE,
-	//             ELYRA_CLICKHOUSE_USERNAME, ELYRA_CLICKHOUSE_PASSWORD, ELYRA_CLICKHOUSE_HTTPS,
-	//             ELYRA_CLICKHOUSE_TIMEOUT_CONNECT, ELYRA_CLICKHOUSE_TIMEOUT_QUERY
+	// Connection config is resolved from (in priority order):
+	// 1. ELYRA_MYSQL_* / ELYRA_CLICKHOUSE_* environment variables
+	// 2. Standard names from .env: DB_HOST, DB_PORT, DB_USERNAME, DB_PASSWORD, DB_DATABASE (MySQL)
+	//    CLICKHOUSE_HOST, CLICKHOUSE_PORT, CLICKHOUSE_DATABASE, CLICKHOUSE_USERNAME, etc. (ClickHouse)
 
 	// ── Tool: query_mysql ──
 	elyra.registerTool({
@@ -266,6 +273,69 @@ function isReadOnly(sql: string): boolean {
 	return /^(SELECT|SHOW|DESCRIBE|DESC|EXPLAIN|WITH)\b/.test(trimmed);
 }
 
+// ── .env Loading ──
+
+/** Parse a .env file into key-value pairs (handles quotes and comments) */
+function parseEnvFile(content: string): Record<string, string> {
+	const result: Record<string, string> = {};
+	for (const line of content.split("\n")) {
+		const trimmed = line.trim();
+		if (!trimmed || trimmed.startsWith("#")) continue;
+		const eqIndex = trimmed.indexOf("=");
+		if (eqIndex === -1) continue;
+		const key = trimmed.slice(0, eqIndex).trim();
+		let value = trimmed.slice(eqIndex + 1).trim();
+		// Strip surrounding quotes
+		if ((value.startsWith('"') && value.endsWith('"')) || (value.startsWith("'") && value.endsWith("'"))) {
+			value = value.slice(1, -1);
+		}
+		result[key] = value;
+	}
+	return result;
+}
+
+/**
+ * Mapping from standard .env keys (Laravel, Docker, etc.) to ELYRA_ env vars.
+ * Only sets the ELYRA_ var if it's not already set (explicit env vars win).
+ */
+const ENV_KEY_MAP: Array<[string, string]> = [
+	// MySQL (Laravel DB_* convention)
+	["DB_HOST", "ELYRA_MYSQL_HOST"],
+	["DB_PORT", "ELYRA_MYSQL_PORT"],
+	["DB_DATABASE", "ELYRA_MYSQL_DATABASE"],
+	["DB_USERNAME", "ELYRA_MYSQL_USER"],
+	["DB_PASSWORD", "ELYRA_MYSQL_PASSWORD"],
+	// ClickHouse
+	["CLICKHOUSE_HOST", "ELYRA_CLICKHOUSE_HOST"],
+	["CLICKHOUSE_PORT", "ELYRA_CLICKHOUSE_PORT"],
+	["CLICKHOUSE_DATABASE", "ELYRA_CLICKHOUSE_DATABASE"],
+	["CLICKHOUSE_USERNAME", "ELYRA_CLICKHOUSE_USERNAME"],
+	["CLICKHOUSE_PASSWORD", "ELYRA_CLICKHOUSE_PASSWORD"],
+	["CLICKHOUSE_HTTPS", "ELYRA_CLICKHOUSE_HTTPS"],
+	["CLICKHOUSE_TIMEOUT_CONNECT", "ELYRA_CLICKHOUSE_TIMEOUT_CONNECT"],
+	["CLICKHOUSE_TIMEOUT_QUERY", "ELYRA_CLICKHOUSE_TIMEOUT_QUERY"],
+];
+
+/** Load .env from the project root and map keys to ELYRA_ equivalents */
+function loadEnvFile(elyra: ExtensionAPI): void {
+	try {
+		const cwd = process.cwd();
+		const envPath = join(cwd, ".env");
+		if (!existsSync(envPath)) return;
+
+		const parsed = parseEnvFile(readFileSync(envPath, "utf-8"));
+
+		for (const [sourceKey, targetKey] of ENV_KEY_MAP) {
+			const value = parsed[sourceKey];
+			if (value !== undefined && !process.env[targetKey]) {
+				process.env[targetKey] = value;
+			}
+		}
+	} catch {
+		// Never fail on .env parse errors
+	}
+}
+
 // ── Schema Discovery ──
 
 async function getMysqlSchema(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elyracode/db-tools",
-  "version": "0.3.1",
+  "version": "0.3.2",
     "description": "Database tools for Elyra - query MySQL and ClickHouse with schema awareness and safety guardrails",
   "type": "module",
   "keywords": ["elyra-package", "database", "mysql", "clickhouse", "sql"],