You may specify the connection parameters in one of the following ways: $dbAlias $dbURL, $dbUser, $dbPass, $dbDriver $dbConnection | ||
$dbAlias | String Optional. Alias of the database on which you want to execute the stored procedure. | |
$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 specified in $dbUser. | |
$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 invoke a stored procedure from a database other than the one to which you are connected. If you are not using a distributed database system, you do not need to specify this parameter. If you are running against DB2, use this parameter to specify the stored procedure's location. | |
$dbSchemaPattern | String Optional. Name of the schema to which the stored procedure 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 of HR% would represent any schema beginning with characters HR. If you are running against DB2, you use this parameter to specify the stored procedure's AuthID. | |
$dbProc | String The name of the stored procedure you want to invoke. | |
$dbProcSig | Document List Optional. Set of parameters containing information about the stored procedure you want to invoke. | |
Key | Description | |
name | String Parameter name defined in the stored procedure. | |
sqlType | String Type of procedure parameter for name as defined in the database. Set to one of the following values: BIT TINYINT SMALLINT INTEGER BiGINT FLOAT REAL DOUBLE NUMBERIC DECIMAL CHAR VARCHAR LONGVARCHAR DATE TIME TIMESTAMP BINARY VARBINARY LONGVARBINARY NULL | |
direction | String Way in which the parameter is used by the stored procedure. Set to one of the following values: in out inout return value | |
$dbParamsByOrder | String Optional. Indicates whether the contents of $data should be sent to the database in order. Set to: true to send the contents of $data to the database in the order they are listed in $data. false to send the contents of $data to the database in no particular order. This is the default. | |
$data | Document Parameter values for the stored procedure. Whether the $data parameter is mandatory or not depends on the watt.server.jdbc.sp.mandateParams property. If this property is set to false, the $data input parameter is optional. If this property is true, you must provide values for the $data parameter. The default value for the watt.server.jdbc.sp.mandateParams property is true. |
$dbMessage | String Conditional. Message indicating the success or failure of the operation. |