@querypanel/node-sdk 1.3.3 → 1.3.5

package/dist/index.d.cts

@@ -37,7 +37,7 @@ interface IntrospectOptions {
     tables?: string[];
 }
 
-type DatabaseDialect = "bigquery" | "clickhouse" | "postgres" | "mysql";
+type DatabaseDialect = "bigquery" | "clickhouse" | "postgres" | "redshift" | "mysql";
 interface DatabaseExecutionResult {
     fields: string[];
     rows: Array<Record<string, unknown>>;
@@ -192,13 +192,19 @@ interface PostgresQueryResult {
     }>;
 }
 type PostgresClientFn = (sql: string, params?: unknown[]) => Promise<PostgresQueryResult>;
+type PostgresWireDialect = "postgres" | "redshift";
 interface PostgresAdapterOptions {
     /** Logical database name used in introspection metadata. */
     database?: string;
     /** Schema to assume when a table is provided without qualification. */
     defaultSchema?: string;
-    /** Optional database kind label. Defaults to "postgres". */
+    /** Optional database kind label. Defaults to the dialect. */
     kind?: SchemaIntrospection["db"]["kind"];
+    /**
+     * Wire-compatible engine behind the client. "redshift" uses Redshift's
+     * svv_* catalog views for introspection. Defaults to "postgres".
+     */
+    dialect?: PostgresWireDialect;
     /**
      * Optional allow-list of table names (schema-qualified or bare).
      * When specified, introspection and queries are restricted to these tables only.
@@ -215,6 +221,7 @@ declare class PostgresAdapter implements DatabaseAdapter {
     private readonly databaseName;
     private readonly defaultSchema;
     private readonly kind;
+    private readonly dialect;
     private readonly allowedTables?;
     constructor(clientFn: PostgresClientFn, options?: PostgresAdapterOptions);
     execute(sql: string, params?: Record<string, string | number | boolean | string[] | number[]>): Promise<DatabaseExecutionResult>;
@@ -225,7 +232,7 @@ declare class PostgresAdapter implements DatabaseAdapter {
      */
     private convertNamedToPositionalParams;
     validate(sql: string, params?: Record<string, string | number | boolean | string[] | number[]>): Promise<void>;
-    getDialect(): "postgres";
+    getDialect(): PostgresWireDialect;
     /**
      * Simplified introspection: only collect table/column metadata for IngestRequest
      * No indexes, constraints, or statistics
@@ -1255,6 +1262,18 @@ declare class QueryPanelSdkAPI {
         tenantFieldType?: string;
         enforceTenantIsolation?: boolean;
     }): void;
+    /**
+     * Attach an Amazon Redshift database. Redshift speaks the Postgres wire
+     * protocol, so `clientFn` can wrap a `pg` client; introspection uses
+     * Redshift's svv_* catalog views and SQL is generated for Redshift.
+     */
+    attachRedshift(name: string, clientFn: PostgresClientFn, options?: Omit<PostgresAdapterOptions, "dialect"> & {
+        description?: string;
+        tags?: string[];
+        tenantFieldName?: string;
+        tenantFieldType?: string;
+        enforceTenantIsolation?: boolean;
+    }): void;
     attachBigQuery(name: string, clientFn: BigQueryClientFn, options: BigQueryAdapterOptions & {
         description?: string;
         tags?: string[];
@@ -1993,4 +2012,4 @@ declare class QueryPanelSdkAPI {
     }, signal?: AbortSignal): Promise<SdkDashboard[]>;
 }
 
-export { ALL_VIZ_CHART_TYPES, type ActiveChartBulkGetResponse, type ActiveChartCreateInput, type ActiveChartListOptions, type ActiveChartUpdateInput, type AggregateOp, type AskOptions, type AskResponse, type AxisField, type AxisFieldInput, BigQueryAdapter, type BigQueryAdapterOptions, type BigQueryClientFn, type BigQueryQueryRequest, type BigQueryQueryResult, CallbackApiClient, type ChartBulkGetResponse, type ChartCreateInput, type ChartEncoding, type ChartEnvelope, type ChartListAllOptions, type ChartListOptions, type ChartModifyInput, type ChartModifyOptions, type ChartModifyResponse, type ChartSpec, type ChartType, type ChartUpdateInput, ClickHouseAdapter, type ClickHouseAdapterOptions, type ClickHouseClientFn, type ContextDocument, type DashboardCreateInput, type DashboardForkInput, type DashboardForkUpdateInput, type DashboardListOptions, type DashboardUpdateInput, type DatabaseAdapter, type DatabaseDialect, type DateRangeInput, type EncodingHints, type FieldRef, type FieldRefInput, type FieldType, type IQueryPanelApi, type IngestResponse, type IntentResult, type MetricEncoding, type MetricField, type MetricSpec, type PaginatedResponse$1 as PaginatedResponse, type PaginationInfo$1 as PaginationInfo, type PaginationQuery$1 as PaginationQuery, type ParamRecord, type ParamValue, type PipelineTrace, PostgresAdapter, type PostgresAdapterOptions, type PostgresClientFn, QueryErrorCode, QueryErrorCode as QueryErrorCodeType, QueryPanelSdkAPI, type QueryPanelSdkAPIOptions, QueryPipelineError, type RequestHandler, type RequestHandlerOptions, type RequestHandlerResult, type SchemaIntrospection, type SchemaSyncOptions, type SdkActiveChart, type SdkChart, type SdkDashboard, type SdkSession, type SdkSessionTurn, type SessionGetOptions, type SessionListOptions, type SessionUpdateInput, type SqlModifications, type StackingMode, type TableColumn, type TableEncoding, type TableSpec, type TimeUnit, type ValueFormat, type VizModifications, type VizSpec, type VizSpecGenerateInput, type VizSpecGenerateOptions, type VizSpecGeneratorInput, type VizSpecKind, type VizSpecResponse, type VizSpecResult, anonymizeResults, mapGeneratedParams, normalizeSqlParamsInput, resolveQueryPipeline };
+export { ALL_VIZ_CHART_TYPES, type ActiveChartBulkGetResponse, type ActiveChartCreateInput, type ActiveChartListOptions, type ActiveChartUpdateInput, type AggregateOp, type AskOptions, type AskResponse, type AxisField, type AxisFieldInput, BigQueryAdapter, type BigQueryAdapterOptions, type BigQueryClientFn, type BigQueryQueryRequest, type BigQueryQueryResult, CallbackApiClient, type ChartBulkGetResponse, type ChartCreateInput, type ChartEncoding, type ChartEnvelope, type ChartListAllOptions, type ChartListOptions, type ChartModifyInput, type ChartModifyOptions, type ChartModifyResponse, type ChartSpec, type ChartType, type ChartUpdateInput, ClickHouseAdapter, type ClickHouseAdapterOptions, type ClickHouseClientFn, type ContextDocument, type DashboardCreateInput, type DashboardForkInput, type DashboardForkUpdateInput, type DashboardListOptions, type DashboardUpdateInput, type DatabaseAdapter, type DatabaseDialect, type DateRangeInput, type EncodingHints, type FieldRef, type FieldRefInput, type FieldType, type IQueryPanelApi, type IngestResponse, type IntentResult, type MetricEncoding, type MetricField, type MetricSpec, type PaginatedResponse$1 as PaginatedResponse, type PaginationInfo$1 as PaginationInfo, type PaginationQuery$1 as PaginationQuery, type ParamRecord, type ParamValue, type PipelineTrace, PostgresAdapter, type PostgresAdapterOptions, type PostgresClientFn, type PostgresWireDialect, QueryErrorCode, QueryErrorCode as QueryErrorCodeType, QueryPanelSdkAPI, type QueryPanelSdkAPIOptions, QueryPipelineError, type RequestHandler, type RequestHandlerOptions, type RequestHandlerResult, type SchemaIntrospection, type SchemaSyncOptions, type SdkActiveChart, type SdkChart, type SdkDashboard, type SdkSession, type SdkSessionTurn, type SessionGetOptions, type SessionListOptions, type SessionUpdateInput, type SqlModifications, type StackingMode, type TableColumn, type TableEncoding, type TableSpec, type TimeUnit, type ValueFormat, type VizModifications, type VizSpec, type VizSpecGenerateInput, type VizSpecGenerateOptions, type VizSpecGeneratorInput, type VizSpecKind, type VizSpecResponse, type VizSpecResult, anonymizeResults, mapGeneratedParams, normalizeSqlParamsInput, resolveQueryPipeline };

package/dist/index.d.ts

@@ -37,7 +37,7 @@ interface IntrospectOptions {
     tables?: string[];
 }
 
-type DatabaseDialect = "bigquery" | "clickhouse" | "postgres" | "mysql";
+type DatabaseDialect = "bigquery" | "clickhouse" | "postgres" | "redshift" | "mysql";
 interface DatabaseExecutionResult {
     fields: string[];
     rows: Array<Record<string, unknown>>;
@@ -192,13 +192,19 @@ interface PostgresQueryResult {
     }>;
 }
 type PostgresClientFn = (sql: string, params?: unknown[]) => Promise<PostgresQueryResult>;
+type PostgresWireDialect = "postgres" | "redshift";
 interface PostgresAdapterOptions {
     /** Logical database name used in introspection metadata. */
     database?: string;
     /** Schema to assume when a table is provided without qualification. */
     defaultSchema?: string;
-    /** Optional database kind label. Defaults to "postgres". */
+    /** Optional database kind label. Defaults to the dialect. */
     kind?: SchemaIntrospection["db"]["kind"];
+    /**
+     * Wire-compatible engine behind the client. "redshift" uses Redshift's
+     * svv_* catalog views for introspection. Defaults to "postgres".
+     */
+    dialect?: PostgresWireDialect;
     /**
      * Optional allow-list of table names (schema-qualified or bare).
      * When specified, introspection and queries are restricted to these tables only.
@@ -215,6 +221,7 @@ declare class PostgresAdapter implements DatabaseAdapter {
     private readonly databaseName;
     private readonly defaultSchema;
     private readonly kind;
+    private readonly dialect;
     private readonly allowedTables?;
     constructor(clientFn: PostgresClientFn, options?: PostgresAdapterOptions);
     execute(sql: string, params?: Record<string, string | number | boolean | string[] | number[]>): Promise<DatabaseExecutionResult>;
@@ -225,7 +232,7 @@ declare class PostgresAdapter implements DatabaseAdapter {
      */
     private convertNamedToPositionalParams;
     validate(sql: string, params?: Record<string, string | number | boolean | string[] | number[]>): Promise<void>;
-    getDialect(): "postgres";
+    getDialect(): PostgresWireDialect;
     /**
      * Simplified introspection: only collect table/column metadata for IngestRequest
      * No indexes, constraints, or statistics
@@ -1255,6 +1262,18 @@ declare class QueryPanelSdkAPI {
         tenantFieldType?: string;
         enforceTenantIsolation?: boolean;
     }): void;
+    /**
+     * Attach an Amazon Redshift database. Redshift speaks the Postgres wire
+     * protocol, so `clientFn` can wrap a `pg` client; introspection uses
+     * Redshift's svv_* catalog views and SQL is generated for Redshift.
+     */
+    attachRedshift(name: string, clientFn: PostgresClientFn, options?: Omit<PostgresAdapterOptions, "dialect"> & {
+        description?: string;
+        tags?: string[];
+        tenantFieldName?: string;
+        tenantFieldType?: string;
+        enforceTenantIsolation?: boolean;
+    }): void;
     attachBigQuery(name: string, clientFn: BigQueryClientFn, options: BigQueryAdapterOptions & {
         description?: string;
         tags?: string[];
@@ -1993,4 +2012,4 @@ declare class QueryPanelSdkAPI {
     }, signal?: AbortSignal): Promise<SdkDashboard[]>;
 }
 
-export { ALL_VIZ_CHART_TYPES, type ActiveChartBulkGetResponse, type ActiveChartCreateInput, type ActiveChartListOptions, type ActiveChartUpdateInput, type AggregateOp, type AskOptions, type AskResponse, type AxisField, type AxisFieldInput, BigQueryAdapter, type BigQueryAdapterOptions, type BigQueryClientFn, type BigQueryQueryRequest, type BigQueryQueryResult, CallbackApiClient, type ChartBulkGetResponse, type ChartCreateInput, type ChartEncoding, type ChartEnvelope, type ChartListAllOptions, type ChartListOptions, type ChartModifyInput, type ChartModifyOptions, type ChartModifyResponse, type ChartSpec, type ChartType, type ChartUpdateInput, ClickHouseAdapter, type ClickHouseAdapterOptions, type ClickHouseClientFn, type ContextDocument, type DashboardCreateInput, type DashboardForkInput, type DashboardForkUpdateInput, type DashboardListOptions, type DashboardUpdateInput, type DatabaseAdapter, type DatabaseDialect, type DateRangeInput, type EncodingHints, type FieldRef, type FieldRefInput, type FieldType, type IQueryPanelApi, type IngestResponse, type IntentResult, type MetricEncoding, type MetricField, type MetricSpec, type PaginatedResponse$1 as PaginatedResponse, type PaginationInfo$1 as PaginationInfo, type PaginationQuery$1 as PaginationQuery, type ParamRecord, type ParamValue, type PipelineTrace, PostgresAdapter, type PostgresAdapterOptions, type PostgresClientFn, QueryErrorCode, QueryErrorCode as QueryErrorCodeType, QueryPanelSdkAPI, type QueryPanelSdkAPIOptions, QueryPipelineError, type RequestHandler, type RequestHandlerOptions, type RequestHandlerResult, type SchemaIntrospection, type SchemaSyncOptions, type SdkActiveChart, type SdkChart, type SdkDashboard, type SdkSession, type SdkSessionTurn, type SessionGetOptions, type SessionListOptions, type SessionUpdateInput, type SqlModifications, type StackingMode, type TableColumn, type TableEncoding, type TableSpec, type TimeUnit, type ValueFormat, type VizModifications, type VizSpec, type VizSpecGenerateInput, type VizSpecGenerateOptions, type VizSpecGeneratorInput, type VizSpecKind, type VizSpecResponse, type VizSpecResult, anonymizeResults, mapGeneratedParams, normalizeSqlParamsInput, resolveQueryPipeline };
+export { ALL_VIZ_CHART_TYPES, type ActiveChartBulkGetResponse, type ActiveChartCreateInput, type ActiveChartListOptions, type ActiveChartUpdateInput, type AggregateOp, type AskOptions, type AskResponse, type AxisField, type AxisFieldInput, BigQueryAdapter, type BigQueryAdapterOptions, type BigQueryClientFn, type BigQueryQueryRequest, type BigQueryQueryResult, CallbackApiClient, type ChartBulkGetResponse, type ChartCreateInput, type ChartEncoding, type ChartEnvelope, type ChartListAllOptions, type ChartListOptions, type ChartModifyInput, type ChartModifyOptions, type ChartModifyResponse, type ChartSpec, type ChartType, type ChartUpdateInput, ClickHouseAdapter, type ClickHouseAdapterOptions, type ClickHouseClientFn, type ContextDocument, type DashboardCreateInput, type DashboardForkInput, type DashboardForkUpdateInput, type DashboardListOptions, type DashboardUpdateInput, type DatabaseAdapter, type DatabaseDialect, type DateRangeInput, type EncodingHints, type FieldRef, type FieldRefInput, type FieldType, type IQueryPanelApi, type IngestResponse, type IntentResult, type MetricEncoding, type MetricField, type MetricSpec, type PaginatedResponse$1 as PaginatedResponse, type PaginationInfo$1 as PaginationInfo, type PaginationQuery$1 as PaginationQuery, type ParamRecord, type ParamValue, type PipelineTrace, PostgresAdapter, type PostgresAdapterOptions, type PostgresClientFn, type PostgresWireDialect, QueryErrorCode, QueryErrorCode as QueryErrorCodeType, QueryPanelSdkAPI, type QueryPanelSdkAPIOptions, QueryPipelineError, type RequestHandler, type RequestHandlerOptions, type RequestHandlerResult, type SchemaIntrospection, type SchemaSyncOptions, type SdkActiveChart, type SdkChart, type SdkDashboard, type SdkSession, type SdkSessionTurn, type SessionGetOptions, type SessionListOptions, type SessionUpdateInput, type SqlModifications, type StackingMode, type TableColumn, type TableEncoding, type TableSpec, type TimeUnit, type ValueFormat, type VizModifications, type VizSpec, type VizSpecGenerateInput, type VizSpecGenerateOptions, type VizSpecGeneratorInput, type VizSpecKind, type VizSpecResponse, type VizSpecResult, anonymizeResults, mapGeneratedParams, normalizeSqlParamsInput, resolveQueryPipeline };

package/dist/index.js

@@ -501,7 +501,8 @@ var PostgresAdapter = class {
     this.clientFn = clientFn;
     this.databaseName = options.database ?? "postgres";
     this.defaultSchema = options.defaultSchema ?? "public";
-    this.kind = options.kind ?? "postgres";
+    this.dialect = options.dialect ?? "postgres";
+    this.kind = options.kind ?? this.dialect;
     if (options.allowedTables) {
       this.allowedTables = normalizeTableFilter3(
         options.allowedTables,
@@ -513,6 +514,7 @@ var PostgresAdapter = class {
   databaseName;
   defaultSchema;
   kind;
+  dialect;
   allowedTables;
   async execute(sql, params) {
     if (this.allowedTables) {
@@ -592,7 +594,7 @@ var PostgresAdapter = class {
     await this.clientFn(`EXPLAIN ${sql}`, paramArray);
   }
   getDialect() {
-    return "postgres";
+    return this.dialect;
   }
   /**
    * Simplified introspection: only collect table/column metadata for IngestRequest
@@ -601,12 +603,13 @@ var PostgresAdapter = class {
   async introspect(options) {
     const tablesToIntrospect = options?.tables ? normalizeTableFilter3(options.tables, this.defaultSchema) : this.allowedTables;
     const normalizedTables = tablesToIntrospect ?? [];
+    const isRedshift = this.dialect === "redshift";
     const tablesResult = await this.clientFn(
-      buildTablesQuery2(normalizedTables)
+      isRedshift ? buildRedshiftTablesQuery(normalizedTables) : buildTablesQuery2(normalizedTables)
     );
     const tableRows = tablesResult.rows;
     const columnsResult = await this.clientFn(
-      buildColumnsQuery2(normalizedTables)
+      isRedshift ? buildRedshiftColumnsQuery(normalizedTables) : buildColumnsQuery2(normalizedTables)
     );
     const columnRows = columnsResult.rows;
     const tablesByKey = /* @__PURE__ */ new Map();
@@ -720,10 +723,11 @@ function buildColumnsQuery2(tables) {
         AND kcu.column_name = cols.column_name
     ) AS is_primary_key
   FROM information_schema.columns cols
+  LEFT JOIN pg_catalog.pg_namespace n ON n.nspname = cols.table_schema
   LEFT JOIN pg_catalog.pg_class c
     ON c.relname = cols.table_name
+   AND c.relnamespace = n.oid
    AND c.relkind IN ('r', 'v', 'm')
-  LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
   LEFT JOIN pg_catalog.pg_attribute attr
     ON attr.attrelid = c.oid
    AND attr.attname = cols.column_name
@@ -733,6 +737,38 @@ function buildColumnsQuery2(tables) {
     ${filter}
   ORDER BY cols.table_schema, cols.table_name, cols.ordinal_position;`;
 }
+var REDSHIFT_EXCLUDED_SCHEMAS = "('pg_catalog', 'information_schema', 'pg_internal', 'pg_automv')";
+function buildRedshiftTablesQuery(tables) {
+  const filter = buildFilterClause(tables, "table_schema", "table_name");
+  return `SELECT
+    table_name,
+    table_schema AS schema_name,
+    table_type,
+    remarks AS comment
+  FROM svv_tables
+  WHERE table_catalog = current_database()
+    AND table_schema NOT IN ${REDSHIFT_EXCLUDED_SCHEMAS}
+    AND table_schema NOT LIKE 'pg_temp%'
+    ${filter}
+  ORDER BY table_schema, table_name;`;
+}
+function buildRedshiftColumnsQuery(tables) {
+  const filter = buildFilterClause(tables, "table_schema", "table_name");
+  return `SELECT
+    table_name,
+    table_schema,
+    column_name,
+    data_type,
+    NULL AS udt_name,
+    remarks AS description,
+    FALSE AS is_primary_key
+  FROM svv_columns
+  WHERE table_catalog = current_database()
+    AND table_schema NOT IN ${REDSHIFT_EXCLUDED_SCHEMAS}
+    AND table_schema NOT LIKE 'pg_temp%'
+    ${filter}
+  ORDER BY table_schema, table_name, ordinal_position;`;
+}
 function buildFilterClause(tables, schemaExpr, tableExpr) {
   if (!tables.length) return "";
   const clauses = tables.map(({ schema, table }) => {
@@ -2866,7 +2902,7 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
     const adapter = new PostgresAdapter(clientFn, options);
     const metadata = {
       name,
-      dialect: "postgres",
+      dialect: adapter.getDialect(),
       description: options?.description,
       tags: options?.tags,
       tenantFieldName: options?.tenantFieldName,
@@ -2878,6 +2914,14 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
     };
     this.queryEngine.attachDatabase(name, adapter, metadata);
   }
+  /**
+   * Attach an Amazon Redshift database. Redshift speaks the Postgres wire
+   * protocol, so `clientFn` can wrap a `pg` client; introspection uses
+   * Redshift's svv_* catalog views and SQL is generated for Redshift.
+   */
+  attachRedshift(name, clientFn, options) {
+    this.attachPostgres(name, clientFn, { ...options, dialect: "redshift" });
+  }
   attachBigQuery(name, clientFn, options) {
     const adapter = new BigQueryAdapter(clientFn, options);
     const metadata = {