get_records_json

​

get_records_json

• get_records_json(
  table_name: string,
  column_names?: string[] | null,
  offset?: number,
  limit?: number,
  expression?: string | null,
  orderby_columns?: string[] | null,
  having_clause?: string | null,
  callback?: GPUdbCallback,
  ): Promise<GetRecordsJsonResponse>

  Retrieves records as JSON, via /get/records/json.

  Only table_name is required; every other parameter is optional. Like insert_records_from_json, this endpoint takes its parameters in the query string and is sent with an empty body.

  ​

  Parameters

  • table_name: string

    Table to read from

  • Optionalcolumn_names: string[] | null

    Columns to return; all columns if omitted

  • Optionaloffset: number

    Record offset; negative values are treated as 0

  • Optionallimit: number

    Maximum records; negative values mean END_OF_SET

  • Optionalexpression: string | null

    Optional filter expression

  • Optionalorderby_columns: string[] | null

    Optional ordering columns

  • Optionalhaving_clause: string | null

    Optional HAVING clause

  • Optionalcallback: GPUdbCallback

    Optional callback function

  ​

  Returns Promise<GetRecordsJsonResponse>

  Promise resolving to the matching records

  ​

  Example

  const response = await gpudb.get_records_json(
      'my_table', ['id', 'name'], 0, 100, 'value > 10', ['id'], '');
  response.records;                  // [{ id: 3, name: 'Charlie' }, ...]
  response.total_number_of_records;  // matches ignoring the limit
  

  • Defined in src/GPUdb.ts:16015