Values for XML Elements | Teradata DSA - 17.20 - Values for XML Elements - BAR - Data Stream Architecture

Teradata® DSA User Guide

Product
BAR
Data Stream Architecture
Release Number
17.20
Release Date
October 2021
Content Type
User Guide
Publication ID
B035-3150-101K
Language
English (United States)

Many DSA commands read an XML file that specifies setup information or job details by specifying values for XML elements.

The following table indicates accepted values, case sensitivity, and character number restrictions for XML element values. These are in accordance with typical XML standards for Advanced SQL Engine / Teradata Database.

XML Element Requirements
all_backup_objects Accepted values: true, false. all_backup_objects must be false when processing individual object restore or copy. If all_backup_objects is false and an objectlist is not provided, the job cannot be created.
auto_retire Accepted values: true, false. Must be entered in lowercase letters.
bar_media_server Maximum of 32 characters
barnc_logging_level Accepted values: Error, Info, Debug, Warning. Must be entered as shown: first character uppercase, others lowercase.
blob_container Maximum of 63 characters. Must be entered in lowercase letters.
block_level_compression Accepted values: DEFAULT, ON, OFF. Must be entered in uppercase letters.
config_map_name Optional, maximum of 128 characters.
concurrent_bld_per_tbl Value between 1-5. Default: 5

Advanced SQL Engine / Teradata Database 16.0 and later

database_query_method Accepted values: BASE_VIEW, EXTENDED_VIEW. Must be entered in uppercase letters.
data_phase Accepted values: DATA, DICTIONARY. Must be entered in uppercase letters.
disable_fallback Accepted values: false, true. Must be entered in lowercase letters.

[Advanced SQL Engine 16.20 Update 1 and later] Always true. Changes are ignored.

[Prior versions Advanced SQL Engine / Teradata Database] Default: false. Can be set to true only if run_as_copy is also true.

dsc_logging_level Accepted values: Error, Info, Debug, Warning. Must be entered as shown: first character uppercase, others lowercase.
dsc_name

Maximum of 128 characters: alphanumeric, "-" and "."

First character must be alphanumeric (a-z, A-Z, and 0-9) only.

dsmain_logging_level Accepted values: Error, Info, Debug, Warning. Must be entered as shown: first character uppercase, others lowercase.
enable_temperature_override Accepted values: true, false. Must be entered in lowercase letters.
fabric_name Maximum of 64 characters: alphanumeric and "-" and "_".

The first character must be alphanumeric (a-z, A-Z, and 0-9) only.

frequency_value Value must be between 1-999. Defaults to 7.
ip_address Maximum of characters 50, alphanumeric plus "." and ":"

Do not use link-local IPv6 addresses (beginning with fe80) for media servers.

is_delete_after Accepted values: Y/N. Must be entered as an uppercase letter.
is_enabled Accepted values: true, false. Must be entered in lowercase letters. Default: false
is_encrypted Accepted values: Y/N. Must be entered as an uppercase letter.
job_description Maximum of 256 characters
job_name Maximum of 128 characters
job_type Accepted values: BACKUP, RESTORE, ANALYZE_VALIDATE, ANALYZE_READ. Must be entered in uppercase letters.
map_to Maximum of 128 characters
media_server Maximum of 32 characters: alphanumeric and "-", "_", and "."

First character must be alphanumeric (a-z, A-Z, and 0-9) only.

media_server_name Maximum of 32 characters: alphanumeric and "-", "_", and "."

First character must be alphanumeric (a-z, A-Z, and 0-9) only.

netmask Maximum of 64 characters, alphanumeric plus "." and ":"
node_name Maximum of 32 characters, alphanumeric and "-", "_", and "."

First character must be alphanumeric (a-z, A-Z, and 0-9) only.

