QueryDetails¶

class oci.nosql.models.QueryDetails(**kwargs)¶

Bases: object

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

Attributes

`CONSISTENCY_ABSOLUTE`	A constant which can be used with the consistency property of a QueryDetails.
`CONSISTENCY_EVENTUAL`	A constant which can be used with the consistency property of a QueryDetails.
`compartment_id`	[Required] Gets the compartment_id of this QueryDetails.
`consistency`	Gets the consistency of this QueryDetails.
`is_prepared`	Gets the is_prepared of this QueryDetails.
`max_read_in_k_bs`	Gets the max_read_in_k_bs of this QueryDetails.
`statement`	[Required] Gets the statement of this QueryDetails.
`timeout_in_ms`	Gets the timeout_in_ms of this QueryDetails.
`variables`	Gets the variables of this QueryDetails.

Methods

__init__(**kwargs) Initializes a new QueryDetails object with values from keyword arguments.

CONSISTENCY_ABSOLUTE = 'ABSOLUTE'¶: A constant which can be used with the consistency property of a QueryDetails. This constant has a value of “ABSOLUTE”

CONSISTENCY_EVENTUAL = 'EVENTUAL'¶: A constant which can be used with the consistency property of a QueryDetails. This constant has a value of “EVENTUAL”

__init__(**kwargs)¶

Initializes a new QueryDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this QueryDetails.
statement (str) – The value to assign to the statement property of this QueryDetails.
is_prepared (bool) – The value to assign to the is_prepared property of this QueryDetails.
consistency (str) – The value to assign to the consistency property of this QueryDetails. Allowed values for this property are: “EVENTUAL”, “ABSOLUTE”
max_read_in_k_bs (int) – The value to assign to the max_read_in_k_bs property of this QueryDetails.
variables (dict(str, object)) – The value to assign to the variables property of this QueryDetails.
timeout_in_ms (int) – The value to assign to the timeout_in_ms property of this QueryDetails.

compartment_id¶

[Required] Gets the compartment_id of this QueryDetails. Compartment OCID, to provide context for a table name in the given statement.

Returns:	The compartment_id of this QueryDetails.
Return type:	str

consistency¶

Gets the consistency of this QueryDetails. Consistency requirement for a read operation.

Allowed values for this property are: “EVENTUAL”, “ABSOLUTE”

Returns:	The consistency of this QueryDetails.
Return type:	str

is_prepared¶

Gets the is_prepared of this QueryDetails. If true, the statement is a prepared statement.

Returns:	The is_prepared of this QueryDetails.
Return type:	bool

max_read_in_k_bs¶

Gets the max_read_in_k_bs of this QueryDetails. A limit on the total amount of data read during this operation, in KB.

Returns:	The max_read_in_k_bs of this QueryDetails.
Return type:	int

statement¶

[Required] Gets the statement of this QueryDetails. A NoSQL SQL query statement; or a Base64-encoded prepared statement.

Returns:	The statement of this QueryDetails.
Return type:	str

timeout_in_ms¶

Gets the timeout_in_ms of this QueryDetails. Timeout setting for the query.

Returns:	The timeout_in_ms of this QueryDetails.
Return type:	int

variables¶

Gets the variables of this QueryDetails. A map of prepared statement variables to values.

Returns:	The variables of this QueryDetails.
Return type:	dict(str, object)