- About MogDB
- Quick Start
- MogDB Playground
- Container-based MogDB Installation
- Installation on a Single Node
- MogDB Access
- Use CLI to Access MogDB
- Use GUI to Access MogDB
- Use Middleware to Access MogDB
- Use Programming Language to Access MogDB
- Using Sample Dataset Mogila
- Characteristic Description
- Overview
- High Performance
- High Availability (HA)
- Primary/Standby
- Logical Replication
- Online Node Replacement
- Logical Backup
- Physical Backup
- Automatic Job Retry upon Failure
- Ultimate RTO
- Cascaded Standby Server
- Delayed Replay
- Adding or Deleting a Standby Server
- Delaying Entering the Maximum Availability Mode
- Parallel Logical Decoding
- DCF
- CM
- Global SysCache
- Using a Standby Node to Build a Standby Node
- Maintainability
- Database Security
- Access Control Model
- Separation of Control and Access Permissions
- Database Encryption Authentication
- Data Encryption and Storage
- Database Audit
- Network Communication Security
- Resource Label
- Unified Audit
- Dynamic Data Anonymization
- Row-Level Access Control
- Password Strength Verification
- Equality Query in a Fully-encrypted Database
- Ledger Database Mechanism
- Transparent Data Encryption
- Enterprise-Level Features
- Support for Functions and Stored Procedures
- SQL Hints
- Full-Text Indexing
- Copy Interface for Error Tolerance
- Partitioning
- Support for Advanced Analysis Functions
- Materialized View
- HyperLogLog
- Creating an Index Online
- Autonomous Transaction
- Global Temporary Table
- Pseudocolumn ROWNUM
- Stored Procedure Debugging
- JDBC Client Load Balancing and Read/Write Isolation
- In-place Update Storage Engine
- Publication-Subscription
- Foreign Key Lock Enhancement
- Data Compression in OLTP Scenarios
- Transaction Async Submit
- Index Creation Parallel Control
- Dynamic Partition Pruning
- COPY Import Optimization
- SQL Running Status Observation
- BRIN Index
- BLOOM Index
- Application Development Interfaces
- AI Capabilities
- Middleware
- Installation Guide
- Installation Preparation
- Container Installation
- PTK-based Installation
- OM-based Installation
- Manual Installation
- Recommended Parameter Settings
- Administrator Guide
- Localization
- Routine Maintenance
- Starting and Stopping MogDB
- Using the gsql Client for Connection
- Routine Maintenance
- Checking OS Parameters
- Checking MogDB Health Status
- Checking Database Performance
- Checking and Deleting Logs
- Checking Time Consistency
- Checking The Number of Application Connections
- Routinely Maintaining Tables
- Routinely Recreating an Index
- Data Security Maintenance Suggestions
- Slow SQL Diagnosis
- Log Reference
- Primary and Standby Management
- MOT Engine
- Introducing MOT
- Using MOT
- Concepts of MOT
- Appendix
- Column-store Tables Management
- Backup and Restoration
- Importing and Exporting Data
- Importing Data
- Exporting Data
- Upgrade Guide
- AI Features Guide
- AI Features Overview
- AI4DB: Autonomous Database O&M
- DBMind Mode
- Components that Support DBMind
- AI Sub-functions of the DBMind
- X-Tuner: Parameter Tuning and Diagnosis
- Index-advisor: Index Recommendation
- AI4DB: Root Cause Analysis for Slow SQL Statements
- AI4DB: Trend Prediction
- SQLdiag: Slow SQL Discovery
- DB4AI: Database-driven AI
- AI in DB
- Intelligence Explain: SQL Statement Query Time Prediction
- Security Guide
- Developer Guide
- Application Development Guide
- Development Specifications
- Development Based on JDBC
- Overview
- JDBC Package, Driver Class, and Environment Class
- Development Process
- Loading the Driver
- Connecting to a Database
- Connecting to the Database (Using SSL)
- Running SQL Statements
- Processing Data in a Result Set
- Closing a Connection
- Managing Logs
- Example: Common Operations
- Example: Retrying SQL Queries for Applications
- Example: Importing and Exporting Data Through Local Files
- Example 2: Migrating Data from a MY Database to MogDB
- Example: Logic Replication Code
- Example: Parameters for Connecting to the Database in Different Scenarios
- JDBC API Reference
- java.sql.Connection
- java.sql.CallableStatement
- java.sql.DatabaseMetaData
- java.sql.Driver
- java.sql.PreparedStatement
- java.sql.ResultSet
- java.sql.ResultSetMetaData
- java.sql.Statement
- javax.sql.ConnectionPoolDataSource
- javax.sql.DataSource
- javax.sql.PooledConnection
- javax.naming.Context
- javax.naming.spi.InitialContextFactory
- CopyManager
- Development Based on ODBC
- Development Based on libpq
- Dependent Header Files of libpq
- Development Process
- Example
- Link Parameters
- libpq API Reference
- Database Connection Control Functions
- Database Statement Execution Functions
- Functions for Asynchronous Command Processing
- Functions for Canceling Queries in Progress
- Psycopg-Based Development
- Commissioning
- Stored Procedure
- User Defined Functions
- PL/pgSQL-SQL Procedural Language
- Scheduled Jobs
- Autonomous Transaction
- Logical Replication
- Foreign Data Wrapper
- Materialized View
- Materialized View Overview
- Full Materialized View
- Incremental Materialized View
- Partition Management
- Partition Pruning
- Recommendations For Choosing A Partitioning Strategy
- Application Development Guide
- Performance Tuning Guide
- System Optimization
- SQL Optimization
- WDR Snapshot
- Using the Vectorized Executor for Tuning
- TPC-C Performance Tunning Guide
- Reference Guide
- System Catalogs and System Views
- Overview of System Catalogs and System Views
- System Catalogs
- GS_ASP
- GS_AUDITING_POLICY
- GS_AUDITING_POLICY_ACCESS
- GS_AUDITING_POLICY_FILTERS
- GS_AUDITING_POLICY_PRIVILEGES
- GS_CLIENT_GLOBAL_KEYS
- GS_CLIENT_GLOBAL_KEYS_ARGS
- GS_COLUMN_KEYS
- GS_COLUMN_KEYS_ARGS
- GS_DB_PRIVILEGE
- GS_ENCRYPTED_COLUMNS
- GS_ENCRYPTED_PROC
- GS_GLOBAL_CHAIN
- GS_GLOBAL_CONFIG
- GS_MASKING_POLICY
- GS_MASKING_POLICY_ACTIONS
- GS_MASKING_POLICY_FILTERS
- GS_MATVIEW
- GS_MATVIEW_DEPENDENCY
- GS_MODEL_WAREHOUSE
- GS_OPT_MODEL
- GS_PACKAGE
- GS_POLICY_LABEL
- GS_RECYCLEBIN
- GS_TXN_SNAPSHOT
- GS_UID
- GS_WLM_EC_OPERATOR_INFO
- GS_WLM_INSTANCE_HISTORY
- GS_WLM_OPERATOR_INFO
- GS_WLM_PLAN_ENCODING_TABLE
- GS_WLM_PLAN_OPERATOR_INFO
- GS_WLM_SESSION_QUERY_INFO_ALL
- GS_WLM_USER_RESOURCE_HISTORY
- PG_AGGREGATE
- PG_AM
- PG_AMOP
- PG_AMPROC
- PG_APP_WORKLOADGROUP_MAPPING
- PG_ATTRDEF
- PG_ATTRIBUTE
- PG_AUTH_HISTORY
- PG_AUTH_MEMBERS
- PG_AUTHID
- PG_CAST
- PG_CLASS
- PG_COLLATION
- PG_CONSTRAINT
- PG_CONVERSION
- PG_DATABASE
- PG_DB_ROLE_SETTING
- PG_DEFAULT_ACL
- PG_DEPEND
- PG_DESCRIPTION
- PG_DIRECTORY
- PG_ENUM
- PG_EXTENSION
- PG_EXTENSION_DATA_SOURCE
- PG_FOREIGN_DATA_WRAPPER
- PG_FOREIGN_SERVER
- PG_FOREIGN_TABLE
- PG_HASHBUCKET
- PG_INDEX
- PG_INHERITS
- PG_JOB
- PG_JOB_PROC
- PG_LANGUAGE
- PG_LARGEOBJECT
- PG_LARGEOBJECT_METADATA
- PG_NAMESPACE
- PG_OBJECT
- PG_OPCLASS
- PG_OPERATOR
- PG_OPFAMILY
- PG_PARTITION
- PG_PLTEMPLATE
- PG_PROC
- PG_PUBLICATION
- PG_PUBLICATION_REL
- PG_RANGE
- PG_REPLICATION_ORIGIN
- PG_RESOURCE_POOL
- PG_REWRITE
- PG_RLSPOLICY
- PG_SECLABEL
- PG_SHDEPEND
- PG_SHDESCRIPTION
- PG_SHSECLABEL
- PG_STATISTIC
- PG_STATISTIC_EXT
- PG_SUBSCRIPTION
- PG_SYNONYM
- PG_TABLESPACE
- PG_TRIGGER
- PG_TS_CONFIG
- PG_TS_CONFIG_MAP
- PG_TS_DICT
- PG_TS_PARSER
- PG_TS_TEMPLATE
- PG_TYPE
- PG_USER_MAPPING
- PG_USER_STATUS
- PG_WORKLOAD_GROUP
- PGXC_CLASS
- PGXC_GROUP
- PGXC_NODE
- PGXC_SLICE
- PLAN_TABLE_DATA
- STATEMENT_HISTORY
- System Views
- DV_SESSION_LONGOPS
- DV_SESSIONS
- GET_GLOBAL_PREPARED_XACTS(Discarded)
- GS_AUDITING
- GS_AUDITING_ACCESS
- GS_AUDITING_PRIVILEGE
- GS_ASYNC_SUBMIT_SESSIONS_STATUS
- GS_CLUSTER_RESOURCE_INFO
- GS_DB_PRIVILEGES
- GS_FILE_STAT
- GS_GSC_MEMORY_DETAIL
- GS_INSTANCE_TIME
- GS_LABELS
- GS_LSC_MEMORY_DETAIL
- GS_MASKING
- GS_MATVIEWS
- GS_OS_RUN_INFO
- GS_REDO_STAT
- GS_SESSION_CPU_STATISTICS
- GS_SESSION_MEMORY
- GS_SESSION_MEMORY_CONTEXT
- GS_SESSION_MEMORY_DETAIL
- GS_SESSION_MEMORY_STATISTICS
- GS_SESSION_STAT
- GS_SESSION_TIME
- GS_SQL_COUNT
- GS_STAT_SESSION_CU
- GS_THREAD_MEMORY_CONTEXT
- GS_TOTAL_MEMORY_DETAIL
- GS_WLM_CGROUP_INFO
- GS_WLM_EC_OPERATOR_STATISTICS
- GS_WLM_OPERATOR_HISTORY
- GS_WLM_OPERATOR_STATISTICS
- GS_WLM_PLAN_OPERATOR_HISTORY
- GS_WLM_REBUILD_USER_RESOURCE_POOL
- GS_WLM_RESOURCE_POOL
- GS_WLM_SESSION_HISTORY
- GS_WLM_SESSION_INFO
- GS_WLM_SESSION_INFO_ALL
- GS_WLM_SESSION_STATISTICS
- GS_WLM_USER_INFO
- GS_WRITE_TERM_LOG
- MPP_TABLES
- PG_AVAILABLE_EXTENSION_VERSIONS
- PG_AVAILABLE_EXTENSIONS
- PG_COMM_DELAY
- PG_COMM_RECV_STREAM
- PG_COMM_SEND_STREAM
- PG_COMM_STATUS
- PG_CONTROL_GROUP_CONFIG
- PG_CURSORS
- PG_EXT_STATS
- PG_GET_INVALID_BACKENDS
- PG_GET_SENDERS_CATCHUP_TIME
- PG_GROUP
- PG_GTT_ATTACHED_PIDS
- PG_GTT_RELSTATS
- PG_GTT_STATS
- PG_INDEXES
- PG_LOCKS
- PG_NODE_ENV
- PG_OS_THREADS
- PG_PREPARED_STATEMENTS
- PG_PREPARED_XACTS
- PG_PUBLICATION_TABLES
- PG_REPLICATION_ORIGIN_STATUS
- PG_REPLICATION_SLOTS
- PG_RLSPOLICIES
- PG_ROLES
- PG_RULES
- PG_RUNNING_XACTS
- PG_SECLABELS
- PG_SESSION_IOSTAT
- PG_SESSION_WLMSTAT
- PG_SETTINGS
- PG_SHADOW
- PG_STAT_ACTIVITY
- PG_STAT_ACTIVITY_NG
- PG_STAT_ALL_INDEXES
- PG_STAT_ALL_TABLES
- PG_STAT_BAD_BLOCK
- PG_STAT_BGWRITER
- PG_STAT_DATABASE
- PG_STAT_DATABASE_CONFLICTS
- PG_STAT_REPLICATION
- PG_STAT_SUBSCRIPTION
- PG_STAT_SYS_INDEXES
- PG_STAT_SYS_TABLES
- PG_STAT_USER_FUNCTIONS
- PG_STAT_USER_INDEXES
- PG_STAT_USER_TABLES
- PG_STAT_XACT_ALL_TABLES
- PG_STAT_XACT_SYS_TABLES
- PG_STAT_XACT_USER_FUNCTIONS
- PG_STAT_XACT_USER_TABLES
- PG_STATIO_ALL_INDEXES
- PG_STATIO_ALL_SEQUENCES
- PG_STATIO_ALL_TABLES
- PG_STATIO_SYS_INDEXES
- PG_STATIO_SYS_SEQUENCES
- PG_STATIO_SYS_TABLES
- PG_STATIO_USER_INDEXES
- PG_STATIO_USER_SEQUENCES
- PG_STATIO_USER_TABLES
- PG_STATS
- PG_TABLES
- PG_TDE_INFO
- PG_THREAD_WAIT_STATUS
- PG_TIMEZONE_ABBREVS
- PG_TIMEZONE_NAMES
- PG_TOTAL_MEMORY_DETAIL
- PG_TOTAL_USER_RESOURCE_INFO
- PG_TOTAL_USER_RESOURCE_INFO_OID
- PG_USER
- PG_USER_MAPPINGS
- PG_VARIABLE_INFO
- PG_VIEWS
- PG_WLM_STATISTICS
- PGXC_PREPARED_XACTS
- PLAN_TABLE
- Functions and Operators
- Logical Operators
- Comparison Operators
- Character Processing Functions and Operators
- Binary String Functions and Operators
- Bit String Functions and Operators
- Mode Matching Operators
- Mathematical Functions and Operators
- Date and Time Processing Functions and Operators
- Type Conversion Functions
- Geometric Functions and Operators
- Network Address Functions and Operators
- Text Search Functions and Operators
- JSON/JSONB Functions and Operators
- HLL Functions and Operators
- SEQUENCE Functions
- Array Functions and Operators
- Range Functions and Operators
- Aggregate Functions
- Window Functions(Analysis Functions)
- Security Functions
- Ledger Database Functions
- Encrypted Equality Functions
- Set Returning Functions
- Conditional Expression Functions
- System Information Functions
- System Administration Functions
- Configuration Settings Functions
- Universal File Access Functions
- Server Signal Functions
- Backup and Restoration Control Functions
- Snapshot Synchronization Functions
- Database Object Functions
- Advisory Lock Functions
- Logical Replication Functions
- Segment-Page Storage Functions
- Other Functions
- Undo System Functions
- Statistics Information Functions
- Trigger Functions
- Hash Function
- Prompt Message Function
- Global Temporary Table Functions
- Fault Injection System Function
- AI Feature Functions
- Dynamic Data Masking Functions
- Other System Functions
- Internal Functions
- Global SysCache Feature Functions
- Data Damage Detection and Repair Functions
- Obsolete Functions
- Supported Data Types
- Numeric Types
- Monetary Types
- Boolean Types
- Enumerated Types
- Character Types
- Binary Types
- Date/Time Types
- Geometric
- Network Address Types
- Bit String Types
- Text Search Types
- UUID
- JSON/JSONB Types
- HLL
- Array Types
- Range
- OID Types
- Pseudo-Types
- Data Types Supported by Column-store Tables
- XML Types
- Data Type Used by the Ledger Database
- SQL Syntax
- ABORT
- ALTER AGGREGATE
- ALTER AUDIT POLICY
- ALTER DATABASE
- ALTER DATA SOURCE
- ALTER DEFAULT PRIVILEGES
- ALTER DIRECTORY
- ALTER EXTENSION
- ALTER FOREIGN TABLE
- ALTER FUNCTION
- ALTER GLOBAL CONFIGURATION
- ALTER GROUP
- ALTER INDEX
- ALTER LANGUAGE
- ALTER LARGE OBJECT
- ALTER MASKING POLICY
- ALTER MATERIALIZED VIEW
- ALTER PACKAGE
- ALTER PROCEDURE
- ALTER PUBLICATION
- ALTER RESOURCE LABEL
- ALTER RESOURCE POOL
- ALTER ROLE
- ALTER ROW LEVEL SECURITY POLICY
- ALTER RULE
- ALTER SCHEMA
- ALTER SEQUENCE
- ALTER SERVER
- ALTER SESSION
- ALTER SUBSCRIPTION
- ALTER SYNONYM
- ALTER SYSTEM KILL SESSION
- ALTER SYSTEM SET
- ALTER TABLE
- ALTER TABLE PARTITION
- ALTER TABLE SUBPARTITION
- ALTER TABLESPACE
- ALTER TEXT SEARCH CONFIGURATION
- ALTER TEXT SEARCH DICTIONARY
- ALTER TRIGGER
- ALTER TYPE
- ALTER USER
- ALTER USER MAPPING
- ALTER VIEW
- ANALYZE | ANALYSE
- BEGIN
- CALL
- CHECKPOINT
- CLEAN CONNECTION
- CLOSE
- CLUSTER
- COMMENT
- COMMIT | END
- COMMIT PREPARED
- CONNECT BY
- COPY
- CREATE AGGREGATE
- CREATE AUDIT POLICY
- CREATE CAST
- CREATE CLIENT MASTER KEY
- CREATE COLUMN ENCRYPTION KEY
- CREATE DATABASE
- CREATE DATA SOURCE
- CREATE DIRECTORY
- CREATE EXTENSION
- CREATE FOREIGN TABLE
- CREATE FUNCTION
- CREATE GROUP
- CREATE INCREMENTAL MATERIALIZED VIEW
- CREATE INDEX
- CREATE LANGUAGE
- CREATE MASKING POLICY
- CREATE MATERIALIZED VIEW
- CREATE MODEL
- CREATE OPERATOR
- CREATE PACKAGE
- CREATE PROCEDURE
- CREATE PUBLICATION
- CREATE RESOURCE LABEL
- CREATE RESOURCE POOL
- CREATE ROLE
- CREATE ROW LEVEL SECURITY POLICY
- CREATE RULE
- CREATE SCHEMA
- CREATE SEQUENCE
- CREATE SERVER
- CREATE SUBSCRIPTION
- CREATE SYNONYM
- CREATE TABLE
- CREATE TABLE AS
- CREATE TABLE PARTITION
- CREATE TABLE SUBPARTITION
- CREATE TABLESPACE
- CREATE TEXT SEARCH CONFIGURATION
- CREATE TEXT SEARCH DICTIONARY
- CREATE TRIGGER
- CREATE TYPE
- CREATE USER
- CREATE USER MAPPING
- CREATE VIEW
- CREATE WEAK PASSWORD DICTIONARY
- CURSOR
- DEALLOCATE
- DECLARE
- DELETE
- DO
- DROP AGGREGATE
- DROP AUDIT POLICY
- DROP CAST
- DROP CLIENT MASTER KEY
- DROP COLUMN ENCRYPTION KEY
- DROP DATABASE
- DROP DATA SOURCE
- DROP DIRECTORY
- DROP EXTENSION
- DROP FOREIGN TABLE
- DROP FUNCTION
- DROP GLOBAL CONFIGURATION
- DROP GROUP
- DROP INDEX
- DROP LANGUAGE
- DROP MASKING POLICY
- DROP MATERIALIZED VIEW
- DROP MODEL
- DROP OPERATOR
- DROP OWNED
- DROP PACKAGE
- DROP PROCEDURE
- DROP PUBLICATION
- DROP RESOURCE LABEL
- DROP RESOURCE POOL
- DROP ROLE
- DROP ROW LEVEL SECURITY POLICY
- DROP RULE
- DROP SCHEMA
- DROP SEQUENCE
- DROP SERVER
- DROP SUBSCRIPTION
- DROP SYNONYM
- DROP TABLE
- DROP TABLESPACE
- DROP TEXT SEARCH CONFIGURATION
- DROP TEXT SEARCH DICTIONARY
- DROP TRIGGER
- DROP TYPE
- DROP USER
- DROP USER MAPPING
- DROP VIEW
- DROP WEAK PASSWORD DICTIONARY
- EXECUTE
- EXECUTE DIRECT
- EXPLAIN
- EXPLAIN PLAN
- FETCH
- GRANT
- INSERT
- LOCK
- MERGE INTO
- MOVE
- PREDICT BY
- PREPARE
- PREPARE TRANSACTION
- PURGE
- REASSIGN OWNED
- REFRESH INCREMENTAL MATERIALIZED VIEW
- REFRESH MATERIALIZED VIEW
- REINDEX
- RELEASE SAVEPOINT
- RESET
- REVOKE
- ROLLBACK
- ROLLBACK PREPARED
- ROLLBACK TO SAVEPOINT
- SAVEPOINT
- SELECT
- SELECT INTO
- SET
- SET CONSTRAINTS
- SET ROLE
- SET SESSION AUTHORIZATION
- SET TRANSACTION
- SHOW
- SHUTDOWN
- SNAPSHOT
- START TRANSACTION
- TIMECAPSULE TABLE
- TRUNCATE
- UPDATE
- VACUUM
- VALUES
- SQL Reference
- MogDB SQL
- Keywords
- Constant and Macro
- Expressions
- Type Conversion
- Full Text Search
- Introduction
- Tables and Indexes
- Controlling Text Search
- Additional Features
- Parser
- Dictionaries
- Configuration Examples
- Testing and Debugging Text Search
- Limitations
- System Operation
- Controlling Transactions
- DDL Syntax Overview
- DML Syntax Overview
- DCL Syntax Overview
- Appendix
- GUC Parameters
- GUC Parameter Usage
- GUC Parameter List
- File Location
- Connection and Authentication
- Resource Consumption
- Write Ahead Log
- HA Replication
- Memory Table
- Query Planning
- Error Reporting and Logging
- Alarm Detection
- Statistics During the Database Running
- Load Management
- Automatic Vacuuming
- Default Settings of Client Connection
- Lock Management
- Version and Platform Compatibility
- Faut Tolerance
- Connection Pool Parameters
- MogDB Transaction
- Developer Options
- Auditing
- SQL Mode
- Upgrade Parameters
- Miscellaneous Parameters
- Wait Events
- Query
- System Performance Snapshot
- Security Configuration
- Global Temporary Table
- HyperLogLog
- Scheduled Task
- Thread Pool
- User-defined Functions
- Backup and Restoration
- DCF Parameters Settings
- Flashback
- Rollback Parameters
- Reserved Parameters
- AI Features
- Global SysCache Parameters
- Appendix
- Schema
- Information Schema
- DBE_PERF
- Overview
- OS
- Instance
- Memory
- File
- Object
- STAT_USER_TABLES
- SUMMARY_STAT_USER_TABLES
- GLOBAL_STAT_USER_TABLES
- STAT_USER_INDEXES
- SUMMARY_STAT_USER_INDEXES
- GLOBAL_STAT_USER_INDEXES
- STAT_SYS_TABLES
- SUMMARY_STAT_SYS_TABLES
- GLOBAL_STAT_SYS_TABLES
- STAT_SYS_INDEXES
- SUMMARY_STAT_SYS_INDEXES
- GLOBAL_STAT_SYS_INDEXES
- STAT_ALL_TABLES
- SUMMARY_STAT_ALL_TABLES
- GLOBAL_STAT_ALL_TABLES
- STAT_ALL_INDEXES
- SUMMARY_STAT_ALL_INDEXES
- GLOBAL_STAT_ALL_INDEXES
- STAT_DATABASE
- SUMMARY_STAT_DATABASE
- GLOBAL_STAT_DATABASE
- STAT_DATABASE_CONFLICTS
- SUMMARY_STAT_DATABASE_CONFLICTS
- GLOBAL_STAT_DATABASE_CONFLICTS
- STAT_XACT_ALL_TABLES
- SUMMARY_STAT_XACT_ALL_TABLES
- GLOBAL_STAT_XACT_ALL_TABLES
- STAT_XACT_SYS_TABLES
- SUMMARY_STAT_XACT_SYS_TABLES
- GLOBAL_STAT_XACT_SYS_TABLES
- STAT_XACT_USER_TABLES
- SUMMARY_STAT_XACT_USER_TABLES
- GLOBAL_STAT_XACT_USER_TABLES
- STAT_XACT_USER_FUNCTIONS
- SUMMARY_STAT_XACT_USER_FUNCTIONS
- GLOBAL_STAT_XACT_USER_FUNCTIONS
- STAT_BAD_BLOCK
- SUMMARY_STAT_BAD_BLOCK
- GLOBAL_STAT_BAD_BLOCK
- STAT_USER_FUNCTIONS
- SUMMARY_STAT_USER_FUNCTIONS
- GLOBAL_STAT_USER_FUNCTIONS
- Workload
- Session/Thread
- SESSION_STAT
- GLOBAL_SESSION_STAT
- SESSION_TIME
- GLOBAL_SESSION_TIME
- SESSION_MEMORY
- GLOBAL_SESSION_MEMORY
- SESSION_MEMORY_DETAIL
- GLOBAL_SESSION_MEMORY_DETAIL
- SESSION_STAT_ACTIVITY
- GLOBAL_SESSION_STAT_ACTIVITY
- THREAD_WAIT_STATUS
- GLOBAL_THREAD_WAIT_STATUS
- LOCAL_THREADPOOL_STATUS
- GLOBAL_THREADPOOL_STATUS
- SESSION_CPU_RUNTIME
- SESSION_MEMORY_RUNTIME
- STATEMENT_IOSTAT_COMPLEX_RUNTIME
- LOCAL_ACTIVE_SESSION
- Transaction
- Query
- STATEMENT
- SUMMARY_STATEMENT
- STATEMENT_COUNT
- GLOBAL_STATEMENT_COUNT
- SUMMARY_STATEMENT_COUNT
- GLOBAL_STATEMENT_COMPLEX_HISTORY
- GLOBAL_STATEMENT_COMPLEX_HISTORY_TABLE
- GLOBAL_STATEMENT_COMPLEX_RUNTIME
- STATEMENT_RESPONSETIME_PERCENTILE
- STATEMENT_USER_COMPLEX_HISTORY
- STATEMENT_COMPLEX_RUNTIME
- STATEMENT_COMPLEX_HISTORY_TABLE
- STATEMENT_COMPLEX_HISTORY
- STATEMENT_WLMSTAT_COMPLEX_RUNTIME
- STATEMENT_HISTORY
- Cache/IO
- STATIO_USER_TABLES
- SUMMARY_STATIO_USER_TABLES
- GLOBAL_STATIO_USER_TABLES
- STATIO_USER_INDEXES
- SUMMARY_STATIO_USER_INDEXES
- GLOBAL_STATIO_USER_INDEXES
- STATIO_USER_SEQUENCES
- SUMMARY_STATIO_USER_SEQUENCES
- GLOBAL_STATIO_USER_SEQUENCES
- STATIO_SYS_TABLES
- SUMMARY_STATIO_SYS_TABLES
- GLOBAL_STATIO_SYS_TABLES
- STATIO_SYS_INDEXES
- SUMMARY_STATIO_SYS_INDEXES
- GLOBAL_STATIO_SYS_INDEXES
- STATIO_SYS_SEQUENCES
- SUMMARY_STATIO_SYS_SEQUENCES
- GLOBAL_STATIO_SYS_SEQUENCES
- STATIO_ALL_TABLES
- SUMMARY_STATIO_ALL_TABLES
- GLOBAL_STATIO_ALL_TABLES
- STATIO_ALL_INDEXES
- SUMMARY_STATIO_ALL_INDEXES
- GLOBAL_STATIO_ALL_INDEXES
- STATIO_ALL_SEQUENCES
- SUMMARY_STATIO_ALL_SEQUENCES
- GLOBAL_STATIO_ALL_SEQUENCES
- GLOBAL_STAT_DB_CU
- GLOBAL_STAT_SESSION_CU
- Utility
- REPLICATION_STAT
- GLOBAL_REPLICATION_STAT
- REPLICATION_SLOTS
- GLOBAL_REPLICATION_SLOTS
- BGWRITER_STAT
- GLOBAL_BGWRITER_STAT
- GLOBAL_CKPT_STATUS
- GLOBAL_DOUBLE_WRITE_STATUS
- GLOBAL_PAGEWRITER_STATUS
- GLOBAL_RECORD_RESET_TIME
- GLOBAL_REDO_STATUS
- GLOBAL_RECOVERY_STATUS
- CLASS_VITAL_INFO
- USER_LOGIN
- SUMMARY_USER_LOGIN
- GLOBAL_GET_BGWRITER_STATUS
- GLOBAL_SINGLE_FLUSH_DW_STATUS
- GLOBAL_CANDIDATE_STATUS
- Lock
- Wait Events
- Configuration
- Operator
- Workload Manager
- Global Plancache
- RTO
- DBE_PLDEBUGGER Schema
- Overview
- DBE_PLDEBUGGER.turn_on
- DBE_PLDEBUGGER.turn_off
- DBE_PLDEBUGGER.local_debug_server_info
- DBE_PLDEBUGGER.attach
- DBE_PLDEBUGGER.info_locals
- DBE_PLDEBUGGER.next
- DBE_PLDEBUGGER.continue
- DBE_PLDEBUGGER.abort
- DBE_PLDEBUGGER.print_var
- DBE_PLDEBUGGER.info_code
- DBE_PLDEBUGGER.step
- DBE_PLDEBUGGER.add_breakpoint
- DBE_PLDEBUGGER.delete_breakpoint
- DBE_PLDEBUGGER.info_breakpoints
- DBE_PLDEBUGGER.backtrace
- DBE_PLDEBUGGER.disable_breakpoint
- DBE_PLDEBUGGER.enable_breakpoint
- DBE_PLDEBUGGER.finish
- DBE_PLDEBUGGER.set_var
- DB4AI Schema
- DBE_PLDEVELOPER
- Tool Reference
- Tool Overview
- Client Tool
- Server Tools
- Tools Used in the Internal System
- mogdb
- gs_backup
- gs_basebackup
- gs_ctl
- gs_initdb
- gs_install
- gs_install_plugin
- gs_install_plugin_local
- gs_preinstall
- gs_sshexkey
- gs_tar
- gs_uninstall
- gs_upgradectl
- gs_expansion
- gs_dropnode
- gs_probackup
- gstrace
- kdb5_util
- kadmin.local
- kinit
- klist
- krb5kdc
- kdestroy
- pg_config
- pg_controldata
- pg_recvlogical
- pg_resetxlog
- pg_archivecleanup
- pssh
- pscp
- transfer.py
- Unified Database Management Tool
- FAQ
- Functions of MogDB Executable Scripts
- System Catalogs and Views Supported by gs_collector
- Extension Reference
- Error Code Reference
- Description of SQL Error Codes
- Third-Party Library Error Codes
- GAUSS-00001 - GAUSS-00100
- GAUSS-00101 - GAUSS-00200
- GAUSS 00201 - GAUSS 00300
- GAUSS 00301 - GAUSS 00400
- GAUSS 00401 - GAUSS 00500
- GAUSS 00501 - GAUSS 00600
- GAUSS 00601 - GAUSS 00700
- GAUSS 00701 - GAUSS 00800
- GAUSS 00801 - GAUSS 00900
- GAUSS 00901 - GAUSS 01000
- GAUSS 01001 - GAUSS 01100
- GAUSS 01101 - GAUSS 01200
- GAUSS 01201 - GAUSS 01300
- GAUSS 01301 - GAUSS 01400
- GAUSS 01401 - GAUSS 01500
- GAUSS 01501 - GAUSS 01600
- GAUSS 01601 - GAUSS 01700
- GAUSS 01701 - GAUSS 01800
- GAUSS 01801 - GAUSS 01900
- GAUSS 01901 - GAUSS 02000
- GAUSS 02001 - GAUSS 02100
- GAUSS 02101 - GAUSS 02200
- GAUSS 02201 - GAUSS 02300
- GAUSS 02301 - GAUSS 02400
- GAUSS 02401 - GAUSS 02500
- GAUSS 02501 - GAUSS 02600
- GAUSS 02601 - GAUSS 02700
- GAUSS 02701 - GAUSS 02800
- GAUSS 02801 - GAUSS 02900
- GAUSS 02901 - GAUSS 03000
- GAUSS 03001 - GAUSS 03100
- GAUSS 03101 - GAUSS 03200
- GAUSS 03201 - GAUSS 03300
- GAUSS 03301 - GAUSS 03400
- GAUSS 03401 - GAUSS 03500
- GAUSS 03501 - GAUSS 03600
- GAUSS 03601 - GAUSS 03700
- GAUSS 03701 - GAUSS 03800
- GAUSS 03801 - GAUSS 03900
- GAUSS 03901 - GAUSS 04000
- GAUSS 04001 - GAUSS 04100
- GAUSS 04101 - GAUSS 04200
- GAUSS 04201 - GAUSS 04300
- GAUSS 04301 - GAUSS 04400
- GAUSS 04401 - GAUSS 04500
- GAUSS 04501 - GAUSS 04600
- GAUSS 04601 - GAUSS 04700
- GAUSS 04701 - GAUSS 04800
- GAUSS 04801 - GAUSS 04900
- GAUSS 04901 - GAUSS 05000
- GAUSS 05001 - GAUSS 05100
- GAUSS 05101 - GAUSS 05200
- GAUSS 05201 - GAUSS 05300
- GAUSS 05301 - GAUSS 05400
- GAUSS 05401 - GAUSS 05500
- GAUSS 05501 - GAUSS 05600
- GAUSS 05601 - GAUSS 05700
- GAUSS 05701 - GAUSS 05800
- GAUSS 05801 - GAUSS 05900
- GAUSS 05901 - GAUSS 06000
- GAUSS 06001 - GAUSS 06100
- GAUSS 06101 - GAUSS 06200
- GAUSS 06201 - GAUSS 06300
- GAUSS 06301 - GAUSS 06400
- GAUSS 06401 - GAUSS 06500
- GAUSS 06501 - GAUSS 06600
- GAUSS 06601 - GAUSS 06700
- GAUSS 06701 - GAUSS 06800
- GAUSS 06801 - GAUSS 06900
- GAUSS 06901 - GAUSS 07000
- GAUSS 07001 - GAUSS 07100
- GAUSS 07101 - GAUSS 07200
- GAUSS 07201 - GAUSS 07300
- GAUSS 07301 - GAUSS 07400
- GAUSS 07401 - GAUSS 07480
- GAUSS 50000 - GAUSS 50999
- GAUSS 51000 - GAUSS 51999
- GAUSS 52000 - GAUSS 52999
- GAUSS 53000 - GAUSS 53699
- Error Log Reference
- System Catalogs and System Views
- Common Faults and Identification
- Common Fault Locating Methods
- Common Fault Locating Cases
- Core Fault Locating
- Permission/Session/Data Type Fault Location
- Service/High Availability/Concurrency Fault Location
- Table/Partition Table Fault Location
- File System/Disk/Memory Fault Location
- After You Run the du Command to Query Data File Size In the XFS File System, the Query Result Is Greater than the Actual File Size
- File Is Damaged in the XFS File System
- Insufficient Memory
- "Error:No space left on device" Is Displayed
- When the TPC-C is running and a disk to be injected is full, the TPC-C stops responding
- Disk Space Usage Reaches the Threshold and the Database Becomes Read-only
- SQL Fault Location
- Index Fault Location
- Source Code Parsing
- FAQs
- Glossary
- Mogeaver
Other Functions
-
plan_seed()
Description: Obtains the seed value of the previous query statement (internal use).
Return type: int
-
pg_stat_get_env()
Description: Obtains the environment variable information of the current node. Only users with the sysadmin or monitor admin permission can access the environment variable information.
Return type: record
Example:
MogDB=# select pg_stat_get_env(); pg_stat_get_env --------------------------------------------------------------------------------------------------------------------------------------- (coordinator1,localhost,144773,49100,/data1/GaussDB_Kernel_TRUNK/install,/data1/GaussDB_Kernel_TRUNK/install/data/coordinator1,pg_log) (1 row)
-
pg_catalog.plancache_clean()
Description: Clears the global plan cache that is not used on nodes.
Return type: Boolean
-
pg_catalog.plancache_status()
Description: Displays information about the global plan cache on nodes. The information returned by the function is the same as that in GLOBAL_PLANCACHE_STATUS.
Return type: record
-
textlen(text)
Description: Provides the method of querying the logical length of text.
Return type: int
-
threadpool_status()
Description: Displays the status of worker threads and sessions in the thread pool.
Return type: record
-
get_local_active_session()
Description: Provides sampling records of the historical active sessions stored in the memory of the current node.
Return type: record
-
pg_stat_get_thread()
Description: Provides status information about all threads on the current node. Users with the sysadmin or monitor admin permission can view information about all threads, and common users can view only their own thread information.
Return type: record
-
pg_stat_get_sql_count()
Description: Provides the counts of the SELECT, UPDATE, INSERT, DELETE, and MERGE INTO statements executed on the current node. Users with the sysadmin or monitor admin permission can view information about all users, and common users can view only their own statistics.
Return type: record
-
pg_stat_get_data_senders()
Description: Provides detailed information about the data-copy sending thread active at the moment.
Return type: record
-
get_wait_event_info()
Description: Provides detailed information about the wait event.
Return type: record
-
generate_wdr_report(begin_snap_id bigint, end_snap_id bigint, report_type cstring, report_scope cstring, node_name cstring)
Description: Generates system diagnosis reports based on two snapshots. You need to run the command in the postgres database. By default, the initial user or the user with the monadmin permission can access the database. The result can be queried only in the system database but cannot be queried in the user database.
Return type: record
Table 1 generate_wdr_report parameter description
Parameter Description Range begin_snap_id Snapshot ID that starts the diagnosis report period. N/A end_snap_id Snapshot ID that ends the diagnosis report period. By default, the value of end_snap_id is greater than that of begin_snap_id. N/A report_type Specifies the type of the generated report. - summary
- detail
- all: Both summary and detail types are included.report_scope Specifies the scope for a report to be generated. - cluster: database-level information
- node: node-level informationnode_name When report_scope is set to node, set this parameter to the name of the corresponding node. (You can run the select * from pg_node_env; command to query the node name.)If report_scope is set to cluster, this parameter can be omitted, left blank, or set to NULL. - cluster: This value is omitted, left blank or set to NULL.
- node: indicates the node name in MogDB. -
create_wdr_snapshot()
Description: Manually generates system diagnosis snapshots. This function requires the sysadmin permission.
Return type: text
-
kill_snapshot()
Description: Kills the WDR snapshot backend thread. Users who invoke this function must have the SYSADMIN permission, the REPLICATION permission, or inherit the gs_role_replication permission of the built-in role.
Return type: void
-
capture_view_to_json(text,integer)
Description: Saves the view result to the directory specified by GUC: perf_directory. If is_crossdb is set to 1, the view is accessed once for all databases. If the value of is_crossdb is 0, the current database is accessed only once. Only users with the sysadmin or monitor admin permission can execute this function.
Return type: int
-
reset_unique_sql
Description: Clears the unique SQL statements in the memory of the database node. (The sysadmin permission is required.)
Return type: Boolean
Table 2 reset_unique_sql parameter description
Parameter Type Description scope text Clearance scope type. The options are as follows:
- GLOBAL: Clears all nodes. If the value is GLOBAL, this function can be executed only on the primary node.
- LOCAL: Clears the current node.clean_type text - BY_USERID: Unique SQL statements are cleared based on user IDs.
- BY_CNID: Unique SQL statements are cleared based on primary node IDs.
- ALL: All data is cleared.clean_value int8 Clearance value corresponding to the clearance type. NOTICE:
- The values GLOBAL and LOCAL of scope apply to distributed databases. For MogDB, the values have the same meaning, indicating that the local node is cleared.
- The value BY_CNID of clean_type applies only to distributed databases and is invalid for MogDB.
-
wdr_xdb_query(db_name_str text, query text)
Description: Provides the capability of executing local cross-database queries. For example, when connecting to the Postgres database, access tables in the test database.
select col1 from wdr_xdb_query('dbname=test','select col1 from t1') as dd(col1 int);
Return type: record
-
pg_wlm_jump_queue(pid int)
Description: Moves a task to the top of the queue of the primary node of the database.
Return type: Boolean
- true: success
- false: failure
-
gs_wlm_switch_cgroup(pid int, cgroup text)
Description: Moves a job to another Cgroup to change the job priority.
Return type: Boolean
- true: success
- false: failure
-
pv_session_memctx_detail(threadid tid, MemoryContextName text)
Description: Records information about the memory context MemoryContextName of the thread tid into the threadid**_timestamp.log** file in the $GAUSSLOG**/pg_log/${node_name}/dumpmem** directory. threadid can be obtained from sessid in the GS_SESSION_MEMORY_DETAIL view. In the officially released version, only the MemoryContextName that is an empty string (two single quotation marks indicate that the input is an empty string) is accepted. In this case, all memory context information is recorded. Otherwise, no operation is performed. For the DEBUG version for internal development and test personnel to debug, you can specify the MemoryContextName to be counted. In this case, all the memory usage of the context is recorded in the specified file. Only the administrator can execute this function.
Return type: Boolean
- true: success
- false: failure
-
pg_shared_memctx_detail(MemoryContextName text)
Description: Records information about the memory context MemoryContextName into the threadid**_timestamp.log** file in the $GAUSSLOG**/pg_log/${node_name}/dumpmem** directory. This function is provided only for internal development and test personnel to debug in the DEBUG version. Calling this function in the officially released version does not involve any operation. Only the administrator can execute this function.
Return type: Boolean
- true: success
- false: failure
-
local_bgwriter_stat()
Description: Displays the information about pages flushed by the bgwriter thread of this instance, number of pages in the candidate buffer chain, and buffer elimination information.
Return type: record
-
local_candidate_stat()
Description: Displays the number of pages in the candidate buffer chain of this instance and buffer elimination information, including the normal buffer pool and segment buffer pool.
Return type: record
-
local_ckpt_stat()
Description: Displays the information about checkpoints and flushing pages of the current instance.
Return type: record
-
local_double_write_stat()
Description: Displays the doublewrite file status of the current instance.
Return type: record
Table 3 local_double_write_stat parameters
Parameter Type Description node_name text Instance name curr_dwn int8 Sequence number of the doublewrite file curr_start_page int8 Start page for restoring the doublewrite file file_trunc_num int8 Number of times that the doublewrite file is reused file_reset_num int8 Number of reset times after the doublewrite file is full total_writes int8 Total number of I/Os of the doublewrite file low_threshold_writes int8 Number of I/Os for writing doublewrite files with low efficiency (the number of I/O flushing pages at a time is less than 16) high_threshold_writes int8 Number of I/Os for writing doublewrite files with high efficiency (the number of I/O flushing pages at a time is more than 421) total_pages int8 Total number of pages that are flushed to the doublewrite file area low_threshold_pages int8 Number of pages that are flushed with low efficiency high_threshold_pages int8 Number of pages that are flushed with high efficiency file_id int8 ID of the current doublewrite file -
local_single_flush_dw_stat()
Description: Displays the elimination of dual-write files on a single page in the instance.
Return type: record
-
local_pagewriter_stat()
Description: Displays the page flushing information and checkpoint information of the current instance.
Return type: record
-
local_redo_stat()
Description: Displays the replay status of the current standby instance.
Return type: record
Note: The returned replay status includes the current replay position and the replay position of the minimum restoration point.
-
local_recovery_status()
Description: Displays log flow control information about the primary and standby nodes.
Return type: record
-
gs_wlm_node_recover(boolean isForce)
Description: Obtains top SQL query statement-level statistics recorded in the current memory. If the input parameter is not 0, the information is cleared from the memory.
Return type: record
-
gs_wlm_node_clean(cstring nodename)
Description: Clears data after the dynamic load management node is faulty. Only administrators can execute this function. This function is called by the database instance management module. You are not advised to directly call this function. This view is not supported in a centralized or standalone system.
Return type: Boolean
-
gs_cgroup_map_ng_conf(group name)
Description: Reads the Cgroup configuration file of a specified logical database.
Return type: record
-
gs_wlm_switch_cgroup(sess_id int8, cgroup name)
Description: Switches the Cgroup of a specified session.
Return type: record
-
hdfs_fdw_handler()
Description: Rewrites a foreign table. It is a function to be defined when a foreign table is defined.
Return type: record
-
hdfs_fdw_validator(text[], oid)
Description: Rewrites a foreign table. It is a function to be defined when a foreign table is defined.
Return type: record
-
comm_client_info()
Description: Queries information about active client connections of a single node.
Return type: SETOF record
-
pg_sync_cstore_delta(text)
Description: Synchronizes the delta table structure of a specified column-store table with that of the column-store primary table.
Return type: bigint
-
pg_sync_cstore_delta()
Description: Synchronizes the delta table structure of all column-store tables with that of the column-store primary table.
Return type: bigint
-
pg_get_flush_lsn()
Description: Returns the position of the Xlog flushed from the current node.
Return type: text
-
pg_get_sync_flush_lsn()
Description: Returns the position of the Xlog flushed by the majority on the current node.
Return type: text
-
gs_create_log_tables()
Description: Creates foreign tables and views for run logs and performance logs.
Return type: void
Example:
MogDB=# select gs_create_log_tables(); gs_create_log_tables ---------------------- (1 row)
-
dbe_perf.get_global_full_sql_by_timestamp(start_timestamp timestamp with time zone, end_timestamp timestamp with time zone)
Description: Obtains full SQL information at the database level. The result can be queried only in the system database but cannot be queried in the user database.
Return type: record
Table 4 dbe_perf.get_global_full_sql_by_timestamp parameter description
Parameter Type Description start_timestamp timestamp with time zone Start point of the SQL start time range. end_timestamp timestamp with time zone End point of the SQL start time range. -
dbe_perf.get_global_slow_sql_by_timestamp(start_timestamp timestamp with time zone, end_timestamp timestamp with time zone)
Description: Obtains slow SQL information at the database level. The result can be queried only in the system database but cannot be queried in the user database.
Return type: record
Table 5 dbe_perf.get_global_slow_sql_by_timestamp parameter description
Parameter Type Description start_timestamp timestamp with time zone Start point of the SQL start time range. end_timestamp timestamp with time zone End point of the SQL start time range. -
statement_detail_decode(detail text, format text, pretty boolean)
Description: Parses the details column in a full or slow SQL statement. The result can be queried only in the system database but cannot be queried in the user database.
Return type: text
Table 6 statement_detail_decode parameter description
Parameter Type Description detail text Set of events generated by the SQL statement (unreadable). format text Parsing output format. The value is plaintext. pretty boolean Whether to display the text in pretty format when format is set to plaintext. The options are as follows:The value true indicates that events are separated by \n.The value false indicates that events are separated by commas (,). -
get_prepared_pending_xid
Description: Returns nextxid when restoration is complete.
Parameter: nan
Return type: text
-
pg_clean_region_info
Description: Clears the regionmap.
Parameter: nan
Return type: character varying
-
pg_get_delta_info
Description: Obtains delta information from a single DN.
Parameter: rel text, schema_name text
Return type: part_name text, live_tuple bigint, data_size bigint, and blocknum bigint
-
pg_get_replication_slot_name
Description: Obtains the slot name.
Parameter: nan
Return type: text
-
pg_get_running_xacts
Description: Obtains running xact.
Parameter: nan
Return type: handle integer, gxid xid, state tinyint, node text, xmin xid, vacuum boolean, timeline bigint, prepare_xid xid, pid bigint, and next_xid xid
-
pg_get_variable_info
Description: Obtains the shared memory variable cache.
Parameter: nan
Return type: node_name text, nextOid oid, nextXid xid, oldestXid xid, xidVacLimit xid, oldestXidDB oid, lastExtendCSNLogpage xid, startExtendCSNLogpage xid, nextCommitSeqNo xid, latestCompletedXid xid, and startupMaxXid xid
-
pg_get_xidlimit
Description: Obtains transaction ID information from the shared memory.
Parameter: nan
Return type: nextXid xid, oldestXid xid, xidVacLimit xid, xidWarnLimit xid, xidStopLimit xid, xidWrapLimit xid, and oldestXidDB oid
-
get_global_user_transaction()
Description: Returns transaction information about each user on all nodes.
Return type: node_name name, usename name, commit_counter bigint, rollback_counter bigint, resp_min bigint, resp_max bigint, resp_avg bigint, resp_total bigint, bg_commit_counter bigint, bg_rollback_counter bigint, bg_resp_min bigint, bg_resp_max bigint, bg_resp_avg bigint, and bg_resp_total bigint
-
pg_collation_for
Description: Returns the sorting rule corresponding to the input parameter string.
Parameter: any (Explicit type conversion is required for constants.)
Return type: text
-
pgxc_unlock_for_sp_database(name Name)
Description: Releases a specified database lock.
Parameter: database name
Return type: Boolean
-
pgxc_lock_for_sp_database(name Name)
Description: Locks a specified database.
Parameter: database name
Return type: Boolean
-
copy_error_log_create()
Description: Creates the error table (public.pgxc_copy_error_log) required for creating the COPY FROM error tolerance mechanism.
Return type: Boolean
NOTE:
- This function attempts to create the public.pgxc_copy_error_log table. For details about the table, see Table 7.
- Create the B-tree index on the relname column and execute REVOKE ALL on public.pgxc_copy_error_log FROM public to manage permissions for the error table (the permissions are the same as those of the COPY statement).
- public.pgxc_copy_error_log is a row-store table. Therefore, this function can be executed and COPY error tolerance is available only when row-store tables can be created in the database instance. Note that after the GUC parameter enable_hadoop_env is enabled, row-store tables cannot be created in the database instance (the default value is off for MogDB).
- Same as the error table and the COPY statement, the function requires sysadmin or higher permissions.
- If the public.pgxc_copy_error_log table or the copy_error_log_relname_idx index exists before the function creates it, the function will report an error and roll back.
Table 7 Error table public.pgxc_copy_error_log
Column Type Description relname character varying Table name in the form of Schema name**.**Table name begintime timestamp with time zone Time when a data format error was reported filename character varying Name of the source data file where a data format error occurs lineno bigint Number of the row where a data format error occurs in a source data file rawrecord text Raw record of a data format error in the source data file detail text Error details -
dynamic_func_control(scope text, function_name text, action text, “{params}” text[])
Description: Dynamically enables built-in functions. Currently, only full SQL statements can be dynamically enabled.
Return type: record
Table 8 Parameter description of dynamic_func_control
Parameter Type Description scope text Scope where the function is to be dynamically enabled. Currently, only LOCAL is supported. function_name text Function name. Currently, only STMT is supported. action text When function_name is set to STMT, the value of action can only be TRACK, UNTRACK, LIST, or CLEAN.
- TRACK: records the full SQL information of normalized SQL statements.
- UNTRACK: cancels the recording of full SQL information of normalized SQL statements.
- LIST: lists normalized SQL information that is recorded in the current track.
- CLEAN: cleans normalized SQL information that is recorded in the current track.params text[] When function_name is set to STMT, the parameters corresponding to different actions are set as follows:
- TRACK: '{“Normalized SQLID”, “L0/L1/L2”}'
- UNTRACK: '{“Normalized SQLID”}'
- LIST - '{}'
- CLEAN - '{}' -
gs_parse_page_bypath(path text, blocknum bigint, relation_type text, read_memory boolean)
Description: Parses a specified table page and returns the path for storing the parsed content.
Return type: text
Note: Only the system administrator or O&M administrator can execute this function.
Table 9 gs_parse_page_bypath parameters
Parameter Type Description path text - For an ordinary table or segment-page table, the relative path is Tablespace name**/Database OID/**Relfilenode of the table (physical file name). For example, base/16603/16394.
- You can run the pg_relation_filepath(table_name text) command to query the relative path of the table file.
- Valid path formats are as follows:
- global/relNode
- base/dbNode/relNode
- pg_tblspc/spcNode/version_dir/dbNode/relNodeblocknum bigint - -1: Information about all blocks
- **0-**MaxBlockNumber: Information about the corresponding blockrelation_type text - heap: Astore table
- uheap: Ustore table
- btree_index: B-tree index
- ubtree_index: UBTree index
- segment: Segment-pageread_memory boolean - false: The system parses the page from the disk file.
- true: The system attempts to parse the page from the shared buffer. If the page does not exist in the shared buffer, the system parses the page from the disk file. -
gs_xlogdump_lsn(start_lsn text, end_lsn text)
Description: Parses Xlogs within the specified LSN range and returns the path for storing the parsed content. You can use pg_current_xlog_location() to obtain the current Xlog position.
Return type: text
Parameters: LSN start position and LSN end position
Note: Only the system administrator or O&M administrator can execute this function.
-
gs_xlogdump_xid(c_xid xid)
Description: Parses Xlogs of a specified XID and returns the path for storing the parsed content. You can use txid_current() to obtain the current XID.
Parameter: XID
Return type: text
Note: Only the system administrator or O&M administrator can execute this function.
-
gs_xlogdump_tablepath(path text, blocknum bigint, relation_type text)
Description: Parses logs corresponding to a specified table page and returns the path for storing the parsed content.
Return type: text
Note: Only the system administrator or O&M administrator can execute this function.
Table 10 gs_xlogdump_tablepath parameters
Parameter Type Description path text - For an ordinary table or segment-page table, the relative path is Tablespace name**/Database OID/**Relfilenode of the table (physical file name). For example, base/16603/16394.
- You can run the pg_relation_filepath(table_name text) command to query the relative path of the table file.
- Valid path formats are as follows:
- global/relNode
- base/dbNode/relNode
- pg_tblspc/spcNode/version_dir/dbNode/relNodeblocknum bigint - -1: Information about all blocks
- **0-**MaxBlockNumber: Information about the corresponding blockrelation_type text - heap: Astore table
- uheap: Ustore table
- btree_index: B-tree index
- ubtree_index: UBTree index
- segment: Segment-page -
gs_xlogdump_parsepage_tablepath(path text, blocknum bigint, relation_type text, read_memory boolean)
Description: Parses the specified table page and logs corresponding to the table page and returns the path for storing the parsed content. It can be regarded as one execution of gs_parse_page_bypath and gs_xlogdump_tablepath. The prerequisite for executing this function is that the table file exists. To view logs of deleted tables, call gs_xlogdump_tablepath.
Return type: text
Note: Only the system administrator or O&M administrator can execute this function.
Table 11 gs_xlogdump_parsepage_tablepath parameters
Parameter Type Description path text - For an ordinary table or segment-page table, the relative path is Tablespace name**/Database OID/**Relfilenode of the table (physical file name). For example, base/16603/16394.
- You can run the pg_relation_filepath(table_name text) command to query the relative path of the table file.
- Valid path formats are as follows:
- global/relNode
- base/dbNode/relNode
- pg_tblspc/spcNode/version_dir/dbNode/relNodeblocknum bigint - -1: Information about all blocks
- **0-**MaxBlockNumber: Information about the corresponding blockrelation_type text - heap: Astore table
- uheap: Ustore table
- btree_index: B-tree index
- ubtree_index: UBTree index
- segment: Segment-pageread_memory boolean - false: The system parses the page from the disk file.
- true: The system attempts to parse the page from the shared buffer. If the page does not exist in the shared buffer, the system parses the page from the disk file. -
gs_index_verify(Oid oid, uint32:wq blkno)
Description: Checks whether the sequence of keys on the UBtree index page or index tree is correct.
Return type: record
Table 12 gs_index_verify parameters
Parameter Type Description oid Oid - Index file relfilenode, which can be queried using select relfilenode from pg_class where relname='Index file name'. blkno uint32 - 0: indicates that all pages in the index tree are checked.
- If the value is greater than 0, the index page whose page code is equal to the value of blkno is checked. -
gs_index_recycle_queue(Oid oid, int type, uint32 blkno)
Description: Parses the UBtree index recycling queue information.
Return type: record
Table 13 gs_index_recycle_queue parameters
Parameter Type Description oid Oid - Index file relfilenode, which can be queried using select relfilenode from pg_class where relname='Index file name'. type int - 0: indicates that the entire queue to be recycled is parsed.
- 1: indicates that the entire empty page queue is parsed.
- 2: indicates that a single page is parsed.blkno uint32 - ID of the recycling queue page. This parameter is valid only when type is set to 2. The value of blkno ranges from 1 to 4294967294. -
gs_stat_wal_entrytable(int64 idx)
Description: Exports the content of the write-ahead log insertion status table in the Xlog.
Return type: record
Table 14 gs_stat_wal_entrytable parameters
Category Parameter Name Type Description Input parameter idx int64 - -1: queries all elements in an array.
- **0-**Maximum value: content of a specific array element.Output parameter idx uint64 Records the subscripts in the corresponding array. Output parameter endlsn uint64 Records the LSN label. Output parameter lrc int32 Records the corresponding LRC. Output parameter status uint32 Determines whether the Xlog corresponding to the current entry has been completely copied to the WAL buffer:
- 0: Not copied.
- 1: Copied -
gs_walwriter_flush_position()
Description: Outputs the refresh position of write-ahead logs.
Return type: record
Table 15 gs_walwriter_flush_position parameters
Category Parameter Name Type Description Output parameter last_flush_status_entry int32 Subscript index obtained after the Xlog flushes the tblEntry of the last flushed disk. Output parameter last_scanned_lrc int32 LRC obtained after the Xlog flushes the last tblEntry scanned last time. Output parameter curr_lrc int32 Latest LRC usage in the WALInsertStatusEntry status table. The LRC indicates the LRC value corresponding to the WALInsertStatusEntry when the next Xlog record is written. Output parameter curr_byte_pos uint64 The latest Xlog position after the Xlog is written to the WAL file, which is also the next Xlog insertion point. Output parameter prev_byte_size uint32 Length of the previous Xlog record. Output parameter flush_result uint64 Position of the current global Xlog flush. Output parameter send_result uint64 Xlog sending position on the current host. Output parameter shm_rqst_write_pos uint64 The write position of the LogwrtRqst request in the XLogCtl recorded in the shared memory. Output parameter shm_rqst_flush_pos uint64 The flush position of the LogwrtRqst request in the XLogCtl recorded in the shared memory. Output parameter shm_result_write_pos uint64 The write position of the LogwrtResult request in the XLogCtl recorded in the shared memory. Output parameter shm_result_flush_pos uint64 The flush position of the LogwrtResult request in the XLogCtl recorded in the shared memory. Output parameter curr_time text Current time. -
gs_walwriter_flush_stat(int operation)
Description: Collects statistics on the frequency of writing and synchronizing write-ahead logs, data volume, and Xlog file information.
Return type: record
Table 16 gs_walwriter_flush_stat parameters
Category Parameter Name Type Description Input parameter operation int - -1: Disable the statistics function. (Default value)
- 0: Enable the statistics function.
- 1: Query statistics.
- 2: Reset statistics.Output parameter write_times uint64 Number of times that the Xlog calls the write API. Output parameter sync_times uint64 Number of times that the Xlog calls the sync API. Output parameter total_xlog_sync_bytes uint64 Total number of backend thread requests for writing data to Xlogs. Output parameter total_actual_xlog_sync_bytes uint64 Total number of Xlogs that call the sync API for disk flushing. Output parameter avg_write_bytes uint32 Number of Xlogs written each time the XLogWrite API is called. Output parameter avg_actual_write_bytes uint32 Number of Xlogs written each time the write API is called. Output parameter avg_sync_bytes uint32 Average number of Xlogs for each synchronization request. Output parameter avg_actual_sync_bytes uint32 Actual Xlog amount of disk flushing by calling sync each time. Output parameter total_write_time uint64 Total time of calling the write operation (unit: μs). Output parameter total_sync_time uint64 Total time of calling the sync operation (unit: μs). Output parameter avg_write_time uint32 Average time for calling the write API each time (unit: μs). Output parameter avg_sync_time uint32 Average time for calling the sync API each time (unit: μs). Output parameter curr_init_xlog_segno uint64 ID of the latest Xlog segment file. Output parameter curr_open_xlog_segno uint64 ID of the Xlog segment file that is being written. Output parameter last_reset_time text Time when statistics were last collected. Output parameter curr_time text Current time. -
gs_comm_proxy_thread_status()
Description: Collects statistics on data packets sent and received by the proxy communication library comm_proxy when a user-mode network is configured for the database instance.
Parameter: nan
Return type: record
NOTE: The query result of this function is displayed only when the user-mode network is deployed in a centralized environment and enable_dfx in comm_proxy_attr is set to true. In other scenarios, an error message is displayed, indicating that queries are not supported.