Overview

A program opens a Database and reads and writes through it. With a Remote, it also synchronizes. The pages below follow that path.

Choose your language

• Python
• Node
• Go
• Rust
• Swift
• Dart
• Java and Kotlin
• .NET
• C++
• Objective-C

Choose a language for the reference. This browser remembers your choice, and the sidebar opens the pages in that language.

How the pieces fit

Remote

Reusable synchronization state for one remote.

• from_directory()
• from_storage()

open()→

Database

The current writable database.

• query()
• execute()
• transaction()
• connect()
• sync()
• status()
• resolve_conflict()

From Databaseconnect()→

Connection

Independent SQLite connections owned by a database.

• query()
• execute()
• transaction()

From Remoteopen_revision()→

Snapshot

Exact retained read-only revisions.

• query()
• status()

Pages

Reference pages

Page	Summary
Overview	The reference classes, languages, and pages.
Open and construct	Opening databases.
Remote	Reusable synchronization state for one remote.
Storage	Remotes over S3, Google Cloud Storage and Azure, and their parameters.
Database	The current writable database.
Connection	Independent SQLite connections owned by a database.
Snapshot	Exact retained read-only revisions.
Results and types	Python results, status records, options, and values.
Options and policies	Every option object and policy factory.
Advanced	Typed operations outside the ordinary path.
Examples	Complete runnable programs, executed against the published package.