Table of Contents

• Title and Copyright Information
• Preface
  • Conventions Used in This Book
  • Diversity and Inclusion
• 1 Introduction
  • Introduction to Oracle NoSQL Database
• 2 Install and Upgrade
  • Installing Oracle NoSQL Database
    • Installation Prerequisites
    • Installation
  • Upgrading an Existing Oracle NoSQL Database Deployment
    • General Upgrade Notes
    • Preparing to Upgrade
    • Steps to Upgrade - Examples
    • Upgrading the Xregion Service Agent
    • Upgrading the Oracle NoSQL Database Proxy
    • Post-Upgrade Procedure
    • Upgrading JDK on your Oracle NoSQL Database deployment
• 3 Configure
  • Configuration Basics
    • Installation Configuration Parameters
    • Configuring the Firewall
  • Configuration Scenarios
    • Configuring KVLite
    • Configuring a Single Region Data Store
      • Steps to configure a non-secure data store
      • Steps to configure a secure data store
      • Configuration Steps
        • Bootstrap the Storage Nodes
        • Start the Storage Node Agents
        • Start the Administration CLI
        • Name your data store
        • Using Plans
        • Create a Zone
          • Create Multiple Zones
        • Deploy Storage Node
        • Create an Admin Process on a Storage Node
          • Create Additional Admin Processes
        • Create a Storage Node Pool
        • Create and Deploy Topology
        • Verify Topology
        • Create a script to configure the data store
        • Troubleshooting
      • Example Use Case - Configuring a Multizone Secure Data Store
    • Configuring Multi-Region Data Stores
      • Use Case 1: Set up Multi-Region Environment
        • Deploy the data store
        • Set Local Region Name
        • Configure XRegion Service
        • Start XRegion Service
        • Create Remote Regions
        • Create Multi-Region Tables
          • Create multi-region table with an MR_COUNTER column
        • Access and Manipulate Multi-Region Tables
        • Stop XRegion Service
      • Use Case 2: Expand a Multi-Region Table
        • Prerequisites
        • Create MR Table in New Region
        • Add New Region to Existing Regions
        • Access MR Table in New and Existing Regions
      • Use Case 3: Contract a Multi-Region Table
        • Alter MR Table to Drop Regions
      • Use Case 4: Drop a Region
        • Prerequisites
        • Isolate the Region
        • Drop MR Tables in the Isolated Region
        • Drop the Isolated Region
      • Use Case 5: Backup and Restore a Multi-Region Table
      • Troubleshooting multi-region data store setup
  • Oracle NoSQL Database Proxy
    • About the Oracle NoSQL Database Proxy
    • Configuring the Proxy
    • Using the Proxy in a non-secure data store
    • Using the Proxy in a secure data store
    • Example: Configuring Multiple Oracle NoSQL Database Proxies for Redundancy
• 4 Administer
  • Changing the Store's Topology
    • Determining Your Store's Configuration
    • Steps for Changing the Store's Topology
      • Make the Topology Candidate
      • Transforming the Topology Candidate
        • Increase Data Distribution
        • Increase Replication Factor
        • Balance a Non-Compliant Topology
        • Contracting a Topology
      • View the Topology Candidate
      • Validate the Topology Candidate
      • Preview the Topology Candidate
      • Deploy the Topology Candidate
      • Verify the Store's Current Topology
    • Deploying an Arbiter Node Enabled Topology
  • Backup and Recovery
    • Backing Up the Store
      • Taking a Snapshot
      • Copying a Snapshot
      • Deleting a Snapshot
      • Managing Snapshots
    • Recovering the Store
      • Using the Load Program
        • Load Program and Metadata
      • Restoring Directly from a Snapshot
    • Use case to Demonstrate Backup and Restoration of Store
      • Backing Up the Store
        • Write Data to Store
        • Create Snapshot of the Store
      • Restoring the Store
        • Load Store Metadata from Backup
        • Grant Required Privileges to Users
        • Load Shard Data from Backup
        • Verify Restored Data
    • Recovering from Data Corruption
      • Detecting Data Corruption
      • Data Corruption Recovery Procedure
    • Replacing a Failed Disk
    • Replacing a Failed Storage Node
      • Using a New Storage Node
      • Task for an Identical Node
    • Repairing a Failed Zone by Replacing Hardware
  • Managing your kvstore
    • Increasing Storage Node Capacity
    • Managing Storage Directory Sizes
      • Managing Disk Thresholds
      • Specifying Storage Directory Sizes
      • Specifying Differing Disk Capacities
      • Monitoring Disk Usage
      • Handling Disk Limit Exception
        • Increasing Storage Directory Size
        • Adding a New Shard
    • Managing Admin Directory Size
      • Admin is Working
      • Admin is not Working
    • Disabling Storage Node Agent Hosted Services
    • Verifying the Store
    • Erasing Data
    • Setting Store Parameters
      • Changing Parameters
      • Setting Store Wide Policy Parameters
      • Admin Parameters
      • Changing Admin JVM Memory Parameters
      • Storage Node Parameters
      • Replication Node Parameters
      • Arbiter Node Parameters
      • Global Parameters
      • Security Parameters
      • Admin Restart
      • Replication Node Restart
    • Removing an Oracle NoSQL Database Deployment
    • Modifying Storage Node HA Port Ranges
    • Modifying Storage Node Service Port Ranges
      • Storage Node Not Deployed
      • Storage Node Deployed
  • Availability, Failover and Switchover
    • Availability and Failover
    • Replication Overview
    • Loss of a Read-Only Replica Node
    • Loss of a Read/Write Master
    • Unplanned Network Partitions
      • Master is in the Majority Node Partition
      • Master is in the Minority Node Partition
      • No Majority Node Partition
    • Failover and Switchover Operations
      • Repairing a Failed Zone
      • Performing a Failover
      • Performing a Switchover
    • Zone Failover
    • Durability Summary
    • Consistency Summary
