DSA Command-Line Interface Job Options - Data Stream Architecture

Teradata Data Stream Architecture (DSA) User Guide
Product
Data Stream Architecture
Release Number
16.10.01
Published
November 2017
ft:locale
en-US
ft:lastEdition
2018-04-17
dita:mapPath
fyx1509665931452.ditamap
dita:ditavalPath
3150_DSA_UG_1610.ditaval.ditaval
dita:id
B035-3150
Product Category
Software
Teradata Tools and Utilities
You can select and define job options for backup, restore, and analyze jobs by specifying the values for the options in the XML file containing the job definition.
Important: The XML files in the sample library and the files produced by the BAR Operations portlet have the XML in a specific order. For the jobs to run correctly, do not change the order of the XML within the files.
Job Option Description Job Type
online Determines the type of backup to perform.
false
Default. Backs up everything associated with each specified object while the database is offline. No updates can be made to the objects during the backup job run.
true
Backs up everything associated with each specified object and initiates an online archive for all objects being archived. The online archive creates a log that contains all changes to the objects while the archive is prepared.
 Backup
nosync Determines where synchronization is done for the job. Only available for online backup jobs.
  • Default value is false. If false, synchronization occurs across all tables simultaneously. If you try to run a job that includes objects that are already being logged, the job aborts.
  • True allows different synchronization points. If you try to run a job that includes objects that are already being logged, the job runs to completion and a warning is returned.
 Backup
data_phase Determines the type of backup to perform.
DATA
Default. Performs a full backup.
DICTIONARY
Performs a dictionary-only backup.
 Backup
enable_temperature_override Optional setting that pertains to restore jobs only.
true
The temperature_override value is applied when restoring the data.
false
The temperature from the backup is applied.
 Restore
temperature_override
Determines the temperature at which data is restored.
DEFAULT
Default. This data is restored at the default temperature setting for the system.
HOT
This data is accessed frequently.
WARM
This data is accessed less frequently.
COLD
This data is accessed least frequently.
 Restore
block_level_compression
Defines data compression used.
DEFAULT
Default. Applies same data compression as the backup job if allowed on the target system.
ON
Compress data at the block level if allowed on the target system.
OFF
Restore the data blocks uncompressed.
 Restore
disable_fallback Fallback protection means that a copy of every table row is maintained on a different AMP in the configuration. Fallback-protected tables are always fully accessible and are automatically recovered by the system.
Default is false. Must be entered in lowercase letters.
The disable_fallback option only takes effect when the run_as_copy value is true.
 Restore
query_band
Allows tagging of sessions or transactions with a set of user-defined name-value pairs to identify where a query originated. These identifiers are in addition to the current set of session identification fields, such as user ID, account string, client ID, and application name.
Valid query band values are defined on the database.
  • Backup
  • Restore
dsmain_logging_level
Determines the types of messages that the database job logs.
error
Default. Enables minimal logging. Provides only error messages.
warning
Adds warning messages to error message logging.
info
Provides informational messages with warning and error messages to the job log.
debug
Enables full logging. All messages, including Debug, are sent to the job log.
  • Backup
  • Restore
nowait Generates warning messages to the job status log for objects that the Teradata Database fails to get locks on immediately.
In either case, the job waits until the lock is released.
  • Default is true. If true, a warning message is generated when a job is stopped because of a lock.
  • If false, no warning message is generated when a job is stopped because of a lock.
  • Backup
  • Restore
reblock Determines level of inserts, either row or block level. This option is valid only for the same configuration restore. Different configuration restore always use row level inserts.
  • Default is false. The restore uses block level inserts.
  • If true, the restore uses row level inserts, forcing reblocking when tables must be restored matching the target system's default block size. Required when the backup is restored to a different AMP configuration, hash function, hash bucket, row format or block alignment. Optional when the backup is restored from a system with different block size than the target system and the block size of the restored data objects must match the target system's block size.
 Restore
run_as_copy Allows restore to run as a copy.
  • Default value is false.
  • If true, the restore runs as a copy.
 Restore
skip_archive Optional, can be true or false. Skip archive during backup or restore job in case of error in access rights. Supported in Teradata Database 15.10.01 and later.
  • Backup
  • Restore
skip_stats Optional, can be true or false. Skips collecting statistics during a backup job. Skips restoring stats during a restore job. Supported in Teradata Database 16.0 and later.
  • Backup
  • Restore
config_map_name Optional, maximum of 128 characters. Hash map name to restore to. When applied to the DATABASE/USER level, only objects under DATABASE/USER and object type of TABLE, NO PI TABLE, or QUEUE TABLE are applied with the new map.
If you have defined map_to, rename_to, or config_map_name for table level objects, this affects the results of a database level restore job definition.
  • If database is selected and includeAll attribute, map_to, or config_map_name is not set at the database level, the DSC expands objects under the database and treats the restore job as table level restore.
  • If database is selected and includeAll attribute, map_to, or config_map_name is set at the database level, the table level definitions are ignored, and the DSC treats the restore job as database level restore.
 Restore
track_empty_tables Optional, can be true or false. Tracks empty tables during a backup job. Supported in Teradata Database 16.0 and later. Backup
concurrent_bld_per_tbl Optional, range is 1 to 5. Number of index and fallback subtables that can be built concurrently per table during restore. Supported in Teradata Database 16.0 and later. Restore
map_to Optional. Map one database to a new database or map a table level object under multiple databases to a new database. Applies to all objects in the restore job. Supported in Teradata Database 16.0 and later.
If you have defined map_to, rename_to, or config_map_name for table level objects, this affects the results of a database level restore job definition.
  • If database is selected and includeAll attribute, map_to, or config_map_name is not set at the database level, the DSC expands objects under the database and treats the restore job as table level restore.
  • If database is selected and includeAll attribute, map_to, or config_map_name is set at the database level, the table level definitions are ignored, and the DSC treats the restore job as database level restore.
 Restore
rename_to Optional, maximum of 128 characters. Rename a table to this name.
If you have defined map_to, rename_to, or config_map_name for table level objects, this affects the results of a database level restore job definition.
  • If database is selected and includeAll attribute, map_to, or config_map_name is not set at the database level, the DSC expands objects under the database and treats the restore job as table level restore.
  • If database is selected and includeAll attribute, map_to, or config_map_name is set at the database level, the table level definitions are ignored, and the DSC treats the restore job as database level restore.
 Restore
stream_softlimit Optional, range is 1- max soft limit of the stream soft limit, where max is the number of AMPs per node in the system. Overrides the system level stream soft limit.
  • Backup
  • Restore
  • Analyze_Validate