Description
The StoredProcedureCallReceiver calls a stored procedure with or without parameters via JDBC. It executes a stored procedure as a closed system, meaning it does not expect any returned values.
In This Article
- Receiver Parameters
- Receiver Attribute Property Keys
- Type Value
- JDBC Configuration File
- Example JDBC Configuration File
Receiver Parameters
The StoredProcedureCallReceiver requires that the following parameters are defined:
- resourceName - Defines the name of the resource that contains the database connection information on a user's local machine.
- databaseName - Defines the name of the database to access.
- procedureName - Defines the name of the stored procedure to call.
Receiver Attribute Property Keys
The Receiver defines four property keys that can be modified on any of its associated Domain Attributes:
- use - Specifies whether or not to use the given Attribute's value as a parameter value in the store procedure call.
- position - Specifies the position of the parameter value within the store procedure call. This parameter must be defined if 'use' is equal to true.
- type - Specifies the parameter type. This parameter must be defined if 'use' is equal to true.
- size - The size of the type.
Type Value
The column data types are the following:
- VarChar - native data type
- Boolean - native data type
- BigDecimal - gets translated to a DECIMAL
- Date - native data type
- Double - native data type
- Float - native data type
- Integer - native data type
- Long - gets translated to a BIGINT
- Time - native data type
- Timestamp - native data type
JDBC Configuration File
This Receiver uses a configuration file located on the user's local computer as a resource to attain the necessary information for connecting to a user's local database via JDBC. The required properties to connect to a database via JDBC are the following:
- driver - the path and filename of the JDBC library for the database to connect to.
- user - the name used to connect as a user to the database.
- password - the password used to connect the given user to the database.
- url - the JDBC universal resource locator required to connect to the given database.
- batchCount - defines the number of rows of generated data that are batched together before writing to the database.
Example JDBC Configuration File
Below is an example of a JDBC configuration file defined to connect to a MySQL database called acme:
driver=com.mysql.jdbc.Driver user=root password=openSaysMe url=jdbc:mysql://localhost:3306/acme batchCount=1000