Defining the Schema

Models

interface Employee {
  id: number;
  name: string;
  address?: string | undefined;
  cell?: string | undefined;
  departmentId: string;
}

Store Schema

Basic Store

// Store with a model
type Employees = Store<Employee>;

Defining a Key

// Store with a model and path to a store key in the model.
type Employees = Store<Employee, 'id'>;

Defining Indices

// Store with a model, a key, and indices with paths to indexed value.
type Employees = Store<Employee, 'id', { department: 'departmentId' }>;

Store Keys

From a Model Field

// Store with a model and path to a store key in the model.
type Employees = Store<Employee, 'id'>;

Manually Defined

interface Employee {
  // id: string;
  name: string;
  // ...
}

// Store with a model and manual key.
type Employees = Store<Employee>;

// Also, a store with a model and manual key.
type Employees = Store<Employee, ManualKey>;

// Also, a store with a model and manual key of a specific type.
type Employees = Store<Employee, ManualKey<number>>;

Auto Incrementing

interface Employee {
  // id: string;
  name: string;
  // ...
}

// Store with a model and auto-increment key.
type Employees = Store<Employee, AutoIncrement>;

From a Model Path

// The key can reference values deep in the object, for example:
type Employees = Store<Employee, 'ids.number'>;
type Employees = Store<Employee, 'ids.ssn'>;
type Employees = Store<Employee, 'ids.dln'>;

Store Indices

From a Model Field

// Store with a model, a key, and indices with paths to indexed value.
type Employees = Store<Employee, 'id', { department: 'departmentId' }>;

From a Model Path

// Indices can reference values deep in the object, for example:
type Employees = Store<Employee, 'id', { department: 'departments.mainId' }>;
type Employees = Store<Employee, 'id', { department: 'departments.secondaryId' }>;

Database Schema

type Employees = Store<...>;
type Departments = Store<...>l
interface Employment {
  employees: Employees;
  departments: Departments;
}

Database Factory

const useEmploymentDatabase = defineDatabase<Employment>({
  name: 'employment',
  migrations: [...];
})

What's Next?

• Learn about upgrading the object stores and indices between database version by read about Migrations.

• Learn how to getting and retrieving records by read about Reading and Writing Data

• Learn how to list and delete database by reading Managing Database.