Spotfire® Server and Environment - Installation and Administration

create-actionlogdb

Creates the Spotfire action log database schema.

create-actionlogdb 
<-c value | --driver-class=value> 
<--database-url=value> 
[--admin-username=value] 
[--admin-password=value] 
[--actiondb-dbname=value] 
[--actiondb-username=value] 
[--actiondb-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 Action log database schema.

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.
--actiondb-dbname=value
Optional only for the Oracle database driver none Specifies the name of the Spotfire database.
--actiondb-username=value
Optional none Specifies the user name for the Spotfire action log database.
--actiondb-password=value
Optional none Specifies the password for the Spotfire action log 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.

Examples

Create Action Log database schema with the PostgreSQL JDBC driver
create-actionlogdb --driver-class="org.postgresql.Driver" --database-url="jdbc:postgresql://{{database-host}}:{{database-port}}/{{database-name}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --actiondb-dbname="{{actionlog-database}}" --actiondb-username="{{actiondb-user}}" --actiondb-password="{{actiondb-password}}"
Create Action Log database schema with the Microsoft JDBC driver
create-actionlogdb --driver-class="com.microsoft.sqlserver.jdbc.SQLServerDriver" --database-url="jdbc:sqlserver://{{database-host}}:{{database-port}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --actiondb-dbname="{{actionlog-database}}" --actiondb-username="{{actiondb-user}}" --actiondb-password="{{actiondb-password}}"
Create Action Log database schema with the Oracle thin JDBC driver
create-actionlogdb --driver-class="oracle.jdbc.OracleDriver" --database-url="jdbc:oracle:thin:@//{{database-host}}:{{database-port}}/{{service}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --actiondb-username="{{actiondb-user}}" --actiondb-password="{{actiondb-password}}" --oracle-rootfolder="{{oracle-rootfolder}}" --oracle-tablespace-prefix="{{tablespace-prefix}}"
Create Spotfire database schema with Azure
PostgreSQL:
create-actionlogdb --driver-class="org.postgresql.Driver" --database-url="jdbc:postgresql://{{database-host}}:{{database-port}}/{{database-name}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --actiondb-dbname="{{actionlog-database}}" --do-not-create-user
MSSQL:
create-actionlogdb --driver-class="com.microsoft.sqlserver.jdbc.SQLServerDriver" --database-url="jdbc:sqlserver://{{database-host}}:{{database-port}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --actiondb-dbname="{{actionlog-database}}" --actiondb-username="{{actiondb-user}}" --actiondb-password="{{actiondb-password}}" --variant="azure"
Create Action Log database schema with AWS
PostgresSQL:
create-actionlogdb --driver-class="org.postgresql.Driver" --database-url="jdbc:postgresql://{{database-host}}:{{database-port}}/{{database-name}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --actiondb-dbname="{{actionlog-database}}" --do-not-create-user
Aurora with PostgreSQL:
create-actionlogdb --driver-class="org.postgresql.Driver" --database-url="jdbc:postgresql://{{database-host}}:{{database-port}}/{{database-name}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --actiondb-dbname="{{actionlog-database}}" --do-not-create-user
MSSQL:
create-actionlogdb --driver-class="com.microsoft.sqlserver.jdbc.SQLServerDriver" --database-url="jdbc:sqlserver://{{database-host}}:{{database-port}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --actiondb-dbname="{{actionlog-database}}" --actiondb-username="{{actiondb-user}}" --actiondb-password="{{actiondb-password}}" --variant="rds"
Oracle:
create-actionlogdb --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}}" --actiondb-username="{{actiondb-user}}" --actiondb-password="{{actiondb-password}}" --variant="rds"
Create Action Log database schema with Google Cloud
PostgresSQL:
create-actionlogdb --driver-class="org.postgresql.Driver" --database-url="jdbc:postgresql://{{database-host}}:{{database-port}}/{{database-name}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --actiondb-dbname="{{actionlog-database}}" --do-not-create-user
MSSQL:
create-actionlogdb --driver-class="com.microsoft.sqlserver.jdbc.SQLServerDriver" --database-url="jdbc:sqlserver://{{database-host}}:{{database-port}}" --admin-username="{{admin-user}}" --admin-password="{{admin-password}}" --actiondb-dbname="{{actionlog-database}}" --actiondb-username="{{actiondb-user}}" --actiondb-password="{{actiondb-password}}" --variant="google"