Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace QueryDetails

All the information surrounding a query, including the query statement, limits, consistency, and so forth.

Enumerations

Properties

Functions

Properties

compartmentId

compartmentId: string

Compartment OCID, to provide context for a table name in the given statement.

Optional consistency

consistency: Consistency

Consistency requirement for a read operation.

Optional isPrepared

isPrepared: undefined | false | true

If true, the statement is a prepared statement.

Optional maxReadInKBs

maxReadInKBs: undefined | number

A limit on the total amount of data read during this operation, in KB. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

statement

statement: string

A NoSQL SQL query statement; or a Base64-encoded prepared statement.

Optional timeoutInMs

timeoutInMs: undefined | number

Timeout setting for the query. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional variables

variables: undefined | object

A map of prepared statement variables to values.

Functions

getDeserializedJsonObj

getJsonObj