Package oracle.nosql.driver.ops
Request
and
Result
.
Request
instances are parameter objects that
hold required and optional state for a given request type and
operation. Some parameters are defaulted based on the
NoSQLHandleConfig
and can be overridden in a specific request. Examples of these are timeouts
and Consistency
. Some parameters are required.
For example, most requests require a table name for the target table,
NoSQLHandle.put(oracle.nosql.driver.ops.PutRequest)
requires a value, etc.
Validation of parameter state is not performed until the object is used in a request, so illegal state is not immediately detected.
Result
instances represent return state for
operations that succeed. All result instances contain information about
throughput used by that operation if available, in the form of
getReadUnits and getWriteUnits interfaces on the objects.
When used against an on-premises service resource consumption information is
not available and will be 0.
Request
and
Result
instances are not thread-safe and not
intended to be shared. Request
can be reused
and are not modified when used in operations, but they should not be modified
while in use by the system.
-
Class Summary Class Description DeleteRequest Represents the input to aNoSQLHandle.delete(oracle.nosql.driver.ops.DeleteRequest)
operation.DeleteResult Represents the result of aNoSQLHandle.delete(oracle.nosql.driver.ops.DeleteRequest)
operation.DurableRequest Represents a base class for operations that support aDurability
setting.GetIndexesRequest Represents the argument of aNoSQLHandle.getIndexes(oracle.nosql.driver.ops.GetIndexesRequest)
operation which returns the information of a specific index or all indexes of the specified table, as returned inGetIndexesResult
.GetIndexesResult Represents the result of aNoSQLHandle.getIndexes(oracle.nosql.driver.ops.GetIndexesRequest)
operation.GetIndexesResult.IndexInfo IndexInfo represents the information about a single index including its name and field names.GetRequest Represents the input to aNoSQLHandle.get(oracle.nosql.driver.ops.GetRequest)
operation which returns a single row based on the specified key.GetResult Represents the result of aNoSQLHandle.get(oracle.nosql.driver.ops.GetRequest)
operation.GetTableRequest Represents the argument of aNoSQLHandle.getTable(oracle.nosql.driver.ops.GetTableRequest)
operation which returns static information associated with a table, as returned inTableResult
.ListTablesRequest Represents the argument of aNoSQLHandle.listTables(oracle.nosql.driver.ops.ListTablesRequest)
operation which lists all available tables associated with the identity associated with the handle used for the operation.ListTablesResult Represents the result of aNoSQLHandle.listTables(oracle.nosql.driver.ops.ListTablesRequest)
operation.MultiDeleteRequest Represents the input to aNoSQLHandle.multiDelete(oracle.nosql.driver.ops.MultiDeleteRequest)
operation which can be used to delete a range of values that match the primary key and range provided.MultiDeleteResult Represents the result of aNoSQLHandle.multiDelete(oracle.nosql.driver.ops.MultiDeleteRequest)
operation.PreparedStatement A class encapsulating a prepared query statement.PrepareRequest A request that encapsulates a query prepare call.PrepareResult The result of a prepare operation.PutRequest Represents the input to aNoSQLHandle.put(oracle.nosql.driver.ops.PutRequest)
operation.PutResult Represents the result of aNoSQLHandle.put(oracle.nosql.driver.ops.PutRequest)
operation.QueryIterableResult QueryIterableResult represents anIterable
over all the query results.QueryRequest A request that represents a query.QueryResult QueryResult comprises a list ofMapValue
instances representing the query results.ReadRequest Represents a base class for read operations such asNoSQLHandle.get(oracle.nosql.driver.ops.GetRequest)
.Request A request is an abstract class used as a base for all requests types.Result Result is a base class for result classes for all supported operations.RetryStats A class that maintains stats on retries during a request.SystemRequest On-premises only.SystemResult On-premises only.SystemStatusRequest On-premises only.TableLimits Cloud service only.TableRequest TableRequest is used to create, modify, and drop tables.TableResult TableResult is returned fromNoSQLHandle.getTable(oracle.nosql.driver.ops.GetTableRequest)
andNoSQLHandle.tableRequest(oracle.nosql.driver.ops.TableRequest)
operations.TableUsageRequest Cloud service only.TableUsageResult Cloud service only.TableUsageResult.TableUsage TableUsage represents a single usage record, or slice, that includes information about read and write throughput consumed during that period as well as the current information regarding storage capacity.WriteMultipleRequest Represents the input to aNoSQLHandle.writeMultiple(oracle.nosql.driver.ops.WriteMultipleRequest)
operation.WriteMultipleResult Represents the result of aNoSQLHandle.writeMultiple(oracle.nosql.driver.ops.WriteMultipleRequest)
operation.WriteMultipleResult.OperationResult The Result associated with the execution of an individual operation in the request.WriteRequest Represents a base class for the single row modifying operationsNoSQLHandle.put(oracle.nosql.driver.ops.PutRequest)
andNoSQLHandle.delete(oracle.nosql.driver.ops.DeleteRequest)
.WriteResult A base class for results of single row modifying operations such as put and delete. -
Enum Summary Enum Description PutRequest.Option Specifies a condition for the put operation.SystemResult.State On-premises only.TableLimits.CapacityMode Table limits optionTableResult.State The current state of the table