Getting Started with the Oracle NoSQL Database Python Driver

Legal Notice

Copyright © 2011 - 2017 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.

25-Jul-2017


Table of Contents

Preface
Conventions Used in This Book
1. Developing for Oracle NoSQL Database
Installing the Driver
Using the Proxy Server
The nosqldb Python Module
Connecting to the Store
Connecting to a Secure Store
Automatically Starting the Proxy Server
The StoreConfig Class
The ProxyConfig Class
Working with a Secured Store
Configuring SSL
Setting the Security Properties for a Proxy Server
2. Introduction to Oracle KVLite
Starting KVLite
Stopping and Restarting KVLite
Verifying the Installation
kvlite Utility Command Line Parameter Options
3. Introducing Oracle NoSQL Database Tables and Indexes
Defining Tables
Executing DDL Statements using the CLI
Supported Table Data Types
Record Fields
Defining Tables using Existing Avro Schema
Defining Child Tables
Table Evolution
Creating Indexes
4. Primary and Shard Key Design
Primary Keys
Data Type Limitations
Partial Primary Keys
Shard Keys
Row Data
5. Writing and Deleting Table Rows
Write Exceptions
Writing Rows to a Table in the Store
Writing Rows to a Child Table
Other put Operations
Deleting Rows from the Store
Using multi_delete()
6. Reading Table Rows
Read Exceptions
Retrieving a Single Row
Retrieve a Child Table
Using multi_get()
Iterating over Table Rows
Specifying Field Ranges
Iterating with Nested Tables
Reading Indexes
Bulk Get Operations
7. Using Data Types
Using Arrays
Using Binary
Using Enums
Using Fixed Binary
Using JSON
Using Maps
Using Embedded Records
8. Indexing Non-Scalar Data Types
Indexing Arrays
Indexing JSON Fields
Indexing Maps
Indexing by Map Keys
Indexing by Map Values
Indexing by a Specific Map Key Name
Indexing by Map Key and Value
Indexing Embedded Records
9. Using Row Versions
10. Consistency Guarantees
Specifying Consistency Policies
Using Simple Consistency
Using Time-Based Consistency
Using Version-Based Consistency
11. Durability Guarantees
Setting Acknowledgment-Based Durability Policies
Setting Synchronization-Based Durability Policies
Setting Durability Guarantees
12. Executing a Sequence of Operations
Sequence Errors
Creating a Sequence
Executing a Sequence
A. Table Data Definition Language Overview
Name Constraints
DDL Comments
CREATE TABLE
Field Definitions
Supported Data Types
Field Constraints
USING TTL
Table Creation Examples
Modify Table Definitions
ALTER TABLE ADD field
ALTER TABLE DROP field
ALTER TABLE USING TTL
DROP TABLE
CREATE INDEX
Indexable Field Types
Simple Indexes
Multi-Key Indexes
JSON Indexes
CREATE FULL TEXT INDEX
DROP INDEX
DESCRIBE AS JSON TABLE
DESCRIBE AS JSON INDEX
SHOW TABLES
SHOW INDEXES
B. Proxy Server Reference
Securing Oracle NoSQL Database Proxy Server
Trouble Shooting the Proxy Server
C. Third Party Licenses