Welcome to the Administration and Operations Guide!¶

Main YottaDB Documentation Page
About This Manual
- Intended Audience
- Purpose of this Manual
- How to Use This Manual
- Overview
- Conventions Used in this Manual
1. About YottaDB
- Hardware/ Operating System Environment
- Installation
- Security
- Program Development Environment
- Database Subsystem
- YottaDB Utility Programs
- Database Integrity
- Interprocess Communication
2. Installing YottaDB
- Obtaining YottaDB Distribution Media
- Before You Begin
- Installation Procedure
  - Compiling the Reference Implementation Plugin
- ydbinstall Script
  - Examples
3. Basic Operations
- YottaDB Environment Setup
  - ydb_env_set
  - gtmscshrc
  - gtmbase
  - gdedefaults
  - ydb
- Environment Variables
- Configuring and operating YottaDB with Unicode™ support (optional)
  - M mode and UTF-8 mode
  - Compiling ICU
- Starting YottaDB
- Configuring huge pages for YottaDB on Linux
  - Using huge pages
    - Using Huge Pages for Shared Memory
    - Using huge pages for YottaDB process working space
- Configuring the Restriction Facility
  - ZSYSTEM and PIPE OPEN command restriction facility
  - Audit Principal Device restriction facility
    - Logging
4. Global Directory Editor
- Global Directory
- GDE Overview
- Using GDE
  - Guidelines for Mapping
- Global Director Editor Commands
  - Specifying File Names in Command Lines
  - Font/Capitalization Conventions Used in this Chapter
  - @
  - Add
    - -Name
    - -Segment
    - -Region
    - -Gblname
  - Change
  - Delete
  - Exit
  - Help
  - LOCKS
  - LOG
  - Quit
  - Rename
  - SETGD
  - Show
  - Template
  - Verify
- Name, Region and Segment Qualifiers
- GDE Command Summary
  - GDE Command Qualifier Summary
5. General Database Management
- Introduction
  - Operations - Standalone and Concurrent Access
  - MUPIP
- Commands and Qualifiers
- MUPIP Command Summary
6. YottaDB Journaling
- Introduction
- SET
- JOURNAL
- JOURNAL EXTRACT FORMATS
7. Database Replication
- Introduction
  - Database Transaction Number
  - Journal Sequence Number
  - Stream Sequence Number
  - Using Multiple Instances in the same Process
    - Notes
    - Example:
  - Examples
  - Limitations- SI Replication
  - Replication Architecture
- Implementing Replication and Recovery
  - Application Architecture
    - Implement a Message Delivery System
  - System Requirements
    - Root Primary Status Identification
  - Switchover
  - Instance Freeze
  - TLS/SSL Replication
  - Network Link Between Systems
  - Choosing Betweeen BEFORE_IMAGE and NOBEFORE_IMAGE
    - Recovery
    - Comparison other than recovery
  - Database Repair
- Procedures
  - Download Replication Examples
