Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 101 additions & 27 deletions client-sdk-references/javascript-web/javascript-orm/drizzle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,58 +11,132 @@ This package enables using [Drizzle](https://orm.drizzle.team/) with the PowerSy

Set up the PowerSync Database and wrap it with Drizzle.

Currently, you need to create the Drizzle schema manually, and it should match the table definitions of your PowerSync [client-side schema](/installation/client-side-setup/define-your-schema).

```js
import { wrapPowerSyncWithDrizzle } from "@powersync/drizzle-driver";
import { PowerSyncDatabase } from "@powersync/web";
import { relations } from "drizzle-orm";
import { index, integer, sqliteTable, text } from "drizzle-orm/sqlite-core";
import { appSchema } from "./schema";

// Define Drizzle schema
export const lists = sqliteTable("lists", {
id: text("id"),
name: text("name"),
import { wrapPowerSyncWithDrizzle } from '@powersync/drizzle-driver';
import { PowerSyncDatabase } from '@powersync/web';
import { relations } from 'drizzle-orm';
import { index, integer, sqliteTable, text } from 'drizzle-orm/sqlite-core';
import { AppSchema } from './schema';

export const lists = sqliteTable('lists', {
id: text('id'),
name: text('name')
});

export const todos = sqliteTable("todos", {
id: text("id"),
description: text("description"),
list_id: text("list_id"),
created_at: text("created_at"),
export const todos = sqliteTable('todos', {
id: text('id'),
description: text('description'),
list_id: text('list_id'),
created_at: text('created_at')
});

export const listsRelations = relations(lists, ({ one, many }) => ({
todos: many(todos),
todos: many(todos)
}));

export const todosRelations = relations(todos, ({ one, many }) => ({
list: one(lists, {
fields: [todos.list_id],
references: [lists.id],
}),
references: [lists.id]
})
}));

export const drizzleSchema = {
lists,
todos,
listsRelations,
todosRelations,
todosRelations
};

// Existing PowerSync database constructor
// As an alternative to manually defining a PowerSync schema, generate the local PowerSync schema from the Drizzle schema with the `DrizzleAppSchema` constructor:
// import { DrizzleAppSchema } from '@powersync/drizzle-driver';
// export const AppSchema = new DrizzleAppSchema(drizzleSchema);
//
// This is optional, but recommended, since you will only need to maintain one schema on the client-side
// Read on to learn more.

export const powerSyncDb = new PowerSyncDatabase({
database: {
dbFilename: "test.sqlite",
dbFilename: 'test.sqlite'
},
schema: appSchema,
schema: AppSchema
});

// Wrap the database with Drizzle
// Provide the Drizzle schema you created above
// This is the DB you will use in queries
export const db = wrapPowerSyncWithDrizzle(powerSyncDb, {
schema: drizzleSchema,
schema: drizzleSchema
});
```

## Schema Conversion

The `DrizzleAppSchema` constructor simplifies the process of integrating Drizzle with PowerSync. It infers the local [PowerSync schema](/installation/client-side-setup/define-your-schema) from your Drizzle schema definition, providing a unified development experience.

As the PowerSync schema only supports SQLite types (`text`, `integer`, and `real`), the same limitation extends to the Drizzle table definitions.

To use it, define your Drizzle tables and supply the schema to the `DrizzleAppSchema` function:

```js
import { DrizzleAppSchema } from '@powersync/drizzle-driver';
import { sqliteTable, text } from 'drizzle-orm/sqlite-core';

// Define a Drizzle table
const lists = sqliteTable('lists', {
id: text('id').primaryKey().notNull(),
created_at: text('created_at'),
name: text('name').notNull(),
owner_id: text('owner_id')
});

export const drizzleSchema = {
lists
};

// Infer the PowerSync schema from your Drizzle schema
export const AppSchema = new DrizzleAppSchema(drizzleSchema);
```

### Defining PowerSync Options

The PowerSync table definition allows additional options supported by PowerSync's app schema beyond that which are supported by Drizzle.
They can be specified as follows. Note that these options exclude indexes as they can be specified in a Drizzle table.

```js
import { DrizzleAppSchema } from '@powersync/drizzle-driver';
// import { DrizzleAppSchema, type DrizzleTableWithPowerSyncOptions} from '@powersync/drizzle-driver'; for TypeScript

const listsWithOptions = { tableDefinition: logs, options: { localOnly: true } };
// const listsWithOptions: DrizzleTableWithPowerSyncOptions = { tableDefinition: logs, options: { localOnly: true } }; for TypeScript

export const drizzleSchemaWithOptions = {
lists: listsWithOptions
};

export const AppSchema = new DrizzleAppSchema(drizzleSchemaWithOptions);
```

### Converting a Single Table From Drizzle to PowerSync

Drizzle tables can also be converted on a table-by-table basis with `toPowerSyncTable`.

```js
import { toPowerSyncTable } from '@powersync/drizzle-driver';
import { Schema } from '@powersync/web';
import { sqliteTable, text } from 'drizzle-orm/sqlite-core';

// Define a Drizzle table
const lists = sqliteTable('lists', {
id: text('id').primaryKey().notNull(),
created_at: text('created_at'),
name: text('name').notNull(),
owner_id: text('owner_id')
});

const psLists = toPowerSyncTable(lists); // converts the Drizzle table to a PowerSync table
// toPowerSyncTable(lists, { localOnly: true }); - allows for PowerSync table configuration

export const AppSchema = new Schema({
lists: psLists // names the table `lists` in the PowerSync schema
});
```

Expand Down
28 changes: 28 additions & 0 deletions client-sdk-references/javascript-web/javascript-orm/kysely.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,34 @@ Below are examples comparing Kysely and PowerSync syntax for common database ope
```
</CodeGroup>

### Watched Queries

For watched queries with Drizzle it's recommended to use the `watch()` function from the Drizzle integration which takes in a Drizzle query.

<CodeGroup>
```js Kysely
const query = db.selectFrom('users');

db.watch(query, {
onResult(results) {
console.log(results);
},
});

// [{ id: '1', name: 'John' }]
```

```js PowerSync
powerSyncDb.watch("select * from users", [], {
onResult(results) {
console.log(results.rows?._array);
},
});

// [{ id: '1', name: 'John' }]
```
</CodeGroup>

### Transactions

<CodeGroup>
Expand Down
Loading