SNAPHADR administrative view and SNAP_GET_HADR table function - Retrieve hadr logical data group snapshot information

The SNAPHADR administrative view and the SNAP_GET_HADR table function return information about high availability disaster recovery from a database snapshot, in particular, the hadr logical data group.

The SNAPHADR administrative view and SNAP_GET_HADR table function have been deprecated and replaced by the MON_GET_HADR table function - Returns high availability disaster recovery (HADR) monitoring information.

Depending on if you are using the administrative view or the table function, refer to one of the following sections:

SNAPHADR administrative view

This administrative view allows you to retrieve hadr logical data group snapshot information for the currently connected database. The data is only returned by this view if the database is a primary or standby high availability disaster recovery (HADR) database.

Used with the MON_GET_DATABASE, MON_GET_MEMORY_SET, MON_GET_MEMORY_POOL, MON_GET_TRANSACTION_LOG and ADMIN_GET_STORAGE_PATHS table functions, the SNAPHADR administrative view provides information equivalent to the GET SNAPSHOT FOR DATABASE ON database-alias CLP command.

The schema is SYSIBMADM.

Refer to Table 1 for a complete list of information that can be returned.

Authorization

One of the following authorizations is required:
  • SELECT privilege on the SNAPHADR administrative view
  • CONTROL privilege on the SNAPHADR administrative view
  • DATAACCESS authority
One of the following is required to use the table function:
  • EXECUTE privilege on the SNAP_GET_HADR table function
  • DATAACCESS authority
In addition, to access snapshot monitor data, one of the following authorities is also required:
  • SYSMON
  • SYSCTRL
  • SYSMAINT
  • SYSADM

Default PUBLIC privilege

In a non-restrictive database, SELECT privilege is granted to PUBLIC when the view is automatically created.

Example

Retrieve the configuration and status information for HADR on the primary HADR database. 
SELECT SUBSTR(DB_NAME, 1, 8) AS DBNAME, HADR_ROLE, HADR_STATE, 
   HADR_SYNCMODE, HADR_CONNECT_STATUS 
   FROM SYSIBMADM.SNAPHADR
The following is an example of output from this query. 
DBNAME   HADR_ROLE HADR_STATE     HADR_SYNCMODE HADR_CONNECT_STATUS
-------- --------- -------------- ------------- -------------------
SAMPLE   PRIMARY   PEER           SYNC          CONNECTED

  1 record(s) selected.

SNAP_GET_HADR table function

The SNAP_GET_HADR table function returns the same information as the SNAPHADR administrative view, but allows you to retrieve the information for a specific database on a specific database member, aggregate of all database members or all database members.

Used with the SNAP_GET_DB, SNAP_GET_DB_MEMORY_POOL, SNAP_GET_DETAILLOG and ADMIN_GET_STORAGE_PATHS table functions, the SNAP_GET_HADR table function provides information equivalent to the GET SNAPSHOT FOR ALL DATABASES CLP command.

Refer to Table 1 for a complete list of information that can be returned.

Syntax

Read syntax diagramSkip visual syntax diagramSNAP_GET_HADR(dbname, member)

The schema is SYSPROC.

Table function parameters

dbname
An input argument of type VARCHAR(128) that specifies a valid database name in the same instance as the currently connected database. Specify a database name that has a directory entry type of either "Indirect" or "Home", as returned by the LIST DATABASE DIRECTORY command. Specify an empty string to take the snapshot from the currently connected database. Specify a NULL value to take the snapshot from all databases within the same instance as the currently connected database.
member
An optional input argument of type INTEGER that specifies a valid database member number. Specify -1 for the current database member, or -2 for an aggregate of all active database members. If dbname is not set to NULL and member is set to NULL, -1 is set implicitly for member. If this input option is not used, that is, only dbname is provided, data is returned from all active database members. An active database member is a member where the database is available for connection and use by applications.

If both dbname and member are set to NULL, an attempt is made to read data from the file created by SNAP_WRITE_FILE procedure. Note that this file could have been created at any time, which means that the data might not be current. If a file with the corresponding snapshot API request type does not exist, then the SNAP_GET_HADR table function takes a snapshot for the currently connected database and database member number.

