Class PinotStore

constructor

• new PinotStore(options?: PinotStoreOptions): PinotStore

  Parameters

  • options: PinotStoreOptions = {}

  Returns PinotStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): PinotHttpClient

  Returns the underlying (internal or injected) HTTP client.

  Returns PinotHttpClient

query

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

  Run a Pinot SQL query via POST /query/sql and return the rows as an array of objects keyed by the result column names. For the raw columnar envelope (schema + positional rows), use queryTable().

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • sql: string

  Returns Promise<T[]>

queryTable

• queryTable(sql: string): Promise<PinotResultTable>

  Run a Pinot SQL query and return the raw resultTable envelope (dataSchema + positional rows), exactly as the broker returns it.

  Parameters

  • sql: string

  Returns Promise<PinotResultTable>