Mask definitions

Mask definitions are reusable; you can define a mask once and use it repeatedly.

Mask names, syntax, hierarchy, processing, and performance is the same whether you specify mask definitions in a data set or in the Change Management database.

Recommendation: Consider having an experienced DBA set up the masks initially. Other DBAs can then reuse the masks. For more recommendations, see Mask recommendations.

Syntax of mask definitions

The syntax of mask definitions depends on the type of mask you are creating:

Name masks
Use the following syntax to define a mask that changes a naming convention:
maskname: inputmask,outputmask
maskname
The name of the mask. Possible values are listed in Table 1.
inputmask
The input mask, which is the string pattern that you want to translate. The specified input mask cannot be longer than 256 bytes.
outputmask
The output mask, which is the string to which you want to translate the input mask. The specified output mask cannot be longer than 256 bytes.

A SINGLECH mask is a type of name mask; it masks a single character and is used in conjunction with another name mask. Use the following syntax for a SINGLECH mask:

SINGLECH:character[,escape character]
maskname: inputmask,outputmask 
character
A single character to use in the subsequent mask definition to indicate any character.
escape character
A character to be used as an escape character in the subsequent mask definition. If the specified escape character precedes character in the mask definition, character is treated as a literal.

Specifying an escape character is optional.

maskname:inputmask,outputmask
This line defines the name mask to which you want to apply the single character mask. Include character in inputmask or both inputmask and outputmask to indicate any single character in a particular position.

For examples of name masks and the SINGLECH mask, see Examples of name mask definitions.

Overwrite masks
Use the following syntax to define a mask that overwrites the value of a table space or index space attribute:
maskname: inputmask, overwrite_value
maskname
The name of the mask. For overwrite masks, the mask name is the name of the attribute that you want to overwrite. Possible values are listed in Table 2.
inputmask
The table space name or index space name. The specified input mask cannot be longer than 256 bytes.
overwrite_value
The new value to use for the attribute. The value that you can specify depends on the attribute. For possible values, see Table 2. The value can be a a string value such as YES or NO, an integer value (n), or an integer percentage of the current value (n%).

The value can also be a REXX user exit that calculates a value. See Specifying a REXX user exit for a mask overwrite value.

The specified overwrite value cannot be longer than 256 bytes. This length restriction also applies to the specification of a REXX user exit and its input variables.

For examples of overwrite masks, see Examples of overwrite mask definitions.

Verification masks
For syntax and examples, see Verification masks.

Masks can contain generic specifications, which are expressed by using an asterisk (*).

Use a plus sign (+) in column 72 to indicate the continuation of a mask definition onto the next line. The plus sign (+) can also be used in the middle of specifying a REXX user exit in the mask definition to indicate that the specification continues on the next line.

You can specify one or more masks. For information about how multiple mask definitions are processed, see Mask order.

Mask names

For name masks, which change a naming convention, valid mask names are listed in Table 1.

For overwrite masks, which overwrite object attributes, valid mask names are listed in Table 2.

