A document is a single object which is stored in a collection. It can be compared to a single record in a relational database table. You get an RxDocument either as return on inserts, or as result-set of queries.


To insert a document into a collection, you have to call the collection's .insert()-function.

  name: 'foo',
  lastname: 'bar'


To find documents in a collection, you have to call the collection's .find()-function. See RxQuery.

myCollection.find().exec() // <- find all documents
  .then(documents => console.dir(documents));



This will get a single field of the document. If the field is encrypted, it will be automatically decrypted before returning.

var name = myDocument.get('name'); // returns the name


This function returns an observable of the given paths-value. The current value of this path will be emitted each time the document changes.

// get the life-updating value of 'name'
var isName;
  .subscribe(newName => {
    isName = newName;

await myDocument.atomicSet('name', 'foobar2');
console.dir(isName); // isName is now 'foobar2'


All properties of a RxDocument are assigned as getters so you can also directly access values instead of using the get()-function.

  // Identical to myDocument.get('name');
  var name = myDocument.name;
  // Can also get nested values.
  var nestedValue = myDocument.whatever.nestedfield;

  // Also useable with observables:
  myDocument.firstName$.subscribe(newName => console.log('name is: ' + newName));
  // > 'name is: Stefe'
  await myDocument.atomicSet('firstName', 'Steve');
  // > 'name is: Steve'


Updates the document based on the mongo-update-syntax, based on modifyjs.

await myDocument.update({
    $inc: {
        age: 1 // increases age by 1
    $set: {
        fistName: 'foobar' // sets firstName to foobar


Updates a documents data based on a function that transforms the current data and returns the new value.

const changeFunction = (oldData) => {
    oldData.age = oldData.age + 1;
    oldData.name = 'foooobarNew';
    return oldData;
await myDocument.atomicUpdate(changeFunction);
console.log(myDocument.name); // 'foooobarNew'


Works like atomicUpdate but only sets the value for a single attribute.

await myDocument.atomicSet('nested.attribute', 'foobar');
console.log(myDocument.nested.attribute); // 'foobar'

Observe $

Calling this will return an rxjs-Observable which emits all change-Events belonging to this document.

// get all changeEvents
  .subscribe(changeEvent => console.dir(changeEvent));


This removes the document from the collection. Notice that this will not purge the document from the store but set _deleted:true like described in the pouchdb-docs in option 3.



Emits a boolean value, depending on whether the RxDocument is deleted or not.

let lastState = null;
myDocument.deleted$.subscribe(state => lastState = state);

// false

await myDocument.remove();

// true

get deleted

A getter to get the current value of deleted$.

// false

await myDocument.remove();

// true


Returns the document's data as plain json object.

const json = myDocument.toJSON();
/* { passportId: 'h1rg9ugdd30o',
  firstName: 'Carolina',
  lastName: 'Gibson',
  age: 33 ...


Only temporary documents

To change data in your document, use this function. It takes the field-path and the new value as parameter. Note that calling the set-function will not change anything in your storage directly. You have to call .save() after to submit changes.

myDocument.set('firstName', 'foobar');
console.log(myDocument.get('firstName')); // <- is 'foobar'


Only temporary documents

All properties of an RxDocument are assigned as setters to it so you can also directly set values instead of using the set()-function.

myDocument.firstName = 'foobar';
myDocument.whatever.nestedfield = 'foobar2';


Only temporary documents

This will update the document in the storage if it has been changed. Call this after modifying the document (via set() or proxy-set).

myDocument.name = 'foobar';
await myDocument.save(); // submit the changes to the storage

NOTICE: All methods of RxDocument are bound to the instance

When you get a method from a RxDocument, the method is automatically bound to the documents instance. This means you do not have to use things like myMethod.bind(myDocument) like you would do in jsx.


Returns true if the given object is an instance of RxDocument. Returns false if not.

const is = RxDB.isRxDocument(myObj);

If you are new to RxDB, you should continue here

results matching ""

    No results matching ""