Struct couchbase_lite::Database

pub struct Database { /* private fields */ }

A connection to a couchbase-lite database.

Implementations

impl Database

pub fn open_named(name: &str, cfg: DatabaseConfig<'_>) -> Result<Self, Error>

pub fn open_with_flags(path: &Path, flags: DatabaseFlags) -> Result<Self, Error>

pub fn transaction(&mut self) -> Result<Transaction<'_>, Error>

Begin a new transaction, the transaction defaults to rolling back when it is dropped. If you want the transaction to commit, you must call Transaction::commit

pub fn document_count(&self) -> u64

Returns the number of (undeleted) documents in the database

pub fn get_existing(&self, doc_id: &str) -> Result<Document, Error>

Return existing document from database

pub fn query(&self, query_json: &str) -> Result<Query<'_>, Error>

Compiles a query from an expression given as JSON. The expression is a predicate that describes which documents should be returned. A separate, optional sort expression describes the ordering of the results.

pub fn n1ql_query(&self, query: &str) -> Result<Query<'_>, Error>

Compiles a query from an expression given as N1QL.

pub fn enumerate_all_docs(
    &self,
    flags: DocEnumeratorFlags
) -> Result<DocEnumerator<'_>, Error>

Creates an enumerator ordered by docID.

pub fn register_observer<F>(&mut self, callback_f: F) -> Result<(), Error> where
    F: FnMut() + Send + 'static, 

Register a database observer, with a callback that will be invoked after the database changes. The callback will be called once, after the first change. After that it won’t be called again until all of the changes have been read by calling Database::observed_changes.

pub fn clear_observers(&mut self)

Remove all database observers

pub fn observed_changes(&mut self) -> ObserverdChangesIter<'_>

Get observed changes for this database

pub fn replicator_state(&self) -> Result<Option<ReplicatorState>, Error>

pub fn init_socket_impl(handle: Handle)

Intialize socket implementation for replication (builtin couchbase-lite websocket library)

pub fn start_replicator<StatusF, DocsReplF, ValidationF>(
    &mut self,
    url: &str,
    auth: ReplicatorAuthentication,
    reset: bool,
    validation_cb: ValidationF,
    repl_status_changed: StatusF,
    repl_docs_ended: DocsReplF
) -> Result<(), Error> where
    ValidationF: FnMut(&str, &str, &str, C4RevisionFlags, FLDict) -> bool + Send + 'static,
    StatusF: FnMut(ReplicatorState) + Send + 'static,
    DocsReplF: FnMut(bool, &mut dyn Iterator<Item = &C4DocumentEnded>) + Send + 'static, 

starts database replication

• reset - If true, the replicator will reset its checkpoint and start replication from the beginning.
• validation_cb - Callback that can reject incoming revisions. Arguments: collection_name, doc_id, rev_id, rev_flags, doc_body. It should return false to reject document.
• repl_status_changed - Callback to be invoked when replicator’s status changes.
• repl_docs_ended - Callback notifying status of individual documents.

pub fn restart_replicator(&mut self) -> Result<(), Error>

restart database replicator, gives error if Database::start_replicator haven’t called yet

pub fn restart_replicator_with_new_auth(
    &mut self,
    auth: ReplicatorAuthentication,
    reset: bool
) -> Result<(), Error>

restart database replicator with new auth information, gives error if Database::start_replicator haven’t called yet

• reset - If true, the replicator will reset its checkpoint and start replication from the beginning.

pub fn stop_replicator(&mut self)

stop database replication

pub fn shared_encoder_session(&mut self) -> Result<FlEncoderSession, Error>

Get shared “fleece” encoder, &mut self to make possible exists only one session

pub fn get_indexes(
    &self
) -> Result<impl FallibleStreamingIterator<Item = IndexInfo, Error = Error>, Error>

Returns the names of all indexes in the database

pub fn create_index(
    &mut self,
    index_name: &str,
    expression_json: &str,
    index_type: IndexType,
    index_options: Option<IndexOptions<'_>>
) -> Result<(), Error>

Creates a database index, of the values of specific expressions across all documents. The name is used to identify the index for later updating or deletion; if an index with the same name already exists, it will be replaced unless it has the exact same expressions. Note: If some documents are missing the values to be indexed, those documents will just be omitted from the index. It’s not an error.

pub fn name(&self) -> Result<&str, Error>

Returns the name of the database, as given to c4db_openNamed. This is the filename without the “.cblite2” extension.

Trait Implementations

impl Drop for Database

fn drop(&mut self)

Executes the destructor for this type.