Table 1. Masks for translating names
Name Description
SINGLECH Single characters
COLNAME Column names
NAME All object names (This mask affects all masks that have NAME as a parent or grandparent. See the mask hierarchy in Table 3.)
BPNAME All buffer pool names
IXBPNAME Buffer pool names for indexes
TSBPNAME Buffer pool names for table spaces
COLLNAME Collection names
CONSNAME Constraint names
DBNAME Database names
DBRMNAME 1 DBRM names (Used for BIND commands.)
GBPNAME 1 Group buffer pool names
GRPNAME Group names
GVNAME Names of global variables
IXNAME Index names
MKNAME Names of column masks
PGMNAME Program names; synonym for DBRM names
PKGNAME Package names
PLNNAME Plan names
PMNAME Names of row permissions
SEQNAME Sequence names
SFNAME 1 Specific function names
SGNAME All storage group names
IXSGNAME Storage group names for indexes
TSSGNAME Storage group names for table spaces
STPNAME Start of changeStored procedure names and specific names for native SQL proceduresEnd of change
TBNAME Table, alias, synonym, and view names
ALNAME Alias names (This mask is valid only for those CREATE statements where the object is clearly defined as an alias.)
SYNNAME Synonym names
VWNAME View names (This mask is valid only for those CREATE statements where the object is clearly defined as an view.)
TCNAME Trusted context names
TGNAME Trigger names
TSNAME Table space names
UDFNAME User-defined function names
UDTNAME User-defined data type names
VCATNAME VCAT names
GRANTEE Grantees
GRANTOR Grantors
OWNER 2, 3 Owners and creators (This mask affects all masks that have OWNER as a parent. See the mask hierarchy in Table 3.)
DBOWNER 2, 3 Database owners
IXOWNER 2, 3 Index owners (IXOWNER masks the index creator field, which is the owner of the index in DB2® UDB for z/OS® 8, but is the schema of the index in DB2 9 for z/OS.)
PKGOWNER 2, 3 Package owners
SGOWNER 2, 3 Storage group owners
TBOWNER 2, 3 Table owners ( TBOWNER masks the table creator field, which is the owner of the table in DB2 UDB for z/OS 8, but is the schema of the table in DB2 9 for z/OS.)

SYNOWNER (subset of TBOWNER) 2, 3

Synonym owners
TSOWNER 2, 3 Table space owners
SCHEMA 3 Schemas (This mask affects all masks that have SCHEMA as a parent. See the mask hierarchy in Table 3.)
GVSCHEMA 3 Global variable schemas
IXSCHEMA 3 Index schemas (IXSCHEMA masks the index creator field, which is the owner of the index in DB2 UDB for z/OS 8, but the SCHEMA of the index in DB2 9 for z/OS or later.)
MKSCHEMA 3 Column mask schemas
PMSCHEMA 3 Row schemas
SEQSCHEMA 3 Sequence schemas
SETPATHSC SET CURRENT PATH schemas
STPSCHEMA Stored procedure schemas
TBSCHEMA Table schemas (TBSCHEMA masks the table creator field, which is the owner of the table in DB2 UDB for z/OS 8, but the schema of the table in DB2 9 for z/OS or later.)

ALSCHEMA (subset of TBSCHEMA)

Alias schemas (This mask is valid only for those CREATE statements where the object is clearly defined as an alias.)

VWSCHEMA (subset of TBSCHEMA)

View schemas (This mask is valid only for those CREATE statements where the object is clearly defined as an view.)
TGSCHEMA Trigger schemas
UDFSCHEMA Function schemas
UDTSCHEMA User-defined type schemas
ROLE Role names
DBROLE 4 Roles that are associated with a database
IXROLE 4 Roles that are associated with an index
TBROLE4 Roles that are associated with a table
TSROLE 4 Roles that are associated with a table space
SQLID1 Current SQLIDs

This mask is needed by cloning when masking SET CURRENT SQLID statements that are already generated. When the GEN function and migrate function generate SET CURRENT SQLID = sqlid statements, the SQLID mask is not used to mask the sqlid value. The sqlid in these statements originates from field values in the Db2

catalog, and these values are masked before the SET statement is generated. For example, CREATE SYNONYM requires a SET CURRENT SQLID statement to set the current SQLID to the synonym owner (creator). The OWNER mask is used to mask the synonym owner before the SET statement is generated.
XMLSCHID Registered XML schema names in an XML-type modifier
WLMENV Workload Manager (WLM) environment names
LOCATION Location names, where the location is the first of a three-part name, as in: location.schema.name
Notes:
  1. DBRMNAME, GBPNAME, SFNAME, and SQLID are used only when work statement lists (WSLs) are cloned. If specified, they have no affect on the GEN function, the migrate function, or importing changes.
  2. Start of changeAll OWNER masks have no affect when WSLs are cloned and when importing changes. (This condition applies to the OWNER mask and all masks that have OWNER as a parent. See the mask hierarchy in Table 3.)End of change
  3. Start of changeIf you want to mask the schema and the owner, you must specify masks for both schema and owner, even if the values are the same. For example:
    SCHEMA:maskA;maskB
    OWNER:maskA;maskB
    For objects that were created in DB2 9 or an earlier version of Db2, the schema and owner had the same value. However, both Db2 Admin Tool and Object Comparison Tool treat schema and owner as distinct values and do not assume that the values are the same.End of change
  4. The DBROLE, TSROLE, TBROLE, and IXROLE masks are not currently used.
