Skip to content

Document fixed_booleans_in_json compatibility option #645

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
simolus3 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Document fixed_booleans_in_json compatibility option #645

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion sync/advanced/compatibility.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,8 @@
| `timestamps_iso8601` | [Link](#timestamps_iso8601) | 1.15.0 | 2 |
| `versioned_bucket_ids` | [Link](#versioned_bucket_ids) | 1.15.0 | 2 |
| `fixed_json_extract` | [Link](#fixed_json_extract) | 1.15.0 | 2 |
| `custom_postgres_types` | [Link](#custom_postgres_types) | 1.15.3 | 2 |
| `custom_postgres_types` | [Link](#custom_postgres_types) | 1.15.3 | 2 |
| `fixed_booleans_in_json` | [Link](#fixed_booleans_in_json). | 1.27.0 (TODO)| None |
| `unstable_sqlite_expression_engine` | [Link](#unstable_sqlite_expression_engine). | 1.22.0 | None (unstable) |

### `timestamps_iso8601`
Expand Down Expand Up @@ -200,6 +201,18 @@
```
- Multi-ranges sync as an array of ranges.

### `fixed_booleans_in_json`

Most source databases supported by PowerSync have a dedicated type for boolean values.
SQLite does not, and uses `0` and `1` integers by convention. For boolean columns,
PowerSync correctly translates values to integers.

Booleans can also appear in nested structures, e.g. in JSON objects or arrays,

Check warning on line 210 in sync/advanced/compatibility.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

sync/advanced/compatibility.mdx#L210 

Did you really mean 'Booleans'?
or plain Postgres composite types, ranges and arrays. These are synced as JSON which supports
boolean literals, but the service still used to map boolean values embedded in such structures to integers.

Enabling this option makes the service preserve booleans in JSON structures.

Check warning on line 214 in sync/advanced/compatibility.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

sync/advanced/compatibility.mdx#L214 

Did you really mean 'booleans'?

### `unstable_sqlite_expression_engine`

<Danger>
Expand Down
Loading