Skip to content

How to Expose a Mongo Datasource

This example demonstrates how Mongo data can be exposed as a data service. These data services are compatible with MongoDB Java Driver version 4.9.1.

Prerequisites

Let's create a simple Mongo database that stores employee information.

  1. Download and set up a MongoDB server.
  2. Use the following commands to create the database.

    mongosh
    use employeesdb
    db.createCollection("employees")
    db.things.insert( { id: 1, name: "Document1" } )
    db.employees.insert( { id: 1, name: "Sam" } )
    db.employees.insert( { id: 2, name: "Mark" } )
    db.employees.insert( { id: 3, name: "Steve" } )
    db.employees.insert( { id: 4, name: "Jack" } )
    

Synapse configuration

Given below is the data service configuration you need to build. See the instructions on how to build and run this example.

<data name="MongoDB" transports="http https local">
   <config enableOData="false" id="MongoDB">
      <property name="mongoDB_servers">localhost</property>
      <property name="mongoDB_database">employeesdb</property>
      <property name="mongoDB_read_preference">PRIMARY</property>
   </config>
   <query id="mongo_insert" useConfig="MongoDB">
      <expression>employees.insert("{id:#, name:#}")</expression>
      <param name="id" optional="false" sqlType="INTEGER"/>
      <param name="name" optional="false" sqlType="STRING"/>
   </query>
   <query id="mongo_find" useConfig="MongoDB">
      <expression>employees.find()</expression>
      <result element="Documents" rowName="Document">
         <element column="document" name="Data" xsdType="string"/>
      </result>
    </query>
   <operation name="mongo_insert_op">
      <call-query href="mongo_insert">
         <with-param name="id" query-param="id"/>
         <with-param name="name" query-param="name"/>
      </call-query>
   </operation>
   <operation name="mongo_find_op">
      <call-query href="mongo_find"/>
   </operation>
   <resource method="POST" path="insert/{id}">
      <call-query href="mongo_insert">
         <with-param name="id" query-param="id"/>
         <with-param name="name" query-param="name"/>
      </call-query>
   </resource>
   <resource method="GET" path="find">
      <call-query href="mongo_find"/>
   </resource>
</data>

Build and run

Create the artifacts:

  1. Launch Visual Studio Code with the WSO2 Integrator: MI for VS Code extension (MI for VS Code) installed.

    Info

    Follow the Install WSO2 Integrator: MI for VS Code documentation for a complete installation guide.

  2. Create an integration project.

  3. Create the data service with the configurations given above.

  4. Deploy the artifacts in your WSO2 Integrator: MI.

Let's try out this sample by invoking the find resource in the data service to GET data. Shown below is the curl command to send the GET request:

curl -X GET http://localhost:8290/services/MongoDB/find

This generates a response as follows.

<Documents xmlns="http://ws.wso2.org/dataservice">
  <Document>
    <Data>{ "_id" : { "$oid" : "5fd21a7dc9b921afa1c9b83c"} , "id" : 1.0 , "name" : "Sam"}</Data>
  </Document>
  <Document>
    <Data>{ "_id" : { "$oid" : "5fd21a87c9b921afa1c9b83d"} , "id" : 2.0 , "name" : "Mark"}</Data>
  </Document>
  <Document>
    <Data>{ "_id" : { "$oid" : "5fd21a90c9b921afa1c9b83e"} , "id" : 3.0 , "name" : "Steve"}</Data>
  </Document>
  <Document>
    <Data>{ "_id" : { "$oid" : "5fd21a9fc9b921afa1c9b83f"} , "id" : 4.0 , "name" : "Jack"}</Data>
  </Document>
</Documents>