Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryRequestSql

export
interface

QueryRequestSql

Hierarchy

  • QueryRequestSql

Index

Properties

Optional default_row_limit

default_row_limit: undefined | number

Row limit to use. Limits specified in the query text will override this default.

memberof

QueryRequestSql

Optional generate_warnings

generate_warnings: undefined | false | true

Flag to enable warnings. Warnings can help debug query issues but negatively affect performance.

memberof

QueryRequestSql

Optional initial_paginate_response_doc_count

initial_paginate_response_doc_count: undefined | number

Number of documents to return in addition to paginating for this query call. Only relevant if paginate flag is also set.

memberof

QueryRequestSql

Optional is_ingest_transformation_preview

is_ingest_transformation_preview: undefined | false | true

If this query is being used for ingest transformations we add fixes to make it closer to what the rollup would actually do

memberof

QueryRequestSql

Optional paginate

paginate: undefined | false | true

Flag to paginate and store the results of this query for later / sequential retrieval.

memberof

QueryRequestSql

Optional parameters

parameters: Array<QueryParameter>

List of named parameters.

memberof

QueryRequestSql

Optional profiling_enabled

profiling_enabled: undefined | false | true

Flag to generate a performance profile for this query.

memberof

QueryRequestSql

query

query: string

SQL query string.

memberof

QueryRequestSql

Generated using TypeDoc