Class MaterializeStore

constructor

• new MaterializeStore(options?: MaterializeStoreOptions): MaterializeStore

  Parameters

  • options: MaterializeStoreOptions = {}

  Returns MaterializeStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): PgClientLike

  Returns the underlying pg client for anything not wrapped here.

  Returns PgClientLike

query

• query<T = Record<string, unknown>>(
      sql: string,
      params?: unknown[],
  ): Promise<T[]>

  Execute a SQL statement over the Postgres wire with optional positional params and return the result rows (pg's result.rows).

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • sql: string
  • Optionalparams: unknown[]

  Returns Promise<T[]>

createSource

• createSource(name: string, definition: string): Promise<any[]>

  Create a streaming SOURCE via CREATE SOURCE <name> <definition>, e.g. createSource('kafka_src', "FROM KAFKA CONNECTION ... (TOPIC 'events')"). Returns the driver result rows.

  Parameters

  • name: string
  • definition: string

  Returns Promise<any[]>

createMaterializedView

• createMaterializedView(name: string, selectSql: string): Promise<any[]>

  Create a MATERIALIZED VIEW (kept incrementally up to date) via CREATE MATERIALIZED VIEW <name> AS <selectSql>. Returns the driver result rows.

  Parameters

  • name: string
  • selectSql: string

  Returns Promise<any[]>