Table of Contents
There are two different APIs that can be used to write Oracle NoSQL Database (Oracle NoSQL Database) applications: the original key/value API, and the tables API. This document describes how to write Oracle NoSQL Database applications using the key/value API. Note that most application developers should use the tables API because it offers important features, including secondary indexes.
This document provides the concepts surrounding Oracle NoSQL Database, data schema considerations, as well as introductory programming examples.
This document is aimed at the software engineer responsible for writing an Oracle NoSQL Database application.
The following typographical conventions are used within in this manual:
Class names are represented in monospaced
font, as are method names.
For example: "The KVStoreConfig()
constructor returns a KVStoreConfig class object."
Variable or non-literal text is presented in italics. For example: "Go to your KVHOME directory."
Program examples are displayed in a monospaced
font on a shaded background. For example:
import oracle.kv.KVStore;
import oracle.kv.KVStoreConfig;
...
KVStoreConfig kconfig = new KVStoreConfig("exampleStore",
"node1.example.org:5088, node2.example.org:4129");
KVStore kvstore = null;
In some situations, programming examples are updated from one
chapter to the next. When this occurs, the new code is presented in
monospaced bold font. For example:
import oracle.kv.KVStore; import oracle.kv.KVStoreConfig;import oracle.kv.KVStoreFactory;... KVStoreConfig kconfig = new KVStoreConfig("exampleStore", "node1.example.org:5088, node2.example.org:4129"); KVStore kvstore = null;try { kvstore = KVStoreFactory.getStore(kconfig); } catch (FaultException fe) { // Some internal error occurred. Either abort your application // or retry the operation. }
Finally, notes of special interest are represented using a note block such as this.