Class QueryOptions
Represents options for the Query operation.
Namespace: Oracle.NoSQL.SDK
Assembly: Oracle.NoSQL.SDK.dll
Syntax
public class QueryOptions : Object
Remarks
These options are passed to
QueryAsync and
GetQueryAsyncEnumerable
APIs. For properties not specified or null
,
appropriate defaults will be used as indicated below.
Note that for options Timeout, Limit,
MaxReadKB and MaxWriteKB the corresponding
limit is applied to each query request, not to the query as a whole.
This means the limit is applied to each call to
QueryAsync or to each
iteration of the await foreach
loop when iterating over
GetQueryAsyncEnumerable.
Examples
Executing Query operation with provided QueryOptions.var enumerable = client.GetQueryAsyncEnumerable(
"SELECT * FROM myTable",
new QueryOptions
{
Timeout = TimeSpan.FromSeconds(20),
MaxReadKB = 128,
MaxMemoryMB = 512
});
await foreach(var result in enumerable)
{
// .....
}
Constructors
Name | Description |
---|---|
QueryOptions() |
Properties
Name | Description |
---|---|
Compartment | Cloud service only. Gets or sets the compartment id or name for the operation. |
Consistency | Gets or sets Consistency used for the operation. |
ContinuationKey | Gets or sets the continuation key for the Query operation. |
Durability | On-premise only. Gets or sets Durability value to use for the update query operation. |
Limit | Gets or sets the limit on the number of rows returned by this operation. |
MaxMemoryMB | Gets or sets the maximum amount of memory that may be used by the driver executing this query, in MB. |
MaxReadKB | Gets or sets the limit on the total amount of data read by this operation, in KB. |
MaxWriteKB | Gets or sets the limit on the total data written by this operation, in KB. |
Namespace | On-premises only. Gets or sets the optional namespace. |
Timeout | Gets or sets the timeout for the request. |