db2ACS_PathEntry DB2 Advanced Copy Services (ACS) API data structure

typedef struct db2ACS_PathEntry
{
   /* INPUT: The path and type will be provided by the database server, as well
    *        as a flag indicating if the path is to be excluded from the backup.
    * ----------------------------------------------------------------------- */
   char                       path[DB2ACS_MAX_PATH_SZ + 1];
   db2ACS_PathType            type;
   db2Uint32                  toBeExcluded;

   /* OUTPUT: The group ID is to be provided by the backup adapter for use by
    *         the DB2 server.  The group ID will be used during with snapshot
    *         operations as an indication of which paths are dependent and must
    *         be included together in any snapshot operation.  Unique group IDs
    *         indicate that the paths in those groups are independent for the
    *         purposes of snapshot operations.
    * ----------------------------------------------------------------------- */
   db2Uint32                  groupID;
} db2ACS_PathEntry;

path

Data type: char[].

A character string of length DB2ACS_MAX_PATH_SZ + 1.

type

Data type: db2ACS_PathType.

The type of path. Values:

DB2ACS_PATH_TYPE_UNKNOWN
DB2ACS_PATH_TYPE_LOCAL_DB_DIRECTORY
DB2ACS_PATH_TYPE_DBPATH
DB2ACS_PATH_TYPE_DB_STORAGE_PATH
DB2ACS_PATH_TYPE_TBSP_CONTAINER
DB2ACS_PATH_TYPE_TBSP_DIRECTORY
DB2ACS_PATH_TYPE_TBSP_DEVICE
DB2ACS_PATH_TYPE_LOGPATH
DB2ACS_PATH_TYPE_MIRRORLOGPATH

toBeExcluded

Data type: db2Uint32.

A flag indicating whether to include the given path in the snapshot backup. Values:

• 0 - include the path in the snapshot backup
• 1 - do not include the path in the snapshot backup

groupID

Data type: db2Uint32.

A group identifier.