The gp_toolkit Administrative Schema
Apache Cloudberry provides an administrative schema called gp_toolkit that you can use to query the system catalogs, log files, and operating environment for system status information. The gp_toolkit schema contains a number of views that you can access using SQL commands. The gp_toolkit schema is accessible to all database users, although some objects may require superuser permissions. For convenience, you may want to add the gp_toolkit schema to your schema search path. For example:
=> ALTER ROLE myrole SET search_path TO myschema,gp_toolkit;
This document describes the most useful views and user-defined functions (UDFs) in gp_toolkit. You may notice other objects (views, functions, and external tables) within the gp_toolkit schema that are not described in this documentation (these are supporting objects to the views described in this section).
Do not change database objects in the gp_toolkit schema. Do not create database objects in the schema. Changes to objects in the schema might affect the accuracy of administrative information returned by schema objects. Any changes made in the gp_toolkit schema are lost when the database is backed up and then restored with the gpbackup and gprestore utilities.
These are the categories for views in the gp_toolkit schema.
- Check for tables that need routine maintenance
- Check for locks
- Check append-optimized tables
- View server log files
- Check server configuration files
- Check for failed segments
- Check resource group activity and status
- Check resource queue activity and status
- Check query disk spill space usage
- View users and groups (roles)
- Check database object sizes and disk space
- Check for missing and orphaned data files
- Move orphaned data files
- Check for uneven data distribution
- Maintain partitions
About the extension
gp_toolkit is implemented as an extension in Apache Cloudberry v2.0.0. Because this extension is registered in the template1 database, it is both registered an immediately available to use in every Apache Cloudberry database that you create.
Upgrade the extension
The gp_toolkit extension is installed when you install or upgrade Apache Cloudberry. A previous version of the extension will continue to work in existing databases after you upgrade Apache Cloudberry. To upgrade to the most recent version of the extension, you must:
ALTER EXTENSION gp_toolkit UPDATE TO '1.4';
in every database in which you use the extension.
Check for tables that need routine maintenance
The following views can help identify tables that need routine table maintenance (VACUUM and/or ANALYZE).
The VACUUM or VACUUM FULL command reclaims disk space occupied by deleted or obsolete rows. Because of the MVCC transaction concurrency model used in Apache Cloudberry, data rows that are deleted or updated still occupy physical space on disk even though they are not visible to any new transactions. Expired rows increase table size on disk and eventually slow down scans of the table.
The ANALYZE command collects column-level statistics needed by the query optimizer. Apache Cloudberry uses a cost-based query optimizer that relies on database statistics. Accurate statistics allow the query optimizer to better estimate selectivity and the number of rows retrieved by a query operation in order to choose the most efficient query plan.
gp_bloat_diag
This view shows regular heap-storage tables that have bloat (the actual number of pages on disk exceeds the expected number of pages given the table statistics). Tables that are bloated require a VACUUM or a VACUUM FULL in order to reclaim disk space occupied by deleted or obsolete rows. This view is accessible to all users, however non-superusers will only be able to see the tables that they have permission to access.
Note
For diagnostic functions that return append-optimized table information, see Check append-optimized tables.
The columns of this view are described as follows:
bdirelid: Table object id.bdinspname: Schema name.bdirelname: Table name.bdirelpages: Actual number of pages on disk.bdiexppages: Expected number of pages given the table data.bdidiag: Bloat diagnostic message.
gp_stats_missing
This view shows tables that do not have statistics and therefore may require an ANALYZE be run on the table.
The columns of this view are described as follows:
smischema: Schema name.smitable: Table name.smisize: Does this table have statistics? False if the table does not have row count and row sizing statistics recorded in the system catalog, which may indicate that the table needs to be analyzed. This will also be false if the table does not contain any rows. For example, the parent tables of partitioned tables are always empty and will always return a false result.smicols: Number of columns in the table.smirecs: The total number of columns in the table that have statistics recorded.
Check for locks
When a transaction accesses a relation (such as a table), it acquires a lock. Depending on the type of lock acquired, subsequent transactions may have to wait before they can access the same relation. For more information on the types of locks, see the Transaction. Apache Cloudberry resource queues (used for resource management) also use locks to control the admission of queries into the system.
The gp_locks_* family of views can help diagnose queries and sessions that are waiting to access an object due to a lock.
gp_locks_on_relation
This view shows any locks currently being held on a relation, and the associated session information about the query associated with the lock. For more information on the types of locks, see the Transaction. This view is accessible to all users, however non-superusers will only be able to see the locks for relations that they have permission to access.
The columns of this view are described as follows:
lorlocktype: Type of the lockable object:relation,extend,page,tuple,transactionid,object,userlock,resource queue, oradvisory.lordatabase: Object ID of the database in which the object exists, zero if the object is a shared object.lorrelname: The name of the relation.lorrelation: The object ID of the relation.lortransaction: The transaction ID that is affected by the lock.lorpid: Process ID of the server process holding or awaiting this lock.NULLif the lock is held by a prepared transaction.lormode: Name of the lock mode held or desired by this process.lorgranted: Displays whether the lock is granted (true) or not granted (false).lorcurrentquery: The current query in the session.
gp_locks_on_resqueue
The gp_locks_on_resqueue view is valid only when resource queue-based resource management is active.
This view shows any locks currently being held on a resource queue, and the associated session information about the query associated with the lock. This view is accessible to all users, however non-superusers will only be able to see the locks associated with their own sessions.
The columns of this view are described as follows:
lorusename: Name of the user running the session.lorrsqname: The resource queue name.lorlocktype: Type of the lockable object:resource queue.lorobjid: The ID of the locked transaction.lortransaction: The ID of the transaction that is affected by the lock.lorpid: The process ID of the transaction that is affected by the lock.lormode: The name of the lock mode held or desired by this process.lorgranted: Displays whether the lock is granted (true) or not granted (false).lorwaiteventtype: The type of waiting event (for example, I/O, lock, network).lorwaitevent: The name or description of the waiting event (for example, the I/O operation or lock object of a file).
Check append-optimized tables
The gp_toolkit schema includes a set of diagnostic functions you can use to investigate the state of append-optimized tables.
When an append-optimized table (or column-oriented append-optimized table) is created, another table is implicitly created, containing metadata about the current state of the table. The metadata includes information such as the number of records in each of the table's segments.
Append-optimized tables may have non-visible rows—rows that have been updated or deleted, but remain in storage until the table is compacted using VACUUM. The hidden rows are tracked using an auxiliary visibility map table, or visimap.
The following functions let you access the metadata for append-optimized and column-oriented tables and view non-visible rows.
For most of the functions, the input argument is regclass, either the table name or the oid of a table.
__gp_aovisimap_compaction_info(oid)
This function displays compaction information for an append-optimized table. The information is for the on-disk data files on database segments that store the table data. You can use the information to determine the data files that will be compacted by a VACUUM operation on an append-optimized table.
Until a VACUUM operation deletes the row from the data file, deleted or updated data rows occupy physical space on disk even though they are hidden to new transactions. The configuration parameter gp_appendonly_compaction controls the functionality of the VACUUM command.
This table describes the __gp_aovisimap_compaction_info function output table. The columns of this table are described as follows:
content: Database segment ID.datafile: ID of the data file on the segment.compaction_possible: The value is eithertorf. The valuetindicates that the data in data file be compacted when a VACUUM operation is performed. The server configuration parametergp_appendonly_compaction_thresholdaffects this value.hidden_tupcount: In the data file, the number of hidden (deleted or updated) rows.total_tupcount: In the data file, the total number of rows.percent_hidden: In the data file, the ratio (as a percentage) of hidden (deleted or updated) rows to total rows.
__gp_aoseg(regclass)
This function returns metadata information contained in the append-optimized table's on-disk segment file.
The input argument is the name or the oid of an append-optimized table. The columns of the output are described as follows:
segment_id: The ID of the data segment in the cluster.segno: The file segment number.eof: The effective end of file for this file segment.tupcount: The total number of tuples in the segment, including invisible tuples.varblockcount: The total number of varblocks in the file segment.eof_uncompressed: The end of file if the file segment were uncompressed.modcount: The number of data modification operations.formatversion: The version of the AO file storage format, which indicates the format version of the file.state: The state of the file segment. Indicates if the segment is active or ready to be dropped after compaction.
__gp_aoseg_history(regclass)
This function returns metadata information contained in the append-optimized table's on-disk segment file. It displays all different versions (heap tuples) of the aoseg meta information. The data is complex, but users with a deep understanding of the system may find it useful for debugging.
The input argument is the name or the oid of an append-optimized table. The columns of the output are described as follows:
segment_id: The ID of the data segment in the cluster.segno: The number of the segment in the segment file.tupcount: The number of tuples, including hidden tuples.eof: The effective end of file for the segment.eof_uncompressed: The end of file for the segment if data were uncompressed.modcount: A count of data modifications.formatversion: The version of the AO file storage format, which indicates the format version of the file.state: The status of the segment.
__gp_aocsseg(regclass)
This function returns metadata information contained in a column-oriented append-optimized table's on-disk segment file, excluding non-visible rows. Each row describes a segment for a column in the table.
The input argument is the name or the oid of a column-oriented append-optimized table. The columns of the output are described as follows:
segment_id: The ID of the data segment in the cluster.segno: The segment number.column_num: The column number.physical_segno: The number of the segment in the segment file.tupcount: The number of rows in the segment, excluding hidden tuples.eof: The effective end of file for the segment.eof_uncompressed: The end of file for the segment if the data were uncompressed.modcount: A count of data modification operations for the segment.formatversion: The version of the AO file storage format, which indicates the format version of the file.state: The status of the segment.
__gp_aocsseg_history(regclass)
This function returns metadata information contained in a column-oriented append-optimized table's on-disk segment file. Each row describes a segment for a column in the table. The data is complex, but users with a deep understanding of the system may find it useful for debugging.
The input argument is the name or the oid of a column-oriented append-optimized table. The columns of the output are described as follows:
segment_id: The ID of the data segment in the cluster.segno: The segment number in the segment file.column_num: The column number.physical_segno: The segment containing data for the column.tupcount: The total number of tuples in the segment.eof: The effective end of file for the segment.eof_uncompressed: The end of file for the segment if the data were uncompressed.modcount: A count of the data modification operations.formatversion: The version of the AO file storage format, which indicates the format version of the file.state: The state of the segment.
__gp_aovisimap(regclass)
This function returns the tuple ID, the segment file, and the row number of each non-visible tuple according to the visibility map.
The input argument is the name or the oid of an append-optimized table. The columns of the output are described as follows:
tid: The tuple id.segno: The number of the segment file.row_num: The row number of a row that has been deleted or updated.
__gp_aovisimap_hidden_info(regclass)
This function returns the numbers of hidden and visible tuples in the segment files for an append-optimized table.
The input argument is the name or the oid of an append-optimized table. The columns of the output are described as follows:
segno: The number of the segment file.hidden_tupcount: The number of hidden tuples in the segment file.total_tupcount: The total number of tuples in the segment file.
__gp_aovisimap_entry(regclass)
This function returns information about each visibility map entry for the table.
The input argument is the name or the oid of an append-optimized table. The columns of the output are described as follows:
segno: Segment number of the visibility map entry.first_row_num: The first row number of the entry.hidden_tupcount: The number of hidden tuples in the entry.bitmap: A text representation of the visibility bitmap.
__gp_aoblkdir(regclass)
For a given AO/AOCO table that had or has an index, this function returns a row for each block directory entry recorded in the block directory relation; it flattens the minipage column of block directory relations and returns a row for each minipage entry.
The input argument is the name or the oid of an append-optimized table.
You must execute this function in utility mode against every segment, or with gp_dist_random() as shown here:
SELECT (gp_toolkit.__gp_aoblkdir('<table_name>')).*
FROM gp_dist_random('gp_id');
The columns of the output are described as follows:
tupleid: The tuple id of the block directory row containing this block directory entry.segno: The physical segment file number.columngroup_no: Theattnumof the column described by thisminipageentry (always0for row-oriented tables).entry_no: The entry serial number inside thisminipagecontaining this block directory entry.first_row_no: The first row number of the rows covered by this block directory entry.file_offset: The starting file offset of the rows covered by this block directory entry.row_count: The count of rows covered by this block directory entry.
get_column_size(oid)
For a given AOCO table, this function returns the column size and compression ratio for all columns in the table.
The input argument is the object identifier of a column-oriented append-optimized table. The columns of the output are described as follows:
segment: The segment id.attnum: The attribute number of the column.size: The size of the column in bytes.size_uncompressed: The size of the column in bytes if the column was not compressed.compression_ratio: The compression ratio.
gp_column_size
This view gathers the column size and compression ratio for column-oriented append-optimized tables from all segments. The columns of the view are described as follows:
gp_segment_id: Segment ID.relid: The object identifier (OID) of the table.schema: The schema to which the table belongs.relname: The table name.attnum: The attribute number of the column.attname: The column name.size: The size of the column in bytes.size_uncompressed: The size of the column in bytes if the column was not compressed.compression_ratio: The compression ratio.
gp_column_size_summary
This view shows a summary of the gp_column_size view. It aggregates the column size and compression ratio for each column in each column-oriented append-optimized table from all segments. The columns of the view are described as follows:
relid: The object identifier (OID) of the table.schema: The schema to which the table belongs.relname: The table name.attnum: The attribute number of the column.attname: The column name.size: The size of the column in bytes.size_uncompressed: The size of the column in bytes if the column were uncompressed.compression_ratio: The compression ratio.
View server log files
Each component of a Apache Cloudberry system (coordinator, standby coordinator, primary segments, and mirror segments) keeps its own server log files. The gp_log_* family of views allows you to issue SQL queries against the server log files to find particular entries of interest. The use of these views require superuser permissions.
gp_log_command_timings
This view uses an external table to read the log files on the coordinator and report the run time of SQL commands in a database session. The use of this view requires superuser permissions. The columns of the view are described as follows:
logsession: The session identifier (prefixed with "con").logcmdcount: The command number within a session (prefixed with "cmd").logdatabase: The name of the database.loguser: The name of the database user.logpid: The process id (prefixed with "p").logtimemin: The time of the first log message for this command.logtimemax: The time of the last log message for this command.logduration: Statement duration from start to end time.
gp_log_database
This view uses an external table to read the server log files of the entire Apache Cloudberry system (coordinator, segments, and mirrors) and lists log entries associated with the current database. Associated log entries can be identified by the session id (logsession) and command id (logcmdcount). The use of this view requires superuser permissions. The columns of the view are described as follows:
logtime: The timestamp of the log message.loguser: The name of the database user.logdatabase: The name of the database.logpid: The associated process id (prefixed with "p").logthread: The associated thread count (prefixed with "th").loghost: The segment or coordinator host name.logport: The segment or coordinator port.logsessiontime: Time session connection was opened.logtransaction: Global transaction id.logsession: The session identifier (prefixed with "con").logcmdcount: The command number within a session (prefixed with "cmd").logsegment: The segment content identifier (prefixed with "seg" for primary or "mir" for mirror. The coordinator always has a content id of -1).logslice: The slice id (portion of the query plan being run).logdistxact: Distributed transaction id.loglocalxact: Local transaction id.logsubxact: Subtransaction id.logseverity: LOG, ERROR, FATAL, PANIC, DEBUG1 or DEBUG2.logstate: SQL state code associated with the log message.logmessage: Log or error message text.logdetail: Detail message text associated with an error message.loghint: Hint message text associated with an error message.logquery: The internally-generated query text.logquerypos: The cursor index into the internally-generated query text.logcontext: The context in which this message gets generated.logdebug: Query string with full detail for debugging.logcursorpos: The cursor index into the query string.logfunction: The function in which this message is generated.logfile: The log file in which this message is generated.logline: The line in the log file in which this message is generated.logstack: Full text of the stack trace associated with this message.
gp_log_coordinator_concise
This view uses an external table to read a subset of the log fields from the coordinator log file. The use of this view requires superuser permissions. The columns of the view are described as follows:
logtime: The timestamp of the log message.logdatabase: The name of the database.logsession: The session identifier (prefixed with "con").logcmdcount: The command number within a session (prefixed with "cmd").logseverity: The log severity level.logmessage: Log or error message text.
gp_log_system
This view uses an external table to read the server log files of the entire Apache Cloudberry system (coordinator, segments, and mirrors) and lists all log entries. Associated log entries can be identified by the session id (logsession) and command id (logcmdcount). The use of this view requires superuser permissions. The columns of the view are described as follows:
logtime: The timestamp of the log message.loguser: The name of the database user.logdatabase: The name of the database.logpid: The associated process id (prefixed with "p").logthread: The associated thread count (prefixed with "th").loghost: The segment or coordinator host name.logport: The segment or coordinator port.logsessiontime: Time session connection was opened.logtransaction: Global transaction id.logsession: The session identifier (prefixed with "con").logcmdcount: The command number within a session (prefixed with "cmd").logsegment: The segment content identifier (prefixed with "seg" for primary or "mir" for mirror. The coordinator always has a content id of -1).logslice: The slice id (portion of the query plan being run).logdistxact: Distributed transaction id.loglocalxact: Local transaction id.logsubxact: Subtransaction id.logseverity: LOG, ERROR, FATAL, PANIC, DEBUG1 or DEBUG2.logstate: SQL state code associated with the log message.logmessage: Log or error message text.logdetail: Detail message text associated with an error message.loghint: Hint message text associated with an error message.logquery: The internally-generated query text.logquerypos: The cursor index into the internally-generated query text.logcontext: The context in which this message gets generated.logdebug: Query string with full detail for debugging.logcursorpos: The cursor index into the query string.logfunction: The function in which this message is generated.logfile: The log file in which this message is generated.logline: The line in the log file in which this message is generated.logstack: Full text of the stack trace associated with this message.
Check server configuration files
Each component of a Apache Cloudberry system (coordinator, standby coordinator, primary segments, and mirror segments) has its own server configuration file (postgresql.conf). The following gp_toolkit objects can be used to check parameter settings across all primary postgresql.conf files in the system:
gp_param_setting('parameter_name')
This function takes the name of a server configuration parameter and returns the postgresql.conf value for the coordinator and each active segment. This function is accessible to all users. The columns of the view are described as follows:
paramsegment: The segment content id (only active segments are shown). The coordinator content id is always -1.paramname: The name of the parameter.paramvalue: The value of the parameter.
Example:
SELECT * FROM gp_toolkit.gp_param_setting('max_connections');
gp_param_settings_seg_value_diffs
Server configuration parameters that are classified as local parameters (meaning each segment gets the parameter value from its own postgresql.conf file), should be set identically on all segments. This view shows local parameter settings that are inconsistent. Parameters that are supposed to have different values (such as port) are not included. This view is accessible to all users.
The columns of the view are described as follows:
psdname: The name of the parameter.psdvalue: The value of the parameter.psdcount: The number of segments that have this value.
Check for failed segments
The gp_pgdatabase_invalid view can be used to check for down segments.
gp_pgdatabase_invalid
This view shows information about segments that are marked as down in the system catalog. This view is accessible to all users. The columns of the view are described as follows:
pgdbidbid: The segment dbid. Every segment has a unique dbid.pgdbiisprimary: Is the segment currently acting as the primary (active) segment? (t or f).pgdbicontent: The content id of this segment. A primary and mirror will have the same content id.pgdbivalid: Is this segment up and valid? (t or f).pgdbidefinedprimary: Was this segment assigned the role of primary at system initialization time? (t or f).
Check resource group activity and status
Note
The resource group activity and status views described in this section are valid only when resource group-based resource management is active.
Resource groups manage transactions to avoid exhausting system CPU and memory resources. Every database user is assigned a resource group. Apache Cloudberry evaluates every transaction submitted by a user against the limits configured for the user's resource group before running the transaction.
You can use the gp_resgroup_config view to check the configuration of each resource group. You can use the gp_resgroup_status* views to display the current transaction status and resource usage of each resource group.
gp_resgroup_configgp_resgroup_rolegp_resgroup_statusgp_resgroup_status_per_hostgp_resgroup_status_per_segment
gp_resgroup_config
The gp_resgroup_config view allows administrators to see the current CPU, memory, and concurrency limits for a resource group.
This view is accessible to all users. The columns of the view are described as follows:
groupid: The ID of the resource group.groupname: The name of the resource group.concurrency: The concurrency (CONCURRENCY) value specified for the resource group.cpu_max_percent: The CPU limit (CPU_MAX_PERCENT) value specified for the resource group, or-1.cpu_weight: The scheduling priority of the resource group (CPU_WEIGHT).cpuset: The CPU cores reserved for the resource group (CPUSET), or -1.memory_quota: The memory limit value specified for the resource group.min_cost: The minimum cost of a query plan to be included in the resource group (MIN_COST).io_limit: The maximum read/write sequential disk I/O throughput, and the maximum read/write I/O operations per second for the queries assigned to a specific tablespace (shown as the tablespace oid) and resource group (IO_LIMIT).
gp_resgroup_role
The gp_resgroup_role view allows administrators to see the resource group assigned to every role.
This view is accessible to all users. The columns of the view are described as follows:
rrrolname: The name of the role.rrrsgname: The name of the resource group.
gp_resgroup_status
The gp_resgroup_status view allows administrators to see status and activity for a resource group. It shows how many queries are waiting to run and how many queries are currently active in the system for each resource group. The view also displays current memory and CPU usage for the resource group.
Resource groups use the Linux control groups (cgroups) configured on the host systems. The cgroups are used to manage host system resources. When resource groups use cgroups that are as part of a nested set of cgroups, resource group limits are relative to the parent cgroup allotment. For information about nested cgroups and Apache Cloudberry resource group limits, see the Use Resource Groups document.
This view is accessible to all users. The columns of the view are described as follows:
groupid: The ID of the resource group.groupname: The name of the resource group.num_running: The number of transactions currently running in the resource group.num_queueing: The number of currently queued transactions for the resource group.num_queued: The total number of queued transactions for the resource group since the Apache Cloudberry cluster was last started, excluding the num_queueing.num_executed: The total number of transactions run in the resource group since the Apache Cloudberry cluster was last started, excluding the num_running.total_queue_duration: The total time any transaction was queued since the Apache Cloudberry cluster was last started.
Sample output for the gp_resgroup_status view:
select * from gp_toolkit.gp_resgroup_status;
groupid | groupname | num_running | num_queueing | num_queued | num_executed | total_queue_duration
---------+-----------+-------------+--------------+------------+--------------+----------------------
(0 rows)
gp_resgroup_status_per_host
The gp_resgroup_status_per_host view displays the real-time CPU and memory usage (MBs) for each resource group on a per-host basis. The view also displays available and granted group fixed and shared memory for each resource group on a host.
The columns of the view are described as follows:
groupid: The ID of the resource group.groupname: The name of the resource group.hostname: The hostname of the segment host.cpu_usage: The real-time CPU core usage by the resource group on a host. The value is the sum of the percentages (as a float value) of the CPU cores that are used by the resource group on the host.memory_usage: The real-time memory usage of the resource group on each database segment's host, in MB.
Sample output for the gp_resgroup_status_per_host view:
select * from gp_toolkit.gp_resgroup_status_per_host;
groupid | groupname | hostname | cpu_usage | memory_usage
---------+-----------+----------+-----------+--------------
(0 rows)
gp_resgroup_status_per_segment
The gp_toolkit.gp_resgroup_status_per_segment view shows memory usage by resource group on each segment. The statistics are reported by the vmem tracker and measured in MB. This view helps database administrators monitor memory consumption of resource groups across segments.
Note
This view is available only when resource group-based resource management is enabled.
Column descriptions:
groupid(type:oid): Unique identifier of the resource group, corresponding topg_resgroup.oid.groupname(type:name): Name of the resource group, corresponding topg_resgroup.rsgname.segment_id(type:smallint): Content ID of the corresponding segment instance, taken fromgp_segment_configuration.content.vmem_usage(type:smallint): Real-time memory usage (in MB) of the resource group on the corresponding segment.
Check resource queue activity and status
The resource queue activity and status views described in this section are valid only when resource queue-based resource management is active.
The purpose of resource queues is to limit the number of active queries in the system at any given time in order to avoid exhausting system resources such as memory, CPU, and disk I/O. All database users are assigned to a resource queue, and every statement submitted by a user is first evaluated against the resource queue limits before it can run. The gp_resq_* family of views can be used to check the status of statements currently submitted to the system through their respective resource queue. Note that statements issued by superusers are exempt from resource queuing.
gp_resq_activitygp_resq_activity_by_queuegp_resq_priority_statementgp_resq_rolegp_resqueue_status
gp_resq_activity
For the resource queues that have active workload, this view shows one row for each active statement submitted through a resource queue. This view is accessible to all users.
The columns of the view are described as follows:
resqprocpid: Process ID assigned to this statement (on the coordinator).resqrole: User name.resqoid: Resource queue object id.resqname: Resource queue name.resqstart: Time statement was issued to the system.resqstatus: Status of statement: running, waiting or cancelled.
gp_resq_activity_by_queue
For the resource queues that have active workload, this view shows a summary of queue activity. This view is accessible to all users.
The columns of the view are described as follows:
resqoid: Resource queue object id.resqname: Resource queue name.resqlast: Time of the last statement issued to the queue.resqstatus: Status of last statement: running, waiting or cancelled.resqtotal: Total statements in this queue.
gp_resq_priority_statement
This view shows the resource queue priority, session ID, and other information for all statements currently running in the Apache Cloudberry system. This view is accessible to all users.
The columns of the view are described as follows:
rqpdatname: The database name that the session is connected to.rqpusename: The user who issued the statement.rqpsession: The session ID.rqpcommand: The number of the statement within this session (the command id and session id uniquely identify a statement).rqppriority: The resource queue priority for this statement (MAX,HIGH,MEDIUM,LOW).rqpweight: An integer value associated with the priority of this statement.rqpquery: The query text of the statement.
gp_resq_role
This view shows the resource queues associated with a role. This view is accessible to all users.
The columns of the view are described as follows:
rrrolname: Role (user) name.rrrsqname: The resource queue name assigned to this role. If a role has not been explicitly assigned to a resource queue, it will be in the default resource queue (pg_default).
gp_resqueue_status
This view allows administrators to see status and activity for a resource queue. It shows how many queries are waiting to run and how many queries are currently active in the system from a particular resource queue.
The columns of the view are described as follows:
queueid: The ID of the resource queue.rsqname: The name of the resource queue.rsqcountlimit: The active query threshold of the resource queue. A value of -1 means no limit.rsqcountvalue: The number of active query slots currently being used in the resource queue.rsqcostlimit: The query cost threshold of the resource queue. A value of -1 means no limit.rsqcostvalue: The total cost of all statements currently in the resource queue.rsqmemorylimit: The memory limit for the resource queue.rsqmemoryvalue: The total memory used by all statements currently in the resource queue.rsqwaiters: The number of statements currently waiting in the resource queue.rsqholders: The number of statements currently running on the system from this resource queue.
Check query disk spill space usage
The gp_workfile_ views show information about all the queries that are currently using disk spill space. Apache Cloudberry creates work files on disk if it does not have sufficient memory to run the query in memory. This information can be used for troubleshooting and tuning queries. The information in the views can also be used to specify the values for the Apache Cloudberry configuration parameters gp_workfile_limit_per_query and gp_workfile_limit_per_segment.
gp_workfile_entries
This view contains one row for each operator using disk space for workfiles on a segment at the current time. The view is accessible to all users, however non-superusers only to see information for the databases that they have permission to access.
The columns of the view are described as follows:
| Column | Type | Description |
|---|---|---|
datname | name | Database name. |
pid | integer | Process ID of the server process. |
sess_id | integer | Session ID. |
command_cnt | integer | Command ID of the query. |
usename | name | Role name. |
query | text | Current query that the process is running. |
segid | integer | Segment ID. |
slice | integer | The query plan slice. The portion of the query plan that is being run. |
optype | text | The query operator type that created the work file. |
size | bigint | The size of the work file in bytes. |
numfiles | integer | The number of files created. |
prefix | text | Prefix used when naming a related set of workfiles. |
gp_workfile_usage_per_query
This view contains one row for each query using disk space for workfiles on a segment at the current time. The view is accessible to all users, however non-superusers only to see information for the databases that they have permission to access.
The columns of the view are described as follows:
| Column | Type | Description |
|---|---|---|
datname | name | Database name. |
pid | integer | Process ID of the server process. |
sess_id | integer | Session ID. |
command_cnt | integer | Command ID of the query. |
usename | name | Role name. |
query | text | Current query that the process is running. |
segid | integer | Segment ID. |
size | numeric | The size of the work file in bytes. |
numfiles | bigint | The number of files created. |
gp_workfile_usage_per_segment
This view contains one row for each segment. Each row displays the total amount of disk space used for workfiles on the segment at the current time. The view is accessible to all users, however non-superusers only to see information for the databases that they have permission to access.
The columns of the view are described as follows:
| Column | Type | Description |
|---|---|---|
segid | smallint | Segment ID. |
size | numeric | The total size of the work files on a segment. |
numfiles | bigint | The number of files created. |
View users and groups (roles)
It is frequently convenient to group users (roles) together to ease management of object privileges: that way, privileges can be granted to, or revoked from, a group as a whole. In Apache Cloudberry, this is done by creating a role that represents the group, and then granting membership in the group role to individual user roles.
The references/sys-catalog/gp-toolkit-schema:gp_roles_assigned view can be used to see all of the roles in the system, and their assigned members (if the role is also a group role).
gp_roles_assigned
This view shows all of the roles in the system, and their assigned members (if the role is also a group role). This view is accessible to all users.
The columns of the view are described as follows:
raroleid: The role object ID. If this role has members (users), it is considered a group role.rarolename: The role (user or group) name.ramemberid: The role object ID of the role that is a member of this role.ramembername: Name of the role that is a member of this role.
Check database object sizes and disk space
The gp_size_* family of views can be used to determine the disk space usage for a distributed Apache Cloudberry database, schema, table, or index. The following views calculate the total size of an object across all primary segments (mirrors are not included in the size calculations).
gp_size_of_all_table_indexesgp_size_of_databasegp_size_of_indexgp_size_of_schema_diskgp_size_of_table_and_indexes_diskgp_size_of_table_and_indexes_licensinggp_size_of_table_diskgp_size_of_table_uncompressedgp_disk_free
The table and index sizing views list the relation by object ID (not by name). To check the size of a table or index by name, you must look up the relation name (relname) in the pg_class table. For example:
SELECT relname as name, sotdsize as size, sotdtoastsize as
toast, sotdadditionalsize as other
FROM gp_size_of_table_disk as sotd, pg_class
WHERE sotd.sotdoid=pg_class.oid ORDER BY relname;
gp_size_of_all_table_indexes
This view shows the total size of all indexes for a table. This view is accessible to all users, however non-superusers will only be able to see relations that they have permission to access.
The columns of the view are described as follows:
soatioid: The object ID of the table.soatisize: The total size of all table indexes in bytes.soatischemaname: The schema name.soatitablename: The table name.
gp_size_of_database
This view shows the total size of a database. This view is accessible to all users, however non-superusers will only be able to see databases that they have permission to access.
The columns of the view are described as follows:
sodddatname: The name of the database.sodddatsize: The size of the database in bytes.
gp_size_of_index
This view shows the total size of an index. This view is accessible to all users, however non-superusers will only be able to see relations that they have permission to access.
The columns of the view are described as follows:
soioid: The object ID of the index.soitableoid: The object ID of the table to which the index belongs.soisize: The size of the index in bytes.soiindexschemaname: The name of the index schema.soiindexname: The name of the index.soitableschemaname: The name of the table schema.soitablename: The name of the table.
gp_size_of_schema_disk
This view shows schema sizes for the public schema and the user-created schemas in the current database. This view is accessible to all users, however non-superusers will be able to see only the schemas that they have permission to access.
The columns of the view are described as follows:
sosdnsp: The name of the schema.sosdschematablesize: The total size of tables in the schema in bytes.sosdschemaidxsize: The total size of indexes in the schema in bytes.
gp_size_of_table_and_indexes_disk
This view shows the size on disk of tables and their indexes. This view is accessible to all users, however non-superusers will only be able to see relations that they have permission to access.
The columns of the view are described as follows:
sotaidoid: The object ID of the parent table.sotaidtablesize: The disk size of the table.sotaididxsize: The total size of all indexes on the table.sotaidschemaname: The name of the schema.sotaidtablename: The name of the table.
gp_size_of_table_and_indexes_licensing
This view shows the total size of tables and their indexes for licensing purposes. The use of this view requires superuser permissions.
The columns of the view are described as follows:
sotailoid: The object ID of the table.sotailtablesizedisk: The total disk size of the table.sotailtablesizeuncompressed: If the table is a compressed append-optimized table, shows the uncompressed table size in bytes.sotailindexessize: The total size of all indexes in the table.sotailschemaname: The schema name.sotailtablename: The table name.
gp_size_of_table_disk
This view shows the size of a table on disk. This view is accessible to all users, however non-superusers will only be able to see tables that they have permission to access. The columns of the view are described as follows:
sotdoid: The object ID of the table.sotdsize: The size of the table in bytes. The size is only the main table size. The size does not include auxiliary objects such as oversized (toast) attributes, or additional storage objects for AO tables.sotdtoastsize: The size of the TOAST table (oversized attribute storage), if there is one.sotdadditionalsize: Reflects the segment and block directory table sizes for append-optimized (AO) tables.sotdschemaname: The schema name.sotdtablename: The table name.
gp_size_of_table_uncompressed
This view shows the uncompressed table size for append-optimized (AO) tables. Otherwise, the table size on disk is shown. The use of this view requires superuser permissions. The columns of the view are described as follows:
sotuoid: The object ID of the table.sotusize: The uncompressed size of the table in bytes if it is a compressed AO table. Otherwise, the table size on disk.sotuschemaname: The schema name.sotutablename: The table name.
gp_disk_free
This external table runs the df (disk free) command on the active segment hosts and reports back the results. Inactive mirrors are not included in the calculation. The use of this external table requires superuser permissions. The columns of the view are described as follows:
dfsegment: The content id of the segment (only active segments are shown).dfhostname: The hostname of the segment host.dfdevice: The device name.dfspace: Free disk space in the segment file system in kilobytes.
Check for missing and orphaned data files
Apache Cloudberry considers a relation data file that is present in the catalog, but not on disk, to be missing. Conversely, when Apache Cloudberry encounters an unexpected data file on disk that is not referenced in any relation, it considers that file to be orphaned.
Apache Cloudberry provides the following views to help identify if missing or orphaned files exist in the current database:
Consider it a best practice to check for these conditions prior to expanding the cluster or before offline maintenance.
By default, the views identified in this section are available to PUBLIC.
gp_check_orphaned_files
The gp_check_orphaned_files view scans the default and user-defined tablespaces for orphaned data files. Apache Cloudberry considers normal data files, files with an underscore (_) in the name, and extended numbered files (files that contain a .<N> in the name) in this check. gp_check_orphaned_files gathers results from the Apache Cloudberry coordinator and all segments.
The columns of the view are described as follows:
gp_segment_id: The database segment identifier.tablespace: The identifier of the tablespace in which the orphaned file resides.filename: The file name of the orphaned data file.filepath: The file system path of the orphaned data file, relative to the data directory of the coordinator or segment.
Caution
Use this view as one of many data points to identify orphaned data files. Do not delete files based solely on results from querying this view.
gp_check_missing_files
The gp_check_missing_files view scans heap and append-optimized, column-oriented tables for missing data files. Apache Cloudberry considers only normal data files (files that do not contain a . or an _ in the name) in this check. gp_check_missing_files gathers results from the Apache Cloudberry coordinator and all segments.
The columns of the view are described as follows:
gp_segment_id: The database segment identifier.tablespace: The identifier of the tablespace in which the table resides.relname: The name of the table that has a missing data file(s).filename: The file name of the missing data file.
gp_check_missing_files_ext
The gp_check_missing_files_ext view scans only append-optimized, column-oriented tables for missing extended data files. Apache Cloudberry considers both normal data files and extended numbered files (files that contain a .<N> in the name) in this check. Files that contain an _ in the name are not considered. gp_check_missing_files_ext gathers results from the Apache Cloudberry database segments only.
The columns of the view are described as follows:
gp_segment_id: The database segment identifier.tablespace: The identifier of the tablespace in which the table resides.relname: The name of the table that has a missing extended data file(s).filename: The file name of the missing extended data file.
Move orphaned data files
The gp_move_orphaned_files() user-defined function (UDF) moves orphaned files found by the gp_check_orphaned_files view into a file system location that you specify.
The function signature is: gp_move_orphaned_files( <target_directory> TEXT ).
<target_directory> must exist on all segment hosts before you move the files, and the specified directory must be accessible by the gpadmin user. If you specify a relative path for <target_directory>, it is considered relative to the data directory of the coordinator or segment.
Apache Cloudberry renames each moved data file to one that reflects the original location of the file in the data directory. The file name format differs depending on the tablespace in which the orphaned file resides:
| Tablespace | Renamed file format |
|---|---|
default | seg<num>_base_<database-oid>_<relfilenode> |
global | seg<num>_global_<relfilenode> |
user-defined | seg<num>_pg_tblspc_<tablespace-oid>_<gpdb-version>_<database-oid>_<relfilenode> |
For example, if a file named 12345 in the default tablespace is orphaned on primary segment 2,
SELECT * FROM gp_move_orphaned_files('/home/gpadmin/orphaned');
moves and renames the file as follows:
- original location:
<data_directory>/base/13700/12345 - new location and file name:
/home/gpadmin/orphaned/seg2_base_13700_12345
gp_move_orphaned_files() returns both the original and the new file system locations for each file that it moves, and also provides an indication of the success or failure of the move operation. For example:
SELECT * FROM gp_toolkit.gp_move_orphaned_files('/home/gpadmin/orphaned');
gp_segment_id | move_success | oldpath | newpath
---------------+--------------+----------------------------+-----------------------------------
-1 | t | /<data_dir>/base/13715/99999 | /home/gpadmin/orphaned/seg-1_base_13715_99999
1 | t | /<data_dir>/base/13715/99999 | /home/gpadmin/orphaned/seg1_base_13715_99999
2 | t | /<data_dir>/base/13715/99999 | /home/gpadmin/orphaned/seg2_base_13715_99999
(3 rows)
Once you move the files, you may choose to remove them or to back them up.
Check for uneven data distribution
All tables in Apache Cloudberry are distributed, meaning their data is divided across all of the segments in the system. If the data is not distributed evenly, then query processing performance may decrease. The following views can help diagnose if a table has uneven data distribution:
gp_skew_coefficients
This view shows data distribution skew by calculating the coefficient of variation (CV) for the data stored on each segment. This view is accessible to all users, however non-superusers will only be able to see tables that they have permission to access.
The columns of the view are described as follows:
skcoid: The object id of the table.skcnamespace: The namespace where the table is defined.skcrelname: The table name.skccoeff: The coefficient of variation (CV) is calculated as the standard deviation divided by the average. It takes into account both the average and variability around the average of a data series. The lower the value, the better. Higher values indicate greater data skew.
gp_skew_idle_fractions
This view shows data distribution skew by calculating the percentage of the system that is idle during a table scan, which is an indicator of processing data skew. This view is accessible to all users, however non-superusers will only be able to see tables that they have permission to access.
The columns of the view are described as follows:
sifoid: The object id of the table.sifnamespace: The namespace where the table is defined.sifrelname: The table name.siffraction: The percentage of the system that is idle during a table scan, which is an indicator of uneven data distribution or query processing skew. For example, a value of0.1indicates 10% skew, a value of0.5indicates 50% skew, and so on. Tables that have more than 10% skew should have their distribution policies evaluated.
Maintain partitions
If your database employs partitions you will need to perform certain tasks regularly to help maintain those partitions. Apache Cloudberry includes a view and a number of user-defined functions to help with these tasks.
The gp_partitions view
The gp_partitions view shows all leaf partitions in a database.
This view provides backwards compatibility with the legacy pg_partitions view (available in earlier major versions of Apache Cloudberry). The columns of the view are described as follows:
| Column | Type | Description |
|---|---|---|
schemaname | name | The name of the schema the partitioned table is in. |
tablename | name | The name of the top-level parent table. |
partitionschemaname | name | The schema of the partition table. |
partitiontablename | name | The relation name of the partitioned table (this is the table name to use if accessing the partition directly). |
parentpartitiontablename | regclass | The relation name of the parent table one level up from this partition. |
partitiontype | text | The type of partition (range or list). |
partitionlevel | integer | The level of this partition in the hierarchy. |
partitionrank | integer | For range partitions, the rank of the partition compared to other partitions of the same level. |
partitionlistvalues | text | For list partitions, the list value(s) associated with this partition. |
partitionrangestart | text | For range partitions, the start value of this partition. |
partitionrangeend | text | For range partitions, the end value of this partition. |
partitionisdefault | boolean | T if this is a default partition, otherwise F. |
partitionboundary | text | The entire partition specification for this partition. |
parenttablespace | name | The tablespace of the parent table one level up from this partition. |
partitiontablespace | name | The tablespace of this partition. |
User-defined functions for partition maintenance
The following table summarizes the functions Apache Cloudberry provides to help you maintain partitions:
| Function | Return type | Description |
|---|---|---|
pg_partition_rank(rp regclass) | integer | For range partitions, returns the rank of the partition compared to other partitions of the same level. For other partition types, it returns NULL. |
pg_partition_range_from(rp regclass) | text | Returns the lower bound of a range partition. |
pg_partition_range_to(rp regclass) | text | Returns the upper bound of a range partition. |
pg_partition_isdefault(rp regclass) | boolean | Evaluates whether a given partition is a default partition. |
pg_partition_lowest_child(rp regclass) | regclass | Finds the lowest ranked child of given partition. |
pg_partition_highest_child(rp regclass) | regclass | Finds the highest ranked child of given partition. |
