where:
- DATA TABLE or DATA TABLES
- Archives fallback, non-fallback, or both types of tables from all AMPs or from clusters of AMPs.
- DICTIONARY TABLE or DICTIONARY TABLES
- Archives only the dictionary rows of an object
- NO FALLBACK TABLE or 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 or 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.
- 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.
- EXCLUDE
- Prevents the listed databases from being archived.
- (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.
- EXCLUDE TABLE or EXCLUDE TABLES
- Prevents individual objects in the listed database from being archived.
- (xtablename)
- Name of an individual object in the designated database to exclude.
- (xdbname.xtablename)
- List of fully-qualified objects (prefixed by database name) to exclude.
- PARTITIONS WHERE
- Specifies the conditional expression for selecting partitions
- (!conditional expression!)
- Conditional expression for specifying selected partitions.
- CLUSTERS = nnn or 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.
- 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 or USE GROUP READ LOCK
- Applies a read or group HUT lock on the entity being archived.
- NONEMPTY DATABASES or NONEMPTY DATABASE
- Excludes any empty users or databases from the ARCHIVE operation.
- FILE
- Names an output archive file.
- 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.