The following sections describe how to replace the default H2 database with MariaDB, which is a drop-in replacement for MySQL.
Table of Contents | ||||||||
---|---|---|---|---|---|---|---|---|
|
Tip | ||
---|---|---|
| ||
You need to set up MariaDB before following the steps to configure your product with it. For more information, see Setting up MariaDB. |
Anchor | ||||
---|---|---|---|---|
|
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.
Anchor | ||||
---|---|---|---|---|
|
Follow the steps below to change the type of the default WSO2_CARBON_DB
datasourcedatasource.
Edit the default datasourceconfigurationin the <
PRODUCT_HOME>/repository/conf/datasources/m
aster-datasources.xml
file as shown below.Note Do not change the
WSO2_CARBON_DB
datasource name in the below configuration.Code Block language html/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:
Note: The<defaultAutoCommit>
property in this configuration is ignored in some WSO2 products, such as WSO2 Identity Server and WSO2 Data Analytics Server, because this functionality is configured at the code level as required for that productElement Description url The URL of the database. The default port for MariaDB is 3306 username and password The name and password of the database user driverClassName The class name of the database driver maxActive The 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. 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. defaultAutoCommit You can set this property to
false
if you want to disable auto committing for your datasource. Disabling this property will allow multiple SQL statements to be committed to the database as one transaction, as opposed to committing each SQL statement as individual transactions. If this property is not used in the configuration, the database type will determine if this functionality is enabled or disabled. Typically, auto committing is enabled by default for an RDBMS.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 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.
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.Multiexcerpt include MultiExcerptName WUM14Sep PageWithExcerpt Changing to Embedded Derby
Anchor | ||||
---|---|---|---|---|
|
Follow the steps below to configure new datasources to point to the new the new databases you create to manage registry and/or user management data separately.
- 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. If you are setting up a separate database to store registry-related data, update the following configurations in the < <
PRODUCT_HOME>/repository/conf/
Code Block language xml <dbConfig name="wso2registry"> <dataSource>jdbc/MY_DATASOURCE_NAME</dataSource> </dbConfig>
If you are setting up a separate database to store user management data, update the following configurations in the < the <
PRODUCT_HOME>/repository/conf/
user-mgt.xml
file.Code Block language xml <Configuration> <Property name="dataSource">jdbc/MY_DATASOURCE_NAME</Property> </Configuration>
...
To create tables in the registry and user manager database (
WSO2CARBON_DB
), use the below script:Info You may have to enter the password for each command when prompted.
Code Block language powershell mysql -u regadmin -p -Dregdb < '<PRODUCT_HOME>/dbscripts/mysql.sql';
Restart the server.
Info 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
Multiexcerpt-include MultiExcerptName Dsetup-dep PageWithExcerpt Changing to Embedded Derby
Excerpt | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
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 databasesThe topics above show how to change the
|