This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
admin:basics:environments:home [2011/01/13 16:02] els |
admin:basics:environments:home [2016/06/28 22:38] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ~~NOTOC~~ | ||
| {{page>:top_add&nofooter&noeditbtn}} | {{page>:top_add&nofooter&noeditbtn}} | ||
| - | ====== Administration: Omnidex Basics ====== | + | ====== Administration: Omnidex Fundamentals ====== |
| ===== Omnidex Environments ===== | ===== Omnidex Environments ===== | ||
| **[[admin:basics:environments:home|Overview]]** | | **[[admin:basics:environments:home|Overview]]** | | ||
| - | [[admin:basics:environments:home|Types of Environments]] | | + | [[admin:basics:environments:types|Types]] | |
| - | [[admin:basics:environments:home|Creating Environments]] | | + | [[admin:basics:environments:create|Creating]] | |
| - | [[admin:basics:environments:home|Maintaining Environments]] | | + | [[admin:basics:environments:maintain|Maintaining]] | |
| - | [[admin:basics:environments:home|Deploying Environments]] | + | [[admin:basics:environments:deploy|Deploying]] |
| - | + | ||
| - | * Sample Environment File | + | |
| - | * Creating the Environment File | + | |
| - | * Connecting to an Environment File | + | |
| - | * Types of Environment Files | + | |
| - | * Grids | + | |
| - | * Multi-Database | + | |
| - | * External File Catalog | + | |
| - | * Changing an Environment File | + | |
| - | * Moving Environments | + | |
| ---- | ---- | ||
| - | |||
| ==== Overview ==== | ==== Overview ==== | ||
| Line 28: | Line 18: | ||
| An Omnidex Environment is a term that describes all the aspects an Omnidex database. This includes: | An Omnidex Environment is a term that describes all the aspects an Omnidex database. This includes: | ||
| - | * The Omnidex Environment File, an XML file containing the metadata about the database and the Omnidex indexes. | + | * The Omnidex Environment File, an XML file containing selective metadata about the database and the Omnidex indexing. |
| * The database, consisting of a relational database, a series of raw datafiles, a series of delimited files, or all three. | * The database, consisting of a relational database, a series of raw datafiles, a series of delimited files, or all three. | ||
| * The Omnidex indexes and support files for the database. | * The Omnidex indexes and support files for the database. | ||
| - | Typically, an Omnidex Environment is a directory with subdirectories that contain all of these elements. This is often the most convenient approach since whole directories are easy to move and back up. In many cases, however, the database and indexes are large enough that they must span multiple disk drives or even machines. In that case, the Omnidex Environment refers to the entire collection, even though it is disbursed. | + | Typically, an Omnidex Environment is a directory with subdirectories that contain all of these elements. This is often the most convenient approach since whole directories are easy to move and back up. In many cases, however, the database and indexes are large enough that they must span multiple disk drives or even machines. In that case, the Omnidex Environment refers to the entire collection, even though it is disbursed. |
| === Omnidex Environment Files === | === Omnidex Environment Files === | ||
| - | An Omnidex Environment File is an XML file that contains all of the metadata about the database and the Omnidex indexes. It is created interactively using the [[programs:odxadmin:home|Omnidex Administrator]], or using SQL statements such as [[dev:sql:statements:create_environment:home|CREATE ENVIRONMENT]], [[dev:sql:statements:create_database:home|CREATE DATABASE]], [[dev:sql:statements:create_table:home|CREATE TABLE]] and [[dev:sql:statements:create_index:home|CREATE INDEX]]. The metadata contained in an Omnidex Environment File includes: | + | An Omnidex Environment File is an XML file that contains all of the metadata about the database and the Omnidex indexing. It is created interactively using the [[programs:odxadmin:home|Omnidex Administrator]], or using SQL statements such as [[dev:sql:statements:create_environment:home|CREATE ENVIRONMENT]], [[dev:sql:statements:create_database:home|CREATE DATABASE]], [[dev:sql:statements:create_table:home|CREATE TABLE]] and [[dev:sql:statements:create_index:home|CREATE INDEX]]. The metadata contained in an Omnidex Environment File includes: |
| * Connection information for one or more databases or data files. | * Connection information for one or more databases or data files. | ||
| Line 42: | Line 32: | ||
| * Omnidex indexing for the tables and columns within the databases. | * Omnidex indexing for the tables and columns within the databases. | ||
| * Configuration information about the entire environment. | * Configuration information about the entire environment. | ||
| + | |||
| + | Omnidex Environments that connect to relational databases can be selective about which tables and columns are included. This can be helpful in that it can greatly reduce the number of tables and columns seen by the Omnidex application. This can also reduce maintenance on the Omnidex Environment since it will only have to be updated for changes to the tables it includes. | ||
| Omnidex Environment Files also serve an important role in connections. An [[dev:connections:home|Omnidex Connection String]] points to an Omnidex Environment File. This means that the Omnidex Environment File is the starting point for nearly every Omnidex operation. | Omnidex Environment Files also serve an important role in connections. An [[dev:connections:home|Omnidex Connection String]] points to an Omnidex Environment File. This means that the Omnidex Environment File is the starting point for nearly every Omnidex operation. | ||
| - | === Types of Environments === | + | === Organizing an Omnidex Environment === |
| - | + | ||
| - | There are several types of Omnidex Environments, as described below. | + | |
| - | + | ||
| - | == Single-Database Environments == | + | |
| - | + | ||
| - | The most common environment encompasses a single database with indexes. This can be either a relational database, such as Oracle, SQL Server or MySQL, or it can be a series of data files arranged as a database. Omnidex indexes are usually added to the database. Connections to this type of environment allow complete, indexed access to the database. | + | |
| - | + | ||
| - | == Multi-Database Environments == | + | |
| - | + | ||
| - | Omnidex Environments can be comprised of multiple databases. These databases can be of different types as well. For example, an environment can contain a database pointing to Oracle tables, and also contain a database pointing to raw data files or delimited files. All databases can have Omnidex indexes, and queries against this environment can reference tables from both databases. This capability is of great benefit to those who have transient log files or transaction files that they want to query in conjunction with a primary relational database. | + | |
| - | + | ||
| - | == Grid Environments == | + | |
| - | + | ||
| - | Omnidex is frequently used on very large databases, often with billions of rows. These databases are appropriate for an [[admin:features:grids:home|Omnidex Grid]]. Omnidex Grids distribute the data and indexing across multiple nodes, allowing indexing and queries to be processed on each node in parallel, or even limited to individual nodes. A Omnidex Grid Environment contains the standard database and indexing information, but also contains the configuration of the Omnidex Grids. | + | |
| - | + | ||
| - | == Document Catalog Environment == | + | |
| - | + | ||
| - | Omnidex provide powerful features for performing [[admin:features:text:home|textual searches]], including searches on external textual files. An Omnidex database acts as a catalog of the textual documents and allows the indexing of both the catalog and the documents themselves. | + | |
| - | == The "OMNIDEX" Environment == | + | An Omnidex Environment can be organized in any fashion to reflect the standards of an organization. If no overriding standards exist, Omnidex recommends the following directory structure for an Omnidex Environment. This example presumes a database named "simple".* |
| - | Omnidex provides a special environment that gives access to features within the product itself, such as connection and query logs, synonym tables, error messages and configuration information. This reserved environment is simply called "omnidex", and is universally available in the product. | ||
| + | |< 75% 20% 80% >| | ||
| + | ^ Directory ^ Description ^ | ||
| + | | /simple | Root directory containing Omnidex Environment File | | ||
| + | | /simple/dat | Directory containing any data files, such as raw data files or delimited files | | ||
| + | | /simple/idx | Directory containing Omnidex indexes | | ||
| + | | /simple/sql | Directory containing SQL files used in this environment | | ||
| + | | /simple/log | Directory containing log files generated in this environment | | ||
| + | * Note that this directory structure is not required, and any structure may be used. | ||
| ===== ===== | ===== ===== | ||
| - | **[[admin:basics:environments:next|Next]]** | + | **[[admin:basics:environments:types|Next]]** |
| ====== Additional Resources ====== | ====== Additional Resources ====== | ||