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 02:32] 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 ====== |
| - | ===== Environment Files ===== | + | ===== Omnidex Environments ===== |
| - | **[[admin:basics:environments:home|Overview]]** | [[nav|Nav2]] | + | **[[admin:basics:environments:home|Overview]]** | |
| + | [[admin:basics:environments:types|Types]] | | ||
| + | [[admin:basics:environments:create|Creating]] | | ||
| + | [[admin:basics:environments:maintain|Maintaining]] | | ||
| + | [[admin:basics:environments:deploy|Deploying]] | ||
| ---- | ---- | ||
| - | |||
| ==== Overview ==== | ==== Overview ==== | ||
| === Omnidex Environments === | === Omnidex Environments === | ||
| - | An //Omnidex Environment// is a term that describes a everything involved in 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//, which is an XML file containing all 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 either 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 by issuing SQL statements such as [[dev:sql:statements:create_environment:home|CREATE ENVIRONMENT]], [[dev:sql:statements:create_database|CREATE DATABASE]], [[dev:sql:statements:create_table|CREATE TABLE]] and [[dev:sql:statements:create_index|CREATE INDEX]]. 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. | + | * Connection information for one or more databases or data files. |
| * Schema layouts for tables and columns within the databases. | * Schema layouts for tables and columns within the databases. | ||
| * Constraint definitions establishing parent-child relationships between tables. | * Constraint definitions establishing parent-child relationships between tables. | ||
| Line 29: | Line 33: | ||
| * Configuration information about the entire environment. | * Configuration information about the entire environment. | ||
| - | //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 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. | ||
| + | |||
| + | === Organizing an 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".* | ||
| + | |< 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 ====== | ||