C API  19.3.0
Oracle NoSQL Database C Client
Write options

Modules

 Row
 
 Array
 
 Map
 
 Record
 

Functions

kv_error_t kv_create_write_options (kv_durability_t durability, kv_long_t timeout_ms, kv_write_options_t **optionsp)
 Creates and initializes a write options structure to be used for write operations. More...
 
void kv_release_write_options (kv_write_options_t **optionsp)
 Releases the resources use by the write options structure. More...
 

Detailed Description

Write options is passed to store operations that can update the store to specify non-default behavior relating to operation durability and timeouts.

Function Documentation

kv_error_t kv_create_write_options ( kv_durability_t  durability,
kv_long_t  timeout_ms,
kv_write_options_t **  optionsp 
)

Creates and initializes a write options structure to be used for write operations.

Parameters
[in]durabilityThe durability policy used for the write options, if NULL the default durability is used.
[in]timeout_msThe time, specified in milliseconds, allowed for processing the operation. If zero, the default request timeout is used.
[out]optionspThe output write options handle.
Returns
KV_SUCCESS on success, and an error code (a negative number) on failure.
void kv_release_write_options ( kv_write_options_t **  optionsp)

Releases the resources use by the write options structure.

Parameters
[in]optionspThe pointer to the write options handle to release.