Main Parameters
{-a|--action} action - action to perform. You can specify the values below.
Value | Action |
catalog | Displays existing database components. |
create | Creates db_component or the database components for product . |
drop | Drops db_component or the database components for product . |
recreate | Drops db_component or the database components for product , then creates db_component or the database components for product . |
checkEncoding | Checks whether your RDBMS is Unicode-enabled and displays the answer. |
{-d|--dbms} {oracle|sqlserver| db2luw} - RDBMS on which to perform action . You can specify the values below.
Value | RDBMS |
oracle | Oracle |
sqlserver | SQL Server |
db2luw | DB2 for LUW |
{-c|--component}db_component {-v|--version}version - database component version for which to perform action . For db_component , you can specify one or more database component codes or names. You can see the list of database component codes and names by specifying -c all with the print action. If you want to specify multiple codes or names, use commas as separators. For version , you can specify the value latest. If you specified one database component for db_component , perform action for the latest version of db_component . If you specified multiple database components or ALL for db_component , you must specify latest for db_component_version . The configurator will create the latest version of each database component.
{-pr|--product}product {-v|--version}release - product release associated with the database components for which to perform action . For product , you can specify one or more product codes or names, or ALL. You can see the list of database components for a product by specifying this parameter with the print action. If you want to specify multiple codes or names, use commas as separators. For release , you can specify the values below.
Value | Description |
latest | Perform action on the database components for the latest release of product or products . |
release | Release of product or products for whose database components to perform action . The configurator will create the correct versions of the database components for the specified release. |
{-l|--url} RDBMS_URL - URL for the RDBMS. For information about options supported by the DataDirect Connect JDBC 5.1 driver used by your products, see DataDirect Connect for JDBC User's Guide and Reference 5.1, available on the Software AG Documentation website. When working with database components on UNIX systems, you must enclose the URL in double quotes. You can specify the values below.
RDBMS | Sample Format for DataDirect Connect Driver |
Oracle | jdbc:wm:oracle://server: {1521|port} ;serviceName=service [;option=value]. ..
Important: | For Oracle, if you are going to create storage and the Data Purge database component, you must specify the sysLoginRole connection option on the URL (for example, ;sysLoginRole=sysdba). |
|
SQL Server | jdbc:wm:sqlserver://server: {1433|port} ;databaseName=database [;option=value]...
|
DB2 for Linux, UNIX, Windows | jdbc:wm:db2://server: {50000|port} ;databaseName=database [;option=value]...
For DB2, if you are going to create database components in a schema other than the default schema for the specified database user, you must specify these connection options in the URL: ;AlternateId=schema;"InitializationString=(SET CURRENT PATH=current_path,schema)" AlternateID is the name of the default schema used to qualify unqualified database objects in dynamically prepared SQL statements. If you are creating Optimize database components (that is, Analysis and ProcessTracker), you must specify schema using all uppercase letters. In addition, you must specify the options CreateDefaultPackage=true, ReplacePackage=true, and DynamicSections=3000. These settings will affect all database components in the same schema or database. |
{-u|--user} db_user {-p|--password}password - depends on the action you are performing.
Note: | You can choose to specify this authentication information in the URL, using DataDirect options, rather than in these parameters. |
If you are... | Specify... |
Creating a database user and storage in Oracle or SQL Server | Database user and password to create. Note: | For SQL Server, the user will be created and a default schema named dbo will be assigned to that user. |
Important: | For Oracle, do not use the SYSTEM user to create the database components in the SYSTEM schema. |
|
Creating a database user and storage in DB2 for LUW | OS user to which to grant permissions. |
Performing the checkEncoding action | Existing database user that has create session and create table privileges, and that database user's password. |
Performing any other action | Existing database user and password. |
[{-au|--admin_user}db_admin_user {-ap|--admin_password}password] - if you are going to create a database user and storage, or drop storage and revoke the database user permissions, database user or operating system user and password that has the necessary database administrator credentials.