2 Store and Library Functions
This chapter describes high-level KV Store functions, which are used to operate on the store handle itself. Other operations operate on the data in the store. There are also functions used to examine the KV Store C library that is in use.
Store Operations Functions
| Store Operations Functions | Description |
|---|---|
| kv_close_store() |
Close an Oracle NoSQL Database store |
| kv_get_open_error() |
Returns the error encountered opening the store, if any |
| kv_open_store() |
Open an Oracle NoSQL Database store |
| kv_open_store_login() |
Open an Oracle NoSQL Database store and authenticate |
| kv_store_login() |
Update the login credentials |
| kv_store_logout() |
Log out of the store |
Store Configuration Functions
| Store Configuration Functions | Description |
|---|---|
| kv_config_add_host_port() |
Identifies an additional helper host |
| kv_config_add_read_zone(), kv_config_get_read_zones() |
Adds a zone used for read operations |
| kv_config_set_consistency() |
Sets the default consistency |
| kv_config_set_durability() |
Sets the default durability policy |
| kv_config_set_security_properties() |
Sets security properties |
| kv_config_set_request_limits() |
Sets store request limits |
| kv_config_set_timeouts() |
Sets store request timeouts |
| kv_create_config() |
Create a store configuration |
| kv_create_password_credentials() |
Creates username/password credentials for store authentication |
| kv_create_properties() |
Create a properties structure |
| kv_release_config() |
Release the store configuration |
| kv_release_credentials() |
Release store authentication credentials |
| kv_release_properties() |
Release a properties structure |
| kv_set_property() |
Sets a property |
Large Object Configuration Functions
| Large Object Configuration Functions | Description |
|---|---|
| kv_config_set_lob_suffix(), kv_config_get_lob_suffix() |
Sets/gets the suffix used by LOB keys |
| kv_config_set_lob_timeout(), kv_config_get_lob_timeout() |
Sets/gets the LOB chunk timeout value |
| kv_config_set_verification_bytes(), kv_config_get_lob_verification_bytes() |
Sets/gets the number of bytes used to verify a resumed LOB put operation |
Library Operations Functions
| Library Operations Functions | Description |
|---|---|
| kv_create_jni_impl() |
Initialize the JNI layer |
| kv_create_jni_impl_from_jvm() |
Initialize the JNI layer using a pointer to a JVM |
| kv_get_impl_type() |
Return the C API implementation type |
| kv_release_impl() |
Release the JNI structures |
| kv_version() |
Return the library version number |
| kv_version_c() |
Return the version number for the C library |