This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

The batch requests feature allows you to send multiple (IN-Only) requests to a datasource using a single operation (batch operation). Follow the steps given below to define a data service that can invoke batch requests:


Setting up a datasource

Follow the steps given below to set up a MySQL database for this tutorial.

  1. Install the MySQL server.
  2. Download the JDBC driver for MySQL from here and copy it to your <EI_HOME>/lib directory.
  3. Create the following database: Company
  4. Create the EMPLOYEES table:

    CREATE TABLE `EMPLOYEES` (`EmployeeNumber` int(11) NOT NULL, `FirstName` varchar(255) NOT NULL, `LastName` varchar(255) DEFAULT NULL, `Email` varchar(255) DEFAULT NULL, `JobTitle` varchar(255) DEFAULT NULL, `OfficeCode` int(11) NOT NULL, PRIMARY KEY (`EmployeeNumber`,`OfficeCode`));

Define a data service to insert records in batches

Let's create a data service using the Create Data Service wizard:

  1. Log in to the management console and click Create under Data Service.
  2. Add a name for the data service and select the Enable Batch Requests check box as shown below.

  3. Click Next and add a new datasource.
  4. Give an ID for the datasource, and create the connection to the Company database. Specifying the following details:

  5. Save the datasource details, and click Next to open the Queries screen.
  6. Click Add New Query to specify the query details:

    1. Enter addEmployeeQuery as the query ID.

    2. Enter the following SQL dialect:

      insert into Employees (EmployeeNumber, FirstName, LastName, Email, JobTitle, OfficeCode) values(:EmployeeNumber,:FirstName,:LastName,:Email,:JobTitle,:Officecode)
  7. Click Generate Input Mapping and input mappings will be generated automatically for the EmployeeNumber, FirstName, LastName, Email, JobTitle, and OfficeCode fields.

  8. Save the query, and click Next to open the Operations screen.

  9. Click Add New Operation, and create an operation for the addEmployeeQuery query as shown below.
  10. Save the operation.
  11. Click Finish to complete the data service creation process.

Invoking the data service 

You can try the data service you created by using the TryIt tool that is in your product by default. 

  1. Go to the Deployed Services screen.
  2. Click Try this Service to open the data service from the TryIt tool.
  3. Click Try this Service to open the data service from the TryIt tool. There will be a batch_request operation automatically generated.
  4. Select the batch operation.
  5. Enter multiple transactions as shown below. In this example, we are sending two transactions with details of two employees.

    <p:addEmployeeOp_batch_req xmlns:p="http://ws.wso2.org/dataservice">
          <!--1 or more occurrences-->
          <addEmployeeOp xmlns="http://ws.wso2.org/dataservice">
             <!--Exactly 1 occurrence-->
             <xs:EmployeeNumber xmlns:xs="http://ws.wso2.org/dataservice">1002</xs:EmployeeNumber>
             <!--Exactly 1 occurrence-->
             <xs:FirstName xmlns:xs="http://ws.wso2.org/dataservice">John</xs:FirstName>
             <!--Exactly 1 occurrence-->
             <xs:LastName xmlns:xs="http://ws.wso2.org/dataservice">Doe</xs:LastName>
             <!--Exactly 1 occurrence-->
             <xs:Email xmlns:xs="http://ws.wso2.org/dataservice">johnd@wso2.com</xs:Email>
             <!--Exactly 1 occurrence-->
             <xs:JobTitle xmlns:xs="http://ws.wso2.org/dataservice">Consultant</xs:JobTitle>
             <!--Exactly 1 occurrence-->
             <xs:Officecode xmlns:xs="http://ws.wso2.org/dataservice">01</xs:Officecode>
          </addEmployeeOp>
          <addEmployeeOp xmlns="http://ws.wso2.org/dataservice">
             <!--Exactly 1 occurrence-->
             <xs:EmployeeNumber xmlns:xs="http://ws.wso2.org/dataservice">1004</xs:EmployeeNumber>
             <!--Exactly 1 occurrence-->
             <xs:FirstName xmlns:xs="http://ws.wso2.org/dataservice">Peter</xs:FirstName>
             <!--Exactly 1 occurrence-->
             <xs:LastName xmlns:xs="http://ws.wso2.org/dataservice">Parker</xs:LastName>
             <!--Exactly 1 occurrence-->
             <xs:Email xmlns:xs="http://ws.wso2.org/dataservice">peterp@wso2.com</xs:Email>
             <!--Exactly 1 occurrence-->
             <xs:JobTitle xmlns:xs="http://ws.wso2.org/dataservice">Consultant</xs:JobTitle>
             <!--Exactly 1 occurrence-->
             <xs:Officecode xmlns:xs="http://ws.wso2.org/dataservice">01</xs:Officecode>
          </addEmployeeOp>
       </p:addEmployeeOp_batch_req>
  6. Execute the batch operation. You will find that all the records have been inserted into the database simultaneously.
  • No labels