SNAPFCM administrative view and SNAP_GET_FCM table function - Retrieve the fcm logical data group snapshot information

The SNAPFCM administrative view and the SNAP_GET_FCM table function return information about the fast communication manager from a database manager snapshot, in particular, the fcm logical data group.

Important: The SNAPFCM administrative view and the SNAP_GET_FCM table function are deprecated and have been replaced by the MON_GET_FCM - Get FCM metrics.
Depending on if you are using the administrative view or the table function, refer to one of the following sections:

SNAPFCM administrative view

Used with the SNAPSWITCHES administrative view an the MON_GET_FCM, MON_GET_INSTANCE, MON_GET_MEMORY_SET, and MON_GET_MEMORY_POOL table functions, the SNAPFCM administrative view provides the data equivalent to the GET SNAPSHOT FOR DBM 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 to use the view:
  • SELECT privilege on the SNAPFCM administrative view
  • CONTROL privilege on the SNAPFCM administrative view
  • DATAACCESS authority
  • DBADM authority
  • SQLADM authority
One of the following is required to use the table function:
  • EXECUTE privilege on the SNAP_GET_FCM table function
  • DATAACCESS authority
  • DBADM authority
  • SQLADM 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 information about the fast communication manager's message buffers on all members. 
SELECT BUFF_FREE, BUFF_FREE_BOTTOM, MEMBER
    FROM SYSIBMADM.SNAPFCM ORDER BY MEMBER
The following is an example of output from this query. 
BUFF_FREE        BUFF_FREE_BOTTOM     MEMBER
---------...---- -------------------- --------------
            5120                 5100              0
            5120                 5100              1
            5120                 5100              2

SNAP_GET_FCM table function

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

Used with the SNAP_GET_DBM, SNAP_GET_DBM_MEMORY_POOL, SNAP_GET_FCM_PART and SNAP_GET_SWITCHES table functions, the SNAP_GET_FCM table function provides the data equivalent to the GET SNAPSHOT FOR DBM command.

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

Syntax

Read syntax diagramSkip visual syntax diagramSNAP_GET_FCM(member)

The schema is SYSPROC.

Table function parameter

member
An optional input argument of type INTEGER that specifies a valid database member number. Specify -1 for the current member, or -2 for an aggregate of all active 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, data will be 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 member is 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_FCM table function takes a snapshot for the currently connected database and database member.

Authorization

One of the following authorizations is required:
  • EXECUTE privilege on the SNAP_GET_FCM 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 information about the fast communication manager's message buffers on database member 1. 
SELECT BUFF_FREE, BUFF_FREE_BOTTOM, MEMBER 
   FROM TABLE(SYSPROC.SNAP_GET_FCM( 1 )) AS T
The following is an example of output from this query. 
BUFF_FREE            BUFF_FREE_BOTTOM     MEMBER
-------------------- -------------------- ------
                5120                 5100      1

Information returned

Table 1. Information returned by the SNAPFCM administrative view and the SNAP_GET_FCM table function
Column name Data type Description or corresponding monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the snapshot was taken.
BUFF_FREE BIGINT buff_free - FCM buffers currently free
BUFF_FREE_BOTTOM BIGINT buff_free_bottom - Minimum FCM Buffers Free
CH_FREE BIGINT ch_free - Channels Currently Free
CH_FREE_BOTTOM BIGINT ch_free_bottom - Minimum Channels Free
DBPARTITIONNUM SMALLINT dbpartitionnum - Database partition number monitor element
MEMBER SMALLINT member - Database member monitor element