@yunfanye/sql-proxy 1.4.3 → 1.5.0

package/README.md

@@ -4,7 +4,7 @@ A lightweight SQL proxy server that accepts SQL queries via HTTP and executes th
 
 ## Features
 
-- **Multi-database support**: Connect to PostgreSQL, MySQL, or Snowflake
+- **Multi-database support**: Connect to PostgreSQL, MySQL, Snowflake, or another sql-proxy instance
 - **HTTP API**: Execute SQL queries via simple HTTP requests
 - **Read-only by default**: Only SELECT queries allowed unless `--allow-write` is specified
 - **Table access control**: Configure disallowed tables to prevent access to sensitive data
@@ -87,11 +87,25 @@ The server reads configuration from `database_config.json` in the current workin
 }
 ```
 
+### SQL Proxy (Chaining)
+
+Connect to another sql-proxy instance for chaining proxies or accessing remote databases through a proxy:
+
+```json
+{
+  "db_engine": "sql-proxy",
+  "disallowed_tables": [],
+  "db_credentials": {
+    "DB_URL": "http://localhost:3001"
+  }
+}
+```
+
 ### Configuration Options
 
 | Field | Type | Required | Description |
 |-------|------|----------|-------------|
-| `db_engine` | string | Yes | Database engine: `postgresql`, `mysql`, or `snowsql` |
+| `db_engine` | string | Yes | Database engine: `postgresql`, `mysql`, `snowsql`, or `sql-proxy` |
 | `disallowed_tables` | string[] | No | List of table names that cannot be queried |
 | `db_credentials` | object | Yes | Database connection credentials |
 
@@ -404,7 +418,7 @@ if (config) {
 ### DatabaseConfig Types
 
 ```typescript
-type DbEngine = 'postgresql' | 'mysql' | 'snowsql';
+type DbEngine = 'postgresql' | 'mysql' | 'snowsql' | 'sql-proxy';
 
 interface StandardCredentials {
   DB_URL: string;
@@ -451,6 +465,15 @@ const snowflakeConfig: DatabaseConfig = {
     SNOWSQL_SCHEMA: 'PUBLIC'
   }
 };
