The Ark DBA Tables

The tables accessed through the DBA tab display a read-only view of the database tables. A DBA can use the information to diagnose some user issues without accessing the console database directly or issuing SQL commands. The tables provide helpful information that a cloud administrator can use when troubleshooting.

For security reasons, the DBA tab does not display the table in which the server stores personal information about registered users, and columns containing sensitive information are obfuscated.

activation

The activation table stores the user activation codes that are generated during registration or password recovery. The table contains one entry for each activation code generated.

Column Name Description
ID The row identifier for the activation table.
ACTIVATION TIME The time that the user activated his account or reset his password.
CODE A unique code that identifies the transaction. This code is supplied to the user as part of the link in the email.
CODETYPE

The activation code types. The valid types are:

NEW_USER

RESET_PASSWORD

CREATION_TIME The time that the activation code was created.
USER_ID The identity of the user to whom the activation email was sent.

attachedvolume

The attachedvolume table provides information about volumes attached to cluster instances. The table contains one entry for each attached volume.

Column Name Description
ID The volume to which the instance is attached. The service provider supplies this identifier.
ATTACHTIME The date and time that the volume was attached.
DEVICE The mount point of the volume.
INSTANCEID The cloud service provider’s instance identifier.
REGION The cloud service provider’s service region (if applicable).
STATUS The current status of the volume.
IOPS The IOPs value for the volume.
OPTIMIZED True if the cluster is optimized, False if the cluster is not optimized.

backups

The backups table provides information about the current backups stored by the server. A backup consists of multiple snapshots (one for each EBS volume in a cluster).

Column Name Description
ID A string value that identifies the backup
BACKUPTYPE Manual Backup if the backup was invoked by a user; Auto Backup if the backup was a scheduled system backup.
CAPACITY The size of the backup. If the cluster is encrypted, the column will also include (encrypted).
ENDED The time at which the backup ended.
ENGINEVERSION The Postgres engine version.
MASTERUSER The name of the database superuser.
NOTES Notes added by the cluster owner when the snapshot was taken.
OWNER The name of the cluster owner.
PROGRESS The most-recent information about the progress of the backup.
SIGNATURE The name of the cluster owner and the cluster (colon delimited).
STARTED The time at which the backup began.
CONTINUOUSARCHIVING True if archiving is enabled; false if archiving is disabled.
CLUSTERUUID The identifier of the cluster from which the backup was created.
XLOGLOCATION The location of the Xlog file for the backup.
XLOGFILENAME The identifier of the Xlog file for the backup.
WALARCHIVECONTAINER The name of the archive container in which the WAL logs are stored.
ENCRYPTFS True if the content of a backup is stored on an encrypted file system; false if it is not.
ENCRYPTKEY The key associated with the backup (obscured).
TENANT The tenant in which the cluster resides.
YUMUPDATE True if updates are enabled for the cluster; false if they are not.
DBENGINE_ID The engine number of the database engine used by the cluster.

consoleurl

The consoleurl table provides a list of the resources currently made available by the console switcher.

Column Name Description
ID The row ID.
NAME The name of the cluster that resides on th eURL.
URL The URL of the master node of the cluster.

dbengine

The dbengine table provides information about the currently defined database engines. The table contains one entry for each engine.

