17.00 - .NET Data Provider for Teradata API - Teradata Database

Teradata Vantageā„¢ - Data Dictionary

prodname
Advanced SQL Engine
Teradata Database
vrm_release
17.00
created_date
June 2020
category
Administration
Programming Reference
featnum
B035-1092-170K

The origin of the .NET Data Provider for Teradata session being reported, such as the user ID or process ID of the client system. LogonSource can contain the following names and identifiers.

When the application writing to LogonSource connects to Vantage using the .NET Data Provider driver, the definitions of the LogonSource string fields are as follows.

The corresponding LogOnOffV[X] or SessionInfoV[X] column shown in the table below appears in the LogOnOffV[X] and SessionInfoV[X] views and EventLog and SessionTbl tables only.

Teradata strongly recommends that applications which use the LogonSource fields instead use the corresponding LogOnOffV[X] or SessionInfoV[X] columns, also referred to as ClientAttribute columns.

You can use Teradata Studio or Teradata Studio Express to learn more about the ClientAttribute columns.

Field Name Description Corresponding LogOnOffV[X] or SessionInfoV[X] Column Description
Mode

(Field 1)

The literal string indicating the connection type, for example:
TCP/IP

This field is always 8 characters long.

This information is provided by Vantage.

ClientConnectionType Value is 1 indicating the client is connected using TCP/IP via the gateway.

To learn more about the possible values for this column see Possible Values for ClientConnectionType or you can use Teradata Studio or Teradata Studio Express.

TCP Port or Socket Number

(Field 2)

Hexadecimal TCP port or socket number on the network client system.

This field contains 4 hexadecimal characters.

The maximum value is 64K -1.

This information is provided by Vantage.

ClientTcpPortNumber Integer value of the TCP port or socket number.
IP Address

(Field 3)

IP address of the network client system.

This field contains a maximum of 45 characters.

This information is provided by Vantage.

ClientIpAddress Standard string representation of the IPv4 or IPv6 IP address.
TDP ID

(Field 4)

TDP ID for the network TDP making the connection with Vantage for this logon.

This field fills whatever space remains after fields 5 through 8 have been filled.

Fields 4 through 8 contains a maximum of 97 characters, and Vantage truncates the TDP ID field to the space remaining after all the other fields have been written.

If not enough space remains, then the data for TDP ID is removed from the LogonSource string.

This field comprises 5 components:

  • DataSource name specified by the application.
  • COLON character.
  • IP address of Vantage node that was connected.
  • COLON character.
  • Port number of Vantage node that was connected.

This information is provided by .NET Data Provider for Teradata.

ClientTdHostName Vantage host name that the client used to connect to Vantage.
Client Process ID

(Field 5)

ID for the client process.

.NET Data Provider removes this field if both the TDP ID and Client User ID fields have been removed, but the resulting string is still longer than the allotted 97 characters for .NET Data Provider for Teradata-supplied fields in LogonSource.

The field is retrieved using the following function call:

Process.GetCurrentProcessID().ID

This information is provided by .NET Data Provider for Teradata.

ClientProcThreadId Client process or thread ID.
Client User ID

(Field 6)

User ID for the logged on user as defined for the client system.

The field comprises 3 components:

  • The domain name.

    This value is retrieved using the following function call:

    System.Environment.UserDomainName

    If a security exception is encountered, the field contains a QUESTION MARK character.

  • The REVERSE SOLIDUS (\) character (U+005C).
  • The user name.

    The value is retrieved using the following function call:

    System.Environment.UserName

    If a security exception is encountered, the field contains a QUESTION MARK character.

This information is provided by .NET Data Provider for Teradata.

ClientSystemUserId Client user ID.
Client Program

(Field 7)

ID for the program running on the client system.

This field comprises 7 components:

  • The program name.

    This value is retrieved using the following function call:

    Process.GetCurrentProcess().ProcessName

    If a security exception is encountered, the field contains a QUESTION MARK character.

  • COLON character.
  • The literal character string NET.

    This identifies .NET Data Provider for Teradata.

  • COLON character.
  • The literal character string: SS

    This identifies the session as a standard SQL session.

  • COLON character.

    The 12-character release number for the .NET Data Provider for Teradata in the format nn.nn.nn.nnn, where n represents an integer value.

This information is provided by .NET Data Provider for Teradata.

ClientProgramName Client system program name.
Format ID

(Field 8)

Format ID that can be used to parse the earlier positional information in the LogonSource attribute.

If the field ends with the following four characters, the format ID is present:

LSS
In the example above, the first character in the four character format ID is a blank space.

This field is always 6 characters long.

For .NET Data Provider for Teradata connections, this value is always:

01 LSS

This information is provided by .NET Data Provider for Teradata.

ClientAttributesEx Description of the client that does not match any of the other client attributes fields.
The data in fields 4 through 7 can be truncated or removed entirely from the LogonSource string as required to ensure that the total length of the fields provided by .NET Data Provider for Teradata does not exceed 97 characters.

When field values must be eliminated, they are eliminated in the following order:

  • TDP ID (Field 4)
  • Client User ID (Field 6)
  • Client Process/Thread ID (Field 5)