Version: datastore-0.5.0

Getting Started

Installing Offix DataStore#

Using npm:

npm install offix-datastore

Or yarn:

yarn add offix-datastore

Using DataStore#

Building your own GraphQL type#

Let's use the following sample schema for our app

scalar GraphQLObjectID

"""
  @model
  @datasync
"""
type Task {
    _id: GraphQLObjectID!
    title: String
    description: String
    numberOfDaysLeft: Number
}

Configuring Datastore#

We have a cli tool that generates DataStore config and Model JSON schema given a GraphQL schema.

Datastore Models#

To be able to store user tasks in the DataStore, you need to create it's DataStore model. The DataStore model provides the API to perform CRUD operations on Task in the DataStore. The cli tool generates code to configure each model defined in your graphql schema. Here we will assume that you generated the DataStore config files in src/datastore/generated.

Instantiate the TaskModel with the Task interface and json schema.

src/datastore/config.ts

import { DataStore } from "offix-datastore";
import { schema, Task } from "./generated";

const datastore = new DataStore({
  dbName: "offix-datastore",
  replicationConfig: {
    client: {
      url: "http://localhost:4000/graphql",
      wsUrl: "ws://localhost:4000/graphql",
    }
  }
});

export const TaskModel = datastore.setupModel<Task>(schema.Task);

datastore.init();

info

Once the DataStore has been configured we need to start replication manually.

Schema Upgrades#

The DataStore creates a table on the device for each model. When you push a new version of your app with models added, replaced or removed, the tables for the new models won't be created on the client device and the unused tables(for removed models) won't be deleted.

To make the DataStore acknowledge these changes, you need to increment the schema version.

Using our sample app, suppose we add a SubTask model, we need to increment the schema version to trigger the creation of the "user_SubTask" table on the client device.

The DataStore constructor takes a schema version parameter (defaults to 1).

const dataStore = new DataStore({
  ...,
  schemaVersion: 2
});