stratadb / SchemaDefinition

Type Alias: SchemaDefinition<T>

type SchemaDefinition<T> = object;

Defined in: src/schema-types.ts:281

Complete schema definition for a document collection.

Remarks

The SchemaDefinition type brings together all schema configuration elements to create a complete, type-safe collection definition. It combines field definitions, compound indexes, timestamp configuration, and optional validation logic.

This type serves as the foundation for collection creation and ensures that all database operations maintain schema consistency and type safety throughout the library.

Example

type User = Document<{
  name: string;
  email: string;
  age: number;
  profile: {
    bio: string;
    settings: {
      theme: 'light' | 'dark';
    };
  };
  createdAt: Date;
  updatedAt: Date;
}>;

const userSchema: SchemaDefinition<User> = {
  // Field definitions for indexing and constraints
  fields: [
    { name: 'name', type: 'TEXT', indexed: true },
    { name: 'email', type: 'TEXT', indexed: true, unique: true, nullable: false },
    { name: 'age', type: 'INTEGER', indexed: true },
    { name: 'profile.bio', type: 'TEXT', indexed: true },
    { name: 'profile.settings.theme', type: 'TEXT', indexed: true }
  ],

  // Compound indexes for multi-field queries
  compoundIndexes: [
    { name: 'name_age', fields: ['name', 'age'] },
    { name: 'email_status', fields: ['email', 'status'], unique: true }
  ],

  // Automatic timestamp management
  timestamps: {
    createdAt: true,
    updatedAt: true
  },

  // Optional validation using Standard Schema
  validate: (doc: unknown): doc is User => {
    return typeof doc === 'object' && doc !== null &&
           'name' in doc && typeof doc.name === 'string' &&
           'email' in doc && typeof doc.email === 'string';
  }
};

// Usage with collection
const users = db.collection('users', userSchema);

Type Parameters

T

T

The document type this schema defines

Properties

compoundIndexes?

readonly optional compoundIndexes: readonly CompoundIndex<T>[];

Defined in: src/schema-types.ts:286

Array of compound index definitions for multi-field queries

---

fields

readonly fields: readonly SchemaField<T, keyof T>[];

Defined in: src/schema-types.ts:283

Array of field definitions for indexing and constraints

---

timestamps?

readonly optional timestamps: TimestampConfig;

Defined in: src/schema-types.ts:289

Configuration for automatic timestamp management

---

validate()?

readonly optional validate: (doc) => doc is T;

Defined in: src/schema-types.ts:292

Optional validation function using Standard Schema type predicate signature

Parameters

doc

unknown

Returns

doc is T