nevisidmdb Usage and Parameters
The nevisidmdb package can be used for creating and managing the DB instances.
usage (nevisidmdb):
INSTANCE ADMINISTRATION
nevisidmdb # Get this usage
nevisidmdb inst # List all instances
nevisidmdb inst create <name> [1] # Create an instance
nevisidmdb inst remove <name> # Remove an instance
nevisidmdb inst exists <name> # Check for existing instance
nevisidmdb handover # Create default config/log
area,start server
nevisidmdb pkg # Show installed package versions
nevisidmdb pkg activate <version> # Activate specified version of
package
DB ADMINISTRATION
nevisidmdb [instance] status
Show the current DB patch level
nevisidmdb [instance] config
Edit environment configuration
nevisidmdb [instance] patch <currentVersion> <newVersion> <dbOwnerName> <dbOwnerPass> <dbUserName> <dbUserPass>
Patches the MySQL or Oracle DB from nevisIDM <currentVersion> to <newVersion>. Both version parameters are neither
directly validated against the existing schema, nor against the deployed application EARs.
The <dbUserName> and <dbUserPass> have to be set only for Oracle.
ORACLE DB ADMINISTRATION
nevisidmdb [instance] dropdb # Destroy db
nevisidmdb [instance] createusers # Create users
nevisidmdb [instance] createobjs # Create objects
nevisidmdb [instance] createjmsuser # Create schema and user for JMS
persistence
nevisidmdb [instance] dropjmsuser # Drop schema and user for JMS
persistence
nevisidmdb [instance] loadpwddictionary # Load full-size password dictionary reference table (time-consuming!)
nevisidmdb [instance] sqlplus [user|owner|system] # Open SQL as schema user, owner or system
nevisidmdb [instance] sqlenv # Show sql environment variables
[1] Optional: Specify 'help', 'try', 'force', a setup.properties file or a list of PARAM=value 'nevisidmdb inst create help' displays the possible setup parameters.
MYSQL DB ADMINISTRATION
nevisidmdb [instance] mysql check [<dbRootPass>]
Performs configuration checks. The MySQL root's password is required for this operation.
nevisidmdb [instance] mysql setup [<dbRootPass>]
Sets up nevisIDM DB schema and loads required reference data. The MySQL root's password is required for this operation.
nevisidmdb [instance] mysql destroy [<dbRootPass>]
Destroys MySQL database. The MySQL root's password is required for this operation.
nevisidmdb [instance] mysql connect [<dbRootPass>]
Connects to MySQL DB as root user. With this command, only the connection with the MySQL root user is supported. Use the 'mysql' command itself to connect with other users.
nevisidmdb [instance] mysql createjmsuser [<dbRootPass>]
Sets up JMS persistence DB schema and users and grants required permissions. The MySQL root's password is required for this operation
nevisidmdb [instance] mysql dropjmsuser [<dbRootPass>]
Drops the JMS persistence DB schema and user. The MySQL root's password is required for this operation
nevisidmdb [instance] mysql remote_enable <dbOwnerPass>
Add permission to the DB_USER user to access MySQL DB remotely.
nevisidmdb [instance] mysql remote_disable <dbOwnerPass>
Remove permission from the DB_USER user not to access MySQL DB remotely.
JMS PERSISTENCE ADMINISTRATION
nevisidmdb [instance] jms configure <nevisidm instance>
Configures the JMS persistence datasource.
Environment configuration file
The environment configuration file env.conf in the config folder contains all environment variable definitions, e.g., JAVA HOME. The configuration file can also be accessed via command-line, by entering the following command: nevisidmdb [instance] config. The following table describes all variables:
ENV Variable | Description |
---|---|
VERSION | The package version to use. If not set, the most recent version is used. |
RTOWNER, RTGROUP | The owner and the group of the instance. |
ORACLE_HOME | The path to the folder where the Oracle client is installed. |
ORACLE_SID | The Oracle System ID (SID). The SID is used to uniquely identify a particular database on a system. |
ORACLE_BIN | The path to the Oracle Client binary files. If not set, the path is derived from the variable ORACLE_HOME. |
ORACLE_LD_LIBRARY_PATH | The path to the library of the Oracle client. If not set, the path is derived from the variable ORACLE_HOME. |
ORACLE_LD_LIBRARY_PATH64 | The path to the 64bit library of the Oracle client. If not set, the path is derived from the variable ORACLE_HOME. |
DBHOST, DBPORT | The host and the port of the database server (Oracle). |
DBOWNER_NAME,DBOWNER_PASSWORD | The name and the password of the database owner (Oracle). |
DBUSER_NAME,DBUSER_PASSWORD | The name and the password of the database user (Oracle). |
ROLE_ADM,ROLE_APPL | The role of the database administrator and the role of the application user (Oracle). |
DBTS_INDEX, DBTS_DATA | The tablespace name for the index and the data of nevisIDM (Oracle). |
DBSYSTEM_NAME | The name of the system user of the Oracle database. |
DBSYSTEM_PASSWORD | The database system password. If it is not set, it must be entered interactively to create users and to drop the database. |
TNS_NAME | The TNS_NAME that will be used by the nevisidmdb script. It is possible to use a custom alias for the database connection. If you do so, the nevisidmdb script uses the alias to connect to the database. The default value is "$ORACLE_SID.$DBHOST". |
TNS_ADMIN | The path to the Transparent Network Substrate (TNS) administration directory. TNS is Oracle's networking architecture. If this variable is not set, the path is derived from the variable ORACLE_HOME. |
ORA_NLS,ORA_NLS33 | Oracle specific environment variables that define where the NLS data is stored. NLS stands for National Language Support. |
DB_TYPE | Defines which type of database is used. Supported are "mysql" and "oracle". The default is "oracle". |
DBHOST_MYSQL, DBPORT_MYSQL | The host and the port of the database server (MySQL). |
DBSYSTEM_NAME_MYSQL | The name of the database root user (MySQL). |
DBOWNER_NAME_MYSQL, DBOWNER_PASSWORD_MYSQL | The name and the password of the database owner (MySQL). |
DBUSER_NAME_MYSQL,DBUSER_PASSWORD_MYSQL | The name and the password of the database user (MySQL). |
IDMDB_JMSUSER, IDMDB_JMSPASSWORD | The user and password for the JMS database. |
ROLE_JMS | The database role of the JMS user. |
IDMDB_JMSCONNECTION | The URL to the JMS database. |
IDMDB_JMSTS | The tablespace for JMS-related tables. |
IDMDB_JMSTS_DATA | The tablespace name of the JMS queue data. |
LD_LIBRARY_PATH | (Oracle) When you use Oracle 12.x, you might be required to configure a custom LD_LIBRARY_PATH so that sqlplus properly works. A recommended setting (for Oracle 12.2) is: LD_LIBRARY_PATH=/usr/lib/oracle/12.2/client64/lib |