Class DruidStore

constructor

• new DruidStore(options?: DruidStoreOptions): DruidStore

  Parameters

  • options: DruidStoreOptions = {}

  Returns DruidStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): DruidHttpClient

  Returns the underlying (internal or injected) HTTP client.

  Returns DruidHttpClient

query

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

  Run a Druid SQL query via POST /druid/v2/sql. Optional positional params are sent as Druid SQL parameters ({ value } objects). Druid returns an array of row objects, which is returned as-is.

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • sql: string
  • Optionalparams: unknown[]

  Returns Promise<T[]>

nativeQuery

• nativeQuery<T = unknown>(spec: Record<string, unknown>): Promise<T>

  Run a native (JSON) Druid query via POST /druid/v2. Returns the parsed response body (shape depends on the native query type).

  Type Parameters

  • T = unknown

  Parameters

  • spec: Record<string, unknown>

  Returns Promise<T>

ingest

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

  Ingest rows into datasource target by submitting an inline index_parallel task to POST /druid/indexer/v1/task. Returns the task submission response (typically { task: '<id>' }).

  Parameters

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

  Returns Promise<any>

submitTask

• submitTask(spec: Record<string, unknown>): Promise<any>

  Submit an arbitrary task spec to POST /druid/indexer/v1/task.

  Parameters

  • spec: Record<string, unknown>

  Returns Promise<any>