Skip to content

Open and construct

open(path: 'str | os.PathLike[str]', remote: 'Remote | None' = None, options: 'OpenOptions | None' = None) -> 'Database'

Section titled “open(path: 'str | os.PathLike[str]', remote: 'Remote | None' = None, options: 'OpenOptions | None' = None) -> 'Database'”

Open (creating if absent) one writable local database.

With a remote, the database bootstraps a pristine directory from the authenticated current head and selects automatic bidirectional synchronization unless the options say otherwise; an already based or locally pending database opens without consulting the remote. Omitting options selects the ordinary behavior. A generated client identity is persisted beside a new database; OpenOptions.client_id exists for deterministic deployment tooling and must agree with the durable identity on later opens.

open_revision(path: 'str | os.PathLike[str]', revision: 'str', remote: 'Remote', options: 'OpenOptions | None' = None) -> 'Snapshot'

Section titled “open_revision(path: 'str | os.PathLike[str]', revision: 'str', remote: 'Remote', options: 'OpenOptions | None' = None) -> 'Snapshot'”

Pin exactly one retained revision from remote and return a read-only Snapshot. OpenOptions.connection configures its sole read connection.