This documentation is for WSO2 IoT Server 3.1.0. View the documentation for the latest release.
Changing to PostgreSQL - IoT Server 3.1.0 - WSO2 Documentation
||
Skip to end of metadata
Go to start of metadata

By default, WSO2 IoT Server uses the embedded H2 database as the database for storing user management and registry data. Given below are the steps you need to follow in order to use a PostgreSQL database for this purpose.

Before you begin

Setting up configuration files

The default datasource configurations are defined in the files listed below.

  • master-datasources.xml

    This file contains the following default datasource configurations to configure IOTS with the Carbon database and the WSO2 API Manager database.

    Edit the WSO2_CARBON_DB and WSO2AM_DB datasources in the <IOTS_HOME>/conf/datasources/ master-datasources.xml file by replacing the url, username, password and driverClassName settings with your custom values.

     WSO2_Carbon_DB datasource
    <datasource>
       <name>WSO2_CARBON_DB</name>
       <description>The datasource used for registry and user manager</description>
       <jndiConfig>
          <name>jdbc/WSO2CarbonDB</name>
       </jndiConfig>
       <definition type="RDBMS">
          <configuration>
             <url>jdbc:postgresql://localhost:3306/WSO2CARBON_DB</url>
             <username>wso2carbon</username>
             <password>wso2carbon</password>
             <driverClassName>org.postgresql.Driver</driverClassName>
             <maxActive>50</maxActive>
             <maxWait>60000</maxWait>
             <minIdle>5</minIdle>
             <testOnBorrow>true</testOnBorrow>
             <validationQuery>SELECT 1</validationQuery>
             <validationInterval>30000</validationInterval>
    		 <defaultAutoCommit>true</defaultAutoCommit>
          </configuration>
       </definition>
    </datasource>
     WSO2AM_DB datasource
    <datasource>
       <name>WSO2AM_DB</name>
       <description>The datasource used for API Manager database</description>
       <jndiConfig>
          <name>jdbc/WSO2AM_DB</name>
       </jndiConfig>
       <definition type="RDBMS">
          <configuration>
             <url>jdbc:postgresql://localhost:3306/WSO2AM_DB</url>
             <username>wso2carbon</username>
             <password>wso2carbon</password>
             <driverClassName>org.postgresql.Driver</driverClassName>
             <maxActive>50</maxActive>
             <maxWait>60000</maxWait>
             <testOnBorrow>true</testOnBorrow>
             <validationQuery>SELECT 1</validationQuery>
             <validationInterval>30000</validationInterval>
    		 <defaultAutoCommit>true</defaultAutoCommit>
          </configuration>
       </definition>
    </datasource>
     WSO2_MB_Store_DB datasource
    <datasource>
       <name>WSO2_MB_STORE_DB</name>
       <description>The datasource used for message broker database</description>
       <jndiConfig>
          <name>jdbc/WSO2MBStoreDB</name>
       </jndiConfig>
       <definition type="RDBMS">
          <configuration>
             <url>jdbc:postgresql://localhost:3306/WSO2MB_DB</url>
             <username>wso2carbon</username>
             <password>wso2carbon</password>
             <driverClassName>org.postgresql.Driver</driverClassName>
             <maxActive>50</maxActive>
             <maxWait>60000</maxWait>
             <testOnBorrow>true</testOnBorrow>
             <validationQuery>SELECT 1</validationQuery>
             <validationInterval>30000</validationInterval>
             <defaultAutoCommit>false</defaultAutoCommit>
          </configuration>
       </definition>
    </datasource>
  • metrics-datasources.xml

    This file contains the datasource required to enable the JVM metrics.

    Edit the WSO2_METRICS_DB datasource in the <IOTS_HOME>/conf/datasources/ metrics-datasources.xml file by replacing the url, username, password and driverClassName settings with your custom values and also the other values accordingly.

     WSO2_Metrics_DB datasource
    <datasource>
       <name>WSO2_METRICS_DB</name>
       <description>The default datasource used for WSO2 Carbon Metrics</description>
       <jndiConfig>
          <name>jdbc/WSO2MetricsDB</name>
       </jndiConfig>
       <definition type="RDBMS">
          <configuration>
             <url>jdbc:postgresql://localhost:3306/WSO2METRICS_DB</url>
             <username>wso2carbon</username>
             <password>wso2carbon</password>
             <driverClassName>org.postgresql.Driver</driverClassName>
             <maxActive>50</maxActive>
             <maxWait>60000</maxWait>
             <testOnBorrow>true</testOnBorrow>
             <validationQuery>SELECT 1</validationQuery>
             <validationInterval>30000</validationInterval>
             <defaultAutoCommit>true</defaultAutoCommit>
          </configuration>
       </definition>
    </datasource> 
  • cdm-datasources.XML

    This file contains the following default datasource configurations to configure WSO2 IoT Server with the Connected Device Management Framework and for device management.

    Edit the DM_DS datasource in the <IOTS_HOME>/conf/datasources/ cdm-datasources.xml file by replacing the url, username, password and driverClassName settings with your custom values and also the other values accordingly.

     DM_DS datasource
    <datasource>
       <name>WSO2DM_DS</name>
       <description>The datasource used for CDM</description>
       <jndiConfig>
          <name>jdbc/DM_DS</name>
       </jndiConfig>
       <definition type="RDBMS">
          <configuration>
             <url>jdbc:postgresql://localhost:3306/WSO2DM_DB</url>
             <username>wso2carbon</username>
             <password>wso2carbon</password>
             <driverClassName>org.postgresql.Driver</driverClassName>
             <maxActive>50</maxActive>
             <maxWait>60000</maxWait>
             <testOnBorrow>true</testOnBorrow>
             <validationQuery>SELECT 1</validationQuery>
             <validationInterval>30000</validationInterval>
          </configuration>
       </definition>
    </datasource>
  • <PLUGIN_NAME>-datasources.xml

    This file contains the following default datasource configurations to configure WSO2 IoT Server with the Connected Device Management Framework and for device management.

    Example:
    Edit the Android_DB datasource in the android-datasources.xml file by replacing the url, username, password and driverClassName settings with your custom values and also the other values accordingly.

     Example: Android_DB datasource
    <datasource>
        <name>Android_DB</name>
        <description>The datasource used as the Android Device Management database</description>
        <jndiConfig>
            <name>jdbc/MobileAndroidDM_DS</name>
        </jndiConfig>
        <definition type="RDBMS">
            <configuration>
                <url>jdbc:postgresql://localhost:3306/WSO2MobileAndroid_DB;
                </url>
                <username>wso2carbon</username>
                <password>wso2carbon</password>
                <driverClassName>org.postgresql.Driver</driverClassName>
                <maxActive>50</maxActive>
                <maxWait>60000</maxWait>
                <testOnBorrow>true</testOnBorrow>
                <validationQuery>SELECT 1</validationQuery>
                <validationInterval>30000</validationInterval>
            </configuration>
        </definition>
    </datasource>
  • analytics-datasources.xml

    This file contains the following default datasources used for summarization and to persist stream data. The database tables are created dynamically when running the spark script along with the required tables.
    Example: Arduino publishes the temperature data that gets stored in this database.

    Edit the WSO2_ANALYTICS_EVENT_STORE_DB and WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB datasources in the <IOTS_HOME>/wso2/analytics/conf/datasources/analytics-datasources.xml file by replacing the url, usernamepassword and driverClassNamesettings with your custom values and also the other values accordingly.

     WSO2_Analytics_Event_Store_DB datasource
    <datasource>
       <name>WSO2_ANALYTICS_EVENT_STORE_DB</name>
       <description>The datasource used for analytics record store</description>
       <definition type="RDBMS">
          <configuration>
             <url>jdbc:postgresql://localhost:3306/ANALYTICS_EVENT_STORE</url>
             <username>wso2carbon</username>
             <password>wso2carbon</password>
             <driverClassName>org.postgresql.Driver</driverClassName>
             <maxActive>50</maxActive>
             <maxWait>60000</maxWait>
             <validationQuery>SELECT 1</validationQuery>
             <defaultAutoCommit>false</defaultAutoCommit>
             <initialSize>0</initialSize>
             <testWhileIdle>true</testWhileIdle>
             <minEvictableIdleTimeMillis>4000</minEvictableIdleTimeMillis>
          </configuration>
       </definition>
    </datasource>
     WSO2_Analytics_Processed_Data_Store_DB datasource
    <datasource>
       <name>WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB</name>
       <description>The datasource used for analytics record store</description>
       <definition type="RDBMS">
          <configuration>
             <url>jdbc:postgresql://localhost:3306/ANALYTICS_PROCESSED_DATA_STORE</url>
             <username>wso2carbon</username>
             <password>wso2carbon</password>
             <driverClassName>org.postgresql.Driver</driverClassName>
             <maxActive>50</maxActive>
             <maxWait>60000</maxWait>
             <validationQuery>SELECT 1</validationQuery>
             <defaultAutoCommit>false</defaultAutoCommit>
             <initialSize>0</initialSize>
             <testWhileIdle>true</testWhileIdle>
             <minEvictableIdleTimeMillis>4000</minEvictableIdleTimeMillis>
          </configuration>
       </definition>
    </datasource>

