Skip to contents

Retrieve a table from NTSPortal using Query DSL

getTableByQuery.Rd

Works similarly to `getTableAsRecords()` but reformats the `ntspRecords` into a `tibble`.

Usage 

getTableByQuery(
  tableName,
  searchBlock = list(),
  fields = "*",
  sortField = "no-sort"
)

Arguments

tableName

Name of table in database, wildcards are permitted

searchBlock

list coercible to json for Elasticsearch Search API (Query DSL)

fields

Fields to include in the response, wildcards are permitted, default is all fields.

sortField

field by which to sort the results, length-one character (optionally preceded by '-') or list, see https://elasticsearch-dsl.readthedocs.io/en/stable/api.html#elasticsearch_dsl.Search.sort

Value

A tibble

Details

The records can take a long time to reformat, use the searchBlock and fields arguments to refine the search as much as possible thereby reducing the size of the data. Nested fields are coerced to list columns of tibbles. Array fields are coerced to character columns with elements concatenated with pipe "|"

See also

`getTableAsRecords`

`getTableByEsql`