Table 2. Masks for overwriting attributes
Name Description Possible values1, 2, 3
APPEND Whether the APPEND option is specified for the table YES, NO
AUDIT AUDIT option for a table CHANGES, ALL, NONE
CLOSE Whether the table space or index space data set is eligible to be closed YES, NO
TSCLOSE Whether the table space data set is eligible to be closed YES, NO
IXCLOSE Whether the index space data set is eligible to be closed YES, NO
COMPRESS Whether a table space or table space partition is compressed YES, NO
TSCOMPRES Whether a table space or table space partition is compressed Start of changeYES, NO, FIXED, HUFFMAN5End of change
IXCOMPRES Whether an index is compressed YES, NO
COPY Whether COPY YES was specified for the index YES, NO
DCAPTURE DATA CAPTURE option for a table NONE, CHANGES
DEFER Whether to build the index when the CREATE INDEX statement is executed YES, NO
DEFINE Whether the underlying data sets for the table space or index space are created when the object is created (NO indicates that the data sets are not created until data is inserted into the object.) YES, NO
IXDEFINE Whether the underlying data sets for the index space is created when the index space is created. (NO indicates that the data sets are not created until data is inserted into the object.) YES, NO
TSDEFINE Whether the underlying data sets for the table space are created when the table space is created (NO indicates that the data sets are not created until data is inserted into the object.) YES, NO
DSSIZE Maximum size, in gigabytes, for each partition in a partitioned table space n, where n is a power of two, in the range 1 - 256
TSDSSIZE DSSIZE attribute for table spaces nG
IXDSSIZE DSSIZE attribute for indexes nG
DTINLOBL INLINE LENGTH integer value for distinct types n
TBINLOBL INLINE LENGTH integer value for tables n
EDITPROC Name of the edit procedure that is associated with the table string
ERASE Whether the Db2-managed data sets are to be erased YES, NO
TSERASE Whether the Db2-managed data sets are to be erased for table spaces YES, NO
IXERASE Whether the Db2-managed data sets are to be erased for indexes YES, NO
FIELDPROC The name of the field procedure that is associated with a column string
FREEPG Number of pages that are loaded before a page is left as free space n
TSFREEPG Number of pages that are loaded before a page is left as free space for table spaces n
IXFREEPG Number of pages that are loaded before a page is left as free space for indexes n
HASHSPC HASH SPACE integer nK, nM, nG
INSALGO INSERT ALGORITHM attribute of a table space 0, 1, or 2
IXGBPCACH Group buffer pool cache option for the index or index partition SYSTEM, CHANGED, ALL, NONE
TSGBPCACH Group buffer pool cache option for the table space or table space partition SYSTEM, CHANGED, ALL, NONE
LOCKSIZE Lock size of the table space TABLE, TABLESPACE, PAGE, ROW, LOB, ANY
LOCKMAX Maximum number of locks that need to be acquired per user for the table or table space before escalating to the next locking level n, SYSTEM
LOGGED Whether the changes to a table space are logged YES, NO
MAXROWS Maximum number of rows that Db2 is to place on a data page n
MEMCLUS Whether or not MEMBER CLUSTER is specified for the table space YES, NO
PADDED Whether keys within the index are padded for varying-length column data YES, NO
PCTFREE Percentage of each page that is left as free space n
TSPCTFREE Percentage of each page that is left as free space for table spaces n
TSPCTFUPD Percentage of free space that is reserved for updates to variable length records, as defined when the table space is created or altered n
IXPCTFREE Percentage of each page that is left as free space for indexes n
PRIQTY Minimum primary space allocation for a Db2-managed data set for table spaces and index spaces n, n%
IXPRIQTY Minimum primary space allocation for a Db2-managed data set for index spaces n, n%
TSPRIQTY Minimum primary space allocation for a Db2-managed data set for table spaces n, n%
RESONDROP RESTRICT ON DROP attribute for tables YES, NO
SECQTY Minimum secondary space allocation for a Db2-managed data set for table spaces and index spaces n, n%
IXSECQTY Minimum secondary space allocation for a Db2-managed data set for index spaces n, n%
TSSECQTY Minimum secondary space allocation for a Db2-managed data set for table spaces n, n%
SEGSIZE Number of pages in each segment of a segmented table space n, where n is a multiple of 4, in the range of 4 - 64
Start of changeSGKEYLABL4 End of change Start of changeThe key label for the storage groupEnd of change Start of changeStart of changestring, NO, NOKEYLABELEnd of changeEnd of change
Start of changeTBKEYLABL4End of change Start of changeThe key label for the tableEnd of change Start of changeStart of changestring, NO, NOKEYLABELEnd of changeEnd of change
TRACKMOD Whether to track page modifications in the space map YES, NO
TSPARTS Number of partitions of the table space n (0 if the table space is not partitioned)
VALIDPROC Name of the validation procedure that is associated with the table string
VOLATILE Whether Db2 uses index access to the table whenever possible for SQL operations YES, NO
Notes:
  1. The values for these overwrite masks can also be a REXX user exit that returns a valid value for the given mask. See Specifying a REXX user exit for a mask overwrite value.
  2. n = an integer
  3. n% = an integer percentage of the current value
  4. Start of changeThese overwrite masks apply to only Db2 12 function level 502 or higher.End of change
  5. Start of changeThe FIXED and HUFFMAN values for TSCOMPRES apply to only Db2 12 function level 509 or higher.End of change

