Spotfire Server and Environment - Quick Start

create-db

Creates the Spotfire database schema.

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.

For instructions on using create-db to create a database for one of the supported database types (Postgres, MSSQL, Oracle) for either on-premises or cloud (Google Cloud, AWS, or Azure) deployments, see Creating a Spotfire database using the command create-db. (This section of the help also provides examples of running this command for different scenarios.)

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, be 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, then the tool prompts for the password. If the --no-prompt flag is given, no prompt for the password is displayed.
--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, then the tool prompts for the password. If the --no-prompt flag is given, no prompt for the password is displayed.
-v value
--variant=value
Optional none Specifies the variant for database user creation.
  • If connecting to MSSQL or Oracle on Amazon RDS, specify rds.
  • For connecting to MSSQL on Azure, specify azure.
  • For connecting to MSSQL on Google, specify google.
Otherwise, omit the option.
-r value
--oracle-rootfolder=value
Optional except for the Oracle database driver none Specifies the Oracle root folder to create the table space.
-t value
--oracle-tablespace-prefix=value
Optional except for 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 does not create a new Spotfire user.
-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.