Skip to content

Commit 0a56e83

Browse files
committed
Micro edit: docs
1 parent dbb6202 commit 0a56e83

File tree

1 file changed

+10
-17
lines changed

1 file changed

+10
-17
lines changed

site/docs/setup.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ For **PostgreSQL**, **MySQL**, and **MariaDB**, LinkedQL integrates directly wit
66

77
## PostgreSQL
88

9-
Use as a drop-in replacement for [`node-postgres`](https://www.npmjs.com/package/pg). Speaks native **PostgreSQL**.
9+
Use as a drop-in replacement for [`node-postgres`](https://www.npmjs.com/package/pg).
1010

1111
```js
1212
import { PGClient } from '@linked-db/linked-ql/postgres';
@@ -29,11 +29,10 @@ await client.disconnect();
2929

3030
### Client Options
3131

32-
`PGClient` can be configured via a few options, including all options supported by `node-postgres`.
32+
`PGClient` can be configured via a few options, **including all options supported by `node-postgres`**.
3333

3434
| Option | Type | Default | Description |
3535
| :--------- | :-------- | :------ | :----------------------------------------------------------- |
36-
| *(all native options)* ||| Fully compatible with `node-postgres` driver configuration. |
3736
| `poolMode` | `boolean` | `false` | When `true`, uses `pg.Pool`; when `false`, uses `pg.Client`. |
3837

3938
### Realtime Setup
@@ -43,7 +42,7 @@ LinkedQL’s realtime behavior can be tuned via:
4342
| Option | Type | Default | Description |
4443
| :------------------- | :------------------- | :------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4544
| `walSlotName` | `string` | `'linkedql_default_slot'` | Logical replication slot name used for change streaming. |
46-
| `walSlotPersistence` | `0 \| 1 \| 2` | `1` | Slot lifecycle policy:<br>`0` — ephemeral, managed by PostgreSQL;<br>`1`ephemeral, managed by LinkedQL;<br>`2` — persistent, assumes external/admin management. |
45+
| `walSlotPersistence` | `0 \| 1`. | `0` | Slot lifecycle policy:<br>`0` — ephemeral, droped by PostgreSQL at end of session;<br>`1`persistent, dropped/managed by you. |
4746
| `pgPublications` | `string \| string[]` | `'linkedql_default_publication'` | Publication name(s) to subscribe to for changes. |
4847

4948
::: warning Logical Replication Required
@@ -53,7 +52,6 @@ To enable **Live Queries**, ensure PostgreSQL [logical replication](https://www.
5352
## MySQL
5453

5554
Use in place of [`mysql2`](https://www.npmjs.com/package/mysql2).
56-
Speaks native **MySQL**.
5755

5856
```js
5957
import { MySQLClient } from '@linked-db/linked-ql/mysql';
@@ -76,22 +74,19 @@ await client.disconnect();
7674
7775
### Client Options
7876
79-
`MySQLClient` can be configured via a few options, including all options supported by `mysql2`.
77+
`MySQLClient` can be configured via a few options, **including all options supported by `mysql2`**.
8078
8179
| Option | Type | Default | Description |
8280
| :--------- | :-------- | :------ | :------------------------------------------------------------------------------------- |
83-
| *(all native options)* | — | — | Fully compatible with `mysql2` driver configuration. |
8481
| `poolMode` | `boolean` | `false` | When `true`, uses `mysql.createPool()`; when `false`, uses `mysql.createConnection()`. |
8582
8683
### Realtime Setup
8784
88-
_Live Queries for MySQL is **coming soon**.
89-
Current client usage is for standard query execution._
85+
_Live Queries for MySQL **coming soon**._
9086
9187
## MariaDB
9288
93-
Use in place of [`mariadb`](https://www.npmjs.com/package/mariadb`).
94-
Speaks native **MariaDB / MySQL**.
89+
Use in place of [`mariadb`](https://www.npmjs.com/package/mariadb`)/[`mysql2`](https://www.npmjs.com/package/mysql2).
9590
9691
```js
9792
import { MariaDBClient } from '@linked-db/linked-ql/mariadb';
@@ -113,25 +108,23 @@ await client.disconnect();
113108

114109
### Client Options
115110

116-
`MariaDBClient` can be configured via a few options, including all options supported by `mariadb`.
111+
`MariaDBClient` accepts all options supported by `mariadb`.
117112

118113
| Option | Type | Default | Description |
119114
| :--------------------- | :--- | :--------- | :---------------------------------------------------- |
120-
| *(all native options)* ||| Fully compatible with `mariadb` driver configuration. |
115+
| - ||| - |
121116

122117
::: tip Auto Pooling
123118
MariaDBClient always runs on a connection pool.
124119
:::
125120

126121
### Realtime Setup
127122

128-
_Live Queries for MariaDB is **coming soon**.
129-
Current client usage is for standard query execution._
123+
_Live Queries for MariaDB **coming soon**._
130124

131125
## FlashQL
132126

133-
Use as an in-memory alternative to engines like SQLite or PGLite.
134-
Provides an embeddable SQL runtime and supports multiple dialects.
127+
Use as an in place of SQLite, PGLite, and similar. Speaks both MySQL and PostgreSQL.
135128

136129
```js
137130
import { FlashQL } from '@linked-db/linked-ql/flashql';

0 commit comments

Comments
 (0)