• 5 Reference
  • Terminologies used in Oracle NoSQL Database
  • Admin CLI Reference
    • aggregate
      • aggregate table
    • await-consistent
    • change-policy
    • configure
    • connect
      • connect admin
      • connect store
    • delete
      • delete kv
      • delete table
    • execute
    • exit
    • get
      • get kv
      • get table
    • help
    • hidden
    • history
    • load
    • logtail
    • namespace
    • page
    • ping
    • plan
      • plan add-index
      • plan add-table
      • plan cancel
      • plan change-parameters
      • plan change-storagedir
      • plan change-user
      • plan create-user
      • plan deploy-admin
      • plan deploy-datacenter
      • plan deploy-sn
      • plan deploy-topology
      • plan deploy-zone
      • plan deregister-es
      • plan drop-user
      • plan enable-requests
      • plan evolve-table
      • plan execute
      • plan failover
      • plan grant
      • plan interrupt
      • plan migrate-sn
      • plan network-restore
      • plan register-es
      • plan remove-admin
      • plan remove-datacenter
      • plan remove-index
      • plan remove-sn
      • plan remove-table
      • plan remove-zone
      • plan repair-topology
      • plan revoke
      • plan start-service
      • plan stop-service
      • plan update-tls-credentials
      • plan upgrade-scv
      • plan verify-data
        • Executing verify-data
      • plan wait
      • Tracking Plan Progress
      • Plan States
      • Reviewing Plans
      • Plan Ownership
      • Pruning Plans
    • pool
      • pool clone
      • pool create
      • pool join
      • pool leave
      • pool remove
    • put
      • put kv
      • put table
    • repair-admin-quorum
    • show
      • show admins
      • show datacenters
      • show events
      • show faults
      • show indexes
      • show mrtable-agent-statistics
      • show parameters
      • show perf
      • show plans
      • show pools
      • show snapshots
      • show regions
      • show tables
      • show tls-credentials
      • show topology
      • show upgrade-order
      • show users
      • show versions
      • show zones
    • snapshot
      • snapshot create
      • snapshot remove
    • table
    • table-size
    • timer
    • topology
      • topology change-repfactor
      • topology change-zone-arbiters
      • topology change-zone-master-affinity
      • topology change-zone-type
      • topology clone
      • topology contract
      • topology create
      • topology delete
      • topology list
      • topology preview
      • topology rebalance
      • topology redistribute
      • topology validate
      • topology view
    • verbose
    • verify
      • verify configuration
      • verify prerequisite
      • verify upgrade
  • Admin Utility Command Reference
    • diagnostics
    • generateconfig
    • help
    • kvlite
    • load admin metadata
    • load store data
    • makebootconfig
    • ping
      • Ping Command Line Parameters
      • Ping Exit Codes
      • Ping Report Text Output
      • Ping Report JSON Output
    • restart
    • runadmin
    • securityconfig
    • start
    • status
    • stop
    • version
    • xrstart
    • xrstatus
    • xrstop
  • Initial Capacity Planning
    • Shard Capacity
      • Application Characteristics
        • Replication Factor
        • Average Key Size
        • Average Value Size
        • Read and Write Operation Percentages
        • Hardware Characteristics
      • Shard Storage and Throughput Capacities
        • Shard Storage Capacity
        • Shard I/O Throughput capacity
      • Memory and Network Configuration
      • Machine Physical Memory
      • Sizing Advice
      • Determine JE Cache Size
      • Machine Network Throughput
    • Estimate total Shards and Machines
      • Number of Partitions
  • Tuning
    • Turn off the swap
    • Linux Page Cache Tuning
    • OS User Limits
      • File Descriptor Limits
      • Process and Thread Limits
    • Linux Network Configuration Settings
      • Server Socket Backlog
      • Isolating HA Network Traffic
      • Receive Packet Steering
      • MTU Size
    • Check AES Intrinsics Settings
    • Viewing Key Distribution Statistics
      • Examples: Key Distribution Statistics
  • Solid State Drives (SSDs)
    • Trim requirements
    • Enabling Trim
  • Diagnostics Utility
    • Setting up the tool
    • Packaging Information and Files
    • Verifying Storage Node configuration