@syncular/dialect-neon 0.0.1-98 → 0.0.2-126
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 +31 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# @syncular/dialect-neon
|
|
2
|
+
|
|
3
|
+
Neon serverless Postgres Kysely dialect (HTTP).
|
|
4
|
+
|
|
5
|
+
Useful for stateless serverless/edge environments. Pair with `@syncular/server-dialect-postgres` when running a Syncular server on Postgres.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @syncular/dialect-neon
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import { createNeonDb } from '@syncular/dialect-neon';
|
|
17
|
+
|
|
18
|
+
const db = createNeonDb<MyDb>({ connectionString: process.env.DATABASE_URL! });
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Documentation
|
|
22
|
+
|
|
23
|
+
- Dialect selection: https://syncular.dev/docs/introduction/installation#client-database-dialects
|
|
24
|
+
- Server dialects: https://syncular.dev/docs/server/dialects
|
|
25
|
+
|
|
26
|
+
## Links
|
|
27
|
+
|
|
28
|
+
- GitHub: https://github.com/syncular/syncular
|
|
29
|
+
- Issues: https://github.com/syncular/syncular/issues
|
|
30
|
+
|
|
31
|
+
> Status: Alpha. APIs may change between releases.
|