Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryResponse

export
interface

QueryResponse

Hierarchy

  • QueryResponse

Index

Properties

Optional aliases

aliases: Array<QueryResponseAlias>

list of aliases specified and referenced collections in query

memberof

QueryResponse

Optional collections

collections: Array<string>

list of collections queried by the query

memberof

QueryResponse

Optional column_fields

column_fields: Array<QueryFieldType>

meta information about each column in the result set

memberof

QueryResponse

Optional query_errors

query_errors: Array<QueryError>

errors encountered while streaming the query

memberof

QueryResponse

Optional query_id

query_id: undefined | string

unique id for this query

memberof

QueryResponse

Optional results

results: Array<any>

list of objects returned by the query

memberof

QueryResponse

Optional stats

meta information about the query

memberof

QueryResponse

Optional warnings

warnings: Array<string>

warnings received from the query

memberof

QueryResponse

Generated using TypeDoc