Integration Server 10.5 | Built-In Services Reference Guide | Db Folder | Summary of Elements in this Folder | pub.db:getTableInfo
 
pub.db:getTableInfo
WmDB. Retrieves information about columns in the specified table. As an alternative to this service, consider using the services provided with the webMethods Adapter for JDBC.
Input Parameters
You may specify the connection parameters in one of the following ways:
*$dbAlias
*$dbURL, $dbUser, $dbPass, $dbDriver
*$dbConnection
$dbAlias
String Optional. Database alias.
$dbURL
String Optional. JDBC URL that identifies the database resource.
$dbUser
String Optional. User name to use to log into the database.
$dbPass
String Optional. Password for the user.
$dbDriver
String Optional. Name of the JDBC driver to use.
$dbConnection
com.wm.app.b2b.server.DBConnection Optional. Connection object returned by pub.db:connect.
$dbCatalog
String Optional. Name of the database's system catalog. Include this parameter if your DBMS supports distributed databases and you want information about a table that is not in the database to which you are connected.
If you are not using a distributed database system or you want information about a table in the database to which you are connected, you do not need to specify this parameter.
If you are running against DB2, use this parameter to specify the database location.
$dbSchemaPattern
String Optional. Name of the schema to which the table belongs.
If your database supports pattern-matching on schemas, you may specify a pattern-matching string for the schema name, where _ represents a single character and % represents any string of characters. For example, the value HR% would represent any schema beginning with the characters HR.
If you are running against DB2, you use this parameter to specify the table's AuthID.
$dbTable
String Name of table whose column names you want to retrieve.
$dbColumnNamePattern
String Optional. Pattern-matching string that specifies the column names that you want to retrieve, where _ represents a single character and % represents any string of characters. For example, the value ADDR% would represent any column name beginning with the characters ADDR.
Output Parameters
This service returns one document (IData object) for each column that matches the specified input criteria. Each document contains information about a column. The document's key will be the same as the column name.
Usage Notes
This service accepts input from a web browser or HTML form.