Show / Hide Table of Contents

Class QueryDetails

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

Inheritance
object
QueryDetails
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.NosqlService.Models
Assembly: OCI.DotNetSDK.Nosql.dll
Syntax
public class QueryDetails

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

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

Remarks

Required

Consistency

Declaration
[JsonProperty(PropertyName = "consistency")]
[JsonConverter(typeof(StringEnumConverter))]
public QueryDetails.ConsistencyEnum? Consistency { get; set; }
Property Value
Type Description
QueryDetails.ConsistencyEnum?

Consistency requirement for a read operation.

IsPrepared

Declaration
[JsonProperty(PropertyName = "isPrepared")]
public bool? IsPrepared { get; set; }
Property Value
Type Description
bool?

If true, the statement is a prepared statement.

MaxReadInKBs

Declaration
[JsonProperty(PropertyName = "maxReadInKBs")]
public int? MaxReadInKBs { get; set; }
Property Value
Type Description
int?

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

Statement

Declaration
[Required(ErrorMessage = "Statement is required.")]
[JsonProperty(PropertyName = "statement")]
public string Statement { get; set; }
Property Value
Type Description
string

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

Remarks

Required

TimeoutInMs

Declaration
[JsonProperty(PropertyName = "timeoutInMs")]
public int? TimeoutInMs { get; set; }
Property Value
Type Description
int?

Timeout setting for the query.

Variables

Declaration
[JsonProperty(PropertyName = "variables")]
public Dictionary<string, object> Variables { get; set; }
Property Value
Type Description
Dictionary<string, object>

A map of prepared statement variables to values.

In this article
Back to top