Differences

This shows you the differences between two versions of the page.

--- oaenv:home [2009/12/07 18:19]
tdo
+++ oaenv:home [2012/10/26 14:24]
@@ Line 1: / Line 1: @@
-{{page>:top_add&nofooter&noeditbtn}}
-<html><div align="center"><span style="color:red">DRAFT</span></div></html>
-====== OMNIDEX Environment Catalog Syntax ======
-The Omnidex Environment Catalog is the starting point for constructing an Omnidex application. It is the primary source of information used by Omnidex to access a database and the Omnidex indexes.
-An Environment Catalog is a collection of information, objects that include descriptions of databases, tables, columns and indexes, as well as Omnidex specific information like optimization options and configuration details. Omnidex uses this information to determine how to access the databases. It can also store supplemental information about the databases, that can enhance Omnidex's ability to optimize queries.
-The Environment Catalog is both a superset and subset of information about the database. It is a superset of database information because a single Environment Catalog can contain information about multiple databases, including databases from different database management systems. However, it contains only a subset of the information tracked in the database management system about each of those databases, limited to the few details required by Omnidex.
-Omnidex is aware only of the objects defined in the Environment Catalog. Any databases, tables, columns, etc... not defined in the Environment Catalog do not exist, as far as Omnidex is concerned, providing a fundamental level of security.
-In the case of flat-file databases, the Environment Catalog plays a special role. Since plain flat-files rarely have meta-data stored in them, Omnidex acts as the database management system, using the Environment Catalog to describe the tables and columns and their relationships to each other, there by allowing standard SQL, ODBC and JDBC access to the data.
-===== Create an Environment Catalog =====
-An Omnidex Environment begins as an environment source file, a text file containing all the environment definitions, then is compiled into a binary file, the Environment Catalog used by Omnidex.
-The best way to create an environment source file is to use the Omnidex utility OAHELPER. OAHELPER, can automatically generate an environment source file for most RDBMSs including Oracle, Informix, DB2 and SQL Server. Alternatively, you can create an environment source file by hand using any text editor.
-If you have an existing Omnidex Environment Catalog, you can use the Omnidex utility OADECOMP, to decompile the binary file into an editable source file.
-When the environment source file is complete, you must use the Omnidex utility OACOMP to compile the environment source file into a binary file, the Environment Catalog.
-An environment file is divided into several statements beginning with the ENVIRONMENT statement. The general environment layout is as follows:
-The ENVIRONMENT declaration contains overall configuration settings and is followed by one or more DATABASE statements.
-Each DATABASE declaration describes the basic database characteristics and access instructions, followed by a series of TABLE statements.
-Each TABLE declaration describes the table including its physical location, key constraints and a series of COLUMN statements.
-Each COLUMN declaration describes the database column, including data type and length.
-INDEX statements describing the native indexes in the database, follow the TABLE declarations.
-This sequence is then repeated, in this order, for each database being described in this environment.
-The following is a simple example Environment source file with a single database and a single table:
-<code>
-Environment start_env
-Database start
-Type flatfile
-table sales_facts
-column odx_seq_ID datatype INTEGER
-column acct datatype CHAR(10)
-column amount datatype INTEGER
-</code>
-===== Syntax =====
-Statements in an environment catalog must follow a certain hierarchy. For example, COLUMN definition statements must follow the TABLE definition statement that defines the table to which the columns belong.
-See the individual statement topics for specific details.
-Syntax Convention
-[ ] Optional syntax
-{ } Required, choose one from the set.
-option1 | option2 - Choose option1 or option2
-option1 / option2 - option1 and option2 have the same meaning, both work.
-===== ENVIRONMENT =====
-  ENVIRONMENT environment_name
-     [VERSION "string"]
-     [TITLE "string"]
-     [SET
-         [WILDCARDS any_char, single_char, single_digit]
-         [OMNIDEX SENTINEL character]
-         [OPTIMIZATION "options"]
-         [ESCAPE character]
-         [SQL_SYNTAX {OMNIDEX | OMNIDEX_PLUS}]
-         [CENTURY_THRESHOLD n]
-      ]>
-==== VERSION "string" ====
-Optional. This is a string of up to 32 characters that defines a version number for the Environment file. VERSION is used for informational purposes only. It in no way affects the application or how Omnidex behaves against the environment.
-==== TITLE "string" ====
-Optional. This is a string of up to 80 characters that describes the Environment file. TITLE is used for informational purposes only. It in no way affects the application or how Omnidex behaves against the environment.
-==== SET ====
-Optional. The keyword SET is a section identifier for the SET section of the ENVIRONMENT definition. The following Environment settings are established through SET:
-== WILDCARDS ==
-Must contain three different wildcard characters, separated by commas, from the following set: *!#%@^~{}'|?[]\/
-Defaults
-* (asterisk) any string
-? (question mark) any character
-# (pound sign) any ASCII digit
-== OMNIDEX SENTINEL character. ==
-Default % (percent sign).
-== OPTIMIZATION ==
-specifies the default type of optimization performed by Omnidex throughout an application connected to this environment. These options can be toggled on (optimization_setting) or off (NO_optimization_setting). Several optimization settings can be specified in a single SET command, separated by commas or spaces.
-Example:
-SET OPTIMIZATION="AGGREGATION, SERIAL"
-== ESCAPE character ==
-Default \ (backslash). Only a single escape character can be defined.
-== SQL_SYNTAX {OMNIDEX | OMNIDEX_PLUS} ==
-== CENTURY THRESHOLD n ==
-Specifies the year cutoff for determining the century in 2 digit years. For example, if the century threshold is set to 60, a 2 digit year of 45 would be translated to 2045 and a 2 digit year of 61 would be translated to 1961. This setting can be explicitly over-ridden for a specific column in the column definition.
-Environment name is a required string of up to 32 characters. Environment name can contain numbers and any of the allowed special characters. However, it MUST BEGIN WITH A LETTER, A-Z (case insensitive).
-===== DATABASE =====
-  [DATABASE database_name
-      TYPE database_type_spec
-      [SUBTYPE database_subtype_spec]
-      [VERSION "version"]
-      [PHYSICAL "filespec"]
-      [OPTIONS "options"]
-      [INDEXPREFIX "filespec"]
-      [USERCLASS "DEFAULT" [USER "user"] [PASSWORD "password"]
-      [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
-ODBC
-DB2
-UNION
-INFORMIX
-== 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
-== 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.
-== PHYSICAL "string" ==
-Optional. Physical declares the name and location of the database's root file or system dictionary and is used primarily with relational databases and ODBC.
-string is a quoted string that may vary according to database type. See the appropriate database type for details on the PHYSICAL clause.
-== OPTIONS "options" ==
-Optional.
-== INDEXPREFIX "filespec" ==
-Optional. The Indexprefix declares the root name and location of the Omnidex index files. filespec is a quoted string up to 251 characters in length and may contain any valid filename as well as appropriate path information and password information.
-DBINSTAL appends 4 characters (0001, 0002, ...) to the end of each index file name, therefore the filespec is limited to 251 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.
-== 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.
-== AUTOPSEUDOCOLUMNS ==
-Automatically constructs pseudocolumns from MDK composite keys.
-== 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 on a table-by-table basis by explicitly defining the indexmaintenance setting on an individual table.
-===== TABLE =====
-  TABLE < tablename | "tablename" >
-      [ TYPE < ROLLUP | > ]
-      [ PHYSICAL "filespec" ]
-      [ AS "select_statment" ]
-      [ PRIMARY KEY “col1”,”col2” ]
-      [ FOREIGN KEY “col1”,”col2” REFERENCES “table1”(“col1”,”col2”) ]
-      < COLUMN column_spec [ COLUMN column_spec ... > ]
-===== Column Specification =====
-  COLUMN column-name DATATYPE datatype-spec
-      [PROXIMITY “options”]
-      [SYNONYMS 'options']
-      [SPELLCHECK 'options']
-      [MISSPELLINGS 'options']
-      [FORMS 'options']
-      [STOPWORDS 'options']
-      [PHONETIC 'options']
-      [INCLUDED_TAGS 'options']
-      [EXCLUDED_TAGS 'options']
-      {AS < columnspec | "$retrieve_file(FILENAME)" > ]
-===== INDEX =====
-===== NODE =====
-      NODE nodename
-          DATABASE dbname FILEDSN "dsn"
-              [ LOCAL ]
-              [ CACHE ]
-          CLUSTER table
-              [PARTITION BY criteria_expression
-===== Example - Creating a simple Omnidex Environment Flatfile database with simulated Networked ODBC  =====
-==== Step 1 - Creating the Omnidex Environment Source ====
-The following sample Environment Catalog Source is the minimum set of statements that will compile into an Omnidex Compiled Environment.
-<code>
-ENVIRONMENT tinyenv
-DATABASE tinydb
-  TYPE flatfile
-TABLE table1
-  COLUMN myseq DATATYPE INTEGER
-  COLUMN mytext DATATYPE CHAR(60)
-</code>
-This creates an Omnidex Environment named "tinyenv" with a single Database named "tinydb" with one table named "table1".  Because the DATABASE TYPE is "flatfile", the name of the underlying operating system file for this table is "table1".  Typically a filespec location would be used.  Copy and save this environment as "tiny.src".
-==== Step 2 - Compiling the Omnidex Environment ====
-  os> oacomp tiny.src tiny.env
-==== Step 3 - Use OdxSQL to test, verify and manipulate the Environment ====
-  os> odxsql tiny.env
-or
-  os> odxsql
-  > connect tiny.env
-  > create file table1
-  > insert into table1 values (1)
-  > select * from table1
-<code>
-C:\dev\odx\tiny>more tiny.src
-ENVIRONMENT tinyenv
-DATABASE tinydb
-  TYPE flatfile
-TABLE table1
-  COLUMN mysq DATATYPE INTEGER
-  COLUMN mytext DATATYPE CHAR(60)
-C:\dev\odx\tiny>oacomp tiny.src tiny.env
-OACOMP - Omnidex Environment Compiler                  Mon Nov 30 21:41:50 2009
-(c) Dynamic Information Systems Corp.  1981-2009                   5.0 Build 1H
-Microsoft Windows XP Professional SP 3 (2600)                        TDO830/TDO
-** Trial Copy **
-Parsed; Validated; Compiled; Done
-** Environment Compiled Successfully! **
-C:\dev\odx\tiny>odxsql tiny.env
-ODXSQL - Omnidex SQL                                   Mon Nov 30 21:41:59 2009
-(c) Dynamic Information Systems Corp.  1981-2009                   5.0 Build 1H
-Microsoft Windows XP Professional SP 3 (2600)                        TDO830/TDO
-** Trial Copy **
-Connected to C:\dev\odx\tiny\tiny.env
-> create file table1
-File table1 created
-> insert into values (1, 'lions, tigers, and bears')
-row inserted into TABLE1
-> insert into values (2, 'lions, tigers, kittys, cougars')
-row inserted into TABLE1
-> insert into valu   (3, 'The teddy bears are having a picnic')
-row inserted into TABLE1
-> select * from table1
-MYSEQ        MYTEXT
------------  ------------------------------------------------------------
-  lions, tigers, and bears
-  lions, tigers, kittys, cougars
-  The teddy bears are having a picnic
-row returned
->
-</code>
-==== Step 4 - Install and Build Indexes with DBINSTAL ====
-<code>
-C:\dev\odx\tiny>dbinstal
-DBINSTAL - Omnidex Database Indexing Utility           Tue Dec 01 07:30:37 2009
-(c) Dynamic Information Systems Corp.  1981-2009                   5.0 Build 1H
-Microsoft Windows XP Professional SP 3 (2600)                        TDO830/TDO
-** Trial Copy **
-Database or Environment: tiny.env
-Cmd: install
-** OMNIDEX MultiDimensional/Keyword (MDK) Index Installation **
-Enter Tables and Columns to be indexed
-To create an index comprised of all or parts of one or more columns,
-enter an Index Name followed by '!' at the Column prompt
-Enter '?' for a list of Tables or Columns, '/' to exit the current prompt
-Table name? table1
-To index this table in any parent domains, enter the
-column linking it to its parent or 'P=' followed by the parent name
-Link column 1: /
-Table will be indexed in its own domain
-Column name: mytext;kw
-Column name: /
-Table name? /
-Specification of MDK indexes is complete
-** OMNIDEX Aggregation/Sorted_Key (ASK) Index Installation **
-Table name? /
-Proceed with installation? [Y]
-Use the Build command to load the following indexes:
-TABLE1 (Omnidex MDK)
-Cmd: build
-Table [;key] table1
-Unloading keywords
-TABLE1: 3 records (15 keywords) processed
-keywords unloaded
-(0MB), 1 (1MB), 0 (0MB)
-Loading keywords
-keywords loaded
-blocks used, 2 levels
-Indexing complete.  CPU time: 0:00:00  Elapsed: 0:00:00
-Cmd: quit
-C:\dev\odx\tiny>
-</code>
-==== Step 5 - Develop an Application with ODBC, JDBC or Stored Procedures ====
-After creating an Omnidex Environment and adding Omnidex indexes via DBINSTAL, applications can be developed using the DISC provided ODBC and JDBC drivers.
-Create an ODBC or JDBC datasource using the Windows Client DataSource Editor (DSEDIT).
-Name the file as "tiny.dsn".
-Or modify the following text file and save as tiny.dsn.
-Change the following lines to the correct path and filenames.
-Change these three lines with:
-  * Host= Change this value to the name of computer being used for this test.
-  * ODBCDSNFILE= Change this value to the path and file name of the dsn file.
-  * FileSpec= Change this value to the path and filename of the Omnidex Environment file.
-Cut and paste this text as "tiny.dsn" with the modifications and save in the same directory as the "tiny.env" Omnidex Environment file.
-<code>
-Host=tdo830
-ODBCDSNFILE=C:\dev\odx\tiny\tiny.dsn
-FileSpec=c:\dev\odx\tiny\tiny.env
-</code>
-<code>
-ODBC]
-DRIVER=DISC OMNIDEX OdxNet Driver
-ODBCDSNFILE=C:\dev\odx\tiny\tiny.dsn
-ODBCDSNNAME=tinydsn
-[DataSources]
-tinydsn=DataSource Edit Wizard Generated
-[DataSource tinydsn]
-Dictionary=tinydsn
-DisplayWindow=NONE
-[Dictionaries]
-tinydsn=DataSource Edit Wizard Generated
-[Dictionary tinydsn]
-Server=Server1
-NetworkServices=OdxNet
-Type=OmniAccess
-FileSpec=c:\dev\odx\tiny\tiny.env
-HostOAConnectOptions=
-Password=!~
-AccessOptions=Write
-[Servers]
-Server1=DataSource Edit Wizard Generated
-[Server Server1]
-Host=tdo830
-Port=7555
-</code>
-==== Step 6 - Simulate a client server environment using OdxNet with ODBC or JDBC ====
-Start a new command window as odxnet will run and await connections in the new command window.
-   os> odxnet
-Go back to the original command window and do the following:
-   os> odxsql tiny.dsn -odbc
-or run an ODXNET listener from within OdexSQL using the -odxnet command line option.
-   os> odxsql -odxnet
-   > connect tiny.dsn using odbc
-<code>
-   > select * from table1 where mytext = 'bears'
-MYSEQ        MYTEXT
------------  ------------------------------------------------------------
-            lions, tigers, and bears
-            The teddy bears are having a picnic
-</code>
-### Note that Omnidex will do a quick text (Keyword) retreival automatically ##
-==== Step 7 - Insert a new row to see that it is indexed ====
-  > insert into table1 values (4, 'Da Bears')
-row inserted into TABLE1
-<code>
-  > select * from table1 where mytext = 'bears'
-MYSEQ        MYTEXT
------------  ------------------------------------------------------------
-            lions, tigers, and bears
-            The teddy bears are having a picnic
-            Da Bears
-</code>
-{{page>:bottom_add&nofooter&noeditbtn}}

Back to top

oaenv/home.txt · Last modified: 2012/10/26 14:24 (external edit)

Sitemap Recent Changes