15.00 - HELP SESSION - Teradata Database

Teradata Database SQL Data Definition Language Detailed Topics

prodname
Teradata Database
vrm_release
15.00
category
Programming Reference
featnum
B035-1184-015K

HELP SESSION

Session Attributes

The following table describes the attributes reported by a HELP SESSION request.

 

Attribute

Data Type

Nullable

Description

User Name

VARCHAR(30)

No

Reports the name of the owner of the session.

Account Name

VARCHAR(30)

No

Reports the account name currently in effect for the session (see “SET SESSION” on page 876).

Logon Date

CHAR(8)

No

Reports the date of logon to the Teradata Database, in the format YY/MM/DD.

Logon Time

CHAR(8)

No

Reports the time of logon to the Teradata Database, in the format HH:MI:SS.

Current Database

VARCHAR(30)

No

Reports the database currently defined as the default for the session (see “DATABASE” on page 786 and “CREATE USER” on page 769).

Collation

VARCHAR(15)

No

Reports the sort sequence defined for the session (see “SET SESSION” on page 876 and “CREATE USER” on page 769).

  • ASCII specifies the collation order is as it would appear if converted for an ASCII session, and a binary sort performed.
  • CHARSET_COLL specifies the collation order is as it would appear if converted to the current client character set and then sorted in binary order.
  • EBCDIC specifies the collation order is as it would appear if converted for an EBCDIC session and a binary sort performed.
  • JIS_COLL specifies the collation order is Japanese Industrial Standards (JIS) in this order.
  • 1 JIS X 0201-defined characters in standard order.

    2 JIS X 0208-defined characters in standard order.

    3 JIS X 0212-defined characters in standard order.

    4 KanjiEBCDIC-defined characters not defined in JIS X 0201, JIS X 0208, or JIS X 0212 in standard order.

    5 All remaining characters in Unicode standard order.

  • MULTINATIONAL specifies the collation order is two‑level based on the Unicode collation standard.
  • For backward compatibility, the following are true.

  • MULTINATIONAL collation of KANJI1 data is single level.
  • Single byte character collation is redefineable by the system administrator.
  • Character Set

    VARCHAR(30)

    No

    Reports the character set currently defined for the session.

    Transaction Semantics

    VARCHAR(8)

    No

    Reports the whether the session is in ANSI or Teradata session mode.

  • ANSI specifies that the session is in ANSI mode.
  • Teradata specifies that the session is in Teradata mode.
  • Current Dateform

    VARCHAR(11)

    No

    Reports the current mode for export and import of DATE values.

    For information about date formats, see SQL Data Types and Literals.

  • IntegerDate specifies that the session uses four‑byte integer values.
  • ANSIDate specifies that the session uses CHARACTER(10) ANSI data format.
  • Session Time Zone

    VARCHAR(6)

    No

    Reports the current time zone value in use by the session, displayed in INTERVAL HOUR TO MINUTE format.

    For example, -08:00. This is an offset from UTC.

    Default Character Type

    VARCHAR(30)

    No

    Reports the default character type for the user logged onto the current session.

    Export Latin

    CHAR(1)

    No

    Reports the export width value for each character data type for the session (see SQL Data Types and Literals).

    Note: No export width is reported for Kanji1 character data type because the export width for such data is always one.

    Export Unicode

    CHAR(1)

    No

    Export Unicode Adjust

    CHAR(1)

    No

    Export KanjiSJIS

    CHAR(1)

    No

    Export Graphic

    CHAR(1)

    No

    Default Date Format

    VARCHAR(30)

    No

    Reports the setting of the default date output format as set in the Specification for Data Formatting (SDF) file by the database administrator. This custom date format serves as the default output format for dates when DATEFORM is set to IntegerDate.

    See “User Name” earlier in this table for information about the data type and system‑defined character sets for DEFAULT DATE FORMAT.

    For information about date formats, see SQL Data Types and Literals.

    For information about changing the default date output format in the SDF and the definition of date formatting characters, see SQL Data Types and Literals.

    Radix Separator

    CHAR(1)

    No

    The character that separates the integer and fractional part of monetary numeric data.

    The system copies the value into the output string of numeric data whenever a D appears in the corresponding output FORMAT phrase.

    Group Separator

    CHAR(1)

    No

    The character that separates groups of digits in the integer part of monetary strings.

    The value of Currency Grouping Rule determines when the system copies the value of Currency Group Separator into the output string of numeric monetary data.

    Grouping Rule

    VARCHAR(30)

    No

    The number of digits to group together before inserting the value of Currency Group Separator in the output of monetary numeric data.

    The grouping rule applies to the output of numeric data that uses a FORMAT phrase containing a G formatting character.

    Currency Radix Separator

    CHAR(1)

    No

    The character that separates the integer and fractional part of monetary numeric data.

    The system returns a value if the format string contains the format element for the currency symbol or name.

    Currency Group Separator

    CHAR(1)

    No

    The character that separates groups of digits in the integer part of monetary strings.

    The system returns a value if the format string contains the format element for the currency symbol or name.

    Currency Grouping Rule

    VARCHAR(30)

    No

    The number of digits to group together before inserting the value of Currency Group Separator in the output of monetary numeric data.

    The system returns a value if the format string contains the format element for the currency symbol or name.

    Currency Name

    VARCHAR(30)

    No

    The local currency as a completely spelled-out currency name. The system copies the value into the output string of monetary numeric data whenever an N appears in the corresponding output FORMAT phrase.

    Currency

    VARCHAR(30)

    No

    The local currency symbol. The system copies the value into the output string of monetary numeric data whenever an L appears in the corresponding output FORMAT phrase.

    ISOCurrency

    VARCHAR(30)

    No

    The local currency as an uppercase, three-character code from ISO 4217. The system copies the value into the output string of monetary numeric data whenever a C appears in the corresponding output FORMAT phrase.

    Dual Currency Name

    VARCHAR(30)

    No

    The dual currency as a completely spelled-out currency name. The system copies the value into the output string of monetary numeric data whenever an A appears in the corresponding output FORMAT phrase.

    Dual Currency

    VARCHAR(30)

    No

    The dual currency symbol. The system copies the value into the output string of monetary numeric data whenever an O appears in the corresponding output FORMAT phrase.

    Dual ISOCurrency

    VARCHAR(30)

    No

    The dual currency as an uppercase, three-character code from ISO 4217. The system copies the value into the output string of monetary numeric data whenever a U appears in the corresponding output FORMAT phrase.

    Default ByteInt Format

    VARCHAR(30)

    No

    The default output format applied to BYTEINT data types.

    Default Integer Format

    VARCHAR(30)

    No

    The default output format applied to INTEGER data types.

    Default SmallInt Format

    VARCHAR(30)

    No

    The default output format applied to SMALLINT data types.

    Default Numeric Format

    VARCHAR(30)

    No

    The default output format applied to NUMERIC and DECIMAL data types.

    Default Real Format

    VARCHAR(30)

    No

    The default output format applied to REAL, DOUBLE PRECISION, and FLOAT data types.

    Default Time Format

    VARCHAR(30)

    No

    The default output format applied to TIME and TIME WITH TIME ZONE data types

    Default Timestamp Format

    VARCHAR(30)

    No

    The default output format applied to TIMESTAMP and TIMESTAMP WITH TIME ZONE data types.

    Current Role

    VARCHAR(30)

    No

    Reports the current role for the session. If no role applies, the system returns an empty string.

    Logon Account

    VARCHAR(30)

    No

    Reports the account name used to log on to the Teradata Database.

    Profile

    VARCHAR(30)

    No

    Reports the name of the profile associated with this session.

    See “User Name” earlier in this table for information about the data type and system‑defined character sets for Profile.

    LDAP

    CHARACTER(1)

    No

    Reports whether the session is authenticated by an LDAP directory and whether the directory user is mapped to a database user.

  • N specifies that the session is not LDAP-based.
  • P specifies the session of an LDAP user mapped to a database user.
  • X specifies the session of an LDAP user not mapped to a database user.
  • Audit Trail ID

    VARCHAR(30)

    No

    Reports the name used for access logging, regardless of whether the user is Directory‑managed or database‑managed.

    The system stores values for external users who do not have a corresponding permanent user name in the User Name column.

    Current Isolation Level

    CHARACTER(2)

    No

    Reports the default read‑only isolation level for the current session.

  • RU specifies that the default read‑only isolation level for the current session is Read Uncommitted.
  • The default read‑only locking severity for the session in ACCESS.

  • SR specifies that the default read‑only isolation level for the current session is Serializable.
  • The default read‑only locking severity for the session is READ.

    Default BigInt Format

    VARCHAR(30)

    No

    Reports the default output format for the BIGINT data type. The value is set in the Specification for Data Formatting (SDF) file by the database administrator.

    If the attribute is Default BIGINT Format, the default output format applies to BIGINT data type

    For information about changing the default data type output format in the SDF and the definition of formatting characters, see SQL Data Types and Literals.

    Query Band

    VARCHAR(2048)

    No

    Reports the query band for the current session using FORMAT X(4105).

  • If there is no query band, then the Query Band text contains an empty string.
  • If there is only a transaction query band, then the Query Band text contains the following string.
  •      =T> transaction_queryband

    where transaction_queryband is the query band for the transaction.

  • If there is only a session query band, then the Query Band text contains the following string.
  •      =S> session_queryband

    where session_queryband is the query band for the current session.

  • If there is both a transaction query band and a session query band, then the Query Band text contains the following concatenated string.
  •      =T> transaction_queryband =S>
         session_queryband

    where transaction_queryband is the query band for the transaction and session_queryband is the query band for the current session.

    Proxy User

    VARCHAR(30)

    No

    If there is a proxy connection in effect for the session, reports the name of the Proxy User.

    If there is no proxy connection in effect for the session, the system returns an empty string.

    Proxy Role

    VARCHAR(30)

    No

    If there is a proxy connection in effect for the session and a role has been assigned to the Proxy User, Proxy Role reports the name of that role.

    If there is no proxy connection in effect for the session, or if no roles have been assigned to the Proxy User, Proxy Role returns an empty string.

    Constraint1Name

    VARCHAR(30)

    No

    The name of a row level security constraint.

    If no row level security constraint applies, the Constraint_n_Name is null.

    If the session has more than 1 security constraint, the system displays each with a unique identifying number, for example:

    Constraint1Name
    Constraint1Value
    Constraint2Name
    Constraint2Value...

    Constraint1Value

    CHAR(68)

    No

    The value code for the default session label for the ConstraintnName.

    If no row level security constraint applies, the Constraint_n_Value is null.

    Temporal Qualifier

    VARCHAR(1024)

    No

    Reports the default temporal attribute for the current session.

    For information about temporal columns, see ANSI Temporal Table Support and Temporal Table Support

    Calendar Name

    VARCHAR(128)

    No

    Reports the default calendar for the current session.

    Export Width Rule Set

    CHAR(40)

    No

    The export width rule in effect for the session.

    For details, see International Character Set Support.

    Default Number Format

    VARCHAR(30)

    No

    The default output format for the NUMBER data type.

    TTGranularity

    VARCHAR(15)

    No

    Indicates the temporal transaction time granularity for the session.

    For information about temporal columns, see ANSI Temporal Table Support and Temporal Table Support

    Redrive Participation

    VARCHAR(60)

    No

    Reports whether Redrive protection is enabled or disabled for the current session.

    User Dictionary Name

    VARCHAR(128)

    No

    The attributes shown in this section are based upon and supersede the corresponding older attributes:

  • User Name
  • Account Name
  • Current Database
  • Current Role
  • Logon Account
  • Profile
  • Audit Trail ID
  • Proxy User
  • Proxy Role
  • Constraint
  • Note: The system reports up to 8 numbered constraint attributes if constraints apply to the session user.

    The older attributes are retained for compatibility with existing applications.

    For details, see the topics beginning with “Working with Object Name and Title Data in HELP Reports” on page 896.

     

    User SQL Name

    VARCHAR(644)

    No

    User UEscape

    VARCHAR(1)

    Yes

    Account Dictionary Name

    VARCHAR(128)

    No

    Account SQL Name

    VARCHAR(644)

    No

    Account UEscape

    VARCHAR(1)

    Yes

    Current Database Dictionary Name

    VARCHAR(128)

    No

    Current Database SQL Name

    VARCHAR(644)

    No

    Current Database UEscape

    VARCHAR(1)

    Yes

    Current Role Dictionary Name

    VARCHAR(128)

    Yes

    Current Role SQL Name

    VARCHAR(644)

    Yes

    Current Role UEscape

    VARCHAR(1)

    Yes

    Logon Account Dictionary Name

    VARCHAR(128)

    No

    Logon Account SQL Name

    VARCHAR(644)

    No

    Logon Account UEscape

    VARCHAR(1)

    Yes

    Profile Dictionary Name

    VARCHAR(128)

    Yes

    (continued)

     

    Profile SQL Name

    VARCHAR(644)

    Yes

    Profile UEscape

    VARCHAR(1)

    Yes

    Audit Trail Id Dictionary Name

    VARCHAR(128)

    No

    Current Database SQL Name

    VARCHAR(644)

    No

    Current Database UEscape

    VARCHAR(1)

    Yes

    Audit Trail Id SQL Name

    VARCHAR(644)

    No

    Audit Trail Id UEscape

    VARCHAR(1)

    Yes

    Proxy User Dictionary Name

    VARCHAR(128)

    Yes

    Proxy User SQL Name

    VARCHAR(644)

    Yes

    Proxy User UEscape

    VARCHAR(1)

    Yes

    Proxy Role Dictionary Name

    VARCHAR(128)

    Yes

    Proxy Role SQL Name

    VARCHAR(644)

    Yes

    Proxy Role UEscape

    VARCHAR(1)

    Yes

    Constraint_n Dictionary Name

    VARCHAR(128)

    Yes

    Constraint_n SQL Name

    VARCHAR(644)

    Yes

    Constraint_n_Name UEscape

    VARCHAR(1)

    Yes