create-db

create-db 
<-c value | --driver-class=value> 
<--database-url=value> 
[--admin-username=value] 
[--admin-password=value] 
[--spotfiredb-dbname=value] 
[--spotfiredb-username=value] 
[--spotfiredb-password=value] 
[-v value | --variant=value] 
[-r value | --oracle-rootfolder=value] 
[-t value | --oracle-tablespace-prefix=value] 
[-a | --do-not-create-user] 
[-n | --no-prompt] 
[--timeout-seconds=value]

Overview

Use this command to create a Spotfire database schema and populate default data in the appropriate tables.

Options


Option	Optional or Required	Default Value	Description
`-c value --driver-class=value`	Required	none	Specifies the name of the JDBC driver class.
`--database-url=value`	Required	none	Specifies the JDBC URL to the database. Because this argument usually contains special characters, make sure to escape those characters, or to enclose the values between quotes.
`--admin-username=value`	Optional	none	Specifies the user name of the database administrator.
`--admin-password=value`	Optional	none	Specifies the password of the database administrator. If no admin password is given, the tool prompts for the password (unless the `--no-prompt flag` is given).
`--spotfiredb-dbname=value`	Optional only for the Oracle database driver; otherwise required	none	Specifies the name of the Spotfire database.
`--spotfiredb-username=value`	Optional	none	Specifies the user name for the Spotfire database.
`--spotfiredb-password=value`	Optional	none	Specifies the password for the Spotfire database. If no Spotfire database password is given, the tool prompts for the password (unless the `--no-prompt flag` is given).
`-v value --variant=value`	Optional	none	Specifies the variant for database user creation. If connecting to MSSQL or Oracle on Amazon RDS, specify '`rds`'. If connecting to MSSQL on Azure, specify '`azure`'. If connecting to MSSQL on Google, specify '`google`'. Otherwise, omit the option.
`-r value --oracle-rootfolder=value`	Optional except for when using the Oracle database driver	none	Specifies the Oracle root folder to create the table space.
`-t value --oracle-tablespace-prefix=value`	Optional except for when using the Oracle database driver	`SPOTFIRE`	Specifies the prefix of the table space name for Oracle. It appends '`_DATA`' and '`_TEMP`' during tablespaces creation. Make sure that it is unique in the database.
`-a --do-not-create-user`	Optional	none	Specifies that the tool will not create a new Spotfire user. Note: Spotfire databases for PostgreSQL created on the cloud must always use `–do-not-create-user=true`. See the examples below.
`-n --no-prompt`	Optional	none	Specifies that the tool does not prompt for missing password arguments.
`--timeout-seconds=value`	Optional	`0`	Specifies the timeout, in seconds, for the operation.

Note: For each option shown in the examples below, replace the placeholder variable with your own value.

Examples of creating a Spotfire database schema on PostgreSQL

Using the PostgreSQL JDBC driver (on-premises)

create-db --driver-class="org.postgresql.Driver" --database-url="jdbc:postgresql://{{database-host}}:{{database-port}}/{{database-name}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --spotfiredb-dbname="{{spotfire-database}}" --spotfiredb-username="{{spotfiredb-user}}" --spotfiredb-password="{{spotfiredb-password}}"

PostgreSQL on Azure

create-db --driver-class="org.postgresql.Driver" --database-url="jdbc:postgresql://{{database-host}}:{{database-port}}/{{database-name}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --spotfiredb-dbname="{{spotfire-database}}" --do-not-create-user

PostgreSQL on AWS or Aurora on AWS

create-db --driver-class="org.postgresql.Driver" --database-url="jdbc:postgresql://{{database-host}}:{{database-port}}/{{database-name}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --spotfiredb-dbname="{{spotfire-database}}" --do-not-create-user

PostgreSQL on Google Cloud

create-db --driver-class="org.postgresql.Driver" --database-url="jdbc:postgresql://{{database-host}}:{{database-port}}/{{database-name}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --spotfiredb-dbname="{{spotfire-database}}" --do-not-create-user

Examples of creating a Spotfire database schema on Microsoft SQL Server

Using the Microsoft JDBC driver (on-premises)

create-db --driver-class="com.microsoft.sqlserver.jdbc.SQLServerDriver" --database-url="jdbc:sqlserver://{{database-host}}:{{database-port}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --spotfiredb-dbname="{{spotfire-database}}" --spotfiredb-username="{{spotfiredb-user}}" --spotfiredb-password="{{spotfiredb-password}}"

MSSQL on Azure

create-db --driver-class="com.microsoft.sqlserver.jdbc.SQLServerDriver" --database-url="jdbc:sqlserver://{{database-host}}:{{database-port}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --spotfiredb-dbname="{{spotfire-database}}" --spotfiredb-username="{{spotfiredb-user}}" --spotfiredb-password="{{spotfiredb-password}}" --variant="azure"

MSSQL on AWS

create-db --driver-class="com.microsoft.sqlserver.jdbc.SQLServerDriver" --database-url="jdbc:sqlserver://{{database-host}}:{{database-port}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --spotfiredb-dbname="{{spotfire-database}}" --spotfiredb-username="{{spotfiredb-user}}" --spotfiredb-password="{{spotfiredb-password}}" --variant="rds"

MSSQL on Google Cloud

create-db --driver-class="com.microsoft.sqlserver.jdbc.SQLServerDriver" --database-url="jdbc:sqlserver://{{database-host}}:{{database-port}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --spotfiredb-dbname="{{spotfire-database}}" --spotfiredb-username="{{spotfiredb-user}}" --spotfiredb-password="{{spotfiredb-password}}" --variant="google"

Examples of creating a Spotfire database schema on Oracle

Using the Oracle thin JDBC driver (on-premises)

create-db --driver-class="oracle.jdbc.OracleDriver" --database-url="jdbc:oracle:thin:@//{{database-host}}:{{database-port}}/{{service}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --spotfiredb-username="{{spotfiredb-user}}" --spotfiredb-password="{{spotfiredb-password}}" --oracle-rootfolder="{{oracle-rootfolder}}" --oracle-tablespace-prefix="{{tablespace-prefix}}"

Oracle on AWS

create-db --driver-class="oracle.jdbc.OracleDriver" --database-url="jdbc:oracle:thin:@{{database-host}}:{{database-port}}:ORCL" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --oracle-tablespace-prefix="{{oracle-tablespace-prefix}}" --spotfiredb-username="{{spotfiredb-user}}" --spotfiredb-password="{{spotfiredb-password}}" --variant="rds"