The datasource configuration options are as follows:

  • url - The URL of the database.
  • username  - The name of the database user.

  • password - The password of the database user.
  • driverClassName  - The class name of the database driver.
  • maxActive - The maximum number of active connections that can be allocated from this pool at the same time, or enter a negative value for no limit.
  • maxWait - The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception. You can enter zero or a negative value to wait indefinitely.
  • minIdle - The minimum number of active connections that can remain idle in the pool without extra ones being created, or enter zero to create none.
  • testOnBorrow -  The indication of whether objects will be validated before being borrowed from the pool. If the object fails to validate, it will be dropped from the pool, and another attempt will be made to borrow another. 
  • validationQuery - The SQL query that will be used to validate connections from this pool before returning them to the caller.
  • validationInterval -  The indication to avoid excess validation, and only run validation at the most, at this frequency (time in milliseconds). If a connection is due for validation but has been validated previously within this interval, it will not be validated again. 

    For more information on other parameters that can be defined in the master-datasources.xml file, see Tomcat JDBC Connection Pool.

Creating database tables

Create the following database tables either manually or automatically.

DatabaseDB Script name and Location
WSO2_CARBON_DB<IOTS_HOME>/dbscripts/postgresql.sql
WSO2AM_DB

<IOTS_HOME>/dbscripts/apimgt/postgresql.sql

