Merge branch 'feat/drizzle-schema' of github.com:powersync-ja/powersync-js into feat/drizzle-schema

Author: Chriztiaan

packages/drizzle-driver/README.md

@@ -15,7 +15,7 @@ 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';
+import { AppSchema } from './schema';
 
 export const lists = sqliteTable('lists', {
   id: text('id'),
@@ -47,23 +47,33 @@ export const drizzleSchema = {
   todosRelations
 };
 
+// As an alternative to manually defining a PowerSync schema, generate the local PowerSync schema from the Drizzle schema with `toPowerSyncSchema`:
+// import { toPowerSyncSchema } from '@powersync/drizzle-driver';
+// export const AppSchema = toPowerSyncSchema(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'
   },
-  schema: appSchema
+  schema: AppSchema
 });
 
+// This is the DB you will use in queries
 export const db = wrapPowerSyncWithDrizzle(powerSyncDb, {
   schema: drizzleSchema
 });
 ```
 
 ## Schema Conversion
 
-The `toPowerSyncSchema` schema function simplifies the process of integrating Drizzle with PowerSync. Define your Drizzle tables and supply the schema to the `toPowerSyncSchema` function for a unified development experience.
+The `toPowerSyncSchema` function simplifies the process of integrating Drizzle with PowerSync. It infers the local [PowerSync schema](https://docs.powersync.com/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.
 
-As the PowerSync table only supports `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 `toPowerSyncSchema` function:
 
 ```js
 import { toPowerSyncSchema } from '@powersync/drizzle-driver';
@@ -81,6 +91,7 @@ export const drizzleSchema = {
   lists
 };
 
+// Infer the PowerSync schema from your Drizzle schema
 export const AppSchema = toPowerSyncSchema(drizzleSchema);
 ```
 
@@ -103,7 +114,7 @@ export const drizzleSchemaWithOptions = {
 export const AppSchema = toPowerSyncSchema(drizzleSchemaWithOptions);
 ```
 
-### Converting a Single Table From Drizzle to Powersync
+### Converting a Single Table From Drizzle to PowerSync
 
 Drizzle tables can also be converted on a table-by-table basis with `toPowerSyncTable`.
 
@@ -128,11 +139,7 @@ export const AppSchema = new Schema({
 });
 ```
 
-## Known limitations
-
-- The integration does not currently support nested transactions (also known as `savepoints`).
-
-### Compilable queries
+## Compilable queries
 
 To use Drizzle queries in your hooks and composables, queries need to be converted using `toCompilableQuery`.
 
@@ -144,3 +151,7 @@ const { data: listRecords, isLoading } = useQuery(toCompilableQuery(query));
 ```
 
 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).
+
+## Known limitations
+
+- The integration does not currently support nested transactions (also known as `savepoints`).