Part I. Internals

Welcome to the Guidelines for Internals of DBMS «Quantum Hybrid Base» (QHB). The main goal of this Part is to get you acquainted with basic aspects of QHB system without technical deep diving into the subject matter.

After you become familiar with this Guidelines you can proceed to Part II Installation and Configuration that describes the installation and administration of the server, or Part III The SQL Language that describes the use of the SQL language in QHB.

---

Table of Contents

• Architectural Fundamentals

• Indexes

  • B-Tree Indexes
  • GiST Indexes
  • SP-GiST Indexes
  • GIN Indexes
  • BRIN Indexes
  • Hash Indexes

• Full Text Search

  • Introduction
  • Tables and Indexes
  • Controlling Text Search
  • Additional Features
  • Parsers
  • Dictionaries
  • Configuration Example
  • Testing and Debugging Text Search
  • Preferred Index Types for Text Search
  • psql Support
  • Limitations

• Concurrency Control

  • Introduction
  • Transaction Isolation
  • Explicit Locking
  • Data Consistency Checks at the Application Level
  • Serialization Failure Handling
  • Caveats
  • Locking and Indexes

• libpq — C Library

  • Database Connection Control Functions
  • Connection Status Functions
  • Command Execution Functions
  • Asynchronous Command Processing
  • Pipeline Mode
  • Retrieving Query Results Row-by-Row
  • Canceling Queries in Progress
  • The Fast-Path Interface
  • Asynchronous Notification
  • Functions Associated with the COPY Command
  • Control Functions
  • Miscellaneous Functions
  • Notice Processing
  • Event System
  • Environment Variables
  • The Password File
  • The Connection Service File
  • LDAP Lookup of Connection Parameters
  • SSL Support
  • Behavior in Threaded Programs
  • Building libpq Programs
  • Example Programs

• Large Objects

  • Introduction
  • Implementation Features
  • Client Interfaces
  • Server-Side Functions
  • Example Program

• The Information Schema

  • The Schema
  • Data Types
  • information_schema_catalog_name
  • administrable_role_​authorizations
  • applicable_roles
  • attributes
  • character_sets
  • check_constraint_routine_usage
  • check_constraints
  • collations
  • collation_character_set_​applicability
  • column_column_usage
  • column_domain_usage
  • column_options
  • column_privileges
  • column_udt_usage
  • columns
  • constraint_column_usage
  • constraint_table_usage
  • data_type_privileges
  • domain_constraints
  • domain_udt_usage
  • domains
  • element_types
  • enabled_roles
  • foreign_data_wrapper_options
  • foreign_data_wrappers
  • foreign_server_options
  • foreign_servers
  • foreign_table_options
  • foreign_tables
  • key_column_usage
  • parameters
  • referential_constraints
  • role_column_grants
  • role_routine_grants
  • role_table_grants
  • role_udt_grants
  • role_usage_grants
  • routine_column_usage
  • routine_privileges
  • routine_routine_usage
  • routine_sequence_usage
  • routine_table_usage
  • routines
  • schemata
  • sequences
  • sql_features
  • sql_implementation_info
  • sql_parts
  • sql_sizing
  • table_constraints
  • table_privileges
  • tables
  • transforms
  • triggered_update_columns
  • triggers
  • udt_privileges
  • usage_privileges
  • user_defined_types
  • user_mapping_options
  • user_mappings
  • view_column_usage
  • view_routine_usage
  • view_table_usage
  • views

• Extending SQL

  • How Extensibility Works
  • The QHB Type System
  • User-Defined Functions
  • User-Defined Procedures
  • Query Language (SQL) Functions
  • Function Overloading
  • Function Volatility Categories
  • Procedural Language Functions
  • Internal Functions
  • Native Language Functions
  • Function Optimization Information
  • User-Defined Aggregates
  • User-Defined Types
  • User-Defined Operators
  • Operator Optimization Information
  • Interfacing Extensions to Indexes
  • Packaging Related Objects into an Extension
  • Extension Building Infrastructure

• Triggers

  • Overview of Trigger Behavior
  • Visibility of Data Changes
  • Writing Trigger Functions in C/RUST
  • A Complete Trigger Example

