Environment Catalog Syntax

Table Section

TABLE table_name
[TYPE table_type_spec]
[PHYSICAL "filespec"]
[PARTITION BY "partition_spec"]
[TIDMAP n,n,n,n,n,n [,n,n [,n,n,n,n]]]
[OPTIONS "options"]
[CARDINALITY n]
[INDEXMAINTENANCE {DBMS | API}]
[{PARENT / PRIMARY} [{KEY / CONSTRAINT}] column_spec
[{CHILD / FOREIGN} [{KEY / CONSTRAINT}] column_spec
REFERENCES table[(column_spec)]]
[AS "as_spec"]
COLUMNS [FROM] "table" | column definitions for this table

TABLE table_name

[[environment_name.]database_name.]table_name

table_name represents a non-ambiguous table or view name.

table_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 table_name contains any reserved words or allowed special characters, it must be enclosed in single or double quotes.

TYPE table_type_spec

TYPE is set according to the DATABASE TYPE declared.

One of the following:

• [{CACHED | DYNAMIC}] VIEW
• DETAIL (TURBOIMAGE XL only)
• [{MANUAL | AUTO}] MASTER (TURBOIMAGE XL only)
• OST(Flat Files)
• TDF(Flat Files)
• RELATIONAL (SQL-Class databases only)
• RELATIVE (RMS only)
• SEQUENTIAL (RMS only)
• STREAM (RMS only)

PHYSICAL "filespec"

Optional. 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.

TIDMAP n,n,n,n,n,n

Optional. This is a numeric list of six segments separated by commas that define how Omnidex internal record numbers are derived from native database row IDs. TIDMAPs are used with ORACLE and RMS files.

OPTIONS "options"

Options apply to TDF (tab-delimited file) tables only. Multiple options are space separated. The entire option string is enclosed in quotes. Valid options are:

COLUMN='string' - Defines the column delimiter.

RECORD='string' - Defines the record delimiter.

options "column='\t' record='\r\n'"

CARDINALITY n

The cardinality of a table is the number of records in the table. This number should be within 1% of actual table cardinality. Omnidex uses this number to better optimize some queries.

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 overrides the indexmaintenance definition in the database section.

[{PARENT / PRIMARY} [{KEY / CONSTRAINT}] column_spec]
[{CHILD / FOREIGN} [{KEY / CONSTRAINT}] column_spec]

Optional. The column_spec is the column name or a column specification qualified by a table name. keytype declares any of the following values:

PARENT or PRIMARY
CHILD or FOREIGN

Foreign keys use a REFERENCES clause to relate the child to a parent table by a previously declared primary constraint. Example:

FOREIGN CUSTOMER_NO REFERENCES
CUSTOMERS(CUSTOMER_NO)

- or -

CHILD KEY CUSTOMER_NO REFERENCES
CUSTOMERS(CUSTOMER_NO)

Primary keys and foreign keys cannot be declared for the same table.
Multiple column constraints are not supported.
Omnidex does not enforce constraints. Constraint enforcement is left up to the DBMS. Therefore, constraints on flat file databases are unenforced.

AS "as_spec"

AS defines a table as a unioned view. Data from other physical tables in the database is unioned together using SQL select statements. The other physical tables must also be defined in the environment file.

The column definitions for the view must match the original physical tables exactly. Therefore, the COLUMNS FROM "table" column definition should be used, as opposed to explicitly defining each column in the view.

top