db2ACS_ObjectInfo Db2 Advanced Copy Services (ACS) API data structure

db2ACS_ObjectInfo contains information about object created using the Db2 Advanced Copy Services (ACS) API.


/* ==========================================================================
 * Object Description and Associated Information.
 *
 * This structure is used for both input and output, and its contents define
 * the minimum information that must be recorded about any object created
 * through this interface.
 * ========================================================================== */
typedef struct db2ACS_ObjectInfo
{
   db2ACS_ObjectType          type;
   SQL_PDB_NODE_TYPE          dbPartitionNum;

   char                       db[SQL_DBNAME_SZ + 1];
   char                       instance[DB2ACS_MAX_OWNER_SZ + 1];
   char                       host[SQL_HOSTNAME_SZ + 1];
   char                       owner[DB2ACS_MAX_OWNER_SZ + 1];

   union
   {
      db2ACS_BackupDetails    backup;
      db2ACS_LogDetails       log;
      db2ACS_LoadcopyDetails  loadcopy;
      db2ACS_SnapshotDetails  snapshot;
   } details;
} db2ACS_ObjectInfo;

type

Data type: db2ACS_ObjectType.

Specifies the snapshot backup objects type. Values:

DB2ACS_OBJTYPE_ALL
DB2ACS_OBJTYPE_BACKUP
DB2ACS_OBJTYPE_LOG
DB2ACS_OBJTYPE_LOADCOPY
DB2ACS_OBJTYPE_SNAPSHOT

DB2ACS_OBJTYPE_ALL can only be used as a filter for queries. There are no objects of type 0.

dbPartitionNum

Data type: SQL_PDB_NODE_TYPE.

An identifier for this database partition.

db

Data type: char[].

A character string of length SQL_DBNAME_SZ + 1.

instance

Data type: char[].

A character string of length DB2ACS_MAX_OWNER_SZ + 1.

host

Data type: char[].

A character string of length SQL_HOSTNAME_SZ + 1.

owner

Data type: char[].

A character string of length DB2ACS_MAX_OWNER_SZ + 1.

details

backup: Data type: db2ACS_BackupDetails
db2ACS_BackupDetails contains information about a snapshot backup operation.
log: Data type: db2ACS_LogDetails
db2ACS_LogDetails contains information that identifies a particular database log file.
loadcopy: Data type: db2ACS_LoadcopyDetails
db2ACS_LoadcopyDetails contains information about a load copy operation.
snapshot: Data type: db2ACS_SnapshotDetails
db2ACS_SnapshotDetails contains information about a snapshot backup operation.