Skip to end of metadata
Go to start of metadata

Setting up the database and users

Follow the steps below to set up MariaDB. See Tested DBMSs for information on the MariaDB versions that we have tested the WSO2 products with.

  1. Download, install and start MariaDB on your computer. See https://downloads.mariadb.org/.

    You can install MariaDB standalone or as a galera cluster for high availability. Database clustering is independent of WSO2 product clustering. For more information on setting up a galera cluster, see the MariaDB Galera Cluster documentation.

    For instructions on installing MariaDB on MAC OS, go to Homebrew.

  2. Log in to MariaDB as the root user (or any other user with database creation privileges).
    mysql -u root -p
  3. Enter the password when prompted.

    In most systems, there is no default root password. Press the Enter key without typing anything if you have not changed the default root password.

  4. In the MySQL command prompt, create the database using the following command:
    create database regdb;
  5. Give authorization of the database to the regadmin user as follows:
    GRANT ALL ON regdb.* TO regadmin@localhost IDENTIFIED BY "regadmin";
  6. Once you have finalized the permissions, reload all the privileges by executing the following command:
    FLUSH PRIVILEGES;
  7. Log out from the MySQL prompt by executing the following command:
    quit;

Setting up the drivers

Download the MySQL Java connector JAR file, and copy it to the <PRODUCT_HOME>/repository/components/lib/ directory.

Note that you must use the MySQL connector that is compatible with your MariaDB version. For example, mysql-connector-java-5.1.36-bin.jar is compatible with MariaDB version 10.0.20. See Tested DBMSs for information on which version of a WSO2 product has been tested for compatibility with which version of MariaDB and MySQL connector.

Setting up datasource configurations

A datasource is used to establish the connection to a database. By default, WSO2_CARBON_DB datasource is used to connect to the default  H2 database, which stores registry and user management data. After setting up the MariaDB database to replace the default H2 database, either change the default configurations of the  WSO2_CARBON_DB datasource, or configure a new datasource to point it to the new database as explained below.

Changing the default WSO2_CARBON_DB datasource

Follow the steps below to change the type of the default WSO2_CARBON_DB  datasource.

  1. Edit the default datasource configuration in the <PRODUCT_HOME>/repository/conf/datasources/m aster-datasources.xml file as shown below.

    Do not change the datasource name WSO2_CARBON_DB in the below configuration.

    <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:mysql://localhost:3306/regdb</url>
                   <username>regadmin</username>
                   <password>regadmin</password>
                   <defaultAutoCommit>false</defaultAutoCommit>
                   <driverClassName>com.mysql.jdbc.Driver</driverClassName>
                   <maxActive>80</maxActive>
                   <maxWait>60000</maxWait>
                   <minIdle>5</minIdle>
                   <testOnBorrow>true</testOnBorrow>
                   <validationQuery>SELECT 1</validationQuery>
                   <validationInterval>30000</validationInterval>
    			   <defaultAutoCommit>false</defaultAutoCommit>
               </configuration>
           </definition>
    </datasource>

    The elements in the above configuration are described below:

    ElementDescription
    urlThe URL of the database. The default port for MariaDB is 3306
    username and passwordThe name and password of the database user
    driverClassNameThe class name of the database driver
    maxActiveThe maximum number of active connections that can be allocated  at the same time from this pool. Enter any negative value to denote an unlimited number of active connections.
    maxWaitThe 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.
    minIdleThe 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.
    validationIntervalThe 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.
    defaultAutoCommit

    This property is not applicable to the Carbon database in WSO2 products because auto committing is usually handled at the code level, i.e., the default auto commit configuration specified for the RDBMS driver will be effective instead of this property element. Typically, auto committing is enabled for an RDBMS drivers by default.

    When auto committing is enabled, each SQL statement will be committed to the database as an individual transaction, as opposed to committing multiple statements as a single transaction.

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

Configuring new  datasources to manage registry or user management data

Follow the steps below to configure new datasources to point to the  new  databases you create to manage registry and/or user management data separately.

  1. Add a new datasource with similar configurations as the WSO2_CARBON_DB  datasource above to the <PRODUCT_HOME>/repository/conf/datasources/ master-datasources.xml file . Change its elements with your custom values. For instructions, see Setting up datasource configurations.
  2. If you are setting up a separate database to store registry-related data, update the following configurations in the < PRODUCT_HOME>/repository/conf/

    <dbConfig name="wso2registry">
    	<dataSource>jdbc/MY_DATASOURCE_NAME</dataSource>
    </dbConfig>
  3. If you are setting up a separate database to store user management data, update the following configurations in the  < PRODUCT_HOME>/repository/conf/ user-mgt.xml  file.

    <Configuration>
    	<Property name="dataSource">jdbc/MY_DATASOURCE_NAME</Property>
    </Configuration>

Creating database tables

To create the database tables, connect to the database that you created earlier and run the following scripts. 

  1. To create tables in the registry and user manager database (WSO2CARBON_DB), use the below script:

     You may have to enter the password for each command when prompted.

    mysql -u regadmin -p -Dregdb < '<PRODUCT_HOME>/dbscripts/mysql.sql';
  2. Restart the server.

    You can create database tables automatically when starting the product for the first time by using the -Dsetup parameter as follows:

    • For Windows: <PRODUCT_HOME>/bin/wso2server.bat -Dsetup

    • For Linux: <PRODUCT_HOME>/bin/wso2server.sh -Dsetup

  • No labels