Class RocksetStore

constructor

• new RocksetStore(options?: RocksetStoreOptions): RocksetStore

  Parameters

  • options: RocksetStoreOptions = {}

  Returns RocksetStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): RocksetClientLike

  Returns the underlying @rockset/client instance for anything not wrapped here.

  Returns RocksetClientLike

query

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

  Run a SQL query via client.queries.query({ sql: { query, parameters } }) and return the results array from the response.

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • sql: string
  • Optionalparams: unknown[]

  Returns Promise<T[]>

ingest

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

  Ingest docs into target (a workspace.collection path, or just a collection name — defaulting the workspace to commons) via client.documents.addDocuments(workspace, collection, { data }).

  Parameters

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

  Returns Promise<any>