Syntax - Teradata Tools and Utilities

where:

DATA TABLE

DATA TABLES

Archives fallback, non-fallback, or both types of tables from all AMPs or from clusters of AMPs.

DICTIONARY TABLE

DICTIONARY TABLES

Archives only the dictionary rows of an object

A dictionary archive of a database includes the definition of all objects in that database, including the dictionary entries for stored procedures. If an individual object is specified, then the archive only includes the definition for that object.

NO FALLBACK TABLE

NO FALLBACK TABLES

Archives non-fallback table from specific AMPs to complete a previous all-AMPs or cluster archive taken with processors offline.

JOURNAL TABLE

JOURNAL TABLES

Archives dictionary rows for journal table and the saved subtable of journal table.

(dbname)

Name of the database from which tables are archived.

This causes all tables of the specified type in the database to be archived.

ALL

Archives all tables from the named database and its descendants, in alphabetical order.

(dbname.tname)

Name of a table within the named database to archive.

All tables must be distinct within the list. Duplicate tables are ignored.

EXCLUDE

Prevents the listed databases from being archived.

Note that individual objects cannot be excluded using this option. Individual objects can be excluded using the EXCLUDE TABLE(S) option after each database. See more in EXCLUDE TABLE, below.

(xdbname)

Name of a database to exclude.

ALL

Excludes the named database and its descendants.

(xdbname1) TO (xdbname2)

Alphabetical list of client databases to exclude.

The delimiting database names need not identify actual databases. Database DBC is not included within a range.

EXCLUDE TABLE

EXCLUDE TABLES

Prevents individual objects in the listed database from being archived.

(xtablename)

Name of an individual object in the designated database to exclude.

Multiple objects are separated by commas.

This form (without a database name prefix) is used only when ALL has not been specified for the current object.

(xdbname.xtablename)

List of fully-qualified objects (prefixed by database name) to exclude.

PARTITIONS WHERE

Specifies the conditional expression for selecting partitions

If the condition selects a partial partition, the entire partition is archived.

(!conditional expression!)

Conditional expression for specifying selected partitions.

CLUSTERS = nnn

CLUSTER = nnn

Specifies AMP clusters to archive, where nnn is the number of the clusters, up to 4096 clusters.

AMP = n

Specifies the AMP (or a list of AMPs) to archive for Teradata Database, where n is the number of the AMP, up to five AMPs.

RELEASE LOCK

Releases utility locks on the identified objects when the archive operation completes successfully.

Releasing a HUT lock while another Teradata ARC job is running could result in data corruption and/or unexpected errors from ARCMAIN or the Teradata Database. Refer to “RELEASE LOCK Keyword (ARCHIVE)” for more information.

FORCED

Instructs Teradata ARC to try and release any placed locks if the archive fails.

The HUT lock is not guaranteed to be released in all cases. The following cases will result in a leftover lock:

• If Teradata ARC is forcibly aborted by the user or operating system.
• If communication to the Teradata Database is lost and cannot be reestablished.
• If an internal failure occurs in Teradata ARC, such that program control cannot proceed to, or complete, the release lock step.

INDEXES

Archives data blocks used for secondary indexing.

This option is not available for archiving selected partitions of PPI tables, although it is allowed for a full-table archive of a PPI table.

ABORT

Aborts an all-AMPs or cluster operation if an AMP goes offline during the archive of nonfallback tables or single image journal tables.

ONLINE

Initiates an online archive on a table or database.

ONLINE

Enables online archive on all tables involved in the archive but does not require all tables to be enabled before access to those tables is allowed. Tables that were blocked during the initial enabling request will be retried as individual requests and will therefore have different sync points. As each table or group of tables is enabled for online logging, it will become available for access by other jobs.

KEEP LOGGING

Overrides the automatic termination of an online archive that was initiated with the ONLINE option.

USE READ LOCK

USE GROUP READ LOCK

Applies a read or group HUT lock on the entity being archived.

This option is available only when archiving data tables.

Specify the GROUP parameter only when archiving all AMPs or cluster AMPs. The GROUP keyword is rejected in a specific AMP archive operation.

If the GROUP parameter is specified during an archive, that archive is unusable if restoring to a system that has a different hash function or configuration than the source system. Therefore, perform an archive with no GROUP parameter prior to a major release upgrade or reconfiguration.

To use the GROUP READ LOCK option, after-image journaling must be enabled for the tables.

NONEMPTY DATABASES

NONEMPTY DATABASE

Excludes any empty users or databases from the ARCHIVE operation.

This option works with all types of archives. If a journal is archived, databases without a journal are excluded.

FILE

Names an output archive file.

Specifying this option twice in the same ARCHIVE statement is supported for mainframe platforms. If the option is specified twice, Teradata ARC generates two identical archive files concurrently.

For all Windows and Linux platforms, only one FILE option is supported per ARCHIVE statement.

If more than one ARCHIVE statement is specified in a script, the value for the FILE option should be different for each statement. Otherwise, the file created by the second ARCHIVE statement will overwrite the file created by the first ARCHIVE statement.

name

Name of the output archive file.

SKIP JOIN INDEX

Skip the archive of join and hash indexes.

SKIP STAT COLLECTION

Skip the archive of Stat Collections.