Skip to main content
Version: Next

PgliteSchemaGenerator

In the default (single-database) setup a PGlite instance maps 1:1 to its dataDir, so there are no separate databases to create or drop and both operations are no-ops. The inherited implementation would otherwise switch dbName and reconnect, rebuilding the instance with the new name as its dataDir — materializing a stray on-disk data directory. Named-database mode (driverOptions.dataDir set) keeps the real CREATE DATABASE lifecycle.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

inheritedclear

  • clear(options): Promise<void>

  • Parameters

    Returns Promise<void>

inheritedcreate

  • create(options): Promise<void>

  • Parameters

    Returns Promise<void>

createDatabase

  • createDatabase(name, options): Promise<void>

  • creates new database and connects to it

    Parameters

    • optionalname: string
    • optionaloptions: { skipOnConnect?: boolean }
      • optionalskipOnConnect: boolean

    Returns Promise<void>

inheritedcreateNamespace

  • createNamespace(name): Promise<void>

  • Parameters

    • name: string

    Returns Promise<void>

inheriteddiffToSQL

  • diffToSQL(schemaDiff, options): string

  • Parameters

    • schemaDiff: SchemaDifference
    • options: { dropTables?: boolean; safe?: boolean; schema?: string; wrap?: boolean }
      • optionaldropTables: boolean
      • optionalsafe: boolean
      • optionalschema: string
      • optionalwrap: boolean

    Returns string

inheriteddrop

  • drop(options): Promise<void>

  • Parameters

    Returns Promise<void>

dropDatabase

  • dropDatabase(name): Promise<void>

  • Parameters

    • optionalname: string

    Returns Promise<void>

inheriteddropNamespace

  • dropNamespace(name): Promise<void>

  • Parameters

    • name: string

    Returns Promise<void>

inheriteddropTableIfExists

  • dropTableIfExists(name, schema): Promise<void>

  • Parameters

    • name: string
    • optionalschema: string

    Returns Promise<void>

inheritedensureDatabase

  • ensureDatabase(options): Promise<boolean>

  • Returns true if the database was created.

    Parameters

    Returns Promise<boolean>

inheritedensureIndexes

  • ensureIndexes(): Promise<void>

  • Returns Promise<void>

inheritedexecute

  • execute(sql, options): Promise<void>

  • Parameters

    • sql: string
    • options: { ctx?: any; wrap?: boolean } = {}
      • optionalctx: any
      • optionalwrap: boolean

    Returns Promise<void>

inheritedgetCreateSchemaSQL

  • getCreateSchemaSQL(options): Promise<string>

  • Parameters

    Returns Promise<string>

inheritedgetDropSchemaSQL

  • getDropSchemaSQL(options): Promise<string>

  • Parameters

    Returns Promise<string>

inheritedgetTargetSchema

  • getTargetSchema(schema, includeWildcardSchema): DatabaseSchema

  • Parameters

    • optionalschema: string
    • includeWildcardSchema: boolean = false

    Returns DatabaseSchema

inheritedgetUpdateSchemaMigrationSQL

  • getUpdateSchemaMigrationSQL(options): Promise<{ down: string; up: string }>

  • Parameters

    Returns Promise<{ down: string; up: string }>

inheritedgetUpdateSchemaSQL

  • getUpdateSchemaSQL(options): Promise<string>

  • Parameters

    Returns Promise<string>

inheritedrefresh

  • refresh(options): Promise<void>

  • Parameters

    Returns Promise<void>

inheritedupdate

  • update(options): Promise<void>

  • Parameters

    Returns Promise<void>

staticregister

  • register(orm): void
Page Options