- Setting up an A -> B Replication Configuration with Empty Databases
- Setting up an A -> B -> C Replication Configuration with Empty Databases
- Setting up an A -> P replication configuration with empty databases
- Replicating Instance Starts from Backup of Originating Instance (A -> B and A -> P)
- Switchover Possibilities in an A -> B replication configuration
- Switchover Possibilities in a B <- A -> P replication configuration
- Switchover possibilities in a B <- A -> P -> Q replication configuration
- Changing the global directory in an A -> B replication configuration
- Rolling Software Upgrade
- Shutting down an instance
- Creating a new Replication Instance File
- Setting up a Secured TLS Replication Connection
- Schema Change Filters
- Recovering from the replication WAS_ON State
- Rollback data from crashed (idle) regions
- Setting up a new replicating instance of an originating instance (A→B, P→Q, or A→P)
- Replacing the replication instance file of a replicating instance (A→B and P→Q)
- Replacing the replication instance file of a replicating instance (A→P)
- Setting up a new replicating instance from a backup of the originating instance (A→P)
- Setting up an A→P for the first time if P is an existing instance (having its own set of updates)
- Commands and Qualifiers
  - Turning Replication On/Off
    - Qualifiers:
  - Creating the Replication Instance File
    - Qualifiers:
  - Displaying/ Changing the attributes of Replication Instance File and Journal Pool
    - Qualifiers
      - -editinstance
      - -cleanslots
      - -jnlpool
      - -change
      - -name=<new-name>
      - -show
      - -detail
      - -size
      - -offset
      - -value
      - -show
      - -[no]qdbrundown
  - Starting the Source Server
    - Qualifiers:
  - Shutting Down the Source Server
    - Qualifiers:
  - Activating a Passive Source Server
    - Qualifiers:
  - Deactivating an Active Source Server
    - Qualifiers:
  - Stopping the Source Filter
  - Checking Server Health
    - Qualifiers:
      - -checkhealth
      - -instsecondary=<instance_name>
  - Changing the Log File
    - Qualifiers:
  - Enabling/ Disabling Detailed Logging
    - Qualifiers:
      - -statslog={ON | OFF}
      - -log_interval=<integer>
  - Stopping a Source Server
    - Qualifiers:
      - -instsecondary=<instance_name>
      - -timeout=<seconds>
  - Reporting the Current Backlog of Journal Records
    - Qualifiers:
      - -showbacklog
  - Processing Lost Transactions File
    - Qualifiers:
      - -losttncomplete
      - -needrestart
    - Lost Transaction File Format
  - Starting the Receiver Server
    - Qualifiers:
  - Starting the Update Process
    - Qualifiers:
      - -updateonly
      - -helpers[=m[,n]]
  - Stopping the Update Process and/or the Receiver Server
    - Qualifiers:
  - Stopping the Receiver Filter
  - Checking Server Health
  - Changing the Log File
    - Qualifiers:
      - -log_interval=”[integer1],[integer2]”
  - Enabling/ Disabling Detailed Logging
    - Qualifiers:
      - -log_interval=”[integer1],[integer2]”
  - Reporting the current backlog of Journal Records
    - Qualifiers:
      - -showbacklog
  - Rolling back the database after System Failures
    - Qualifiers:
- Update Helper Processes
  - Description
  - MUPIP Commands
  - DSE Commands
  - Average Blocks Read per 100 records
  - Update Process Reserved Area
  - Pre-read Trigger Factor
  - Update Writer Trigger Factor
8. M Lock Utility (LKE)
- Introduction
  - To Invoke and Exit LKE
  - To Establish a Global Directory
- LKE Commands and Qualifiers
- Summary
- LKE Exercises
  - Exercise 1: Preventing concurrent updates using M Locks
  - Exercise 2: Rectifying a deadlock situation
9. YottaDB Database Structure (GDS)
- Database File Organization with GDS
  - Database File Header
  - File Header Data Elements
- Local Bitmaps
- Master Bitmap
- Database Structure
10. Database Structure Editor
- Operating in DSE
- DSE Commands and Qualifiers
- DSE Command Summary
11. Maintaining Database Integrity
- Verifying Database Integrity
- Approaches to Database Recovery
- Repairing the Database with DSE
- Finding and Fixing Database Errors
12. Database Encryption
- Introduction
- Theory of Operation
  - Definition of Terms
  - Overview
- Examples of Use
  - Key Management
- Tested Reference Implementations
- Special Note - GNU Privacy Guard and Agents
  - Using the Reference Implementation’s Custom pinentry Program
- Installation
- Administration and Operation of Encrypted Databases
- Plugin Architecture and Interface
- Using the Reference Implementation with Older Releases
13. GT.CM Client/Server
- Introduction
- Overview
Appendix A : YottaDB’s IPC Resource Usage
- Examining YottaDB’s IPC Resources
- gtmsecshr
Appendix B: Monitoring YottaDB
- Monitoring YottaDB Messages
- Managing Core Dumps
Appendix C : YottaDB Security Philosophy
- Philosophy
- gtmsecshr Commands
- Shared Resource Authorization Permissions
Appendix D : YottaDB Docker Container
- Quick Start
Appendix E : Packaging YottaDB Applications
- Setting Up a Captive User Application with YottaDB
  - Sample .profile
- Invoking YottaDB in a C main() program
- Defensive Practices
- Other
Appendix F : Creating a TLS Configuration File
- Creating a TLS Configuration File
- Supported OpenSSL options
  - CAFile
  - CApath
  - cipher-list
  - crl
  - dh512 and dh1024
  - format
  - cert
  - key
  - session-id-hex
  - session-timeout
  - ssl-options
  - verify-depth
  - verify-level
  - verify-mode
Glossary
- I
- O
- R
- S
Appendix G: Extending YottaDB
- Applications, Wrappers, and Plugins
- Plugins
LICENSE

Indices and tables¶