@syncular/dialect-neon 0.0.6-223 → 0.0.6-225
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,9 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
Neon serverless Postgres Kysely dialect (HTTP).
|
|
4
4
|
|
|
5
|
-
Useful for stateless serverless
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
Useful for stateless serverless and edge environments.
|
|
6
|
+
|
|
7
|
+
This package is the Kysely runtime dialect. When you are running a Syncular
|
|
8
|
+
server on Neon-backed Postgres, pair it with `createNeonServerDialect()` from
|
|
9
|
+
`@syncular/server-dialect-postgres` (or `syncular/server-dialect-neon`).
|
|
8
10
|
|
|
9
11
|
## Install
|
|
10
12
|
|
|
@@ -24,6 +26,15 @@ const db = createDatabase<MyDb>({
|
|
|
24
26
|
});
|
|
25
27
|
```
|
|
26
28
|
|
|
29
|
+
### Server pairing
|
|
30
|
+
|
|
31
|
+
```ts
|
|
32
|
+
import { ensureSyncSchema } from '@syncular/server';
|
|
33
|
+
import { createNeonServerDialect } from '@syncular/server-dialect-postgres';
|
|
34
|
+
|
|
35
|
+
await ensureSyncSchema(db, createNeonServerDialect());
|
|
36
|
+
```
|
|
37
|
+
|
|
27
38
|
## Documentation
|
|
28
39
|
|
|
29
40
|
- Dialect selection: https://syncular.dev/docs/introduction/installation#client-database-dialects
|