• Event Triggers

  • Overview of Event Trigger Behavior
  • Event Trigger Firing Matrix
  • Writing Event Trigger Functions in C/RUST
  • A Complete Event Trigger Example
  • A Table Rewrite Event Trigger Example

• The Rule System

  • The Query Tree
  • Views and the Rule System
  • Materialized Views
  • Rules on INSERT, UPDATE, and DELETE
  • Rules and Privileges
  • Rules and Command Status
  • Rules Versus Triggers

• Server Programming Interface

  • Interface Functions
  • Interface Support Functions
  • Memory Management
  • Transaction Management
  • Visibility of Data Changes
  • Examples

• Background Worker Processes

• Logical Decoding

  • Logical Decoding Examples
  • Logical Decoding Concepts
  • Streaming Replication Protocol Interface
  • Logical Decoding SQL Interface
  • System Catalogs Related to Logical Decoding
  • Logical Decoding Output Plugins
  • Logical Decoding Output Writers
  • Synchronous Replication Support for Logical Decoding
  • Streaming of Large Transactions for Logical Decoding
  • Two-phase Commit Support for Logical Decoding

• Replication Progress Tracking

• Archive Modules

  • Initialization Functions
  • Archive Module Callbacks

• qhb instance

  • Description
  • Options
  • Environment
  • Diagnostics
  • Notes
  • Bugs
  • Examples
  • See Also

• Overview of QHB Internals

  • The Path of a Query
  • How Connections Are Established
  • The Parser Stage
  • The QHB Rule System
  • Planner/Optimizer
  • Executor

• System Catalogs

  • Overview
  • pg_aggregate
  • pg_am
  • pg_amop
  • pg_amproc
  • pg_attrdef
  • pg_attribute
  • pg_authid
  • pg_auth_members
  • pg_cast
  • pg_class
  • pg_collation
  • pg_constraint
  • pg_conversion
  • pg_database
  • pg_db_role_setting
  • pg_default_acl
  • pg_depend
  • pg_description
  • pg_enum
  • pg_event_trigger
  • pg_extension
  • pg_foreign_data_wrapper
  • pg_foreign_server
  • pg_foreign_table
  • pg_index
  • pg_inherits
  • pg_init_privs
  • pg_language
  • pg_largeobject
  • pg_largeobject_metadata
  • pg_namespace
  • pg_opclass
  • pg_operator
  • pg_opfamily
  • pg_parameter_acl
  • pg_partitioned_table
  • pg_policy
  • pg_proc
  • pg_publication
  • pg_publication_namespace
  • pg_publication_rel
  • pg_range
  • pg_replication_origin
  • pg_rewrite
  • pg_seclabel
  • pg_sequence
  • pg_shdepend
  • pg_shdescription
  • pg_shseclabel
  • pg_statistic
  • pg_statistic_ext
  • pg_statistic_ext_data
  • pg_subscription
  • pg_subscription_rel
  • pg_tablespace
  • pg_transform
  • pg_trigger
  • pg_ts_config
  • pg_ts_config_map
  • pg_ts_dict
  • pg_ts_parser
  • pg_ts_template
  • pg_type
  • pg_user_mapping

• System Views

  • Overview
  • pg_available_extensions
  • pg_available_extension_versions
  • pg_config
  • pg_cursors
  • pg_file_settings
  • pg_group
  • pg_hba_file_rules
  • pg_ident_file_mappings
  • pg_indexes
  • pg_locks
  • pg_matviews
  • pg_policies
  • pg_prepared_statements
  • pg_prepared_xacts
  • pg_publication_tables
  • pg_replication_origin_status
  • pg_replication_slots
  • pg_roles
  • pg_rules
  • pg_seclabels
  • pg_sequences
  • pg_settings
  • pg_shadow
  • pg_stats
  • pg_stats_ext
  • pg_tables
  • pg_timezone_abbrevs
  • pg_timezone_names
  • pg_user
  • pg_user_mappings
  • pg_views
  • qhb_grant_info
  • qhb_stat_vacuum_tables
  • qhb_stat_vacuum_database

