Class SQLite

inTransaction

memory

name

open

readonly

StaticSqliteError

aggregate

• aggregate<T>(
      name: string,
      options: RegistrationOptions & {
          inverse?: (total: T, dropped: T) => T;
          result?: (total: T) => unknown;
          start?: T | (() => T);
          step: (total: T, next: ElementOf<T>) => void | T;
      },
  ): this

  Type Parameters

  • T

  Parameters

  • name: string
  • options: RegistrationOptions & {
        inverse?: (total: T, dropped: T) => T;
        result?: (total: T) => unknown;
        start?: T | (() => T);
        step: (total: T, next: ElementOf<T>) => void | T;
    }

  Returns this

backup

• backup(
      destinationFile: string,
      options?: BackupOptions,
  ): Promise<BackupMetadata>

  Parameters

  • destinationFile: string
  • Optionaloptions: BackupOptions

  Returns Promise<BackupMetadata>

close

• close(): this

  Returns this

defaultSafeIntegers

• defaultSafeIntegers(toggleState?: boolean): this

  Parameters

  • OptionaltoggleState: boolean

  Returns this

exec

• exec(source: string): this

  Parameters

  • source: string

  Returns this

function

• function(name: string, cb: (...params: any[]) => any): this

  Parameters

  • name: string
  • cb: (...params: any[]) => any

  Returns this

• function(
      name: string,
      options: RegistrationOptions,
      cb: (...params: any[]) => any,
  ): this

  Parameters

  • name: string
  • options: RegistrationOptions
  • cb: (...params: any[]) => any

  Returns this

loadExtension

• loadExtension(path: string): this

  Parameters

  • path: string

  Returns this

pragma

• pragma(source: string, options?: PragmaOptions): unknown

  Parameters

  • source: string
  • Optionaloptions: PragmaOptions

  Returns unknown

prepare

• prepare<BindParameters extends {} | unknown[] = unknown[], Result = unknown>(
      source: string,
  ): BindParameters extends unknown[]
      ? Statement<BindParameters<BindParameters>, Result>
      : Statement<[BindParameters], Result>

  Type Parameters

  • BindParameters extends {} | unknown[] = unknown[]
  • Result = unknown

  Parameters

  • source: string

  Returns BindParameters extends unknown[]
      ? Statement<BindParameters<BindParameters>, Result>
      : Statement<[BindParameters], Result>

serialize

• serialize(options?: SerializeOptions): Buffer

  Parameters

  • Optionaloptions: SerializeOptions

  Returns Buffer

table

• table(name: string, options: VirtualTableOptions): this

  Parameters

  • name: string
  • options: VirtualTableOptions

  Returns this

transaction

• transaction<F extends VariableArgFunction>(fn: F): Transaction<F>

  Type Parameters

  • F extends VariableArgFunction

  Parameters

  • fn: F

  Returns Transaction<F>

unsafeMode

• unsafeMode(unsafe?: boolean): this

  Parameters

  • Optionalunsafe: boolean

  Returns this