Quickstart

• Install the RxDB library and RxJS (if not installed before)

npm install rxdb rxjs --save

• Create a database with the Dexie.js RxStorage (You can also use any other RxStorage that is based on a different storage engine)

import { createRxDatabase } from 'rxdb';
import { getRxStorageDexie } from 'rxdb/plugins/storage-dexie';

const myDatabase = await createRxDatabase({
  name: 'heroesdb',
  storage: getRxStorageDexie()
});

• Create a schema for a collection

const mySchema = {
    title: 'human schema',
    version: 0,
    primaryKey: 'passportId',
    type: 'object',
    properties: {
        passportId: {
            type: 'string',
            maxLength: 100 // <- the primary key must have set maxLength
        },
        firstName: {
            type: 'string'
        },
        lastName: {
            type: 'string'
        },
        age: {
            description: 'age in years',
            type: 'integer',

            // number fields that are used in an index, must have set minimum, maximum and multipleOf
            minimum: 0,
            maximum: 150,
            multipleOf: 1
        }
    },
    required: ['firstName', 'lastName', 'passportId'],
    indexes: ['age']
}

• Add a collection to the database

const myCollections = await myDatabase.addCollections({
  humans: {
    schema: mySchema
  },
});

• Insert a document

const myDocument = await myDatabase.humans.insert({
    passportId: 'foobar',
    firstName: 'Alice',
    lastName: 'Bobby',
    age: 42
});

• Subscribe to a document value

myDocument.lastName$.subscribe(lastName => {
    console.log('lastName is now ' + lastName);
});

• Query some documents

const foundDocuments = await myDatabase.humans.find({
    selector: {
        age: {
            $gt: 21
        }
    }
}).exec();

• Subscribe to query results

myDatabase.humans.find({
    selector: {
        age: {
            $gt: 21
        }
    }
}).$.subscribe(documents => {
    console.log('query has found ' + documents.length + ' documents');
});

• Update the document

// either via incrementalModify()
await myDocument.incrementalModify(data => {
    data.lastName = 'Carol';
    return data;
});

// or via incrementalPatch()
await myDocument.incrementalPatch({
    lastName: 'Carol'
});

• Remove the document

await myDocument.remove();