• Frontend/Backend Protocol

  • Overview
  • Message Flow
  • SASL Authentication
  • Streaming Replication Protocol
  • Logical Streaming Replication Protocol
  • Message Data Types
  • Message Formats
  • Error and Notice Message Fields
  • Logical Replication Message Formats
  • Summary of Changes since Protocol 2.0

• Table Access Method Interface Definition

• Index Access Method Interface Definition

  • Basic API Structure for Indexes
  • Index Access Method Functions
  • Index Scanning
  • Index Locking Considerations
  • Index Uniqueness Checks
  • Index Cost Estimation Functions

• Generic WAL Records

• Custom WAL Resource Managers

• Database Physical Storage

  • Database File Layout
  • TOAST
  • Free Space Map
  • Visibility Map
  • The Initialization Fork
  • Database Page Layout
  • Heap-Only Tuples (HOT)

• Transaction Processing

  • Transactions and Identifiers
  • Transactions and Locking
  • Subtransactions
  • Two-Phase Transactions

• System Catalog Declarations and Initial Contents

  • System Catalog Declaration Rules
  • System Catalog Initial Data
  • BKI File Format
  • BKI Commands
  • Structure of the Bootstrap BKI File
  • BKI Example

• How the Planner Uses Statistics

  • Row Estimation Examples
  • Multivariate Statistics Examples
  • Planner Statistics and Security

• Backup Manifest Format

  • Backup Manifest Top-level Object
  • Backup Manifest File Object
  • Backup Manifest WAL Range Object

• QSS Secure Storage Module

  • Description
  • Usage
  • Maintenance
  • Features and Limitations of Encryption in QHB
  • User Guide for Cold Re-encryption of QHB Database Objects

• QCP Asynchronous Connection Pool

  • Operation Framework
  • Start and Operation
  • Memory Consumption
  • Connecting to Database System
  • Applying Settings Without QCP Restarting

• QDL Data Bulk Direct Loading Module

  • Supported Field Types
  • Synopsis
  • The create_table Command
  • The insert_values Command
  • The validate Command
  • The Configuration File
  • Usage Scenario
  • See Also

• Example of Using QDL

  • General
  • Loading Data into a New Partition of an Existing Table
  • Example of Using QDL in Case of Logical Table Replication
  • Conclusion

• QDLM Loading Metric Data into a Database Module

  • Setting up Loading of Metric Data into a Database Table
  • Installing QDLM
  • Running QDLM
  • Processing Results

• TARQ Disk Block Cache Manager

• Dump and Load of the UMCA Disk Block Cache Manager Contents

  • Creating a Dump
  • Loading a Dump
  • Viewing Dump Files

• Parameter HOLDMEM and Additional Disk Block Caches

  • HOLDMEM Values
  • Compatibility
  • See Also

• Tables APPEND_ONLY

• Metric Server

  • Metric Server Configuration
  • queryid Metric Configuration

• Shared Plan Cache

  • Shared Cache Settings in qhb.conf
  • Limitations
  • Views
  • Showing the Query Plan
  • Metrics

• Built-in Message Queue

  • Description
  • Required System Configuration
  • Launching Message Queue Broker at DBMS Starting
  • Functions for Working with Message Queues
  • Message Queue Broker
  • Message Processing Procedure
  • Typing
  • Transactionality Support
  • Internal State of the Message Queue

• QSched Task Scheduler

  • Description
  • Usage
  • Number of Allowed Parallel Processes
  • QSched Limitations

• Session Level Variables qhb-variables

  • Description
  • qhb-variables Functions
  • Other Usage Examples

• Profiling Long Queries

  • Preparation
  • Information Analysis
  • Limitations

• Cluster Computing Management Module QLUSTER

  • Purpose and General Architecture
  • QLUSTER Installation
  • Setting Up the Configuration File
  • Reinitializing a Cluster Under QLUSTER Control
  • List of Commands
  • Important Features
  • qluster rest api Description
  • QRAFT Protocol Description

• QMAN — application for monitoring and managing QHB instances

  • Description
  • Installing Components
  • QMAN Interface Application
  • QMAN — Command Reference