+
+// SQL Proxy (chaining to another sql-proxy instance)
+const sqlProxyConfig: DatabaseConfig = {
+  db_engine: 'sql-proxy',
+  disallowed_tables: [],
+  db_credentials: {
+    DB_URL: 'http://localhost:3001'
+  }
+};
 ```
 
 ### Using Low-Level Connectors
@@ -462,7 +485,8 @@ import {
   createConnector,
   PostgreSQLConnector,
   MySQLConnector,
-  SnowflakeConnector
+  SnowflakeConnector,
+  SqlProxyConnector
 } from '@yunfanye/sql-proxy';
 
 // Using factory function

package/dist/connectors/index.d.ts

@@ -3,4 +3,5 @@ export declare function createConnector(config: DatabaseConfig): DatabaseConnect
 export { PostgreSQLConnector } from './postgresql';
 export { MySQLConnector } from './mysql';
 export { SnowflakeConnector } from './snowflake';
+export { SqlProxyConnector } from './sql-proxy';
 //# sourceMappingURL=index.d.ts.map

package/dist/connectors/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/connectors/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAuD,MAAM,UAAU,CAAC;AAKlH,wBAAgB,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,iBAAiB,CAWzE;AAED,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/connectors/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAuD,MAAM,UAAU,CAAC;AAMlH,wBAAgB,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,iBAAiB,CAazE;AAED,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC"}

package/dist/connectors/index.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SnowflakeConnector = exports.MySQLConnector = exports.PostgreSQLConnector = void 0;
+exports.SqlProxyConnector = exports.SnowflakeConnector = exports.MySQLConnector = exports.PostgreSQLConnector = void 0;
 exports.createConnector = createConnector;
 const postgresql_1 = require("./postgresql");
 const mysql_1 = require("./mysql");
 const snowflake_1 = require("./snowflake");
+const sql_proxy_1 = require("./sql-proxy");
 function createConnector(config) {
     switch (config.db_engine) {
         case 'postgresql':
@@ -13,6 +14,8 @@ function createConnector(config) {
             return new mysql_1.MySQLConnector(config.db_credentials);
         case 'snowsql':
             return new snowflake_1.SnowflakeConnector(config.db_credentials);
+        case 'sql-proxy':
+            return new sql_proxy_1.SqlProxyConnector(config.db_credentials);
         default:
             throw new Error(`Unsupported database engine: ${config.db_engine}`);
     }
@@ -23,4 +26,6 @@ var mysql_2 = require("./mysql");
 Object.defineProperty(exports, "MySQLConnector", { enumerable: true, get: function () { return mysql_2.MySQLConnector; } });
 var snowflake_2 = require("./snowflake");
 Object.defineProperty(exports, "SnowflakeConnector", { enumerable: true, get: function () { return snowflake_2.SnowflakeConnector; } });
+var sql_proxy_2 = require("./sql-proxy");
+Object.defineProperty(exports, "SqlProxyConnector", { enumerable: true, get: function () { return sql_proxy_2.SqlProxyConnector; } });
 //# sourceMappingURL=index.js.map

package/dist/connectors/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/connectors/index.ts"],"names":[],"mappings":";;;AAKA,0CAWC;AAfD,6CAAmD;AACnD,mCAAyC;AACzC,2CAAiD;AAEjD,SAAgB,eAAe,CAAC,MAAsB;IACpD,QAAQ,MAAM,CAAC,SAAS,EAAE,CAAC;QACzB,KAAK,YAAY;YACf,OAAO,IAAI,gCAAmB,CAAC,MAAM,CAAC,cAAqC,CAAC,CAAC;QAC/E,KAAK,OAAO;YACV,OAAO,IAAI,sBAAc,CAAC,MAAM,CAAC,cAAqC,CAAC,CAAC;QAC1E,KAAK,SAAS;YACZ,OAAO,IAAI,8BAAkB,CAAC,MAAM,CAAC,cAAsC,CAAC,CAAC;QAC/E;YACE,MAAM,IAAI,KAAK,CAAC,gCAAgC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;IACxE,CAAC;AACH,CAAC;AAED,2CAAmD;AAA1C,iHAAA,mBAAmB,OAAA;AAC5B,iCAAyC;AAAhC,uGAAA,cAAc,OAAA;AACvB,yCAAiD;AAAxC,+GAAA,kBAAkB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/connectors/index.ts"],"names":[],"mappings":";;;AAMA,0CAaC;AAlBD,6CAAmD;AACnD,mCAAyC;AACzC,2CAAiD;AACjD,2CAAgD;AAEhD,SAAgB,eAAe,CAAC,MAAsB;IACpD,QAAQ,MAAM,CAAC,SAAS,EAAE,CAAC;QACzB,KAAK,YAAY;YACf,OAAO,IAAI,gCAAmB,CAAC,MAAM,CAAC,cAAqC,CAAC,CAAC;QAC/E,KAAK,OAAO;YACV,OAAO,IAAI,sBAAc,CAAC,MAAM,CAAC,cAAqC,CAAC,CAAC;QAC1E,KAAK,SAAS;YACZ,OAAO,IAAI,8BAAkB,CAAC,MAAM,CAAC,cAAsC,CAAC,CAAC;QAC/E,KAAK,WAAW;YACd,OAAO,IAAI,6BAAiB,CAAC,MAAM,CAAC,cAAqC,CAAC,CAAC;QAC7E;YACE,MAAM,IAAI,KAAK,CAAC,gCAAgC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;IACxE,CAAC;AACH,CAAC;AAED,2CAAmD;AAA1C,iHAAA,mBAAmB,OAAA;AAC5B,iCAAyC;AAAhC,uGAAA,cAAc,OAAA;AACvB,yCAAiD;AAAxC,+GAAA,kBAAkB,OAAA;AAC3B,yCAAgD;AAAvC,8GAAA,iBAAiB,OAAA"}

package/dist/connectors/sql-proxy.d.ts

@@ -0,0 +1,11 @@
+import { DatabaseConnector, QueryResult, StandardCredentials } from '../types';
+export declare class SqlProxyConnector implements DatabaseConnector {
+    private baseUrl;
+    private connected;
+    constructor(credentials: StandardCredentials);
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    executeQuery(sql: string): Promise<QueryResult>;
+    listTables(): Promise<string[]>;
+}
+//# sourceMappingURL=sql-proxy.d.ts.map

package/dist/connectors/sql-proxy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sql-proxy.d.ts","sourceRoot":"","sources":["../../src/connectors/sql-proxy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAe/E,qBAAa,iBAAkB,YAAW,iBAAiB;IACzD,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,SAAS,CAAkB;gBAEvB,WAAW,EAAE,mBAAmB;IAKtC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IASxB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAoC/C,UAAU,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;CActC"}

package/dist/connectors/sql-proxy.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SqlProxyConnector = void 0;
+class SqlProxyConnector {
+    constructor(credentials) {
+        this.connected = false;
+        // Remove trailing slash if present
+        this.baseUrl = credentials.DB_URL.replace(/\/$/, '');
+    }
+    async connect() {
+        // Test the connection by hitting the health endpoint
+        const response = await fetch(`${this.baseUrl}/health`);
+        if (!response.ok) {
+            throw new Error(`Failed to connect to sql-proxy at ${this.baseUrl}: ${response.statusText}`);
+        }
+        this.connected = true;
+    }
+    async disconnect() {
+        this.connected = false;
+    }
+    async executeQuery(sql) {
+        if (!this.connected) {
+            return { success: false, error: 'Not connected to sql-proxy' };
+        }
+        try {
+            const response = await fetch(`${this.baseUrl}/query`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                },
+                body: JSON.stringify({ sql }),
+            });
+            const result = await response.json();
+            if (result.success) {
+                return {
+                    success: true,
+                    data: result.data,
+                    rowCount: result.rowCount,
+                };
+            }
+            else {
+                return {
+                    success: false,
+                    error: result.error,
+                };
+            }
+        }
+        catch (error) {
+            return {
+                success: false,
+                error: error.message,
+            };
+        }
+    }
+    async listTables() {
+        if (!this.connected) {
+            throw new Error('Not connected to sql-proxy');
+        }
+        const response = await fetch(`${this.baseUrl}/tables`);
+        const result = await response.json();
+        if (result.success && result.tables) {
+            return result.tables;
+        }
+        else {
+            throw new Error(result.error || 'Failed to list tables');
+        }
+    }
+}
+exports.SqlProxyConnector = SqlProxyConnector;
+//# sourceMappingURL=sql-proxy.js.map

package/dist/connectors/sql-proxy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sql-proxy.js","sourceRoot":"","sources":["../../src/connectors/sql-proxy.ts"],"names":[],"mappings":";;;AAeA,MAAa,iBAAiB;IAI5B,YAAY,WAAgC;QAFpC,cAAS,GAAY,KAAK,CAAC;QAGjC,mCAAmC;QACnC,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,OAAO;QACX,qDAAqD;QACrD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,SAAS,CAAC,CAAC;QACvD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,qCAAqC,IAAI,CAAC,OAAO,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QAC/F,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,UAAU;QACd,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,GAAW;QAC5B,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,4BAA4B,EAAE,CAAC;QACjE,CAAC;QAED,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,QAAQ,EAAE;gBACpD,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,CAAC;aAC9B,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAA2B,CAAC;YAE9D,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,OAAO;oBACL,OAAO,EAAE,IAAI;oBACb,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,QAAQ,EAAE,MAAM,CAAC,QAAQ;iBAC1B,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO;oBACL,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,MAAM,CAAC,KAAK;iBACpB,CAAC;YACJ,CAAC;QACH,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,KAAK,CAAC,OAAO;aACrB,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,UAAU;QACd,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,SAAS,CAAC,CAAC;QACvD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAA4B,CAAC;QAE/D,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YACpC,OAAO,MAAM,CAAC,MAAM,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,IAAI,uBAAuB,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;CACF;AAxED,8CAwEC"}

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-export type DbEngine = 'postgresql' | 'mysql' | 'snowsql';
+export type DbEngine = 'postgresql' | 'mysql' | 'snowsql' | 'sql-proxy';
 export interface SnowflakeCredentials {
     SNOWSQL_ACCOUNT: string;
     SNOWSQL_USER: string;

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,YAAY,GAAG,OAAO,GAAG,SAAS,CAAC;AAE1D,MAAM,WAAW,oBAAoB;IACnC,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,aAAa,GAAG,oBAAoB,GAAG,mBAAmB,CAAC;AAEvE,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,QAAQ,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,cAAc,EAAE,aAAa,CAAC;CAC/B;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAChD,UAAU,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;CACjC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,YAAY,GAAG,OAAO,GAAG,SAAS,GAAG,WAAW,CAAC;AAExE,MAAM,WAAW,oBAAoB;IACnC,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,aAAa,GAAG,oBAAoB,GAAG,mBAAmB,CAAC;AAEvE,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,QAAQ,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,cAAc,EAAE,aAAa,CAAC;CAC/B;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAChD,UAAU,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;CACjC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yunfanye/sql-proxy",
-  "version": "1.4.3",
+  "version": "1.5.0",
   "description": "A SQL proxy server that accepts SQL queries via HTTP and executes them against configured database backends (PostgreSQL, MySQL, Snowflake)",
   "main": "dist/index.js",
   "bin": {