Class StarrocksStore

constructor

• new StarrocksStore(options?: StarrocksStoreOptions): StarrocksStore

  Parameters

  • options: StarrocksStoreOptions = {}

  Returns StarrocksStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): MysqlConnectionLike

  Returns the underlying mysql2 connection for anything not wrapped here.

  Returns MysqlConnectionLike

query

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

  Execute a SQL statement over the MySQL wire with optional positional params and return the result rows (the first element of mysql2's [rows, fields] tuple).

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • sql: string
  • Optionalparams: unknown[]

  Returns Promise<T[]>

ingest

• ingest(table: string, rows: Record<string, unknown>[]): Promise<any>

  Batch-insert rows into table via a single parameterized INSERT INTO table (cols) VALUES (...) over the MySQL wire. Columns are taken from the first row. Returns the driver result (OkPacket).

  For high-throughput bulk loading, use StarRocks Stream Load (HTTP) instead — see the module header.

  Parameters

  • table: string
  • rows: Record<string, unknown>[]

  Returns Promise<any>