Setting up with PostgreSQL

The following sections describe how to replace the default H2 databases with PostgreSQL:

Creating the database

The topics given below explains how to create a PostgreSQL database.

Setting up the database and login role

Install PostgreSQL on your computer as follows:
Start the PostgreSQL service using the following command:
Create a database and the login role from a GUI using the PGAdminIII tool.
To connect PGAdminIII to a PostgreSQL database server, locate the server from the object browser, right-click the client, and click Connect. This will show you the databases, tablespaces, and login roles as follows:
To create a database, click Databases in the tree (inside the object browser), and click New Database.
In the New Database dialog box, give a name to the database (for example: gregdb) and click OK.
To create a login role, click Login Roles in the tree (inside the object browser), and click New Login Role. Enter the role name and a password.

These values will be used in the product configurations as described in the following sections. In the sample configuration, gregadmin will be used as both the role name and the password.
Optionally enter other policies, such as the expiration time for the login and the connection limit.
Click OK to finish creating the login role.

Creating a datasource for the database

After creating the database, you create the datasource to point to it in the master-datasources.xml file, located in the <PRODUCT_HOME>/repository/conf/datasources directory.

Replace the url, username, password and driverClassName settings with your custom values and also the other values accordingly in the master-datasources.xml file as shown below.

Edit the default datasource configuration for storing user management and registry data as shown below. The database configurations in registry.xml and user-mgt.xml files refer to this 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:5432/gregdb</url>
                <username>regadmin</username>
                <password>regadmin</password>
                <driverClassName>org.postgresql.Driver</driverClassName>
                <maxActive>80</maxActive>
                <maxWait>60000</maxWait>
                <minIdle>5</minIdle>
                <testOnBorrow>true</testOnBorrow>
                <validationQuery>SELECT 1</validationQuery>
                <validationInterval>30000</validationInterval>
           </configuration>
       </definition>
</datasource>
```
Following are the database configuration options:
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.

Edit the default datasource configuration for storing RSS meta data as shown below. The RSS meta data specific configurations in the rss-config.xml file refers to this datasource.

<datasource>
	<name>MetadataRepo</name>
	<jndiConfig>
		<name>MetadataRepoDS</name>
	</jndiConfig>
	<definition type="RDBMS">
		<configuration>
			<dataSourceClassName>org.postgresql.xa.PGXADataSource</dataSourceClassName>
			<dataSourceProps>                         	 	 	 	
				<property name="serverName">localhost</property>
				<property name="portNumber">5432</property>
				<property name="databaseName">rss_db</property>                     	 	 	 	
				<property name="user">RootUser</property>
				<property name="password">RootPassword</property>
			</dataSourceProps>
		</configuration>
	</definition>
</datasource>

RSS meta data configurations

If you have changed the default database for storing RSS meta data as explained above, the following RSS meta data specific configurations should be updated. See Changing the Default RSS configuration for more details.

Open the rss-config.xml file stored in the <PRODUCT_HOME>/repository/conf/etc/ directory and do the following changes:

<Provider>POSTGRES</Provider>

<Environments>
	<Environment>
		<Name>DEFAULT</Name>
		<RSSInstances>
			<RSSInstance>
				<Name>WSO2RSS1</Name>
				<InstanceType>SYSTEM</InstanceType>
				<DbmsType>POSTGRES</DbmsType>
				<ServerCategory>LOCAL</ServerCategory>
				<DataSourceConfiguration>
					<Definition> 	 	 	
						<Url>jdbc:postgresql://localhost:5432</Url>
						<Username>postgres</Username>
						<Password>postgres</Password>
						<DriverClassName>org.postgresql.Driver</DriverClassName>
					</Definition>
				</DataSourceConfiguration>
			</RSSInstance>
		</RSSInstances>
	</Environment>
</Environments>

Open the persistence.xml file stored in the <PRODUCT_HOME>/repository/conf/etc/ directory and change the properties as shown below.

<property name="openjpa.ConnectionDriverName" value="org.postgresql.xa.PGXADataSource" />
<property name="dialect" value="org.apache.openjpa.jdbc.sql.PostgresDictionary" />

Setting up the drivers

Download the PostgreSQL JDBC4 driver.
Copy the driver to your WSO2 product's <PRODUCT_HOME>/repository/components/lib directory.

Creating database tables

Create the database tables either manually by running the script or automatically by using a startup parameter as follows:

Using the script

You can create database tables manually by logging into the created database and executing the following script:

Use the scripts given in the following locations to change the respective database and then restart the server.
- To create tables for the registry and user manager database, use the below script:
```
<PRODUCT_HOME>/dbscripts/postgresql.sql
```
- To create tables for the RSS meta data repository database, use the below script:
```
<PRODUCT_HOME>/dbscripts/rss-manager/postgresql/wso2_rss_postgresql.sql
```

Using a startup parameter

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

For Linux:
```
wso2server.sh -Dsetup
```

For Windows:
```
wso2server.bat -Dsetup
```