@rikishi/watermelondb/Schema/migrations/index.d.ts

Build powerful React Native and React web apps that scale from hundreds to tens of thousands of records and remain fast

declare module '@rikishi/watermelondb/Schema/migrations' {
  import {
    SchemaVersion,
    TableName,
    ColumnMap,
    ColumnSchema,
    TableSchemaSpec,
  } from '@rikishi/watermelondb/Schema'

  export interface SchemaMigrations {
    validated: true
    minVersion: SchemaVersion
    maxVersion: SchemaVersion
    sortedMigrations: Migration[]
  }

  export interface CreateTableMigrationStep {
    type: 'create_table'
    name: TableName<any>
    columns: ColumnMap
  }

  export interface AddColumnsMigrationStep {
    type: 'add_columns'
    table: TableName<any>
    columns: ColumnSchema[]
  }

  export type MigrationStep = CreateTableMigrationStep | AddColumnsMigrationStep

  export interface Migration {
    toVersion: SchemaVersion
    steps: MigrationStep[]
  }

  interface SchemaMigrationsSpec {
    migrations: Migration[]
  }

  export function schemaMigrations(migrationSpec: SchemaMigrationsSpec): SchemaMigrations
  export function createTable(tableSchemaSpec: TableSchemaSpec): CreateTableMigrationStep
  export function addColumns({
    table,
    columns,
  }: {
    table: TableName<any>
    columns: ColumnSchema[]
  }): AddColumnsMigrationStep
}