Examples of name mask definitions

NAME mask example
The following mask changes any name that starts with ABC to a name that starts with DEF in the generated SQL.
NAME: ABC*,DEF*
AUTHID mask example
The following mask translates all authorization IDs that have the value SYSIBM to COPY.
AUTHID: SYSIBM, COPY
TBNAME mask example
The following mask can be used to translate a table that is named EMPLOYEE01 to EMPLOYEE02.
TBNAME: *01*, *02*
COLNAME mask example
The following mask changes any column name that starts with COL in any table. In this case, the column name is changed to start with NEWCOL. The column names that are changed include column names in triggers, views, and indexes. You cannot selectively change column names in specific tables.
COLNAME: COL*, NEWCOL*
SINGLECH mask examples
The following masks change any character in position 2 of the matching database names to a 9.
SINGLECH:# 
DBNAME:D#J12345, D9J12345

With the following masks, the table name ABC is translated to DBF:

SINGLECH:_
TBNAME:A_C,D_F 

The following masks specify that for any name that matches the input mask, any character in the seventh position is to be replaced with FL. For example, ADMIN_TASKS is to be replaced with ADMIN_FLASKS. Notice that the plus sign (+) is defined as an escape character; when it used in the name mask, the following underscore (_) is treated as a literal.

SINGLECH:_,+   
NAME:ADMIN+__*,ADMIN+_FL*   

Examples of overwrite mask definitions

COMPRESS attribute mask example
The following mask changes any table spaces that start with TESTTS in the TESTDB database to be compressed.
COMPRESS: TESTDB.TESTTS*, YES
PRIQTY attribute mask example
The following mask changes the PRIQTY value of all table spaces and index spaces in TESTDB database to 75% of the current value of PRIQTY.
PRIQTY: TESTDB.*, 75%
Example of specifying a REXX user exit for an overwrite value
The following mask changes table spaces that start with TESTTS in the TESTDB database to use the DSSIZE value that is returned by the REXX user exit PDDSSIZE.
DSSIZE: TESTDB.TESTTS*, REXX(PDDSSIZE,PARTITIONS,BPOOL)

Mask Hierarchy

Mask specifications can use high-level options, such as NAME, AUTHID, SCHEMA, OWNER, GRANTID, or ROLE, or more granular options such as DBNAME, TSNAME, SQLID, TBSCHEMA, DBOWNER, or GRANTOR. This defined hierarchy of masks is shown in the following tables.

