17.00 - ODBC Driver 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 ODBC session being reported, such as the user ID or process ID of the client system.

When the application writing to LogonSource connects to Vantage using the ODBC 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 and 6 have been filled.

This field comprises 5 components:

  • Vantage host name specified by the application.
  • SEMICOLON character.
  • Host name or IP address of Vantage node that was connected.
  • COLON character.
  • Port number of Vantage node that was connected.

This information is provided by the Teradata ODBC driver.

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

(Field 5)

ID for the ODBC process on the network client system.

This field contains a maximum of 12 characters.

This information is not provided by the Teradata ODBC driver.

ClientProcThreadId Client process or thread ID.
Client User ID

(Field 6)

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

This field contains a maximum of 20 characters.

This information is provided by the Teradata ODBC driver.

ClientSystemUserId Client user ID.