[Other doc versions]
[Doc downloads (PDF, HTML, XML)]
This page describes how to connect Stash to a PostgreSQL database.
The overall process for using a PostgreSQL database with Stash is:
It is assumed here that you already have PostgreSQL installed and running. For more information about PostgreSQL installation and operation, refer to the PostgreSQL documentation.
PostgreSQL has the idea of schemas. When you create a PostgreSQL database, a 'public' schema is created and set as the default for that database. It is possible to create a different schema (e.g. 'stash') and set that as the default schema. Stash will use whatever schema is set as the default for the logged-in user. Stash does not provide a way for a user to nominate the schema to use; it uses schema that is set as the PostgreSQL default.
See Supported platforms for the versions of PostgreSQL supported by Stash.
If you are migrating your Stash data from the HSQL internal database, back up the Stash home directory.
If you are migrating your Stash data from another external database, back up that database by following the instructions provided by the database vendor before proceeding with these instructions.
Before you can use Stash with PostgreSQL, you must:
Here is an example of how to create a user called
stashuser with password
jellyfish, and a database called
stash, which is configured for use by
stashuser. Using a PostgreSQL client application like psql or pgAdmin, run the following commands, replacing the user name, password, and database name with your own values.
If the server that is hosting the PostgreSQL database is not the same server as Stash, then please ensure that the Stash server can connect to the database server. Please also refer to the PostgreSQL documentation on how to set up pg_hba.conf. If the
pg_hba.conf file is not set properly, remote communication to the PostgreSQL server will fail.
You can now connect Stash to the PostgreSQL database, either:
The host name or IP address of the computer running the database server.
|Port||The TCP port with which Stash can connect to the database server. The default value is the default port that PostgreSQL runs against. You can change that if you know the port that your PostgreSQL instance is using.|
|Database name||The name of the database that Stash should connect to.|
|Database username||The username that Stash should use to access the database.|
|Database password||The password that Stash should use to access the database.|
This section is only relevant to some distributions of Stash, for example if you are running Stash via the Atlassian Plugin SDK, or have built Stash from source.
If the PostgreSQL JDBC driver is not bundled with Stash, you will need to download and install the driver yourself.