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
    • 1. GDE
    • 2. MUPIP
    • 3. LKE
    • 4. DSE
    • 5. Command Qualifiers
  • Database Integrity
  • Interprocess Communication
• 2. Installing YottaDB
  • Obtaining YottaDB Distribution Media
  • Before You Begin
  • Installation Procedure
    • Installing prerequisite packages
    • Installing YottaDB
    • Compiling the Reference Implementation Plugin
  • ydbinstall Script
    • Examples
• 3. Basic Operations
  • YottaDB Environment Setup
    • ydb_env_set
    • gdedefaults
    • ydb
  • Environment Variables
    • EDITOR
    • LC_CTYPE
    • LC_ALL
    • LD_LIBRARY_PATH
    • TZ
    • ydb_aio_nr_events
    • ydb_app_ensures_isolation
    • ydb_autorelink_ctlmax
    • ydb_autorelink_keeprtn
    • ydb_autorelink_shm
    • ydb_badchar
    • ydb_baktmpdir
    • ydb_boolean
    • ydb_chset
    • ydb_ci
    • ydb_cm_<node-name>
    • ydb_collate_n
    • ydb_compile
    • ydb_coredump_filter
    • ydb_crypt_config
    • ydb_crypt_fips
    • ydb_crypt_plugin
    • ydb_custom_errors
    • ydb_db_create_ver
    • ydb_cur_gbldir
    • ydb_dbfilext_syslog_disable
    • ydb_dbglvl
    • ydb_db_startup_max_wait
    • ydb_dist
    • ydb_dmterm
    • ydb_dollartest
    • ydb_env_translate
    • ydb_error_on_jnl_file_lost
    • ydb_etrap
    • ydb_extract_nocol
    • ydb_flushoncallout
    • ydb_fullblockwrites
    • ydb_gbldir
    • ydb_gbldir_translate
    • ydb_gdscert
    • ydb_hugetlb_shm
    • ydb_hupenable
    • ydb_icu_version
    • ydb_ipv4_only
    • ydb_jnl_release_timeout
    • ydb_keep_obj
    • ydb_lct_stdnull
    • ydb_link
    • ydb_linktmpdir
    • ydb_locale
    • ydb_local_collate
    • ydb_log
    • ydb_lvnullsubs
    • ydb_malloc_limit
    • ydb_maxtptime
    • ydb_max_indrcache_count/ydb_max_indrcache_memory
    • ydb_max_sockets
    • ydb_max_storalloc
    • ydb_memory_reserve
    • ydb_msgprefix
    • ydb_mstack_crit_threshold
    • ydb_mstack_size
    • ydb_mupjnl_parallel
    • ydb_nocenable
    • ydb_nofflf
    • ydb_non_blocked_write_retries
    • ydb_nontprestart_log_delta
    • ydb_nontprestart_log_first
    • ydb_noundef
    • ydb_obfuscation_key
    • ydb_passwd
    • ydb_patnumeric
    • ydb_pattern_file/ydb_pattern_table
    • ydb_pinshm
    • ydb_poollimit
    • ydb_principal
    • ydb_principal_editing
    • ydb_procstuckexec
    • ydb_prompt
    • ydb_quiet_halt
    • ydb_readline
    • ydb_recompile_newer_src
    • ydb_rel
    • ydb_repl_filter_timeout
    • ydb_repl_instance
    • ydb_repl_instname
    • ydb_repl_instsecondary
    • ydb_retention
    • ydb_routines
    • ydb_side_effects
    • ydb_snaptmpdir
    • ydb_string_pool_limit
    • ydb_statsdir
    • ydb_statshare
    • ydb_stdxkill
    • ydb_sysid
    • ydb_tls_passwd_<label>
    • ydb_tmp
    • ydb_tpnotacidtime
    • ydb_tprestart_log_delta
    • ydb_tprestart_log_first
    • ydb_trace_gbl_name
    • ydb_treat_sigusr2_like_sigusr1
    • ydb_trigger_etrap
    • ydb_xc_gpgagent
    • ydb_zdate_form
    • ydb_zinterrupt
    • ydb_zlib_cmp_level
    • ydb_zquit_anyway
    • ydb_zstep
    • ydb_ztrap_form/ydb_zyerror
    • ydb_ztrap_new
  • Some Things To Remember
  • Configuring and operating YottaDB with Unicode™ support (optional) for M
  • Running YottaDB
  • Configuring hugepages for YottaDB on Linux
    • Using Hugepages
      • Using Hugepages for Shared Memory
      • Using hugepages for YottaDB process working space
  • Configuring the Restriction Facility
    • ZSYSTEM and PIPE OPEN command restriction facility
    • Audit Logging Facility
      • Logging