The following table shows the hierarchy of name masks. Name masks that are not listed in this table do not participate in a hierarchy. For example, the COLNAME mask has no levels and does not participate in a hierarchy. To translate a column name, you must use COLNAME.

Table 3. Hierarchy of name masks
Grandparent Parent Child
NAME BPNAME IXBPNAME
TSBPNAME
COLLNAME  
CONSNAME  
DBNAME  
DBRMNAME  
GBPNAME  
GRPNAME  
GVNAME  
IXNAME  
MKNAME  
PGMNAME  
PKGNAME  
PLNNAME  
PMNAME  
SEQNAME  
SFNAME  
SGNAME IXSGNAME
TSSGNAME
STPNAME  
TBNAME
TBNAME ALNAME
SYNNAME
VWNAME
TCNAME  
TGNAME  
TSNAME
UDFNAME  
UDTNAME  
VCATNAME  
AUTHID GRANTID GRANTEE
GRANTOR
OWNER DBOWNER
IXOWNER
PKGOWNER
SGOWNER
TBOWNER
SYNOWNER (subset of TBOWNER)
TSOWNER
SCHEMA GVSCHEMA
IXSCHEMA
MKSCHEMA
PMSCHEMA
SEQSCHEMA
SETPATHSC
STPSCHEMA
TBSCHEMA
ALSCHEMA (subset of TBSCHEMA)
VWSCHEMA (subset of TBSCHEMA)
TGSCHEMA
UDFSCHEMA
UDTSCHEMA
ROLE DBROLE
IXROLE
TBROLE
TSROLE
SQLID  

The following table shows the hierarchy of overwrite masks. Overwrite masks that are not listed in this table do not participate in a hierarchy.

Table 4. Hierarchy of overwrite masks
Parent Child
CLOSE TSCLOSE
IXCLOSE
COMPRESS TSCOMPRES
IXCOMPRES
DEFINE IXDEFINE
TSDEFINE
ERASE TSERASE
IXERASE
FREEPG IXFREEPG
TSFREEPG
GBPCACH IXGBPCACH
TSGBPCACH
PCTFREE IXPCTFREE
TSPCTFREE
PRIQTY IXPRIQTY
TSPRIQTY
SECQTY IXSECQTY
TSSECQTY
DSSIZE IXDSSIZE
TSDSSIZE

If you use a mask data set to edit or view mask definitions, you can also see a list of mask names and their hierarchy in the MSG lines of the mask data set. See Creating masks in a data set.

Examples of mask heirarchy

DBNAME example
To translate a database name so that it starts with Y instead of X, you can specify either of the following masks:
DBNAME: X*,Y*
NAME: X*,Y*

The NAME mask is a grandparent in the hierarchy and, therefore, more general than the DBNAME mask, which is a child of NAME. Using the higher-level NAME mask affects all masks that are children or grandchildren of NAME.

BPNAME example
The BPNAME mask (for buffer pool name) has three levels: TSBPNAME, BPNAME and NAME. To translate a table space buffer pool name, you can use either TSBPNAME, BPNAME, or NAME. Depending on the situation, the NAME mask is probably too general. However, even the BPNAME mask might be too general. The BPNAME mask affects the matching names for all table space buffer pools and index space buffer pools. The lower-level TSBPNAME affects only the names of table space buffer pools.
TSPRIQTY example
TSPRIQTY is second in the hierarchy of PRIQTY and TSPRIQTY. TSPRIQTY overwrites the PRIQTY for table spaces only, whereas PRIQTY overwrites the PRIQTY for both table spaces and index spaces.

Mask order

You can specify as many masks as you want. Masks are processed in the order that you list them. The first mask that matches is used. A match means that both of the following conditions are true:

  • The mask name is applicable to the value. For example, for a table name, mask names TBNAME and NAME are applicable.
  • The value conforms to the inputmask in the mask syntax. For example, a table named PRODTAB1 conforms to input mask PROD*1.

The value is translated based on the outputmask value in the syntax, or, in the case where an attribute value is overwritten, the value of the attribute is overwritten to the new value.

Only the first matching mask is used for a given value. If no matching mask is found, the value is not translated. Generally, you should put the most specific masks first and the more general ones at the end.

