Interface: ReactiveDb

Gives the current state of the web-socket between the client and the ReactiveDb service of the Webcom back end.

Gives the current time of the Webcom back end. If a web-socket is established with the ReactiveDb service, the given time takes into account the possible time offset between the client and the server.

Gets a reference to a collection.

Opens a web-socket to the ReactiveDb service of the Webcom back end. If already opened, this method just returns an already completed Promise.

Returns the count of documents that are matched by a given query. This request requires connectivity to the Webcom back end (it never counts the documents within the local cache) and is aimed at evaluating the actual bandwidth required to download a series of documents from the back end before performing such a download (e.g. using the ReactiveDb#findMany method).

Generates a unique identifier across all possible clients. Such a unique key is intended to be used as a Document identifier.

Deletes a series of documents that are matched by a given query.

Deletes an existing document from a collection.

If the document to delete doesn't exist, then the method fails.

Closes the web-socket to the ReactiveDb service of the Webcom back end. If already closed, this method does nothing.

Retrieves a series of documents that are matched by a given query, either from the local cache if no connectivity to the Webcom back end is available, or from the Webcom back end otherwise.

Retrieves a series of documents from the local cache, without requesting the Webcom back end.

Retrieves a series of documents that are matched by a given query from the Webcom back end. If no connectivity is available, the returned Promise is rejected.

Retrieves a given document, either from the local cache if no connectivity to the Webcom back end is available, or from the Webcom back end otherwise.

Retrieves a given document from the local cache, without requesting the Webcom back end.

Retrieves a given document from the Webcom back end. If no connectivity is available, the returned Promise is rejected.

Inserts a new document in a collection. If no connectivity to the Webcom back end is available, the request is cached and will be actually sent to the back end as soon as a connection is established.

If the document to insert already exists, then the request fails.

Inserts a new document in a given collection. The difference with the insertOne method is that the document identifier is automatically generated and is unique across all clients.

If no connectivity to the Webcom back end is available, the request is cached and will be actually sent to the back end as soon as a connection is established.

Overwrites an existing document in a collection. If no connectivity to the Webcom back end is available, the request is cached and will be actually sent to the back end as soon as a connection is established.

If the document to overwrite doesn't already exist, then the request fails.

Overwrites a given document, and insert it if it doesn't exist yet in the database. If no connectivity to the Webcom back end is available, the request is cached and will be actually sent to the back end as soon as a connection is established.

Updates a series of documents that are matched by a given query with a given diff.

Updates an existing document with a given diff.

If the document to update doesn't exist, this method fails.

Watches a set of documents that satisfy a given query. All changes to this set will be notified realtime to the returned Watcher.

Watches a given document in a collection. All changes to this document (including its creation, its modification or its removal) will be notified realtime to the returned ReactiveDb.Watcher.

Constants and static methods associated to the ReactiveDb service.

Such an object is available through the Webcom.ReactiveDb property.

Represents the connection state of the web-socket between the client and the ReactiveDb service of the Webcom back end. It is mainly returned by the ReactiveDb#connectionState property.

Represents the content (or "user data") of a document to write (typically passed to the ReactiveDb#insertOne method).

It can be either:

• any object implementing the ReactiveDb.Serializable interface, in this case the content is the value returned by the serialize method,
• any JSON value (including objects, arrays, primitives and null),
• an enhanced JSON value, that is an array whose elements are recursively ReactiveDb.DocumentData values or a JSON object whose mapped values are recursively ReactiveDb.DocumentData values.

Example: Serializable object

{
    serialize() {
        return {key: "value"};
    }
}

Example: Basic JSON value

{
    key:"value"
}

Example: Enhanced JSON

{
    key: { serialize() { return "value"; } }
}

Formal definition of a JSON value.
It is mainly used as return type of functions that read some content from a document (for example ReactiveDb.Document#getDataAt).

Represents an update descriptor (passed to the ReactiveDb#updateOne and ReactiveDb#updateMany methods).

It basically consists in a JSON object, in which:

• each key represents a segment of a document field to update (it may use the dotted notation to give a path, that is a series of segments),
• each key describes the update to apply on the segment. It can be either:
  • recursively an Update descriptor (typically to reach deeper document fields),
  • an ReactiveDb.UpdateOperator that specifies the update operation to apply on the segment,
  • a simple JSON value (basically a number, a string, a boolean or an array), in this case it is equivalent to the ReactiveDb.UpdateOperator.set operator with this value.