Environment Catalog Syntax

Database Section

[DATABASE database_name
TYPE database_type_spec
[SUBTYPE database_subtype_spec]
[INDEXPREFIX "filespec"]
[PHYSICAL "filespec"]
[VERSION "version"]
[USERCLASS "DEFAULT" [USER "user"] [PASSWORD "password"]
[OPTIONS "options"]
[AUTOPSEUDOCOLUMNS]
[INDEXMAINTENANCE {DBMS | API}]
table_definitions for this database
index_specs for this database

DATABASE database_name

[environment_name.]database_name

Required. database_name represents a non-ambiguous database.

database_name MUST BEGIN WITH A LETTER, A-Z (case insensitive) and may contain up to 32 characters including letters, numbers and allowed special characters.

If database_name contains any reserved words or allowed special characters, it must be enclosed in single or double quotes.

TYPE database_type_spec

Required string that declares the type of the underlying database. It can be any one of these values:

• ORACLE
• FLATFILE
• TURBOIMAGEXL
• ODBC
• DB2
• UNION
• INFORMIX
• RMS
• ISAM
• CISAM
• DISAM

SUBTYPE database_subtype_spec

Optional. Specifies the subtype of the database. If database type (above) is ODBC, indicate here what the actual underlying database type is. This will allow Omnidex to provide some additional functionality not available in strictly ODBC applications, depending on the database type. It can be any one of these values:

• ORACLE
• INFORMIX
• DB2
• SQLSERVER
• ACCESS

When connecting to a database using the Omnidex ODBC driver, defining the SUBTYPE will enable some additional features specific to the database type.

INDEXPREFIX "filespec"

Optional. The Indexprefix declares the root name location of the Omnidex index files. filespec is a quoted string up to 253 characters in length and may contain any valid filename as well as appropriate path information and password information. The enclosing quotes may be single or double quotes.

DBINSTAL appends 2 characters (0A, 0B, ...) to the end of each index file name, therefore the filespec is limited to 253 characters.

Indexprefix is not used with TurboIMAGE databases, as the database name determines the index prefix and the group and account in the physicals indicates the index location.

PHYSICAL "filespec"

Optional. Physical declares the name and location of the database's root file or system dictionary and is used primarily with relational databases, ODBC, and TurboIMAGE. filespec is a quoted string up to 255 characters in length and may contain any valid filename as well as appropriate path information and password information. The enclosing quotes may be single or double quotes.

It is required with a TurboIMAGE database in client/server environment unless the server job is running in the same group and account.

In ODBC, the PHYSICAL "filespec" is specified by entering an ODBC database file name, where "filespec" is from the ODBC Data Source Administrator. By default, if it is not entered as a part of the "filespec", "DSN=" is prefixed automatically to be used by ODBC. Example:

PHYSICAL"Star_db"

Setting "filespec" to "DSN=name", where name is a value that is specified in the ODBC Data Source Administrator User DSN list or System DSN list. Example:

PHYSICAL"DSN=Star_db"

The function searches for a User DSN, and then if a name is not found, it will search for a System DSN. If there is a User DSN and a System DSN with the same name, the User DSN will take precedence.

Setting "filespec" to a value of "FILEDSN=name", with name taking a value that is specified in the ODBC Data Source Administrator File DSN list. Example:

PHYSICAL"FILEDSN=Star_db"

Version "version"

Required in ORACLE and optional in other databases. This is a quoted string of up to 255 characters that declares the version of the DBMS. It is used primarily with relational databases.

USERCLASS "DEFAULT" [USER "username"] [PASSWORD "password"]

A Required clause for ORACLE and TurboIMAGE (if the TurboIMAGE database is password secured) and optional for INFORMIX. It declares either or both the name and password of a valid database. All connections to the database will connect with this option. username and password can be filespecs where the contents of the file contain the username and password.

OPTIONS "options"

Optional.

AUTOPSEUDOCOLUMNS

INDEXMAINTENANCE {DBMS | API}

Optional. Default is API. Specify how Omnidex indexes will be updated.

API - The indexes will be updated by Omnidex automatically as the database data is updated.

DBMS - The indexes will be updated by some other means, ODXAIM for example, in a separated process.

This setting applies to the entire index installation on this database. It can be over-ridden by explicitly defining the indexmaintenance setting on a table.

top