Skip to content

Commit b8e1848

Browse files
ChriztiaanChriztiaan
authored
feat: drizzle (#380)
1 parent 41b649e commit b8e1848

File tree

18 files changed

+1202
-8
lines changed

18 files changed

+1202
-8
lines changed

‎.changeset/silly-lions-vanish.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@powersync/drizzle-driver': patch
3+
---
4+
5+
Initial Alpha version.

‎packages/drizzle-driver/CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# @powersync/drizzle-driver

‎packages/drizzle-driver/LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎packages/drizzle-driver/README.md

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# PowerSync Drizzle Driver
2+
3+
This package (`@powersync/drizzle-driver`) brings the benefits of an ORM through our maintained [Drizzle](https://orm.drizzle.team/) driver to PowerSync.
4+
5+
## Alpha Release
6+
7+
The `drizzle-driver` package is currently in an Alpha release.
8+
9+
## Getting Started
10+
11+
Set up the PowerSync Database and wrap it with Drizzle.
12+
13+
```js
14+
import { wrapPowerSyncWithDrizzle } from '@powersync/drizzle-driver';
15+
import { PowerSyncDatabase } from '@powersync/web';
16+
import { relations } from 'drizzle-orm';
17+
import { index, integer, sqliteTable, text } from 'drizzle-orm/sqlite-core';
18+
import { appSchema } from './schema';
19+
20+
import { wrapPowerSyncWithDrizzle } from '@powersync/drizzle-driver';
21+
22+
export const lists = sqliteTable('lists', {
23+
id: text('id'),
24+
name: text('name')
25+
});
26+
27+
export const todos = sqliteTable('todos', {
28+
id: text('id'),
29+
description: text('description'),
30+
list_id: text('list_id'),
31+
created_at: text('created_at')
32+
});
33+
34+
export const listsRelations = relations(lists, ({ one, many }) => ({
35+
todos: many(todos)
36+
}));
37+
38+
export const todosRelations = relations(todos, ({ one, many }) => ({
39+
list: one(lists, {
40+
fields: [todos.list_id],
41+
references: [lists.id]
42+
})
43+
}));
44+
45+
export const drizzleSchema = {
46+
lists,
47+
todos,
48+
listsRelations,
49+
todosRelations
50+
};
51+
52+
export const powerSyncDb = new PowerSyncDatabase({
53+
database: {
54+
dbFilename: 'test.sqlite'
55+
},
56+
schema: appSchema
57+
});
58+
59+
export const db = wrapPowerSyncWithDrizzle(powerSyncDb, {
60+
schema: drizzleSchema
61+
});
62+
```
63+
64+
## Known limitations
65+
66+
- The integration does not currently support nested transations (also known as `savepoints`).
67+
- The Drizzle schema needs to be created manually, and it should match the table definitions of your PowerSync schema.
68+
69+
### Compilable queries
70+
71+
To use Drizzle queries in your hooks and composables, queries need to be converted using `toCompilableQuery`.
72+
73+
```js
74+
import { toCompilableQuery } from '@powersync/drizzle-driver';
75+
76+
const query = db.select().from(lists);
77+
const { data: listRecords, isLoading } = useQuery(toCompilableQuery(query));
78+
```
79+
80+
For more information on how to use Drizzle queries in PowerSync, see [here](https://docs.powersync.com/client-sdk-references/javascript-web/javascript-orm/drizzle#usage-examples).

‎packages/drizzle-driver/package.json

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
{
2+
"name": "@powersync/drizzle-driver",
3+
"version": "0.0.0",
4+
"description": "Drizzle driver for PowerSync",
5+
"main": "lib/src/index.js",
6+
"types": "lib/src/index.d.ts",
7+
"author": "JOURNEYAPPS",
8+
"license": "Apache-2.0",
9+
"files": [
10+
"lib"
11+
],
12+
"repository": "https://github.com/powersync-ja/powersync-js",
13+
"bugs": {
14+
"url": "https://github.com/powersync-ja/powersync-js/issues"
15+
},
16+
"publishConfig": {
17+
"registry": "https://registry.npmjs.org/",
18+
"access": "public"
19+
},
20+
"homepage": "https://docs.powersync.com",
21+
"scripts": {
22+
"build": "tsc --build",
23+
"build:prod": "tsc --build --sourceMap false",
24+
"clean": "rm -rf lib tsconfig.tsbuildinfo",
25+
"watch": "tsc --build -w",
26+
"test": "vitest"
27+
},
28+
"peerDependencies": {
29+
"@powersync/common": "workspace:^1.19.0"
30+
},
31+
"dependencies": {
32+
"drizzle-orm": "0.35.2"
33+
},
34+
"devDependencies": {
35+
"@powersync/web": "workspace:*",
36+
"@journeyapps/wa-sqlite": "^0.4.1",
37+
"@types/node": "^20.17.6",
38+
"@vitest/browser": "^2.1.4",
39+
"ts-loader": "^9.5.1",
40+
"ts-node": "^10.9.2",
41+
"typescript": "^5.6.3",
42+
"vite": "^5.4.10",
43+
"vite-plugin-top-level-await": "^1.4.4",
44+
"vite-plugin-wasm": "^3.3.0",
45+
"vitest": "^2.1.4",
46+
"webdriverio": "^9.2.8"
47+
}
48+
}

‎packages/drizzle-driver/src/index.ts

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
import { wrapPowerSyncWithDrizzle } from './sqlite/db';
2+
import { toCompilableQuery } from './utils/compilableQuery';
3+
4+
export { wrapPowerSyncWithDrizzle, toCompilableQuery };

‎packages/drizzle-driver/src/sqlite/db.ts

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
import { AbstractPowerSyncDatabase, QueryResult } from '@powersync/common';
2+
import { DefaultLogger } from 'drizzle-orm/logger';
3+
import {
4+
createTableRelationsHelpers,
5+
extractTablesRelationalConfig,
6+
ExtractTablesWithRelations,
7+
type RelationalSchemaConfig,
8+
type TablesRelationalConfig
9+
} from 'drizzle-orm/relations';
10+
import { SQLiteTransaction } from 'drizzle-orm/sqlite-core';
11+
import { BaseSQLiteDatabase } from 'drizzle-orm/sqlite-core/db';
12+
import { SQLiteAsyncDialect } from 'drizzle-orm/sqlite-core/dialect';
13+
import type { DrizzleConfig } from 'drizzle-orm/utils';
14+
import { PowerSyncSQLiteSession, PowerSyncSQLiteTransactionConfig } from './sqlite-session';
15+
16+
export interface PowerSyncSQLiteDatabase<TSchema extends Record<string, unknown> = Record<string, never>>
17+
extends BaseSQLiteDatabase<'async', QueryResult, TSchema> {
18+
transaction<T>(
19+
transaction: (
20+
tx: SQLiteTransaction<'async', QueryResult, TSchema, ExtractTablesWithRelations<TSchema>>
21+
) => Promise<T>,
22+
config?: PowerSyncSQLiteTransactionConfig
23+
): Promise<T>;
24+
}
25+
26+
export function wrapPowerSyncWithDrizzle<TSchema extends Record<string, unknown> = Record<string, never>>(
27+
db: AbstractPowerSyncDatabase,
28+
config: DrizzleConfig<TSchema> = {}
29+
): PowerSyncSQLiteDatabase<TSchema> {
30+
const dialect = new SQLiteAsyncDialect();
31+
let logger;
32+
if (config.logger === true) {
33+
logger = new DefaultLogger();
34+
} else if (config.logger !== false) {
35+
logger = config.logger;
36+
}
37+
38+
let schema: RelationalSchemaConfig<TablesRelationalConfig> | undefined;
39+
if (config.schema) {
40+
const tablesConfig = extractTablesRelationalConfig(config.schema, createTableRelationsHelpers);
41+
schema = {
42+
fullSchema: config.schema,
43+
schema: tablesConfig.tables,
44+
tableNamesMap: tablesConfig.tableNamesMap
45+
};
46+
}
47+
48+
const session = new PowerSyncSQLiteSession(db, dialect, schema, {
49+
logger
50+
});
51+
return new BaseSQLiteDatabase('async', dialect, session, schema) as PowerSyncSQLiteDatabase<TSchema>;
52+
}

0 commit comments

Comments
 (0)