Database API: Schema

• Summary

  type Store<Model, Key = ManualKey, Indices = {}>

  Stores schema are defined using the Store type,

• Type Parameters

  • Model — The model of the object store's records.
  • Key — The key source for the model. This can be either a path to a member of the model, AutoIncrement for an auto-incrementing key, or the default ManualKey for a manually specified key.
  • Indices — An interface describing the indices of the object store.

Models

Record models are just any structured clone compatible interface.

Indices

type Indices = { [name: string]: string };

Indices are an interface of index names to key paths of the record. When using an index, the index name is referenced and not the key path. The index key may reference be any value that is compatible with the primary key.

Keys

Primary keys for an object store may be a path to the key within the model, a manually specified key, or an auto-incremented key. The referenced or provided key values must be number, string, Date, binary blobs, and arrays of those types.

Key Paths

Key paths are specified as a string of period, ., separated values; for example name.full.

Manual Keys

• Summary

  // Allows any valid IndexedDB key value.
  type ManualKey = typeof ManualKey;
  // Allows only the specified type of key.
  type ManualKey<K> = typeof ManualKey;
  // Unique symbol to identify a manual key when creating or introspecting the database.
  const ManualKey: unique symbol;

  Manually provided keys are not stored in the record. Using them as the primary key may offer more flexibility when dealing with certain kinds of data. You can also specify the type of the manual key.

Auto Incrementing Keys

• Summary

  // Prevents any key being specified, the database
  type AutoIncrement = typeof AutoIncrement;
  // Unique symbol to identify a auto increment key when creating or introspecting the database.
  const AutoIncrement: unique symbol;

  Auto-incrementing key are stored like manual keys, but are automatically incremented with each new record.