Versions Compared

Old Version 3

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: ✉️ : Correct in valid spaces

...

Table of Contents
location
maxLevel3
locationtop
styleborder:1
topseparatorpipe

Excerpt
hiddentrue

NOTE TO WRITERS: Add the following to the beginning of your hosting page:

The following sections describe how to replace the default H2 database with MariaDB, which is a drop-in replacement for MySQL.

Table of Contents
maxLevel3
locationtop
styleborder:1locationtop
separatorpipe

Setting up the database and users

...

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

Warning

Note  that that you must  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.

...

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

    Note

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

    Code Block
    languagehtml/xml
    <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>
           </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.
    Info

    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.

...

Excerpt
hiddentrue

Note to writers: Add this content at the end of the page if any of the additional databases is relevant to your product.

Changing the identity/storage/product-specific databases

The topics above show how to change the WSO2_CARBON_DB, which is used to store registry and user manager information. If you changed the product-specific database that come by default or set up a separate database for identity or storage related data, the instructions are the same. In summary:

  1. Add a new datasource configuration to the following files for each of the separate databases that you need to create.

    For the identity databaseAdd it to the <PRODUCT_HOME>/repository/conf/datasources/<check the correct path and add file name (something like master-datasources.xml)>
    For the storage databaseAdd it to the <PRODUCT_HOME>/repository/conf/datasources/<check the correct path and add file name (something like master-datasources.xml)
    For the product-specific databaseAdd it to the <PRODUCT_HOME>/repository/conf/<check the correct path and add file name (something likeapi-manager.xml)

  2. Create the database tables using the following scripts:

    For the identity databaseUse  <PRODUCT_HOME>/dbscripts/identity/<check the correct path and add file name (something like mysql.sql)>
    For the storage databaseUse  <PRODUCT_HOME>/dbscripts/storage/<check the correct path and add file name (something like /mysql/resoucre.sql)>
    For the product-specific databaseUse  <PRODUCT_HOME>/dbscripts/<check the correct path and add file name (something like /apimgt/mysql.sql)> 

  3. Update the following configurations, with the defined datasource name of the corresponding database configuration you added to the <PRODUCT_HOME>/repository/conf/datasources/master-datasources.xml file.

    • If you are setting up a separate database to store identity related data, update the following configurations in the <PRODUCT_HOME>/repository/conf/identity.xml file.

      Code Block
      languagexml
      <JDBCPersistenceManager>
	<DataSource>
		<!-- Include a data source name (jndiConfigName) from the set of datasources defined in master-datasources.xml -->
		<Name>jdbc/WSO2CarbonDB</Name>
	</DataSource>
</JDBCPersistenceManager>

      Note to writers: For step 3, add content on the XML files which include references on any of the additional databases and require edits that are relevant to your product similar to the given example.