17.00 - JDBC 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

When the application writing to LogonSource connects to Vantage using the JDBC 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 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 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 TDP making the connection with Vantage for this logon.

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

This field contains a maximum of 97 characters, and is truncated to the space remaining after all the other fields have been written.

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 JDBC driver.

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

(Field 5)

An ID for the Java process or thread on the client system.

The field contains a maximum of 12 characters.

Because Java threads are not tied to particular database connections, any thread can execute requests on a connection that was originally created by a different thread.

To avoid confusion, the Teradata JDBC driver provides a unique connection ID, which is derived from the hash code of the connection object.

This field comprises 2 components:

  • The four-character literal string, for example:
    CID=
  • The unique connection ID.

This information is provided by the Teradata JDBC driver.

ClientProcThreadId Client process or thread ID.
Client User ID

(Field 6)

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

This field contains a maximum of 20 characters.

This information is provided by the Teradata JDBC driver.

ClientSystemUserId Client user ID.
Client Program

(Field 7)

An ID for the Java client program.

This field contains a maximum of 26 characters.

This field comprises 4 components:

  • The literal string JDBC.
  • The JDBC driver version.
  • SEMICOLON character.
  • The system version number:
    getProperty

This field is retrieved using the following method:

System.getProperty(“java.version”)

This information is provided by the Teradata JDBC driver.

ClientProgramName Client system program name.
Format ID

(Field 8)

A 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 JDBC connections, this value is always:

01 LSS

This information is provided by the Teradata JDBC driver.

ClientAttributesEx Description of the client that does not match any of the other client attributes fields.