Class ClientBackend

constructor

• new ClientBackend(
      ctx: IntegrationCheckContext,
      Platform: DatabasePlatform,
      prefix: string,
  ): ClientBackend

  Parameters

  • ctx: IntegrationCheckContext
  • Platform: DatabasePlatform
  • prefix: string

  Returns ClientBackend

ReadonlyLabel

OracleCategoryID

ReadonlyPlatform

CountQueries

• CountQueries(categoryID: string, name: string): Promise<number>

  How many queries named name the category holds.

  Parameters

  • categoryID: string
  • name: string

  Returns Promise<number>

Describe

• Describe(sql: string): Promise<DescribedColumn[]>

  Parameters

  • sql: string

  Returns Promise<DescribedColumn[]>

ReadRows

• ReadRows(queryID: string): Promise<StoredQueryRows>

  Parameters

  • queryID: string

  Returns Promise<StoredQueryRows>

RefreshQueries

• RefreshQueries(): Promise<void>

  Makes saved queries visible to composition and run-by-name lookups.

  Returns Promise<void>

Rows

• Rows(sql: string): Promise<Record<string, unknown>[]>

  Parameters

  • sql: string

  Returns Promise<Record<string, unknown>[]>

SaveQuery

• SaveQuery(
      categoryID: string,
      spec: SaveSpec,
  ): Promise<{ Message: string; Record: SavedRecord | null }>

  Saves a query (extraction on); Record null when the save was refused, with its message.

  Parameters

  • categoryID: string
  • spec: SaveSpec

  Returns Promise<{ Message: string; Record: SavedRecord | null }>