Oracle NoSQL Database C API Reference Guide
		Next

Oracle NoSQL Database C API Reference Guide

Oracle NoSQL Database C Reference Guide	Description
kv_close_store()	Close an Oracle NoSQL Database store
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_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
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_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_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_release_config()	Release the store configuration
kv_release_credentials()	Release store authentication credentials
kv_release_impl()	Release the JNI structures
kv_release_properties()	Release a properties structure
kv_set_property()	Sets a property
kv_store_login()	Update the login credentials
kv_store_logout()	Log out of the store
kv_version()	Return the library version number
kv_version_c()	Return the version number for the C library
kv_create_delete_op()	Create a delete operation to be used with an operation sequence
kv_create_delete_with_options_op()	Create a delete operation, with parameters, to be used with an operation sequence
kv_create_operations()	Creates and initializes a structure used to contain a sequence of store operations
kv_create_put_op()	Create a put operation to be used with an operation sequence
kv_create_put_with_options_op()	Create a put operation, with parameters, to be used with an operation sequence
kv_delete()	Delete the key/value pair associated with the key
kv_delete_with_options()	Delete the key/value pair using options
kv_execute()	Execute the operation
kv_get()	Get the value associated with the key
kv_get_with_options()	Get the value that matches the options
kv_init_key_range()	Create and initialize a key range for use in multiple-key operations
kv_init_key_range_prefix()	Create and initialize a key range using prefix information
kv_iterator_next()	Return the next key/value pair from a store iterator
kv_iterator_next_key()	Return the next key from a store iterator
kv_iterator_size()	Return the number of elements in the store iterator
kv_lob_delete()	Delete the LOB
kv_lob_get_for_read()	Open a LOB handle for read operations
kv_lob_get_for_write()	Open a LOB handle for write operations
kv_lob_get_version()	Returns the Version of the LOB key/value pair
kv_lob_put_from_file()	Put a LOB key/value pair, inserting or overwriting as appropriate
kv_lob_read()	Read a LOB from the store
kv_lob_release_handle()	Release the LOB handle
kv_multi_delete()	Delete all descendant key/value pairs associated with the parent key
kv_multi_get()	Return all descendant key/value pairs associated with the parent key
kv_multi_get_iterator()	Returns an iterator that provides traversal of descendant key/value pairs
kv_multi_get_iterator_keys()	Returns an iterator that provides traversal of descendant keys
kv_multi_get_keys()	Return the descendant keys associated with the parent key
kv_operation_get_abort_on_failure()	Returns whether the entire operation aborts in the event of an execution failure
kv_operation_get_key()	Returns the Key associated with the operation
kv_operation_get_type()	Returns the operation type
kv_operation_results_size()	Returns the size of the operation's result set
kv_operations_set_copy()	Configures a list of operations to copy user-supplied structures and buffers
kv_operations_size()	Returns the number of operations in the operation structure
kv_parallel_scan_iterator_next()	Return the next key/value pair from a parallel scan iterator
kv_parallel_scan_iterator_next_key()	Return the next key from a parallel scan iterator
kv_parallel_store_iterator()	Return a parallel scan store iterator
kv_parallel_store_iterator_keys()	Return an parallel scan iterator providing traversal of store keys
kv_put()	Put a key/value pair, inserting or overwriting as appropriate
kv_put_with_options()	Put the key/value pair using options
kv_release_iterator()	Release the store iterator
kv_release_parallel_scan_iterator()	Release the parallel scan iterator
kv_release_operation_results()	Release the results obtained by executing an operation
kv_release_operations()	Release the operation structure
kv_result_get_previous_value()	For a put or delete operation, returns the previous value associated with the key
kv_result_get_previous_version()	For a put or delete operation, returns the version or the previous value associated with the Key
kv_result_get_success()	Returns whether the operation was successful
kv_result_get_version()	For a put operation, returns the Version of the new key/value pair
kv_store_iterator()	Return an iterator that provides traversal of all store key/value pairs
kv_store_iterator_keys()	Return an iterator that provides traversal of all store keys
kv_avro_get_current_schemas()	Get all the schemas enabled in the store
kv_avro_release_schemas()	Release the schemas datastructure
kv_avro_get_schema()	Retrieve the schema associated with a value
kv_avro_generic_to_value()	Serialize using a generic Avro binding
kv_avro_generic_to_object()	Deserialize using a generic Avro binding
kv_avro_raw_to_value()	Serialize using a raw Avro binding
kv_avro_raw_to_bytes()	Deserialize using a raw Avro binding
kv_copy_version()	Copies a version structure
kv_create_key()	Allocate and initialize a key structure using major and minor path components
kv_create_key_copy()	Allocate and initialize a key structure using major and minor path components
kv_create_key_from_uri()	Allocate and initialize a key structure using a URI string
kv_create_key_from_uri_copy()	Allocate and initialize a key structure using a URI string
kv_create_value()	Allocate and initialize a value structure
kv_create_value_copy()	Allocate and initialize a value structure
kv_get_key_major()	Return the major path components for the key
kv_get_key_minor()	Return the minor path components for the key
kv_get_key_uri()	Return the key's major and minor path components as a URI
kv_get_value()	Returns the value as a string
kv_get_value_size()	Returns the value's size
kv_get_version()	Returns a value's version
kv_release_key()	Release the key structure, freeing all associated memory
kv_release_value()	Release a value structure
kv_release_version()	Release a version structure
kv_create_durability()	Allocate and initialize a Durability structure
kv_create_simple_consistency()	Create and initialize a Consistency structure
kv_create_time_consistency()	Create and initialize a Consistency structure using time information
kv_create_version_consistency()	Create and initialize a Consistency structure using a Version
kv_get_consistency_type()	Return the Consistency type
kv_get_default_durability()	Return the store's default Durability
kv_get_durability_master_sync()	Return the transaction synchronization policy used on the Master
kv_get_durability_replica_ack()	Return the replica's acknowledgement policy
kv_get_durability_replica_sync()	Return the transaction synchronization policy used on the replica
kv_is_default_durability()	Return whether the durability is the store's default
kv_release_consistency()	Release the Consistency structure
kv_detailed_metrics_list_size()	Returns the size of the detailed metrics list
kv_detailed_metrics_list_get_record_count()	Returns the number of records in the detailed metrics list
kv_detailed_metrics_list_get_scan_time()	Returns the time used to perform the parallel scan
kv_detailed_metrics_list_get_name()	Returns the name of the shard or partition used by the parallel scan
kv_get_node_metrics()	Returns metrics associated with each node in the KV Store
kv_get_num_nodes()	Return the number of nodes contained in the KV Store
kv_get_num_operations()	Return the number of operations that were executed
kv_get_operation_metrics()	Aggregates the metrics associated with a KV Store operation
kv_get_stats()	Return statistics associated with the KV Store
kv_parallel_scan_get_partition_metrics()	Returns parallel scan metrics for the partition
kv_parallel_scan_get_shard_metrics()	Returns parallel scan metrics for the partition
kv_release_detailed_metrics_list()	Releases the detailed metrics list
kv_release_stats()	Release the statistics structure
kv_stats_string()	Returns a descriptive string containing metrics for each operation
kv_get_last_error()	Return a string explaining the last error

Legal Notice

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

5/18/2015

		Next
		Preface