Module document 

Procedures to create and manipulate documents.

Structs

RefContent

A document ref along with its content.

RefQueryParams

Parameters for filtering a search of refs

RefStub

A subset of user relevant information about a ref. Used for showing users information on a variety of refs without having to load whole refs.

Functions

autosave

Saves the document by overwriting the snapshot at the current head.

create_snapshot

Saves the document by replacing the head with a new snapshot.

delete_ref

Soft-deletes a document reference by setting deleted_at.

get_doc_id

get_ref_children_stubs

Gets ref stubs for children, where a child is defined as any document which has an top level object containing the field _id = parent.id.

head_snapshot

Gets the content of the head snapshot for a document ref.

head_snapshot_binary

Gets the binary automerge data for a document ref.

new_ref

Creates a new document ref with initial content.

ref_deleted_at

Gets the deleted_at timestamp for a document ref.

restore_ref

Restores a soft-deleted document reference.

search_ref_stubs

Searches for RefStubs that the current user has permission to access, returning lightweight metadata about each matching ref