@observablehq/notebook-kit 1.2.0-rc.1 → 1.2.0

package/dist/bin/query.js

@@ -17,7 +17,8 @@ export default async function run(args) {
                 default: "."
             },
             database: {
-                type: "string"
+                type: "string",
+                default: "duckdb"
             },
             help: {
                 type: "boolean",
@@ -28,7 +29,7 @@ export default async function run(args) {
     if (values.help || !values.database) {
         console.log(`usage: notebooks query <...query>
 
-  --database <name>        name of the database
+  --database <name>        name of the database; defaults to duckdb
   --root <dir>             path to the root directory; defaults to cwd
   -h, --help               show this message
 `);

package/dist/package.json

@@ -5,7 +5,7 @@
         "type": "git",
         "url": "git+https://github.com/observablehq/notebook-kit.git"
     },
-    "version": "1.2.0-rc.1",
+    "version": "1.2.0",
     "type": "module",
     "scripts": {
         "test": "vitest",
@@ -63,6 +63,7 @@
         "vite": "^7.0.0"
     },
     "devDependencies": {
+        "@databricks/sql": "^1.11.0",
         "@duckdb/node-api": "^1.3.2-alpha.26",
         "@eslint/js": "^9.29.0",
         "@google-cloud/bigquery": "^8.1.1",
@@ -80,12 +81,16 @@
         "vitest": "^3.2.4"
     },
     "peerDependencies": {
+        "@databricks/sql": "^1.11.0",
         "@duckdb/node-api": "^1.3.2-alpha.26",
         "@google-cloud/bigquery": "^8.1.1",
         "postgres": "^3.4.7",
         "snowflake-sdk": "^2.1.3"
     },
     "peerDependenciesMeta": {
+        "@databricks/sql": {
+            "optional": true
+        },
         "@duckdb/node-api": {
             "optional": true
         },

package/dist/src/databases/bigquery.d.ts

@@ -1,4 +1,11 @@
-import type { BigQueryConfig, QueryTemplateFunction } from "./index.js";
+import type { QueryTemplateFunction } from "./index.js";
+export type BigQueryConfig = {
+    type: "bigquery";
+    apiKey?: string;
+    keyFilename?: string;
+    keyFile?: string;
+    projectId?: string;
+};
 export default function bigquery({ type, ...options }: BigQueryConfig): QueryTemplateFunction;
 export declare function replacer(this: {
     [key: string]: unknown;

package/dist/src/databases/databricks.d.ts

@@ -0,0 +1,14 @@
+import type { QueryTemplateFunction } from "./index.js";
+export type DatabricksConfig = {
+    type: "databricks";
+    host: string;
+    path: string;
+} & ({
+    authType?: "access-token";
+    token: string;
+} | {
+    authType: "databricks-oauth";
+    oauthClientId?: string;
+    oauthClientSecret?: string;
+});
+export default function databricks({ type, ...options }: DatabricksConfig): QueryTemplateFunction;

package/dist/src/databases/databricks.js

@@ -0,0 +1,65 @@
+import { DBSQLClient, DBSQLLogger, LogLevel, thrift } from "@databricks/sql";
+const TTypeId = thrift.TCLIService_types.TTypeId;
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export default function databricks({ type, ...options }) {
+    return async (strings, ...params) => {
+        const logger = new DBSQLLogger({ level: LogLevel.error });
+        const client = new DBSQLClient({ logger });
+        await client.connect(options);
+        try {
+            const session = await client.openSession();
+            try {
+                const date = new Date();
+                const operation = await session.executeStatement(strings.join("?"), {
+                    runAsync: true,
+                    ordinalParameters: params,
+                    maxRows: 10000
+                });
+                try {
+                    const rows = (await operation.fetchAll());
+                    const schema = await operation.getSchema();
+                    return { rows, schema: getTableSchema(schema), duration: Date.now() - +date, date };
+                }
+                finally {
+                    await operation.close();
+                }
+            }
+            finally {
+                await session.close();
+            }
+        }
+        finally {
+            await client.close();
+        }
+    };
+}
+function getTableSchema({ columns }) {
+    return columns.map(getColumnSchema);
+}
+function getColumnSchema(column) {
+    return { name: column.columnName, type: getColumnType(column.typeDesc) };
+}
+function getColumnType({ types: [type] }) {
+    switch (type.primitiveEntry?.type) {
+        case TTypeId.BINARY_TYPE:
+            return "buffer";
+        case TTypeId.BOOLEAN_TYPE:
+            return "boolean";
+        case TTypeId.BIGINT_TYPE:
+        case TTypeId.TINYINT_TYPE:
+        case TTypeId.SMALLINT_TYPE:
+        case TTypeId.INT_TYPE:
+        case TTypeId.DECIMAL_TYPE:
+            return "integer";
+        case TTypeId.DOUBLE_TYPE:
+        case TTypeId.FLOAT_TYPE:
+            return "number";
+        case TTypeId.DATE_TYPE:
+        case TTypeId.TIMESTAMP_TYPE:
+        case TTypeId.INTERVAL_DAY_TIME_TYPE:
+        case TTypeId.INTERVAL_YEAR_MONTH_TYPE:
+            return "date";
+        default:
+            return "string";
+    }
+}

package/dist/src/databases/duckdb.d.ts

@@ -1,2 +1,9 @@
-import type { DuckDBConfig, QueryTemplateFunction } from "./index.js";
+import type { QueryTemplateFunction } from "./index.js";
+export type DuckDBConfig = {
+    type: "duckdb";
+    path?: string;
+    options?: {
+        [key: string]: string;
+    };
+};
 export default function duckdb({ path, options }: DuckDBConfig): QueryTemplateFunction;

package/dist/src/databases/index.d.ts

@@ -1,42 +1,11 @@
 import type { ColumnSchema, QueryParam } from "../runtime/index.js";
-export type DatabaseConfig = BigQueryConfig | DuckDBConfig | SQLiteConfig | SnowflakeConfig | PostgresConfig;
-export type BigQueryConfig = {
-    type: "bigquery";
-    apiKey?: string;
-    keyFilename?: string;
-    keyFile?: string;
-    projectId?: string;
-};
-export type DuckDBConfig = {
-    type: "duckdb";
-    path?: string;
-    options?: {
-        [key: string]: string;
-    };
-};
-export type SQLiteConfig = {
-    type: "sqlite";
-    path?: string;
-};
-export type SnowflakeConfig = {
-    type: "snowflake";
-    account: string;
-    database?: string;
-    role?: string;
-    schema?: string;
-    username?: string;
-    warehouse?: string;
-    password?: string;
-};
-export type PostgresConfig = {
-    type: "postgres";
-    host?: string;
-    port?: string | number;
-    username?: string;
-    password?: string;
-    database?: string;
-    ssl?: boolean;
-};
+import type { BigQueryConfig } from "./bigquery.js";
+import type { DatabricksConfig } from "./databricks.js";
+import type { DuckDBConfig } from "./duckdb.js";
+import type { SQLiteConfig } from "./sqlite.js";
+import type { SnowflakeConfig } from "./snowflake.js";
+import type { PostgresConfig } from "./postgres.js";
+export type DatabaseConfig = BigQueryConfig | DatabricksConfig | DuckDBConfig | SQLiteConfig | SnowflakeConfig | PostgresConfig;
 export type QueryTemplateFunction = (strings: readonly string[], ...params: QueryParam[]) => Promise<SerializableQueryResult>;
 export type SerializableQueryResult = {
     rows: Record<string, unknown>[];

package/dist/src/databases/index.js

@@ -26,7 +26,7 @@ export async function getDatabaseConfig(sourcePath, databaseName) {
         else if (/\.duckdb$/i.test(databaseName))
             config = { type: "duckdb", path: databaseName };
         else if (/\.db$/i.test(databaseName))
-            config = { type: "sqlite", path: databaseName }; // TODO disambiguate
+            config = { type: "sqlite", path: databaseName };
         else
             throw new Error(`database not found: ${databaseName}`);
     }
@@ -36,10 +36,12 @@ export async function getDatabase(config) {
     switch (config.type) {
         case "bigquery":
             return (await import("./bigquery.js")).default(config);
+        case "databricks":
+            return (await import("./databricks.js")).default(config);
         case "duckdb":
             return (await import("./duckdb.js")).default(config);
         case "sqlite":
-            return (await import(process.versions.bun ? "./sqlite-bun.js" : "./sqlite-node.js")).default(config);
+            return (await import(process.versions.bun ? "./sqlite-bun.js" : "./sqlite-node.js")).default(config); // prettier-ignore
         case "snowflake":
             return (await import("./snowflake.js")).default(config);
         case "postgres":

package/dist/src/databases/postgres.d.ts

@@ -1,2 +1,11 @@
-import type { PostgresConfig, QueryTemplateFunction } from "./index.js";
+import type { QueryTemplateFunction } from "./index.js";
+export type PostgresConfig = {
+    type: "postgres";
+    host?: string;
+    port?: string | number;
+    username?: string;
+    password?: string;
+    database?: string;
+    ssl?: boolean;
+};
 export default function postgres(options: PostgresConfig): QueryTemplateFunction;

package/dist/src/databases/snowflake.d.ts

@@ -1,4 +1,14 @@
-import { QueryTemplateFunction, SnowflakeConfig } from "./index.js";
+import { QueryTemplateFunction } from "./index.js";
+export type SnowflakeConfig = {
+    type: "snowflake";
+    account: string;
+    database?: string;
+    role?: string;
+    schema?: string;
+    username?: string;
+    warehouse?: string;
+    password?: string;
+};
 export default function snowflake(options: SnowflakeConfig): QueryTemplateFunction;
 export declare function replacer(this: {
     [key: string]: unknown;

package/dist/src/databases/sqlite-bun.d.ts

@@ -1,2 +1,3 @@
-import type { SQLiteConfig, QueryTemplateFunction } from "./index.js";
+import type { QueryTemplateFunction } from "./index.js";
+import type { SQLiteConfig } from "./sqlite.js";
 export default function sqlite({ path }: SQLiteConfig): QueryTemplateFunction;

package/dist/src/databases/sqlite-node.d.ts

@@ -1,2 +1,3 @@
-import type { SQLiteConfig, QueryTemplateFunction } from "./index.js";
+import type { QueryTemplateFunction } from "./index.js";
+import type { SQLiteConfig } from "./sqlite.js";
 export default function sqlite({ path }: SQLiteConfig): QueryTemplateFunction;

package/dist/src/databases/sqlite.d.ts

@@ -1,2 +1,6 @@
 import type { ColumnSchema } from "../runtime/index.js";
+export type SQLiteConfig = {
+    type: "sqlite";
+    path?: string;
+};
 export declare function getColumnType(type: string | null): ColumnSchema["type"];

package/package.json

@@ -5,7 +5,7 @@
     "type": "git",
     "url": "git+https://github.com/observablehq/notebook-kit.git"
   },
-  "version": "1.2.0-rc.1",
+  "version": "1.2.0",
   "type": "module",
   "scripts": {
     "test": "vitest",
@@ -63,6 +63,7 @@
     "vite": "^7.0.0"
   },
   "devDependencies": {
+    "@databricks/sql": "^1.11.0",
     "@duckdb/node-api": "^1.3.2-alpha.26",
     "@eslint/js": "^9.29.0",
     "@google-cloud/bigquery": "^8.1.1",
@@ -80,12 +81,16 @@
     "vitest": "^3.2.4"
   },
   "peerDependencies": {
+    "@databricks/sql": "^1.11.0",
     "@duckdb/node-api": "^1.3.2-alpha.26",
     "@google-cloud/bigquery": "^8.1.1",
     "postgres": "^3.4.7",
     "snowflake-sdk": "^2.1.3"
   },
   "peerDependenciesMeta": {
+    "@databricks/sql": {
+      "optional": true
+    },
     "@duckdb/node-api": {
       "optional": true
     },