nosync Accepted values: true, false. Must be entered in lowercase letters.
object_name Maximum of 128 characters
object_type Must be entered in uppercase letters. Accepted values are: AGGREGATE_FUNCTION, AUTHORIZATION, COMBINED_AGGREGATE_FUNCTIONS, CONTRACT_FUNCTION, DATABASE, EXTERNAL_PROCEDURE, FUNCTION_ALIAS, GLOP_SET, HASH_INDEX, INSTANCE_OR_CONSTRUCTOR_METHOD, JAR, JOIN_INDEX, MACRO, NO_PI_TABLE, ORDERED_ANALYTICAL_FUNCTION, QUEUE_TABLE, SERVER_OBJECT, STANDARD_FUNCTION, STATISTICAL_FUNCTION, STORED_PROCEDURE, TABLE, TABLE_FUNCTION, TABLE_OPERATOR, TRIGGER, USER, USER_DEFINED_METHOD, USER_DEFINED_DATA_TYPE, USER_INSTALLED_FILE, VIEW
online Accepted values: true, false. Must be entered in lowercase letters.
parent_name Maximum of 128 characters
parent_type Accepted values: DATABASE, USER. Must be entered in uppercase letters.
policy_class_name Maximum of 128 characters, alphanumeric and "-" and "_"
port Maximum of 5 digits. Must be between 1 and 65535
prefix_name Maximum of 256 characters
query_band Maximum of 2,048 characters
rename_to Maximum of 128 characters
reset_node_limit Accepted values: true, false. Must be entered in lowercase letters.
retire_units Accepted values: DAYS, WEEKS. Must be entered in uppercase letters.
role_name AWS only. IAM Role. Maximum of 64 characters. Alphanumeric only.
run_as_copy Accepted values: true, false. Must be entered in lowercase letters.
skip_archive Accepted values: true, false. Must be entered in lowercase letters.
skip_force_full Accepted values: true, false. Must be entered in lowercase letters.
skip_joinhash_index Optional. Accepted values: true, false. Default is false.
skip_stats Accepted values: true, false. Default is false.
source_media Maximum of 32 characters
start_am_pm Accepted values: AM, PM. Must be entered in uppercase letters.
start_time Maximum of 5 characters. Values must be between 1:00 and 12:00 (AM and PM are entered in the start_am_pm element )
storage_account Maximum of 24 characters. Must be entered in lowercase letters.
storage_devices Maximum of 3 characters, numeric range between 1-999
storage_type Accepted values: cool, hot. Must be entered in lowercase letters.
streams_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.
Optimize for the following:
  • Best backup throughput or storage efficiency: use 1- # of AMPs per node
    • Best deduplication
    • Take NetBackup startup time and Data Domain limits into account
  • Backup performance with unreasonable backup job start up time due to the NBU 1 stream per second limit: target 100 streams per Data Domain unit. This is usually enough to hit the Data Domain ingest limit for multiplexed deduplication ratio
  • Restore to the same configuration: Use the best backup value
  • Restore to a different configuration: Never let the total stream count (limit * nodes) exceed the AMP count of the smallest system.
Rough guidelines for deduplication impact.
  • If global reduction ratio is expected in 8x or higher range, reduce the expected ratio by 50%
  • If global reduction ratio is expected to be 3-8x, reduce the expected ratio by 25%
  • If global reduction ratio is expected to be below 3x, reduce the expected ratio by 10%
system_name Maximum of 32 characters, alphanumeric and "-", "_", and "."

The first character of the name can be alphanumeric (a-z, A-Z, and 0-9) only.

target_entity Maximum of 32 characters
target_group_name Maximum of 32 characters, alphanumeric and "-", "_", and "."

The first character of the name can be alphanumeric (a-z, A-Z, and 0-9) only.

target_media Maximum of 32 characters
table_name Maximum of 63 characters
target_accountid Maximum of 30 characters
target_name Maximum of 32 characters
target_tdpid Maximum of 32 characters
temperature_override Accepted values: DEFAULT, HOT, WARM, COLD. Must be entered in uppercase letters.
third_party_media_type Accepted values: net_backup, dd_boost. Must be entered in lowercase letters.
third_party_server_name Maximum of 32 characters, alphanumeric plus "-" and "_"
threshold_units Accepted values: MB, GB
track_empty_tables Accepted values: true, false. Default is false.