Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
drizzle
✓ import { drizzle } from 'drizzle-orm-databricks'
✗ import { drizzle } from 'drizzle-orm'
The `drizzle` function here is specifically the Databricks adapter; do not import from 'drizzle-orm'.
databricksTable
✓ import { databricksTable } from 'drizzle-orm-databricks'
✗ import { databricksTable } from 'drizzle-orm/databricks'
All core symbols are exported from the root package, not a subpath.
string
✓ import { string } from 'drizzle-orm-databricks'
✗ import { string } from 'drizzle-orm/mysql-core'
Column builders are specific to Databricks; do not mix with MySQL or PostgreSQL column definitions.
DrizzleConfig
✓ import type { DrizzleConfig } from 'drizzle-orm'
✗ import { DrizzleConfig } from 'drizzle-orm-databricks'
DrizzleConfig is a TypeScript type exported only from 'drizzle-orm' for type safety.
Demonstrates basic CRUD operations: table schema definition, query, insert, update, delete, and graceful connection close with Databricks SQL.
import { drizzle, databricksTable, string, bigint, timestamp, boolean } from 'drizzle-orm-databricks';
import { eq } from 'drizzle-orm';
const users = databricksTable('users', {
id: string('id').primaryKey(),
email: string('email').notNull(),
loginCount: bigint('login_count').notNull(),
active: boolean('active').notNull(),
createdAt: timestamp('created_at').notNull(),
});
const db = drizzle({
host: process.env.DATABRICKS_HOST ?? '',
path: process.env.DATABRICKS_SQL_PATH ?? '',
token: process.env.DATABRICKS_TOKEN ?? '',
});
const rows = await db.select().from(users).where(eq(users.active, true));
await db.insert(users).values({
id: crypto.randomUUID(),
email: 'a@b.com',
loginCount: BigInt(0),
active: true,
createdAt: new Date(),
});
await db.update(users).set({ active: false }).where(eq(users.id, 'u1'));
await db.delete(users).where(eq(users.id, 'u1'));
await db.$close();
Errors
Common errors & fixes
Error: Cannot find module 'drizzle-orm-databricks'
Package not installed or not in node_modules.
fixRun `npm install drizzle-orm-databricks drizzle-orm @databricks/sql` (or pnpm/yarn equivalent).
TypeError: drizzle is not a function
Importing `drizzle` from the wrong package (e.g., 'drizzle-orm') instead of 'drizzle-orm-databricks'.
fixUse `import { drizzle } from 'drizzle-orm-databricks'`. Error: The 'bigint' column expects a BigInt value.
Inserting a regular JavaScript number into a bigint column.
fixWrap the number with `BigInt(value)`, e.g., `loginCount: BigInt(0)`.
Error: Spark SQL does not support ON CONFLICT clause.
Using Drizzle's `onConflictDoNothing()` or `onConflictDoUpdate()` which generate SQL with `ON CONFLICT`, not supported in Databricks.
fixAvoid upsert methods; use separate insert and update operations.
Audit
Dependencies
@databricks/sqlrequiredPeer dependency: official Databricks SQL client driver for Node.js.
drizzle-ormrequiredPeer dependency: Drizzle ORM core library (>=0.45.0).