Performance tip: Using many masks might increase processing time. If a match is not found early in the process, the program must search through the list of masks until a match is found.

Object-specific masks

The effects of some naming masks are too general for all situations. For example, the IXBPNAME mask changes the name of every matching instance of an index buffer pool. If you need to change a buffer pool name for only one index, you can use specify that a mask applies to only a specific object. This type of mask is called an object-specific mask. Object-specific masks change only names, not attributes.

Use the following syntax to define an object-specific mask:

maskname:qual.name:inputmask,outputmask
maskname
The name of the mask. Possible values are listed in Mask names
qual.name
The name of the object. A qualifier (qual) is optional.
name does not always refer to the name of the masked item. For example, for the IXSGNAME mask, name refers to the index name, not the storage group name. To determine which object needs to be specified, see Table 5.
inputmask
The input mask, which is the string pattern that you want to change. When you use object-specific masking, the input mask can be greater than 256 bytes.
outputmask
The output mask, which is the string to which you want to translate the input mask. The maximum length allowed for an output mask is 256 bytes.

The following tables lists all of the object-specific masks.

Table 5. Object-specific masks and the objects they affect
Name Syntax
ALNAME ALNAME:alias_schema.alias_name:current_alname,new_alname
ALSCHEMA ALSCHEMA:alias_schema.alias_name:current_alschema,new_alschema
COLNAME COLNAME:table_schema.table_name:current_colname,new_colname
CONSNAME CONSNAME:table_schema.table_name:current_consname,new_consname
DBOWNER DBOWNER:database_name:current_dbowner,new_dbowner
DBRMNAME1  DBRMNAME:stp_schema.stp_name:current_dbrmname,new_dbrmname
DBRMNAME DBRMNAME:udf_schema.udf_name:current_dbrmname,new_dbrmname
DBRMNAME DBRMNAME:table_schema.table_name:current_dbrmname,new_dbrmname
GRPNAME GRPNAME:database_name:current_grpname,new_grpname
GVNAME GVNAME:gv_schema.gv_name:current_gvname,new_gvname
GVSCHEMA GVSCHEMA:gv_schema.gv_name:current_gvschema,new_gvschema
IXBPNAME2 IXBPNAME:index_schema.index_name:current_bpname,new_bpname
IXBPNAME IXBPNAME:database_name:current_db_indexbpname,new_db_indexbpname
IXNAME IXNAME:index_schema,index_name:current_ixname,new_ixname
IXOWNER IXOWNER:index_schema.index_name:current_ixowner,new_ixowner
IXSCHEMA IXSCHEMA:index_schema.index_name:current_ixschema,new_ixschema
IXSGNAME IXSGNAME:index_schema.index_name:current_ixsgname,new_ixsgname
LOCATION LOCATION:schema_name.obj_name:current_location,new_location
MKNAME MKNAME:mask_schema.mask_name:current_maskname,new_maskname
MKSCHEMA MKSCHEMA:mask_schema.mask_name:current_mkschema,new_mkschema
PGMNAME1 PGMNAME:stp_schema.stp_name:current_pgmname,new_pgmname
PGMNAME PGMNAME:udf_schema.udf_name:current_pgmname,new_pgmname
PGMNAME PGMNAME:table_schema.table_name:current_pgmname,new_pgmname
PKGNAME PKGNAME:collection_id.package_name:current_pkgname,new_pkgname
PKGOWNER PKGOWNER:collection_id.package_name:current_packageowner,new_packageowner
PMNAME PMNAME:pm_schema.pm_name:current_pmname,new_pmname
PMSCHEMA PMSCHEMA:pm_schema.pm_name:current_pmschema,new_pmschema
SEQNAME SEQNAME:seq_schema.seq_name:current_seqname,new_seqname
SEQSCHEMA SEQSCHEMA:seq_schema.seq_name:current_seqschema,new_seqschema
SGOWNER SGOWNER:stogroup_name:current_stogroupowner, new_stogroupowner
STPNAME STPNAME:stp_schema.stp_name:current_stpname,new_stpname
STPSCHEMA STPSCHEMA:stp_schema.stp_name:current_stpschema,new_stpschema
SYNNAME SYNNAME:synonym_owner.synonym_name:current_syname,new_syname
SYNOWNER SYNOWNER:synonym_owner.synonym_name:current_synowner,new_synowner
TBNAME TBNAME:table_schema.table_name:current_tbname,new_tbname
TBOWNER TBOWNER:table_schema.table_name.current_tbowner,new_tbowner
TBSCHEMA TBSCHEMA:table_schema.table_name:current_tbschema,new_tbschema
TGNAME TGNAME:trigger_schema.trigger_name:current_tgname,new_tgname
TGSCHEMA TGSCHEMA:trigger_schema.trigger_name:current_tbschema,new_tgschema
TSBPNAME2 TSBPNAME:database_name.tablespace_name:current_tspbname,new_tsbpname
TSBPNAME TSBPNAME:database_name:current_dbbpname,new_dbbpname
TSNAME TSNAME:database_name.tablespace_name:current_tsname,new_tsname
TSOWNER TSOWNER:database_name.tablespace_name:current_tsowner,new_tsowner
TSSGNAME2 TSSGNAME:database_name.tablespace_name:current_tssgname,new_tssgname
TSSGNAME TSSGNAME:database_name:current_dbsgname,new_dbsgname
UDFNAME UDFNAME:udf_schema.udf_name:current_udfname,new_udfname
UDFSCHEMA UDFSCHEMA:udf_schema.udf_name:current_udfschema,new_udfschema
UDTNAME UDTNAME:udt_schema.udt_name:current_udtname,new_udtname
UDTSCHEMA UDTSCHEMA:udt_schema.udt_name:current_udtschema,new_udtschema
VCATNAME1 VCATNAME:stogroup_name:current_vcatname, new_vcatname
VCATNAME VCATNAME:schema.obj_name:current_vcatname,new_vcatname
VWNAME VWNAME:view_schema.view_name:current_vwname,new_vwname
VWSCHEMA VWSCHEMA:view_schema.view_name:current_vwschema,new_vwschema
WLMENV WLMENV:udf_schema.udf_name:current_wlmenvname.new_wlmenvname
WLMENV WLMENV:stp_schema.stp_name:current_wlmenvname,new_wlmenvname
Notes:
  1. The DBRMNAME, PGMNAME, and VCATNAME masks can be used for more than one object type.
  2. The IXBPNAME, TSPBNAME, and TSSGNAME masks can be used for both object-level and database-level versions of the names.