• 4. Global Directory Editor
  • Global Directory
  • GDE Overview
    • Identifying the Current Global Directory
    • Creating a Default Global Directory
    • Mapping Global Variables in a Global Directory
    • Examining the Default Global Directory
      • TEMPLATES
      • NAMES
      • REGIONS
      • SEGMENTS
      • MAP
    • Global Directory Abbreviations
    • Customizing a Global Directory
      • Adding a Journaling Information Section
  • Using GDE
    • Guidelines for Mapping
      • NAMES
      • REGIONS
      • SEGMENTS
      • FILE
        • Example of a Basic 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
    • Name Qualifiers
    • Region Qualifiers
      • -[NO]AU[TODB]
      • -C[OLLATION_DEFAULT]=number
      • -D[YNAMIC_SEGMENT]=segment-name
      • -[NO]EPOCHTAPER
      • -[NO]INST[_FREEZE_ON_ERROR]
      • -[NO]J[OURNAL][=journal-option-list]
        • -AU[TOSWITCHLIMIT]=blocks
        • -[NO]BE[FORE_IMAGE]
        • -F[ILE_NAME]="file-name"
        • Journal Options Summary
      • -K[EY_SIZE]=size in bytes
      • -[NO]L[OCK_CRIT_SEPARATE]
      • -[NO]N[ULL_SUBSCRIPTS]=[ALWAYS|NEVER|EXISTING]
      • -[NO]Q[DBRUNDOWN]
      • -R[ECORD_SIZE]=size in bytes
      • -[NO]STA[TS]
      • -[NO]STD[NULLCOLL]
    • Segment Qualifiers
      • -AC[CESS_METHOD]=code
      • -AL[LOCATION]=blocks
      • -[NO]AS[YNCIO]
      • -BL[OCK_SIZE]=size
      • -[NO]DEFER[_ALLOCATE]
      • -[NO]E[NCRYPTION]
      • -EX[TENSION_COUNT]=blocks
      • -F[ILE_NAME]=file-name
      • -G[LOBAL_BUFFER_COUNT]=size
      • -L[OCK_SPACE]=integer
      • -M[UTEX_SLOTS]=integer
      • -R[ESERVED_BYTES]=size
    • Gblname Qualifiers
      • -C[OLLATION]=collation_number
    • Instance Qualifier
      • -F[ILE_NAME=[repl_inst_filename|""]
  • GDE Command Summary
    • GDE Command Qualifier Summary
• 5. General Database Management
  • Introduction
    • Operations - Standalone and Concurrent Access
    • MUPIP
  • Commands and Qualifiers
    • BACKUP
      • Before Starting a MUPIP Backup
      • BACKUP Qualifiers
        • -BKupdbjnl
        • -BYtestream
        • -Database
        • -DBG
        • -NETtimeout
        • -NEWJNLFILES
        • -Online
        • -Record
        • -REPLAce
        • -REPLICation
        • -REPLINstance
        • RETry
        • SHowprogress
        • -Since
        • -Transaction
      • Examples for MUPIP BACKUP
    • CREATE
      • REGION
      • V6
      • Examples for MUPIP CREATE
    • DOWNGRADE
      • -VERSION={version}
      • Examples for MUPIP DOWNGRADE
    • DUMPFHEAD
      • -FILE file-name
      • -REGION region-list
      • Examples for MUPIP DUMPFHEAD
    • ENDIANCVT
      • -OVERRIDE
      • Examples for MUPIP ENDIANCVT
    • EXIT
    • EXTEND
      • -Blocks
      • Examples for MUPIP EXTEND
    • EXTRACT
      • -FORMAT
      • -FREEZE
      • -LABEL
      • -LOG
      • -NULL_IV
      • -REGION
      • -SELECT
      • -STDOUT
      • Examples for MUPIP EXTRACT
    • FREEZE
      • -OFF
      • -ON
      • -[NO]A[UTORELEASE]
      • -DBG
      • -ONLINE
      • -OVERRIDE
      • -RECORD
      • Examples for MUPIP FREEZE
    • FTOK
      • -DB
      • -JNLPOOL
      • -RECVPOOL
      • -ID
      • -ONLY
      • -HEADER
    • HASH
    • INTEG
      • INTEG Qualifiers
        • -ADJACENCY
        • -BLOCK
        • -BRIEF
        • -DBG
        • -FAST
        • -FILE
        • -FULL
        • -KEYRANGES
        • -MAP
        • -MAXKEYSIZE
        • -ONLINE
        • -REGION
        • -SUBSCRIPT
        • -STATS
        • -TN_RESET
        • -TRANSACTION
      • Examples for MUPIP INTEG
    • INTRPT
    • JOURNAL
    • LOAD
      • -FORMAT
      • -BEGIN
      • -END
      • -FILLFACTOR
      • -IGNORECHSET
      • -ONERROR
      • -STDIN
      • Examples for MUPIP LOAD
    • RCTLDUMP
    • REORG
      • -DOWNGRADE
      • -ENCRYPT
      • -EXCLUDE
      • -FILL_FACTOR
      • -INDEX_FILL_FACTOR
      • KEEP
      • -NOCOALESCE
      • -NOSPLIT
      • -NOSWAP
      • -RESUME
      • -REGION
      • -SELECT
      • TRUNCATE
      • Examples for MUPIP REORG
      • -UPGRADE
    • USER_DEFINED_REORG
    • REPLICATE
    • RESTORE
      • -EXTEND
      • Examples for MUPIP RESTORE
    • RUNDOWN
      • -FILE
      • -OVERRIDE
      • -REGION
      • -RELINKCTL
    • SEMAPHORE
    • SET
      • SET Qualifiers
        • -FILE
        • -JNLFILE
        • -REGION
        • -REPLICATION
        • -ACCESS_METHOD
        • -ASYNCIO
        • -DEFER_TIME
        • -DEFER_ALLOCATE
        • -EPOCHTAPER
        • -ENCRYPTABLE
        • -EXTENSION_COUNT
        • -FLUSH_TIME
        • -FULLBLKWRT
        • -GLOBAL_BUFFERS
        • -HARD_SPIN_COUNT
        • -INST_FREEZE_ON_ERROR
        • -JOURNAL
        • -KEY_SIZE
        • -LOCK_SPACE
        • -MUTEX_SLOTS
        • -NULL_SUBSCRIPTS
        • -LCK_SHARES_DB_CRIT
        • PROBLKSPLIT
        • -QDBRUNDOWN
        • -PARTIAL_RECOV_BYPASS
        • -READ_ONLY
        • -RECORD_SIZE
        • -REORG_SLEEP_NSEC
        • -RESERVED_BYTES
        • -SLEEP_SPIN_COUNT
        • -SPIN_SLEEP_MASK
        • -STATS
        • -STDNULLCOLL
        • -TRIGGER_FLUSH
        • -VERSION
        • -WAIT_DISK
        • -WRITES_PER_FLUSH
      • Examples for MUPIP SET
    • SIZE
      • -HEURISTIC=estimation_technique
      • -ADJACENCY=integer
      • -SELECT
      • -REGION
      • -SUBSCRIPT
      • Examples for MUPIP SIZE
    • STOP
    • TRIGGER
      • -TRIGGERFILE=<trigger_definitions_file>
      • -SELECT=name-list
      • -UPGRADE
      • -STDIN
      • -STDOUT
      • Examples for MUPIP TRIGGER
    • UPGRADE
  • MUPIP Command Summary
• 6. YottaDB Journaling
  • Introduction
    • Journal Files
      • Turning on Journaling
    • Recovery from a Journal File
      • Forward Recovery
      • Backward Recovery
    • rolled_bak* files
    • Journal Files Access Authorization
    • Triggers in Journal Files
    • BEFORE_IMAGE_JOURNALING
    • NOBEFORE_IMAGE Journaling
    • Choosing between BEFORE_IMAGE and NOBEFORE_IMAGE
      • Recovery
      • Comparison other than recovery
    • Database Repair
    • Broken Transaction File
    • Lost Transaction File
    • Epoch
    • Journaling Benefits
    • Backup Journal Files
    • Select Database Files for Journaling
    • Fencing Transactions
    • Deciding Whether to Use Fencing
      • Fencing Advantages
      • Fencing Disadvantages
    • VIEW Keywords
    • $VIEW() Keywords
  • SET
    • SET Object Identifying Qualifiers
      • FILE
      • REGION
      • JNLFILE
        • -bypass
        • -dbfilename=file_name
        • -prevjnlfile=jnlfilename
        • -noprevjnlfile
        • -repl_state={on|off}
    • SET Action Qualifiers
      • -JOURNAL
      • -REPLICATION
      • SET -JOURNAL OPTIONS
        • ALI[GNSIZE]=blocks
        • ALL[OCATION]=blocks
        • AU[TOSWITCHLIMIT]=blocks
        • [NO]BEFORE_IMAGES
        • BU[FFER_SIZE]=blocks
        • DISABLE
        • ENABLE
        • EP[OCH_INTERVAL]=seconds
        • EX[TENSION]=blocks
        • F[ILENAME]=journal_filename
        • NOPREVJNLFILE
        • [NO]S[YNC_IO]
        • OFF
        • ON
        • Y[IELD_LIMIT]=yieldcount
    • Examples for MUPIP SET
  • JOURNAL
    • Journal Action Qualifiers
      • -EXtract[=<file-name>|-stdout]
        • -GVPATFILE
      • -PARA[LLEL][=n]
      • -RECover
      • -ROLLBACK [{-ON[LINE]|-NOO[NLINE]}]
        • -NOO[NLINE]
        • -ON[LINE]
      • -SHow=show-option-list
      • -[NO]Verify
    • Journal Direction Qualifiers
    • Journal Time Qualifiers
    • Journal Sequence Number Qualifiers
    • Journal Control Qualifiers
    • Journal Selection Qualifiers
  • Journal Extract Formats
• 7. Database Replication
  • Introduction
    • Database Transaction Number
    • Journal Sequence Number
    • Stream Sequence Number
    • Instance Bound Global Directories
      • Notes
      • Example:
    • Examples
      • Simple Example
      • Ensuring consistency with rollback
      • Rollback not Desired or Required by Application Design
      • Two Originating Primary Failures
      • Replication and Online Rollback
    • Limitations- SI Replication
    • Replication Architecture
      • Helper Processes
      • Filters
      • Replication Instance File
  • Implementing Replication and Recovery
    • Application Architecture
      • Implement a Message Delivery System
    • System Requirements
      • Root Primary Status Identification
    • Switchover
    • Instance Freeze
    • TLS/SSL Replication
      • Creating a root-level certification authority
      • Creating Leaf-level certificates
      • Creating a configuration file
    • Network Link Between Systems
  • 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
      • -file and -region
      • -replication=replication-state
      • OFF
      • ON
      • [WAS_ON] OFF
    • Creating the Replication Instance File
      • -instance_create
      • -name
      • -noreplace
      • -supplementary
      • -noqdbrundown
    • Displaying/ Changing the attributes of Replication Instance File and Journal Pool
      • -editinstance
      • -cleanslots
      • -jnlpool
      • -change
      • -name=<new-name>
      • -detail
      • -size
      • -offset
      • -value
      • -show
      • -[no]qdbrundown
    • Starting the Source Server
      • -source
      • -start
      • -passive
      • Connection Qualifiers
        • -cmplvl=n
        • -connectparams=<hard tries>,<hard tries period>,<soft tries period>,<alert time>,<heartbeat period>,<max heartbeat wait>
      • Journal Pool Setup Qualifiers
        • -buffsize=<Journal Pool size in bytes>
        • -[no]jnlfileonly
      • Log File Management Qualifiers
        • -log=<log file name>
        • -log_interval=<integer>
      • Primary Role Qualifiers
        • -propagate[primary]
        • -rootprimary
        • -updok
        • -updnotok
      • Replication Filter Qualifiers
        • -filter=<filter command>
      • Secondary Qualifiers
        • -instsecondary
        • -secondary=<hostname:port>
        • -trigupdate
      • TLS Replication Qualifiers
        • -tlsid=<label>
        • -[NO]PLAINtextfallback
        • -RENEGotiate_interval=<minutes>
    • Shutting Down the Source Server
      • -shutdown
      • -timeout=<timeout in seconds>
      • -zerobacklog
    • Activating a Passive Source Server
      • -activate
      • -instsecondary=<instance_name>
      • -rootprimary
      • -propagateprimary
      • -log_interval
    • Deactivating an Active Source Server
      • -deactivate
      • -instsecondary=<instance_name>
      • -rootprimary
      • -propagateprimary
    • Stopping the Source Filter
    • Checking Source Server Health
      • -checkhealth
      • -instsecondary=<instance_name>
    • Changing the Source Server Log File
      • -changelog
      • -instsecondary=<instance_name>
      • -log=<log file name>
      • -log_interval=<integer>
    • Enabling/ Disabling Detailed Logging in Source server
      • -statslog={ON | OFF}
      • -log_interval=<integer>
    • Stopping a Source Server
      • -instsecondary=<instance_name>
      • -timeout=<seconds>
    • Reporting the Current Backlog of Source Server
      • -showbacklog
    • Processing Lost Transactions File
      • -losttncomplete
      • -needrestart
      • Lost Transaction File Format
    • Starting the Receiver Server
      • Autorollback Qualifier
      • Connection Qualifiers
      • Logfile Management Qualifiers
      • Operator Override Qualifiers
      • SI Replication Qualifiers
      • -reuse=<instname>
      • -stopreceiverfilter
      • -updateresync=</path/to/bkup-orig-repl-inst-file>
      • -initialize
      • -resume=<strm_num>
      • -noresync
      • TLS Replication Qualifiers
    • Starting the Update Process
      • -updateonly
      • -helpers[=m[,n]]
    • Stopping the Update Process and/or the Receiver Server
      • -shutdown
      • -helper
      • -timeout
      • -updateonly
    • Stopping the Receiver Filter
    • Freezing an instance
      • -[no]comment[='"<string>"']
      • -freeze[=on|off]
    • Checking Receiver Server Health
    • Changing the Receiver Server Log File
      • -log_interval="[integer1],[integer2]"
    • Enabling/ Disabling Detailed Logging in Receiver server
      • -log_interval="[integer1],[integer2]"
    • Reporting the current backlog of Receiver Server
      • -showbacklog
    • Rolling back the database after System Failures
      • -rollback
      • -fetchresync=<port number>
      • -resync=<JNL_SEQNO>
      • -losttrans=<extract file>
      • -rsync_strm=<strm_num>
  • 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
    • CLEAR
      • -A[LL]
      • -L[OCK]=""resource_name""
      • -[NO]I[NTERACTIVE]
      • -O[UTPUT]="file-name"
      • -P[ID]=pid
      • -R[EGION]=region-name | -R[EGION] region-name
    • CLNUP
      • -A[LL]
      • -I[NTEG]
      • -P[ERIODIC]=n
      • -R[EGION]
    • SHOW
      • -ALL
      • -L[OCK]=resource_name
      • -O[UTPUT]="file-name"
      • -P[ID]=pid
      • -R[EGION]=region-name | -R[EGION] region-name
      • -W[AIT]
    • EXIT
    • HELP
    • SPAWN
  • 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
    • Tree Organization
    • GDS Blocks
    • GDS Records
      • Using GDS records to hold spanning nodes
    • GDS Keys
    • Compression Count
    • Use of Keys
    • Characteristics of Keys
    • Global Variable Names
    • String Subscripts
    • Numeric Subscripts
• 10. Database Structure Editor
  • Operating in DSE
  • DSE Commands and Qualifiers
    • ADD
      • Qualifiers of ADD
        • -B[LOCK]=block-number
        • -D[ATA]=string
        • -K[EY]=key
        • -O[FFSET]=offset
        • -P[OINTER]=pointer
        • -R[ECORD]=record-number
        • -S[TAR]
      • Examples for ADD
    • ALL
      • Qualifiers
        • -ALL
        • -BUFFER_FLUSH
        • -C[RITINIT]
        • -D[UMP]
        • -[NO]F[REEZE]
        • -O[VERRIDE]
        • -REF[ERENCE]
        • -REL[EASE]
        • -REN[EW]
        • -S[EIZE]
        • -W[CINIT]
      • Examples of ALL
    • BUFFER_FLUSH
    • CACHE
      • Qualifiers of CACHE
        • -RE[COVER] [-ALL]
        • -SH[OW]
        • -VE[RIFY] [-ALL]
      • Examples for CACHE
    • CHANGE
      • CHANGE -BLOCK Qualifiers
        • -BL[OCK]=block_number
        • -BS[IZ]=block_size
        • -L[EVEL]=level
        • -TN[=transaction_number]
        • -OF[FSET]=offset
        • -RE[CORD]=record_number
        • -CM[PC]=compression_count
        • -RS[IZ]=record_size
      • CHANGE -FILEHEADER Qualifiers
        • -FI[LEHEADER]
        • -AB[ANDONED_KILLS]=value
        • -BLK[_SIZE]=block_size
        • -BLO[CKS_FREE]=free blocks
        • -B[YTESTREAM]=transaction_number
        • -D[ATABASE]=transaction_number
        • -B_R[ECORD]=transaction_number
        • -CO[RRUPT_FILE]=boolean
        • -COM[MITWAIT_SPIN_COUNT]=value
        • -CU[RRENT_TN]=transaction_number
        • -DECLOCATION
        • -E[NCRYPTION_HASH]
        • -[NO]EPOCHTAPER
        • -FL[USH_TIME][=delta_time]
        • -FR[EEZE]=value
        • -FU[LLY_UPGRADED]=boolean
        • -GV[STATSRESET]
        • -HEXLOCATION
        • -INT[ERRUPTED_RECOV]=boolean
        • -K[EY_MAX_SIZE]=key_max_size
        • -KI[LL_IN_PROG]=value
        • -N[ULL_SUBSCRIPTS]=value
        • -OV[ERRIDE]
        • -[NO]Q[DBRUNDOWN]
        • -REC[ORD_MAX_SIZE]=record_max_size
        • -REF[ERENCE_COUNT]=reference_count
        • -REG[_SEQNO]=sequence-number
        • -RESET_MAX_PROCS
        • -RESYNC_S[EQNO]=sequence-number
        • -RESYNC_T[N]=sequence-number
        • -S[PIN_SLEEP_MASK]=hexadecimal-mask
        • -SLEE[P_SPIN_COUNT]=integer
        • -[NO]STD[NULLCOL]
        • -STRM_NUM=stream-number -STRM_R[EG_SEQNO]=str_num's_region_sequence_number
        • -TI[MERS_PENDING]=timers_pending
        • -TO[TAL_BLKS]=total_blocks
        • -TR[IGGER_FLUSH]=trigger_flush
        • -WR[ITES_PER_FLUSH]=writes_per_flush
      • Examples for CHANGE
    • CLOSE
    • CRITICAL
      • Qualifiers of CRITICAL
        • -A[LL]
        • -I[NIT]
        • -O[WNER]
        • -REL[EASE]
        • -REM[OVE]
        • -RES[ET]
        • -S[EIZE]
      • Examples for CRITICAL
    • DUMP
      • Qualifiers of DUMP
        • -A[LL]
        • -B[LOCK]=block-number
        • -C[OUNT]=count
        • -F[ILEHEADER]
        • -G[LO]
        • -G[VSTATS]
        • -NO[CRIT]
        • -[NO]H[EADER]
        • -O[FFSET]=offset
        • -R[ECORD]=record_number
        • -U[PDPROC]
        • -Z[WR]
      • Examples for DUMP
    • EVALUATE
      • Qualifiers of EVALUATE
        • -D[ECIMAL]
        • -H[EXADECIMAL]
        • -N[UMBER]=number
      • Examples for EVALUATE
    • EXIT
    • FIND
      • Qualifiers of FIND
        • -B[LOCK]=block_number
        • -E[XHAUSTIVE]
        • -F[REEBLOCK]
        • -H[INT]=block_number
        • -K[EY]=key
        • -[NO]C[RIT]
        • -R[EGION][=region] | -R[EGION][ region]
        • -SI[BLINGS]
        • ST[ATS]
      • Examples for FIND
    • HELP
    • INTEGRIT
      • Qualifiers of INTEGRIT
        • -B[LOCK]=block_number
        • -NO[CRIT]
    • MAPS
      • Qualifiers for MAP
        • -BL[OCK]=block_number
        • -BU[SY]
        • -F[REE]
        • -M[ASTER]
        • -R[ESTORE_ALL]
      • Examples
    • OPEN
      • Qualifiers for OPEN
        • -F[ILE]=file-name
      • Examples for OPEN
    • OVERWRITE
      • Qualifiers for OVERWRITE
        • -B[LOCK]=block number
        • -D[ATA]=string
        • -O[FFSET]=offset
      • Examples for OVERWRITE
    • PAGE
    • RANGE
      • Qualifiers of RANGE
        • -F[ROM]=block_number
        • -T[O]=block-number
        • -I[NDEX]
        • -LOS[T]=block_number
        • -LOW[ER]=key
        • -[NO]BU[SY]=busy/free
        • -[NO]C[RIT]
        • -S[TAR]
        • -U[PPER]=key
      • Examples for RANGE
    • REMOVE
      • Qualifiers of REMOVE
        • -B[LOCK]=block_number
        • -C[OUNT]=count
        • -O[FFSET]=offset
        • -R[ECORD]=record_number
        • -V[ERSION]=version_number
    • RESTORE
      • Qualifiers of RESTORE
        • -B[LOCK]=block_number
        • -F[ROM]=block_number
        • -R[EGION]=region | -R[EGION] region
        • -V[ERSION]=version_number
    • SAVE
      • Qualifiers of SAVE
        • -B[LOCK]=block_number
        • -C[OMMENT]=string
        • -L[IST]
        • -[NO]C[RIT]
    • SHIFT
      • Qualifiers of SHIFT
        • -B[ACKWARD]=shift
        • -BL[OCK]=block_number
        • -F[ORWARD]=shift
        • -O[FFSET]=offset
    • SPAWN
      • Examples of SPAWN
    • WCINIT
  • DSE Command Summary
• 11. Maintaining Database Integrity
  • Verifying Database Integrity
    • Regularly Scheduled Verification
    • Before or After Major Transfers
    • Immediately after Catastrophic Events
    • Immediately after Runtime Database Errors
    • Immediately after Database Repairs
  • Approaches to Database Recovery
    • Recover from Journals
    • Restore from Backup
    • Repair with DSE
    • Preventative Maintenance
      • Determining the cause of the Problem
      • MUPIP Recovery
      • Follow-up
  • Repairing the Database with DSE
    • Using the proper database file
    • Locating Structures with DSE
    • Safety in Repairs
    • Discarding Data
    • Concurrent Repairs
    • Terminating Processes
    • Recovering Data from Damaged Binary Extracts
      • CORRUPT Errors
      • LDSPANGLOINCMP Errors
  • Finding and Fixing Database Errors
    • C1 - Possible Cache Control Problems
    • H1 - Process Hangs
    • H3 - Database Access Problems
    • H4 - Database Cache Problems
    • H5 - Critical Section Problems
    • H6 - UNIX Problems
    • H7 - Disk Hardware Problems
    • H8 - Application Problems
      • Persistent Locks
      • Deadlocks
      • Preventing Deadlocks
    • I1 - MUPIP INTEG Errors
      • Evaluating the Danger Level of a Database Problem
      • MUPIP INTEG Error Messages
    • I2 - YottaDB Version Mismatch
    • I3 - File Header Errors
    • I4 - File Size Errors
    • I5 - More Database Access Problems
    • I6 - Transient Errors
    • I7 - Database Rundown Problem
    • I8 - Repair Induced Problems
    • K1 - Bad Key
    • K2 - Keys Misplaced
    • K3 - Blocks Doubly Allocated
    • K4 - Pointer Problems
    • K5 - Star Key Problems
    • K6 - Compression Count Error
    • K7 - Key Warning
    • M1 - Bitmap Errors
    • M2 - Bitmap Header Problems
    • O1 - Bad Block
    • O2 - Record Errors
    • O3 - Data Block Errors
    • O4 - Salvage of Data Blocks with Lost Indices
      • Download salvage.m
    • O5 - Salvage of a Damaged Spanning Node
    • P1 - Process Damage
    • Q1 - Restricting Database Access
    • R1 - Runtime Errors
      • Run-Time Error Messages Identifying Potential System Problems
    • R2 - Structural Database Integrity Errors
      • Run-time Database Failure Codes
    • R3 - Runtime Database Cache Problems
    • R4 - Stopped Processes
    • R5 - No More Room in the File
    • R6 - GTMASSERT and GTMCHECK Errors
    • R7 - Interlocked Queue Hardware Problems
    • R8 - Database Tree Maximum Level Exceeded
    • R9 - Read-Only Process Blocked
• 12. Database Encryption
  • Introduction
    • Overview
    • Disclaimer
    • Limitations of YottaDB Database Encryption
      • Data Not At Rest Not Protected
      • Keys in the Process Address Space/Environment
      • Long lived Keys
      • Voluminous Samples of Encrypted Data
      • Encryption Algorithms Neither Endorsed nor Supported by YottaDB
      • No Key Recovery
      • Human Intervention Required
      • MM Databases
    • Alternatives to Database Encryption
    • Device IO
    • GT.CM
    • FIPS Mode
  • Theory of Operation
    • Definition of Terms
    • Overview
      • Warning
      • Data in Database and Journal Files
      • Symmetric and Asymmetric Ciphers
      • Key Ring on Disk
      • Master Key Configuration File and Encryption Keys
      • Memory Key Ring
      • Key Validation and Hashing
      • Database Operation
  • Examples of Use
    • Key Management
      • Instructions for Helen to verify the hash
      • Updating GPG configuration
      • Test access to data blocks with wrong passphrase
  • 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
    • Utility Programs
      • GDE
        • Format/Upgrade
        • -[NO]ENcryption
      • MUPIP
        • MUPIP CREATE
        • MUPIP JOURNAL
        • MUPIP LOAD
      • DSE
        • Changing the hash in the database file header
    • Changing Encryption Keys
    • Database Creation
  • Plugin Architecture and Interface
    • Packaging
    • Extensions to the YottaDB External Interface
    • Operation
      • gtmcrypt_close()
      • gtmcrypt_encrypt_decrypt()
      • gtmcrypt_init()
      • gtmcrypt_init_db_cipher_context_by_hash()
      • gtmcrypt_init_device_cipher_context_by_keyname()
      • gtmcrypt_obtain_db_key_hash_by_keyname()
      • gtmcrypt_release_cipher_context()
      • gtmcrypt_same_key()
      • gtmcrypt_strerror()
  • Using the Reference Implementation with Older Releases
• 13. GT.CM Client/Server
  • Introduction
  • Overview
    • GT.CM Server
    • GT.CM Client
    • GT.CM Server Startup and Shutdown
      • GT.CM Server Startup
      • GT.CM Server Shutdown
    • Types of Operations
    • Error Messages
    • Examples
• 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
    • Normal User and Group ID Rule
      • Exceptions
    • Shared Memory Exception for BG
    • gtmsecshr Exception
      • Triggers
    • Recommendations
  • gtmsecshr Commands
  • Shared Resource Authorization Permissions
• Appendix D : Containerization and YottaDB
  • YottaDB Docker Container
    • Quick Start
      • Pre-requisites
      • Docker Pull Command
      • Image Information
      • Running a pre-built image
      • Build Steps
  • Recommendations for running YottaDB in Kubernetes
• 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
    • 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
    • C Functions
    • M Routines
    • Databases
    • Environment Variables
    • Executables
    • Include Files
    • Other (non-executable) Files
    • Local Variables
    • Permanent Global Variables
    • Dynamic M Routines
    • Temporary Global Variables
• LICENSE

Indices and tables

• Index

• Search Page