Authorization

One of the following authorizations is required:
  • EXECUTE privilege on the SNAP_GET_HADR table function
  • DATAACCESS authority
In addition, to access snapshot monitor data, one of the following authorities is also required:
  • SYSMON
  • SYSCTRL
  • SYSMAINT
  • SYSADM

Default PUBLIC privilege

In a non-restrictive database, EXECUTE privilege is granted to PUBLIC when the function is automatically created.

Example

Retrieve the configuration and status information for HADR for all databases. 
SELECT SUBSTR(DB_NAME, 1, 8) AS DBNAME, HADR_ROLE, HADR_STATE, 
   HADR_SYNCMODE, HADR_CONNECT_STATUS 
   FROM TABLE (SNAP_GET_HADR (CAST (NULL as VARCHAR(128)), 0)) as T
The following is an example of output from this query. 
DBNAME   HADR_ROLE HADR_STATE     HADR_SYNCMODE HADR_CONNECT_STATUS
-------- --------- -------------- ------------- -------------------
SAMPLE   PRIMARY   PEER           SYNC          CONNECTED
TESTDB   PRIMARY   DISCONNECTED   NEARSYNC      DISCONNECTED 

2 record(s) selected.

Information returned

Table 1. Information returned by the SNAPHADR administrative view and the SNAP_GET_HADR table function
Column name Data type Description or corresponding monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
HADR_ROLE VARCHAR(10) hadr_role - HADR role . This interface returns a text identifier based on the defines in sqlmon.h, and is one of:
  • PRIMARY
  • STANDARD
  • STANDBY
HADR_STATE VARCHAR(14) hadr_state - HADR state . This interface returns a text identifier based on the defines in sqlmon.h, and is one of:
  • DISCONNECTED
  • LOCAL_CATCHUP
  • PEER
  • REM_CATCH_PEN
  • REM_CATCHUP
HADR_SYNCMODE VARCHAR(10) hadr_syncmode - HADR synchronization mode . This interface returns a text identifier based on the defines in sqlmon.h, and is one of:
  • ASYNC
  • NEARSYNC
  • SUPERASYNC
  • SYNC
HADR_CONNECT_STATUS VARCHAR(12) hadr_connect_status - HADR connection status . This interface returns a text identifier based on the defines in sqlmon.h, and is one of:
  • CONGESTED
  • CONNECTED
  • DISCONNECTED
HADR_CONNECT_TIME TIMESTAMP hadr_connect_time - HADR connection time
HADR_HEARTBEAT INTEGER hadr_heartbeat - HADR heartbeat
HADR_LOCAL_HOST VARCHAR(255) hadr_local_host - HADR local host
HADR_LOCAL_SERVICE VARCHAR(40) hadr_local_service - HADR local service
HADR_REMOTE_HOST VARCHAR(255) hadr_remote_host - HADR remote host
HADR_REMOTE_SERVICE VARCHAR(40) hadr_remote_service - HADR remote service
HADR_REMOTE_INSTANCE VARCHAR(128) hadr_remote_instance - HADR remote instance
HADR_TIMEOUT BIGINT hadr_timeout - HADR timeout
HADR_PRIMARY_LOG_FILE VARCHAR(255) hadr_primary_log_file - HADR primary log file
HADR_PRIMARY_LOG_PAGE BIGINT hadr_primary_log_page - HADR primary log page
HADR_PRIMARY_LOG_LSN BIGINT hadr_primary_log_lsn - HADR primary log LSN
HADR_STANDBY_LOG_FILE VARCHAR(255) hadr_standby_log_file - HADR standby log file
HADR_STANDBY_LOG_PAGE BIGINT hadr_standby_log_page - HADR standby log page
HADR_STANDBY_LOG_LSN BIGINT hadr_standby_log_lsn - HADR standby log LSN
HADR_LOG_GAP BIGINT hadr_log_gap - HADR log gap
DBPARTITIONNUM SMALLINT dbpartitionnum - Database partition number monitor element
MEMBER SMALLINT member - Database member monitor element