|In Chapter 5, Metadata Templates, the following metadata templates should
|be included.
|
|Table 9. New Metadata templates supplied with the Data Warehouse Center
Template | Description | See: |
---|---|---|
commit.tag |
| 23.1.1, "Commit.tag" |
Foreignkey.tag |
| 23.1.2, ForeignKey.tag |
Foreignkeyadditional.tag |
| 23.1.3, ForeignKeyAdditional.tag |
Primarykey.tag |
| 23.1.4, PrimaryKey.tag |
Primarykeyadditional.tag |
| 23.1.5, PrimaryKeyAdditional.tag |
|Use this template to improve performance when you are using large tag |language files. A commit template can be inserted between any of the groups |of templates described here. A commit template cannot be inserted between |templates within a group. For example, it is valid to insert a commit template |between AgentSite.tag and VWPGroup.tag but invalid to insert a commit tag |between VWPProgramTemplate.tag and VWPProgramTemplateParameter.tag. If commit |templates are used incorrectly, import may report an error. |
|The use of the commit template is optional.
|Table 10 provides information about each token in the template.
|
Token | Description | Allowed values |
---|---|---|
Relationship parameters | ||
*CurrentCheckPointID++ | An index, starting with 0, that increases
each time it is substituted in a token.
This token is required. | A numeric value. |
|Table 11 provides example values for each token to illustrate
|the kind of metadata you might provide for each token.
|
|Table 11. Example values for Commit.tag tokens
Token | Example value |
---|---|
*CurrentCheckPointID++ | 1 |
|Use this template to define foreign key constraints on tables. The ForeignKey.tag |template defines the relationships to the table and the column on which the |constraint is being defined. This template also defines the relationships |to the table and column of the primary key that is being referred to. Before |you use the ForeignKey.tag template, you must define the primary key constraint |(using the PrimaryKey.tag template) and the tables and columns (using the |Table.tag and Column.tag templates) on which you want to define the foreign |key constraint.
|Table 12 provides information about each token in the template.
|
|Table 12. ForeignKey.tag tokens
Token | Description | Allowed values |
---|---|---|
Entity parameters | ||
*ConstraintName | The name of the constraint.
The name must be unique within a table or field.
This token is required. | A text string, up to 80 bytes in length. |
*ForeignColumnKeyName | Name of the column on which the foreign key constraint is being defined. | A text string, up to 254 bytes in length. |
*ForeignKeyID | The key that uniquely identifies the foreign
key. The key must be unique from all other keys in the tag language file.
Tip: Finish processing the ForeignKey.tag template before increasing the value of the key.
This token is required. | A numeric value. |
*MapID | An arbitrary number that is unique from all other
keys in the interchange file.
Tip: Finish processing the ForeignKey.tag template before increasing the value of this token.
This token is required. | A numeric value. |
*PrimaryColumnKeyName | The column name of the referenced column. | A text string, up to 80 bytes in length. |
*ReferencedPrimaryKeyID | The key that uniquely identifies the primary key. The key must be unique
from all other keys in the tag language file.
Tip: Finish processing the ForeignKey.tag template before increasing the value of the key.
This token is required. | A numeric value. |
Relationship parameters | ||
*DatabaseName | The business name of the warehouse source
or warehouse target.
This token is required. | A text string, up to 40 bytes in length. |
*ForeignTablePhysicalName | The database-defined name of the physical table containing the foreign keys that reference the keys in other tables. | A text string, up to 254 bytes in length. |
*PrimaryTablePhysicalName | The database-defined name of the physical table containing the keys that are referenced by the foreign keys. | A text string, up to 80 bytes in length. |
*PrimaryTableOwner | The owner, high-level qualifier, collection,
or schema of the table that contains the primary key column that is being
referenced.
This token is required. | A text string, up to 128 bytes in length. |
*ForeignTableOwner | The owner, high-level qualifier, collection,
or schema of the table that contains the foreign key constraint column.
This token is required. | A text string, up to 128 bytes in length. |
|Table 13 provides example values for each token to illustrate
|the kind of metadata that you might provide for each token.
|
|Table 13. Example values for ForeignKey.tag tokens
Token | Example value |
---|---|
*ConstraintName | Department |
*DatabaseName | Finance Warehouse |
*ForeignColumnKeyName | Country_code |
*ForeignKeyID | 07011 |
*ForeignTablePhysicalName | Geography |
*MapID | 02568 |
*PrimaryColumnKeyName | State_code |
*Referenced PrimaryKeyID | Name |
*PrimaryTablePhysicalName | City |
*PrimaryTableOwner | DB2ADMIN |
*ForeignTableOwner | IWH |
|Use this template to define a composite foreign key. Before you use the |ForeignKeyAdditional.tag template, you must define a constraint (using the |ForeignKey.tag template) on the first column. You can then add columns by |using this template for each column that you want to add.
|Table 14 provides information about each token in the template.
|
|Table 14. ForeignKeyAdditional.tag tokens
Token | Description | Allowed values |
---|---|---|
Entity parameters | ||
*ForeignColumnKeyName | The name of the column on which the foreign key constraint is being defined. | A text string, up to 80 bytes in length. |
*ForeignKeyID | The key that uniquely identifies the foreign key.
The key must be unique from all other keys in the tag language file.
Tip: Finish processing the ForeignKey.tag template before increasing the value of the key.
This token is required. | A numeric value. |
*MapID | An arbitrary number that is unique from all other
keys in the interchange file.
Tip: Finish processing the ForeignKeyAdditional.tag template before increasing the value of this token.
This token is required. | A numeric value. |
*MapSeqNo | A number signifying each additional column added as part of a composite key to the foreign key constraint. | Unique, increasing, consecutive number starting at 2. |
*PrimaryColumnKeyName | The column name of the referenced column. | A text string, up to 80 bytes in length. |
Relationship parameters | ||
*DatabaseName | The business name of the warehouse source or warehouse
target.
This token is required. | A text string, up to 40 bytes in length. |
*ForeignTablePhysicalName | The database-defined name of the physical table containing the foreign keys that reference the keys in other tables. | A text string, up to 80 bytes in length. |
*PrimaryTablePhysicalName | The database-defined name of the physical table containing the keys that are referenced by the foreign keys. | A text string, up to 80 bytes in length. |
*PrimaryTableOwner | The owner, high-level qualifier, collection, or
schema of the table that contains the primary key column that is being referenced.
This token is required. | A text string, up to 128 bytes in length. |
*ForeignTableOwner | The owner, high-level qualifier, collection, or
schema of the table that contains the foreign key constraint column.
This token is required. | A text string, up to 128 bytes in length. |
|Table 15 provides example values for each token to illustrate
|the kind of metadata that you might provide for each token.
|
|Table 15. Example values for ForeignKeyAdditional.tag tokens
Token | Example value |
---|---|
*DatabaseName | Finance Warehouse |
*ForeignColumnKeyName | Country_code |
*ForeignKeyID | 07011 |
*ForeignTablePhysicalName | Geography |
*MapID | 22578 |
*MapSeqNo | 2 |
*PrimaryColumnKeyName | State_code |
*PrimaryTablePhysicalName | City |
*PrimaryTableOwner | DB2ADMIN |
*ForeignTableOwner | IWH |
|Use this template to define primary key constraints on tables. The template |also defines the relationships to the table and the column on which the constraint |is being defined. Before you use the PrimaryKey.tag template, you must define |the tables and columns (using the Table.tag and Column.tag templates) on which |you want to define the primary key constraint.
|Table 16 provides information about each token in the template.
|
|Table 16. PrimaryKey.tag tokens
Token | Description | Allowed values |
---|---|---|
Entity parameters | ||
*ColumnName | The name of the column or field.
The name must be unique within a table or field.
This token is required. | A text string, up to 80 bytes in length. |
*MapID | An arbitrary number that is unique from all other
keys in the interchange file.
Tip: Finish processing the PrimaryKey.tag template before increasing the value of this token.
This token is required. | A numeric value. |
*PrimaryKeyID | The key that uniquely identifies the primary key. The key must be unique
from all other keys in the tag language file.
Tip: Finish processing the ForeignKey.tag template before increasing the value of the key.
This token is required. | A numeric value. |
Relationship parameters | ||
*DatabaseName | The business name of the warehouse source
or warehouse target.
This token is required. | A text string, up to 40 bytes in length. |
*TableOwner | The owner, high-level qualifier, collection,
or schema of the table that contains the column.
This token is required. | A text string, up to 128 bytes in length. |
*TablePhysicalName | The physical name of the table or file that contains
the column as defined to the database manager or file system.
This token is required. | A text string, up to 80 bytes in length. |
|Table 17 provides example values for each token to illustrate
|the kind of metadata that you might provide for each token.
|
|Table 17. Example values for PrimaryKey.tag tokens
Token | Example value |
---|---|
*ColumnName | Country_code |
*DatabaseName | Finance Warehouse |
*MapID | 54627 |
*PrimaryKeyID | 74622 |
*TableOwner | DB2ADMIN |
*TablePhysicalName | GEOGRAPHY |
|Use this template to define a composite primary key. Before you use the |PrimaryKeyAdditional.tag template, you must define a constraint on the first |column by using the PrimaryKey.tag template. Any additional columns can then |be added using this template. The template also relates the additional primary |keys to the first primary key which is defined using PrimaryKey.tag.
|Table 18 provides information about each token in the template.
|
|Table 18. PrimaryKeyAdditional.tag tokens
Token | Description | Allowed values |
---|---|---|
Entity parameters | ||
*ColumnName | The name of the column or field.
The name must be unique within a table or field.
This token is required. | A text string, up to 80 bytes in length. |
*FirstPrimaryKeyID | The key that uniquely identifies the primary key.
The key must be unique from all other keys in the tag language file.
Tip: Finish processing the ForeignKey.tag template before increasing the value of the key.
This token is required. | A numeric value. |
*MapID | An arbitrary number that is unique from all other
keys in the interchange file.
Tip: Finish processing the PrimaryKeyAdditional.tag template before increasing the value of this token.
This token is required. | A numeric value. |
*MapSeqNo | A number signifying each additional column added as part of a composite key to the primary key constraint. | Unique, increasing, consecutive number starting at 2. |
Relationship parameters | ||
*DatabaseName | The business name of the warehouse source or warehouse
target.
This token is required. | A text string, up to 40 bytes in length. |
*TableOwner | The owner, high-level qualifier, collection, or
schema of the table that contains the column.
This token is required. | A text string, up to 15 bytes in length. |
*TablePhysicalName | The physical name of the table or file that contains
the column as defined to the database manager or file system.
This token is required. | A text string, up to 80 bytes in length. |
|Table 19 provides example values for each token to illustrate
|the kind of metadata that you might provide for each token.
|
|Table 19. Example values for PrimaryKeyAdditional.tag tokens
Token | Example value |
---|---|
*ColumnName | Country_code |
*DatabaseName | Finance Warehouse |
*MapID | 99542 |
*MapSeqNo | 2 |
*FirstPrimaryKeyID | 07801 |
*TableOwner | DB2ADMIN |
*TablePhysicalName | GEOGRAPHY |