<IOTS_HOME>/dbscripts/identity/postgresql.sql

WSO2_MB_STORE_DB<IOTS_HOME>/wso2/broker/dbscripts/mb-store/postgresql.sql
WSO2_METRICS_DB<IOTS_HOME>/dbscripts/metrics/Postgresql.sql
WSO2DM_DS<IOTS_HOME>/dbscripts/cdm/postgresql.sql

<DEVICE_PLUGIN>_DB

Example: Arduino_DB

<IOTS_HOME>/dbscripts/cdm/plugins/<DEVICE_PLUGIN>/postgresql.sql

Example: <IOTS_HOME>/dbscripts/cdm/plugins/android/postgresql.sql

Using the script

You can create database tables manually by executing the following script:

  1. Run the PostgreSQL script individually for the latter mentioned databases that are provided with the product using the below command (outside the PostgreSQL prompt):

    psql -U <USERNAME> -d <DATABASE-NAME> -a -f '<PATH-TO-PostgreSQL-DB-SCRIPT>'

    Example:

    psql -U username -d WSO2_CARBON_DB -a -f <IOTS_HOME>/dbscripts/postgresql.sql

    Enter the password for each command when prompted.

  2. Start the WSO2 IoT Server as follows:
    • For Linux:

      ./iot-server.sh
    • For Windows:

      iot-server.bat
Using a startup parameter

You can create database tables automatically when starting the product for the first time by running the following command:

  • For Linux:

    ./iot-server.sh -Dsetup
  • For Windows:

    iot-server.bat -Dsetup
  • No labels