DID DataStore¶

DID DataStore is a runtime library that allows any application to store and retrieve data from a Ceramic account's personal datastore, with support for public and private data. The DID DataStore API is based on data models; when multiple applications reuse the same data model, they reuse the same underlying data. As such, DID DataStore is core to how Ceramic delivers user-centric data composability across applications.

How it works¶

The DID DataStore is an implementation of the Identity Index (IDX) protocol, allowing to associate records to a DID. To learn more about the IDX protocol, see its reference documentation.

Getting started with DID DataStore¶

Visit the DID DataStore reference → documentation for full instructions on how to install, configure, and use the module in your application. For convenience, here's a look at what's possible with DID DataStore:

Installation¶

npm install @glazed/did-datastore

Usage¶

The DID DataStore requires a Ceramic instance and either a DataModel instance or PublishedModel object provided by the Glaze DataModel library:

import { DataModel } from '@glazed/datamodel'
import { DIDDataStore } from '@glazed/did-datastore'

const aliases = {
  schemas: {
    MySchema: 'ceramic://mySchemaURL',
  },
  definitions: {
    myDefinition: 'myDefinitionID',
  },
  tiles: {},
}

const model = new DataModel({ ceramic, aliases })
const dataStore = new DIDDataStore({ ceramic, model })

import { DIDDataStore } from '@glazed/did-datastore'

const aliases = {
  schemas: {
    MySchema: 'ceramic://mySchemaURL',
  },
  definitions: {
    myDefinition: 'myDefinitionID',
  },
  tiles: {},
}

const dataStore = new DIDDataStore({ ceramic, model: aliases })

Read/Write Data¶

It is then possible to read and write with data in the user's DataStore:

await dataStore.set('myDefinition', { record: 'content' })

await dataStore.get('myDefinition') // { record: 'content' }