Spotfire database setup
The Spotfire database is an important part of the Spotfire environment. Depending on which method you use for your installations, you configure the database before or after installing the server.
The Spotfire environment supports a number of different database systems. See system requirements for the list of supported databases.
You can set up the Spotfire database in different ways:
- If you plan to prepare the Spotfire database using the command-line command create-db, then you must install Spotfire Server first to get access to the command-line configuration commands. This option is usually preferred when installation and upgrades are done using an automated process or when running the Spotfire Server in a containerized environment.
- If you plan to prepare the Spotfire database using the scripts included in the installation package, then you often do this before running the server installer. This option can be used when the person installing the Spotfire Server is not the same person as the database administrator. See the subsection for your specific database for details.
- To create and configure the Spotfire databases in a containerized environment, use the Cloud Deployment Kit for Spotfire on GitHub or the prebuilt container images. See create-db for details and examples on how to use the command with the different database types.
- You can also use the configuration tool to create the database schemas as a part of your installation or upgrade process.
Note: When configuring the databases for various managed databases in cloud
services (GCP Postgres, AWS Postgres RDS, and so on) using Helm charts,
additional parameters and configuration is required.
This is an overview of the various supported systems and the parameters needed for configuration:
PostgreSQL
The driver class is always
org.postgresql.Driver for PostgreSQL databases.
| Database | Url used by create-db | Url for bootstrapping | Additional parameters |
|---|---|---|---|
| PostgreSQL | jdbc:postgresql://databasehost:databaseport/ | jdbc:postgresql://databasehost:databaseport/databasename | |
| Amazon RDS for PostgreSQL | jdbc:postgresql://databasehost:databaseport/databasename | jdbc:postgresql://databasehost:databaseport/databasename | doNotCreateUser = true |
| Amazon Aurora with PostgreSQL compatibility | jdbc:postgresql://databasehost:databaseport/databasename | jdbc:postgresql://databasehost:databaseport/databasename | doNotCreateUser = true |
| Azure Database for PostgreSQL | jdbc:postgresql://databasehost:databaseport/databasename | jdbc:postgresql://databasehost:databaseport/databasename | doNotCreateUser = true |
| Google Cloud PostgreSQL | jdbc:postgresql://databasehost:databaseport/ | jdbc:postgresql://databasehost:databaseport/databasename | doNotCreateUser = true |
Microsoft SQL Server
The driver class is always
com.microsoft.sqlserver.jdbc.SQLServerDriver for
Microsoft SQL Server databases.
| Database | Url used by create-db | Url for bootstrapping | Additional parameters |
|---|---|---|---|
| Microsoft SQL Server | jdbc:sqlserver://databasehost:databaseport | jdbc:sqlserver://databasehost:databaseport;DatabaseName=databasename | |
| Amazon RDS for Microsoft SQL Server | jdbc:sqlserver://databasehost:databaseport | jdbc:sqlserver://databasehost:databaseport;DatabaseName=databaseName | variant = rds |
| Azure SQL Database | jdbc:sqlserver://databasehost:databaseport | jdbc:sqlserver://databasehost:databaseport;DatabaseName=databaseName | variant = azure |
| Google Cloud SQL for Microsoft SQL Server | jdbc:sqlserver://databasehost:databaseport | jdbc:sqlserver://databasehost:databaseport;DatabaseName=databaseName | variant = google |
Oracle
The driver class is always
oracle.jdbc.OracleDriver for Oracle databases.
| Database | Url used by create-db | Url for bootstrapping | Additional parameters |
|---|---|---|---|
| Oracle | jdbc:oracle:thin:@//databasehost:databaseport/service | jdbc:oracle:thin:@//databasehost:databaseport/service | oracleRootfolder, oracleTablespacePrefix |
| Amazon RDS for Oracle | jdbc:oracle:thin:@databasehost:databaseport/ORCL | jdbc:oracle:thin:@databasehost:databaseport/ORCL | variant = rds |