DB2 Version 9.7 for Linux, UNIX, and Windows

SNAPAGENT administrative view and SNAP_GET_AGENT table function - Retrieve agent logical data group application snapshot information

The SNAPAGENT administrative view and the SNAP_GET_AGENT table function return information about agents from an application snapshot, in particular, the agent logical data group.

SNAPAGENT administrative view

This administrative view allows you to retrieve agent logical data group application snapshot information for the currently connected database.

Used with the SNAPAGENT_MEMORY_POOL, SNAPAPPL, SNAPAPPL_INFO, SNAPSTMT and SNAPSUBSECTION administrative views, the SNAPAGENT administrative view provides information equivalent to the GET SNAPSHOT FOR APPLICATIONS ON database-alias CLP command, but retrieves data from all database partitions.

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 SNAPAGENT administrative view
  • CONTROL privilege on the SNAPAGENT administrative view
  • DATAACCESS authority
In addition, one of the following privileges or authorities is also required:
  • EXECUTE privilege on the SNAP_GET_AGENT table function
  • DATAACCESS authority
In addition, to access snapshot monitor data, one of the following authorities is also required:
  • SYSMON
  • SYSCTRL
  • SYSMAINT
  • SYSADM

Example

Retrieve all application snapshot information for the currently connected database from the agent logical data group. 
SELECT * FROM SYSIBMADM.SNAPAGENT
The following example is a sample output from this query. 
SNAPSHOT_TIMESTAMP         DB_NAME     AGENT_ID        ... 
-------------------------- -------...- ---------...--- ... 
2005-07-19-11.03.26.740423 SAMPLE                  101 ... 
2005-07-19-11.03.26.740423 SAMPLE                   49 ... 
                                                       ... 
  2 record(s) selected.                                ...
Output from this query (continued). 
...  AGENT_PID            LOCK_TIMEOUT_VAL     DBPARTITIONNUM
...  -------------------- -------------------- --------------
...                 11980                   -1              0
...                 15940                   -1              0
...                                                          
...

SNAP_GET_AGENT table function

The SNAP_GET_AGENT table function returns the same information as the SNAPAGENT administrative view, but allows you to retrieve the information for a specific database on a specific database partition, aggregate of all database partitions or all database partitions.

Used with the SNAP_GET_AGENT_MEMORY_POOL, SNAP_GET_APPL_V95, SNAP_GET_APPL_INFO_V95, SNAP_GET_STMT and SNAP_GET_SUBSECTION table functions, the SNAP_GET_AGENT table function provides information equivalent to the GET SNAPSHOT FOR ALL APPLICATIONS CLP command, but retrieves data from all database partitions.

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

Syntax

Read syntax diagramSkip visual syntax diagram
>>-SNAP_GET_AGENT--(--dbname--+------------------+--)----------><
                              '-, dbpartitionnum-'      

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.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database partition number. Specify -1 for the current database partition, or -2 for an aggregate of all active database partitions. If dbname is not set to NULL and dbpartitionnum is set to NULL, -1 is set implicitly for dbpartitionnum. If this input option is not used, that is, only dbname is provided, data is returned from all active database partitions. An active database partition is a partition where the database is available for connection and use by applications.

If both dbname and dbpartitionnum 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_AGENT table function takes a snapshot for the currently connected database and database partition number.

Authorization

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

Example

Retrieve all application snapshot information for all applications in all active databases. 
SELECT * FROM TABLE(SNAP_GET_AGENT(CAST(NULL AS VARCHAR(128)), -1)) AS T
The following example is a sample output from this query. 
SNAPSHOT_TIMESTAMP         DB_NAME     AGENT_ID      ... 
-------------------------- -------...- --------...-- ... 
2006-01-03-17.21.38.530785 SAMPLE                 48 ... 
2006-01-03-17.21.38.530785 SAMPLE                 47 ... 
2006-01-03-17.21.38.530785 SAMPLE                 46 ... 
2006-01-03-17.21.38.530785 TESTDB                 30 ... 
2006-01-03-17.21.38.530785 TESTDB                 29 ... 
2006-01-03-17.21.38.530785 TESTDB                 28 ... 
                                                         
6 record(s) selected.
Output from this query (continued). 
... AGENT_PID        LOCK_TIMEOUT_VAL     DBPARTITIONNUM 
... ---------...---- -------------------- -------------- 
...             7696                   -1              0 
...             8536                   -1              0 
...             6672                   -1              0 
...             2332                   -1              0 
...             8360                   -1              0 
...             6736                   -1              0 
...

Information returned

Table 1. Information returned by the SNAPAGENT administrative view and the SNAP_GET_AGENT table function
Column name Data type Description or corresponding monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP snapshot_timestamp - Snapshot timestamp monitor element
DB_NAME VARCHAR(128) db_name - Database name
AGENT_ID BIGINT agent_id - Application handle (agent ID)
AGENT_PID BIGINT agent_pid - Engine dispatchable unit (EDU)
LOCK_TIMEOUT_VAL BIGINT lock_timeout_val - Lock timeout (seconds)
DBPARTITIONNUM SMALLINT The database partition from which the data for the row was retrieved.
Parent topic: Supported system-defined SQL routines and views
Related tasks:
Capturing database system snapshots using snapshot administrative views and table functions
Related reference:
Administrative views versus table functions
Database system monitor elements
GET SNAPSHOT command
SNAPAGENT_MEMORY_POOL administrative view and SNAP_GET_AGENT_MEMORY_POOL table function - Retrieve memory_pool logical data group snapshot information
SNAPAPPL administrative view and SNAP_GET_APPL_V95 table function - Retrieve appl logical data group snapshot information
SNAPAPPL_INFO administrative view and SNAP_GET_APPL_INFO_V95 table function - Retrieve appl_info logical data group snapshot information
SNAPSTMT administrative view and SNAP_GET_STMT table function - Retrieve statement snapshot information
SNAPSUBSECTION administrative view and SNAP_GET_SUBSECTION table function - Retrieve subsection logical monitor group snapshot information
SNAP_WRITE_FILE procedure