Getting Started with Oracle NoSQL Database

Legal Notice

Copyright © 2011, 2012, 2013, Oracle and/or its affiliates. All rights reserved.

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.

4/23/2013


Table of Contents

Preface
Conventions Used in This Book
1. Introduction to Oracle NoSQL Database
The KVStore
Replication Nodes and Shards
Replication Factor
Partitions
Topologies
Access and Security
KVLite
Hadoop Integration
Oracle External Tables Integration
Coherence Integration
2. Introduction to Oracle KVLite
Starting KVLite
Stopping and Restarting KVLite
Verifying the Installation
kvlite Utility Command Line Parameter Options
3. Record Design Considerations
Keys
What is a Key Component?
Values
4. Developing for Oracle NoSQL Database
The KVStore Handle
The KVStoreConfig Class
5. Writing and Deleting Records
Write Exceptions
Writing Records to the Store
Other put Operations
Deleting Records from the Store
Using multiDelete()
6. Reading Records
Read Exceptions
Retrieving a Single Record
Using multiGet()
Using multiGetIterator()
Using storeIterator()
Specifying Subranges
7. Avro Schemas
Creating Avro Schemas
Avro Schema Definitions
Primitive Data Types
Complex Data Types
Using Avro Schemas
Schema Evolution
Rules for Changing Schema
Writer and Reader Schema
How Schema Evolution Works
Managing Avro Schema in the Store
Adding Schema
Changing Schema
Disabling and Enabling Schema
Showing Schema
8. Avro Bindings
Avro Bindings Overview
Generic Binding
Using a Single Generic Schema Binding
Using Multiple Generic Schema Bindings
Using Embedded Records
Managing Generic Schemas Dynamically
Specific Binding
Generating Specific Avro Classes
Using Avro-specific Bindings
Using Multiple Avro-specific Bindings
JSON Bindings
Using Avro JSON Bindings
Using a JSON Binding with a JSON Record
9. Key Ranges and Depth for Multi-Key Operations
Specifying Subranges
Specifying Depth
10. Using Versions
11. Consistency Guarantees
Specifying Consistency Policies
Using Predefined Consistency
Using Time-Based Consistency
Using Version-Based Consistency
12. Durability Guarantees
Setting Acknowledgment-Based Durability Policies
Setting Synchronization-Based Durability Policies
Setting Durability Guarantees
13. Executing a Sequence of Operations
Sequence Errors
Creating a Sequence
Executing a Sequence
14. Using Large Objects
LOB Keys
LOB APIs
LOB Example
A. Third Party Licenses