Column Name Description
ID The row ID.
ENGINE_ID The engine identifier.
EOL true if the engine is no longer supported; false if the engine is supported.
NAME The (user-friendly) name of the database engine.
OPTIONAL_PKGS The optional packages that are installed on the database server (specified in the engine definition).
REQUIRED_PKGS The required packages that are installed on the database server (specified in the engine definition.
TYPE The database server type.
VERSION The version of the database server.
SERVERIMAGE_ID The database ID of the server image that is linked to the database engine.
RHELSUBSCRIPTION_ID The identifier of the Red Hat subscription associated with the engine.

instances

The instances table provides information about the currently active EDB Ark nodes for the EDB Ark service account. The table contains one entry for each instance (master or replica node).

Column Name Description
ID The instance ID assigned by the service provider.
AUTOSCALE true if auto-scaling is enabled on the cluster; false if auto-scaling is disabled.
AVAILABILITYZONE The data center in which the cluster resides.
BACKUPRETENTION The number of backups that EDB Ark will retain for the master node of the cluster.
BACKUPWINDOW The time during which backups will be taken.
CLUSTERNAME The name of the cluster.
CLUSTERSTATE

The current state of the database. Valid values are:

STOPPED = 0

STARTING = 1

RUNNING = 2

WARNING = 3

UNKNOWN = 99

CLUSTERNODEID On a primary instance, this is the count of how many nodes have been created so far in this cluster, including any dead nodes. On a replica instance, this represents the order in which it was created in the cluster.
CONNECTIONTHRESHOLD The value specified in the Auto-Scaling Thresholds portion of the Details panel, on the Clusters tab. Specifies the number of connections made before the cluster is scaled up.
CONNECTIONS The number of active database connections.
CPULOAD The current CPU load of the instance.
CPUTHRESHOLD The CPU load threshold at which the cluster will be automatically scaled up.
CREATIONTIME The date and time that the node was created.
DATATHRESHOLD The disk space threshold at which the cluster will be automatically scaled up.
DBNAME The name of the default database created when the instance was created (edb or postgres).
DBPORT The database listener port.
DBSTATE
The current state of the database:
0 – Stopped

1 – Starting

2 – Running

3 – Warning

99 – Unknown

DNSNAME The IP address of the instance.
ENGINEVERSION The version of the database that is running on the instance.
FREEDATASPACE The current amount of free data space on the instance.
IMAGEID The server image used when creating the node.
INSTANCESTATE The current state of the node.
MASTERPW The password of the cluster owner.
MASTERUSER The name of the cluster owner.
OWNER The owner of the node.
PARAMETERGROUP The name of the database parameter group used by the instance.
PENDINGMODIFICATIONS A message describing any cluster modification in progress (if applicable).
PORT The SSH port for the cluster.
PRIMARYFAILOVERTOREPLICA Boolean value; true if the cluster will fail over to a replica; false if the cluster will fail over to a new master instance.
PRIVATEIP The private IP address of the node.
HARDWARE The specified hardware size of the instance.
PUBLICIP The public IP address of the node.
READONLY True id the node is a read-only replica; false if the node is a master node.
REGION The region in which the node resides.
SECURITYGROUP The security group assigned to the node.
SSHKEY The node’s SSH key.
SSHKEYNAME The name of the node’s SSH key.
STORAGE The amount of disk space on the instance.
SUBNET The VPC subnet ID (valid for AWS users only).
USEDATASPACE The current amount of used data space on the instance.
OPTIMIZED Boolean value; true if an instance is optimized; false if not (valid for AWS users only).
IOPS The requested IOPS setting for the cluster (valid for AWS users only).
MONITORINGLB Boolean value; true if load balancing is enabled, false if load balancing is not enabled.
CASTATE The most-recent continuous archiving state of the instance.
CONTINUOUSARCHIVING Boolean value; true if continuous archiving is enabled, false if continuous archiving is not enabled.
CLUSTERUUID The unique cluster identifier.
VPC The VPC ID (valid for AWS users only).
ENCRYPTFS True if encryption is enabled for the cluster; false if it is not.
ENCRYPTKEY The encryption key for the cluster.
CLUSTERKEY The SSH key shared by all of the instances in the cluster.
CLUSTERKEYNAME The name of the SSH key.
LBPORT The load balancing port of the instance.
NOTIFICATIONEMAIL The notification email for the cluster.
TENANT The tenant in which the node was created.
VERSION_NUM The version of EDB Ark under which the instance was created.
VOLUMETYPE If supported, the volume type of the cluster.
YUMSTATUS
The current yum status of the node:
0 – OK

1 – Unknown

2 – Warning

3 – Critical

YUMUPDATE Boolean value; true if the cluster was created with “yum update” enabled, false if “yum update” was not enabled when the cluster was created.
DBENGINE_ID The selected database engine installed on the instance.

nodestatistics

The nodestatistics table displays information gathered by the cluster manager about the activity for each node. The table contains one record for each time that the cluster manager collected information.

Column Name Description
ID The row identifier for the nodestatistics table.
CONNECTIONS The number of connections to the specified node.
CPULOAD The processing load placed on the CPU by connecting clients.
FREEMEM The amount of free memory available to the node.
NODEID The service provider’s node identifier.
OPSPERSECOND The number of operations per second.
TIMESTAMP The time at which the data was gathered.
USEDMEM The amount of used memory (on the node).

pcshistory

The pcshistory table provides a sortable list of the transactions that have been displayed on the Events tabs of the registered users of the EDB Ark service account.

Column Name Description
ID The row identifier for the pcshistory table.
CLOCKTIME The time at which the event occurred.
DESCRIPTION The description of the event.
OWNER The registered owner of the cluster on which the event occurred.
SOURCE The name of the cluster on which the event occurred.

property

The property table displays persistent properties used in the console, such as the console name used during backups and wall messages.

Column Name Description
NAME The name of a property.
VALUE The value of the property.

rhelrepo

The rhelrepo table provides information about the repositories required by the described Red Hat Subscription Manager services.

Column Name Description
ID The unique identifier of the repository.
REPO_NAME The repository name.
SUBSCRIPTION_ID The descriptive identifier of the Red Hat Subscription Manager service.

rhelsubscription

The rhelsubscription table provides information about currently defined Red Hat Subscription Manager services.

Column Name Description
ID The unique identifier of the server.
ACTIVATION_KEY The activation key of the Red Hat subscription.
AUTO_ATTACH Indicates if nodes associated with the subscription will automatically attach to the service.
BASE_URL The content delivery server used by the service.
ENVIRONMENT The name of the environment (within the organization that will be registered).
FORCE Indicates if the node should be registered (even if the node is already registered).
NAME The name of the system that will be registered.
ORG The organization that will be registered with the Red Hat subscription system.
PASSWORD The password associated with the user account.
RELEASE The operating system minor release that will be used when identifying updates to any nodes provisioned with the subscription.
SERVER_URL The host name of the subscription server used by the service.
SERVICE_LEVEL The service level of the Red Hat subscription.
SUBSCRIPTION_ID The user-friendly name of the subscription.
TYPE The type of consumer that is being registered by the subscription service.
USERNAME The name of the user account registered with the Red Hat content server.
POOL The pool identifier for the Red Hat subscription service.
QUANTITY The number of subscriptions in the subscription pool.
ATTACH_AUTO Indicates if nodes using the pool will automatically attach to the service.

serverimage

The serverimage table provides information about currently defined EDB Ark server images.

Column Name Description
ID The unique identifier of the server.
INIT_USER The virtual machine OS user (as provided on the Add Server dialog).
SERVER_DESCRIPTION The server description.
SERVER_ID The descriptive identifier of the server.
OS_TYPE The operating system type of the server.
IS_STATIC The provisioning mode of the server; true if the server is static, false if the server is not static.

snapshots

The snapshots table provides information about cluster backups that reside in the cloud.

Column Name Description
ID The unique snapshot identifier.
BACKUPID An application-managed foreign key reference to the ID column of the backups table.
CAPACITY The size of the snapshot.
DESCRIPTION The name of the cluster owner and the cluster (colon delimited).
ENDED The time at which the backup ended.
ENGINEVERSION The Postgres engine version.
MASTERPW The password of the database superuser.
MASTERUSER The name of the database superuser.
NOTES Notes added by the cluster owner when the snapshot was taken.
OWNER The name of the cluster owner.
PROGRESS The most-recent information about the progress of the snapshot.
SHARED Deprecated column.
STARTED The time at which the backup began.
STATUS Manual Backup if the backup was invoked by a user; Auto Backup if the backup was a scheduled system backup.
VOLUMESIZE The size of the retained backup.

template

The template table provides information about the configurations available with each template.

Column Name Description
ID The unique identifier of the template (system assigned).
BACKUPRETENTION The number of backups that Ark will retain for the master node of the cluster.
BACKUPWINDOW The time during which backups will be taken.
CONTINUOUSARCHIVING True if archiving is enabled; false if archiving is disabled.
DESCRIPTION The colon delimited namd of the cluster owner and the cluster.
DISABLED True if the template is enabled; false if it is disabled.
ENCRYPTFS True if the content of a backup is stored on an encrypted file system; false if it is not.
HARDWARE The specified hardware size of the instance.
NAME The name of the template.
NUMNODES The number of nodes that will be created in a cluster deployed with this template.
STORAGE The amount of disk space available to the cluster.
TENANTS The names of the roles or tenants that may use this template.
VPC The VPC ID (valid for AWS users only).
YUMUPDATE True if updates are enabled for the cluster; false if they are not.
DBENGINE_ID The database engine used by the template.
MANUALLYSCALEREPLICAS MANUALLYSCALEREPLICAS indicates if users of this template will be allowed to manually scale replica nodes configured by this template.
MANUALLYSCALESTORAGE MANUALLYSCALESTORAGE indicates if users of this template will be allowed to manually scale storage on clusters configured by this template.
AUTOSCALEREPLICAS AUTOSCALEREPLICAS indicates if users of this template will be able to configure automatic node scaling for clusters configured by this template.
AUTOSCALESTORAGE AUTOSCALESTORAGE indicates if users of this template will be able to configure automatic storage scaling for clusters configured by this template.
OPTIMIZED Boolean value; true if an instance is optimized; false if not (valid for AWS users only).
IOPS The IOPS setting for the cluster (valid for AWS users only).