This is an old revision of the document!
Documentation Map for Omnidex 5.n
The following is a draft documentation map for the Omnidex 5.n documentation.
Table of Contents
Overview
What is Omnidex?
Omnidex Architecture
Quick Start Guide
Using Omnidex: Customer Lists
Using Omnidex: Business Analytics
Using Omnidex: Transaction Logs
Using Omnidex: Flat File Databases
Using Omnidex: Text Databases
Using Omnidex: Knowledgebases
Topics
Fast Counts
Fast Aggregations
Textual Searches
Portable Snapshots
Scalable Grids
Environment Files
Administrators
The Omnidex Development and Deployment Lifecycle
Development
Testing
Staging
Deployment
Environment Files
Overview
Using Omnidex Administrator to create an Environment File
Creating an Environment File from an existing RDBMS
Creating an Environment File from existing flat files
Creating an Environment File from scratch
Using DDL to create an Environment File
Legacy: Using OACOMP to create an Environment File
Legacy: Using OAHELPER to create an Environment File
Omnidex Criteria
Wildcards and Pattern Matching
Boolean Operators
Range Operators
Files Containing Criteria Values
Synonym Searches
Thesaurus Searches
Word Form Searches
Spellchecked and Misspelling Searches
Number Transposition Searches
Phonetic Searches
Saved Searches
Multi-Column Index Searches
Case Sensitivity
Unicode Datatypes
Textual Searches
QuickText Indexes and Options
Effect of Boolean Operators
Effect of Wildcards and Pattern Matching
FullText Indexes and Options
Proximity Operators
Effect of Boolean Operators
Effect of Wildcards and Pattern Matching
Relevancy Scoring
Retrieval Excerpts
Indexing External Text Files
Omnidex Indexing Strategies
Basic Indexing Strategies
Basic Strategies for Optimizing Criteria
Omnidex Indexes
Basic Strategies for Optimizing Aggregations
Indexing for Aggregations
Rollup Tables
Basic Strategies for Optimizing Nested Queries
Indexing Criteria Columns
Indexing Select Items
Basic Strategies for Optimizing Table Joins
Indexing Primary and Foreign Keys
Advanced Indexing Strategies
Strategies for Optimizing Complex Criteria
Multi-component Indexes
Indexing Expression-based Columns
Strategies for Optimizing Complex Table Relationships
Prejoined Indexes
Multiple-Level Hierarchical Relationships
Strategies for Optimizing Distinct Count
Distinct Counts on Primary or Foreign Keys
Distinct Counts on Other Columns
Distinct Counts in Omnidex Grids
Strategies for Optimizing Latitude/Longitude Searches
Radius Searches from One Set of Coordinates
Radius Searches from Multiple Sets of Coordinates
Strategies for Indexing Multiple Columns as a Single Column
Grouping Columns within One Table
Grouping Columns within Multiple Tables
Optimizing Query Performance
Analyzing Query Performance
Explain Plans
Options
[NO]COUNTS
[NO]SUMMARY
[NO]DETAILS
[NO]ADDIN
[NO]TEXT
$OX (internal use)
Summary Section
Details Section
Addin Section
Estimating Omnidex Performance
Estimating Indexing Performance
Estimating Query Performance
Estimating Processing of Criteria
Estimating Processing of Table Joins
Estimating Process of Nested Queries
Nested Queries in the Criteria
Nested Queries in the Table List
Estimating Processing of Aggregations
Estimating Processing of Order By
Database Update Strategies
Batch Indexing
Incremental Indexing
Online Updates
OdxAIM
Scalability Strategies
RDBMS Topics
Oracle Topics
SQL Server Topics
MySQL Topics
Generic ODBC Topics
Stored Procedures (link)
Triggered Updates (link)
Omnidex Administrator
[details needed]
OdxSQL
Overview
Command-line options
-help Help
-version Display the OdxSQL version
-use=filename Execute statements in named file
-cmd='cmd1;cmd2' Execute specified statements
-where='criteria' Apply criteria against directives in use file
-exit Exit after completion of use file
-exit_on_error Exit if an error occurs
-nobanner Do not print the banner
-cloa Run OdxSQL using the CLOA client interface
-jdbc Run OdxSQL using the JDBC client interface
-odbc Run OdxSQL using the ODBC client interface
-odxnet[=port] Launch an Omnidex Network Services for this session
Commands
! Execute a shell command
. Execute last command
; Comment line
ABORT Cause software abort
ASSIGNVALUES * Assign values for a $VALUES clause
ATTACH * Attach an OST file as a table
BENCHMARK Perform performance benchmarks
BIND Bind a SELECT statement
CALC Perform basic calculator functions
CD Change directories
CLOSE CURSOR * Close a cursor
COMMAND * Execute a shell command via $COMMAND table
CONNECT * Connect to an environment file
CONVERT Export a file with data conversions
COPY Copy a fileset
CREATE DATABASE Create an Omnidex database
CREATE DIRECTORY Create a directory
CREATE ENVIRONMENT Create an Omnidex environment
CREATE FILE Create a file
CREATE INDEX * Create an Omnidex index
CREATE INDEXES * Create Omnidex indexes for a database
CREATE TABLE * Create a table
DATE Show the current date and time
DELETE * Issue an SQL delete statement
DELETEINDEX * Delete values directly from Omnidex indexes
DESCRIBE Describe a SELECT statement
DETACH * Detach a previously attached OST file
DIR Display a directory of files
DISCONNECT * Disconnect from an environment file
DROP DATABASE Drop an Omnidex database
DROP ENVIRONMENT Drop an Omnidex environment
DROP INDEX Drop an Omnidex index
DROP INDEXES * Drop Omnidex indexes for a database
DROP TABLE * Drop a table
DUMP Dump files, memory or caches
EDIT Edit a previous command or file
ERROR Display an error message
EVAL Evaluate a condition
EXECDB Execute statement through oaexecdb
EXECSQL Execute statement through oaexecsql
EXIT Exit Omnidex SQL
EXPLAIN Explain approach to retrieval
EXPORT * Export records to a file
EXTRACT Extract SQL statements from database
FETCH Explicitly fetch data from a database
FETCHKEYS Explicitly fetch keys from the indexes
FLIP Flip data from one endian to another
FOR Form a 'FOR n ... END' construct
FORMAT Format a file of ODXSQL statements
GETENV Display an environment variable
HELP Help
HELPER * Access oahelper utilities
HISTORY Show history of ODXSQL commands
IF Form an 'IF ELIF ELSE ENDIF' construct
INSERT * Issue an SQL insert statement
INSERTINDEX * Insert values directly into Omnidex indexes
IS Check database conditions
JOIN * Join tables using Omnidex
LOAD OFX * Load indexes for a table
LOOKUP Look up text metadata
MESSAGE Display an environment catalog message
NETWORKACCESS Execute an Omnidex network access command
OPEN CURSOR * Open a cursor
OXKERNEL Execute an Omnidex kernel command
PARSE Parse a statement
PARTITION * Partition a table
PWD Print current working directory
QUALIFY * Qualify rows using Omnidex
QUIT Quit Omnidex SQL
REMOVE Remove one or more files
RENAME Rename a fileset
RESET HISTORY Reset history of ODXSQL commands
RESET TIMER Reset the cumulative timer
RESTORE SETTINGS Restore settings, optionally from a file
SAVE HISTORY Save commands to file
SAVE SETTINGS Save settings, optionally to a file
SELECT * Issue an SQL select statement
SET Set an option
SETENV Set an environment variable
SHOW Describe an object
SIGNAL Send a signal to a process
SLEEP Sleep for a specified number of seconds
SORTMERGE Sort/merge test system
UPDATE * Issue an SQL update statement
UPDATE INDEXES * Update Omnidex indexes
UPDATE ROLLUP * Update rollup table
UPDATE ROLLUPS * Update rollup tables
UPDATE STATISTICS * Update statistical information
UPDATE TEXT * Update textual statistics
UPDATEINDEX * Update values directly in Omnidex indexes
USE Execute a file of ODXSQL commands
VALIDATE Validate an environment
VERSION * Display current software versions
VIEW View a text file
n Execute numbered command
n: Send command to ODXSQL subprocess
Omnidex Network Services
Overview
Command-line options
[details needed]
Configuration file
[details needed]
Utilities (later renamed to Legacy Tools)
OACOMP/OADECOMP
Environment File Syntax
DBINSTAL
OAHELPER
DSEdit
OdxQuery
NSAdmin
VERSIONS
SYSINFO
REGMAINT
Administrator FAQ
Developers
Omnidex SQL Reference
ASSIGNVALUES Assign values for a $VALUES clause
ATTACH Attach an OST file as a table
CLOSE CURSOR Close a cursor
COMMAND Execute a shell command via $COMMAND table
CONNECT Connect to an environment file
CREATE DATABASE Create an Omnidex database
CREATE DIRECTORY Create a directory
CREATE ENVIRONMENT Create an Omnidex environment
CREATE FILE Create a file
CREATE INDEX Create an Omnidex index
CREATE INDEXES Create Omnidex indexes for a database
CREATE TABLE Create a table
DELETE Issue an SQL delete statement
DELETEINDEX Delete values directly from Omnidex indexes
DETACH Detach a previously attached OST file
DISCONNECT Disconnect from an environment file
DROP DATABASE Drop an Omnidex database
DROP ENVIRONMENT Drop an Omnidex environment
DROP INDEX Drop an Omnidex index
DROP INDEXES Drop Omnidex indexes for a database
DROP TABLE Drop a table
EXPORT Export records to a file
HELPER Access oahelper utilities
INSERT Issue an SQL insert statement
INSERTINDEX Insert values directly into Omnidex indexes
JOIN Join tables using Omnidex
LOAD OFX Load indexes for a table
OPEN CURSOR Open a cursor
PARTITION Partition a table
QUALIFY Qualify rows using Omnidex
SELECT Issue an SQL select statement
SET Set an option
UPDATE Issue an SQL update statement
UPDATE INDEXES Update Omnidex indexes
UPDATE ROLLUP Update rollup table
UPDATE ROLLUPS Update rollup tables
UPDATE STATISTICS Update statistical information
UPDATE TEXT Update textual statistics
UPDATEINDEX Update values directly in Omnidex indexes
VERSION Display current software versions
ODBC Interface
Setting up the ODBC Interface
Using the ODBC Interface
(details needed)
Examples
JDBC Interface
Setting up the JDBC Interface
Using the JDBC Interface
(details needed)
Examples
The JDBC Intelligent Router
(insert technote here)
Stored Procedures
Oracle
SQL Server
Legacy API's
OmniAccess
(insert legacy documentation here)
Client OmniAccess
(insert legacy documentation here)
ImagePlus
(insert legacy documentation here)
Developer FAQ
General
Software Installation
Platform Support
Release Notes
Migration From Earlier Versions
Glossary
Documentation Map
Installation FAQ
(c)Copyright Dynamic Information Systems - This document was last updated November 11, 2009.