Integration Server 10.3 | Built-In Services Reference Guide | Db Folder | Summary of Elements in this Folder | pub.db:delete
 
pub.db:delete
WmDB. Removes all rows in the specified table that meet the given criteria. 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 to delete rows from a table that is not in the database to which you are connected.
If you are not using a distributed database system or if you want to delete rows from 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 the schema name with a pattern-matching string, 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 the table to remove rows from.
$data
Document Optional. Criteria that the rows to delete must meet.
Important:
If no criteria are provided, all rows are deleted from the table.
Output Parameters
$updateCount
String Number of rows deleted.
$dbMessage
String Conditional. Message indicating the success or failure of the operation.