The following masks cannot have object-specific qualifiers:

  • SINGLECH
  • NAME
  • BPNAME
  • COLLNAME
  • DBNAME
  • GBPNAME
  • PLNNAME
  • SFNAME
  • SGNAME
  • TCNAME
  • AUTHID
  • GRANTID
  • GRANTEE
  • GRANTOR
  • OWNER
  • SCHEMA
  • SETPATHSC
  • ROLE
  • DBROLE
  • IXROLE
  • TBROLE
  • TSROLE
  • SQLID
  • XMLSCHID

Examples of object-specific masks

TBNAME object-specific mask example
The following mask applies to only the CREATOR1.TB2 table:
TBNAME:CREATOR1.TB2:CREATOR1,NEW_CRE1
IXBPNAME object-specific mask example
The following mask changes the buffer pool name to BP3 for only index IXOWN1.IX2:
IXBPNAME:IXOWN1.IX2:BP1,BP3
TSSGNAME object-specific mask example
The following mask changes the storage group name for only database TESTDB from SG1 to SG0.
TSSGNAME: TESTDB : SG1,SG0
TSBPNAME object-specific mask example
The following mask changes the bufferpool name BP0 to BP1 for all table spaces that start with TESTTS in the TESTDB database.
TSBPNAME: TESTDB.TESTTS* : BP0,BP1
VWSCHEMA object-specific mask example
The following mask changes the view schema for all views that start with VWA and have schema names that start with SCH. In this case, TEST is added to the end of these schema names.
VWSCHEMA: SCH*.VWA* : *, *TEST