DBconnectInformation

Synopsis

A DBconnectInformation group describes a connection with a database.

Input Ports

None

Parameters

None

Output Ports

None

Description

A DBconnectInformation group describes a connection with a database. Its subobjects include all of the connection specifications except the user password as well as a connect status indicator.

This group typically obtains the values for its subobjects dynamically, from the connection descriptor for the current connection via a pointer in the module to that descriptor. It is incorporated into many Database Kit modules as a way to keep track of the connection in which the current SQL statement is executing.

SubObjects

database_driver

A string representing the name of the database driver, which indicates the type of database.

server_host

A string representing the host name of the machine on which the server that manages the database resides.

server_name

A string representing the name of the server that manages the database.

database_name

A string representing the database to which the user is connected.

user_id

A string representing the user's ID on the host system.

connect_string

A string representing the connect string that the database server used to connect the user to the specified database.

connected

An integer value representing the status of the connection: 1 indicates connected and 0 indicates not connected .

Example

Not available.

File

v/db.v

See also related modules

DBconnect