Informix DBTUNE configuration parameters
Configuration parameters, which are stored in the parameter_name column of the DBTUNE table, identify database objects to be stored in the database. Their corresponding values, which are stored in the config_string column of DBTUNE, identify how the object will be stored in the database. The parameters and their configuration strings are grouped together in the DBTUNE table by configuration keywords. Keyword/Parameter name combinations are unique, but most parameter names are not and are reused under a number of different keywords throughout the DBTUNE table.
Valid values for the parameter_name column are fixed; you cannot invent new parameter names. Likewise, the config_string column accepts only certain numeric values or SQL strings. In most cases, these strings are appended to SQL CREATE TABLE and CREATE INDEX statements so they must match the SQL syntax necessary for the given DBMS.
In geodatabases stored in an IBM Informix database, parameter name–configuration string pairs are used by ArcSDE to do the following:
- Establish the storage characteristics of tables and indexes.
- Make keywords available for users in the ArcGIS interface.
- Provide comments that describe the configuration keyword.
The following table is an alphabetic list of all the possible configuration parameters that can be used in a geodatabase in Informix. Following that is a more in-depth explanation of the parameters grouped by their functionality.
Parameter name |
Description |
Value |
---|---|---|
A_INDEX_ROWID |
Adds table object ID column index storage definition |
See your Informix documentation for CREATE INDEX parameters. |
A_INDEX_STATEID |
Adds table sde_state_id column index storage definition |
See your Informix documentation for CREATE INDEX parameters. |
A_INDEX_USER |
Adds table index storage definition |
See your Informix documentation for CREATE INDEX parameters. |
A_RTREE |
Adds table R-tree index storage definition |
See your Informix documentation for CREATE INDEX parameters. The default value in DBTUNE is blank; therefore, the Informix default is used. Consult your Informix documentation for this value. |
A_STORAGE |
Adds table storage definition |
See your Informix documentation for CREATE TABLE parameters. |
AUX_INDEX_COMPOSITE |
Raster AUX table composite column index storage definition |
See your Informix documentation for CREATE INDEX parameters. |
AUX_STORAGE |
Raster AUX table storage definition |
See your Informix documentation for CREATE TABLE parameters. |
B_INDEX_ROWID |
Business table object ID column index and raster rowid index R<N>_SDE_ROWID_UK storage definition |
See your Informix documentation for CREATE INDEX parameters. |
B_INDEX_TO_DATE |
Storage parameter info for creating the index R<registration_id>_sde_todate, which is used when updating the history table during an archive operation |
See your Informix documentation for CREATE INDEX parameters. |
B_INDEX_USER |
Business table user index storage definition |
See your Informix documentation for CREATE INDEX parameters. |
B_RTREE |
Business table R-tree index storage definition |
See your Informix documentation for CREATE INDEX parameters. The default value in DBTUNE is blank; therefore, the Informix default is used. Consult your Informix documentation for this value. |
B_STORAGE |
Business table and raster attribute table storage definition |
See your Informix documentation for CREATE TABLE parameters. |
BLK_INDEX_COMPOSITE |
Raster BLK table composite column index storage definition |
See your Informix documentation for CREATE INDEX parameters. |
BLK_LOB_STORAGE |
Allows you to specify a storage location for raster block data |
See your Informix documentation for CREATE TABLE parameters. |
BLK_STORAGE |
Raster BLK table storage definition |
See your Informix documentation for CREATE TABLE parameters. |
BND_INDEX_COMPOSITE |
Raster BND table composite column index storage definition |
See your Informix documentation for CREATE INDEX parameters. |
BND_INDEX_ID |
Raster BND table RID column index storage definition |
See your Informix documentation for CREATE INDEX parameters. |
BND_STORAGE |
Raster BND table storage definition |
See your Informix documentation for CREATE TABLE parameters. |
COMMENT |
Line used for comments |
You can place any comment up to 2,048 characters. |
D_INDEX_DELETED_AT |
Deletes table sde_deleted_at column index storage definition |
See your Informix documentation for CREATE INDEX parameters. |
D_INDEX_ STATE_ROWID |
Deletes table sde_states_id and sde_deletes_row_id column index storage definition |
See your Informix documentation for CREATE INDEX parameters. |
D_STORAGE |
Deletes table storage definition |
See your Informix documentation for CREATE TABLE parameters. |
LD_INDEX_DATA_ID |
Sde_logfile_data storage definition |
See your Informix documentation for CREATE INDEX parameters. |
LD_INDEX_ROWID |
Sde_logfile_data and sde_logpool<sde_id> tables' sde_rowid column index storage definition |
See your Informix documentation for CREATE INDEX parameters. |
LD_STORAGE |
Sde_logfile_data and sde_logpool<sde_id> tables' storage definition |
See your Informix documentation for CREATE TABLE parameters. |
LF_INDEXES |
Sde_logfiles table column indexes storage definition |
See your Informix documentation for CREATE INDEX parameters. |
LF_STORAGE |
Sde_logfiles table storage definition |
See your Informix documentation for CREATE TABLE parameters. |
MAX_CACHED_CURSORS |
Maximum number of cached cursors |
0 or higher 0 = disabled The default value is 80. |
MVTABLES_MODIFIED_INDEX |
Mvtables_modified index storage definition |
See your Informix documentation for CREATE INDEX parameters. |
MVTABLES_MODIFIED_TABLE |
Mvtables_modified table storage definition |
See your Informix documentation for CREATE TABLE parameters. |
RAS_INDEX_ID |
Raster RAS table RID index storage definition |
See your Informix documentation for CREATE INDEX parameters. |
RAS_STORAGE |
Raster RAS table storage definition |
See your Informix documentation for CREATE TABLE parameters. |
S_STORAGE |
Represents a "smart BLOB sbspace" |
See your Informix documentation for CREATE TABLE parameters. |
SESSION_INDEX |
ArcSDE session-based and stand-alone log file indexes storage definition |
See your Informix documentation for CREATE INDEX parameters. |
SESSION_STORAGE |
ArcSDE session-based and stand-alone log file tables storage definition |
See your Informix documentation for CREATE TABLE parameters. |
SESSION_TEMP_TABLE |
Not used in geodatabases in Informix |
1 or 0 |
STATE_LINEAGES_TABLE |
State_lineages table storage definition |
See your Informix documentation for CREATE TABLE parameters. |
STATES_INDEX |
States table storage definition |
See your Informix documentation for CREATE INDEX parameters. |
STATES_TABLE |
States table storage definition |
See your Informix documentation for CREATE TABLE parameters. |
UI_NETWORK_TEXT |
User interface parameter, which indicates associated configuration keyword will appear in the ArcGIS user interface; contains description of network configuration |
Description up to 2,048 characters |
UI_TERRAIN_TEXT |
User interface parameter, which indicates associated configuration keyword will appear in the ArcGIS user interface; contains description of terrain configuration |
Description up to 2,048 characters |
UI_TEXT |
User interface parameter, which indicates associated configuration keyword will appear in the ArcGIS user interface; contains description of associated noncomposite configuration keyword |
Description up to 2,048 characters |
UI_TOPOLOGY_TEXT |
User interface parameter, which indicates associated configuration keyword will appear in the ArcGIS user interface; contains description of topology configuration |
Description up to 2,048 characters |
USE_EXCLUSIVE_LOCKING |
Exclusive Locking used during ArcSDE compression |
TRUE or FALSE |
VERSIONS_INDEX |
Version index storage definition |
See your Informix documentation for CREATE INDEX parameters. |
VERSIONS_TABLE |
Versions table storage definition |
See your Informix documentation for CREATE TABLE parameters. |
XML_DOC_LOB_STORAGE |
Storage and access information for XML documents in the xml_doc column of the sde_xml_doc<n> table |
Provide the name of a Smart BLOB space where the LOB data will be stored, "<SBLOBspace_name>" |
XML_DOC_STORAGE |
Storage clause for sde_xml_doc<n> table |
See your Informix documentation for CREATE TABLE parameters. |
XML_DOC_VAL_LOB_STORAGE |
Storage and access information for the XML document content in the xml_doc_val column of the sde_xml_doc<n> table |
Provide the name of a Smart BLOB space where the LOB data will be stored, "<SBLOBspace_name>" |
XML_IDX_FULLTEXT_PARAMS |
A comma-separated list of secondary access method parameter-value pairs as required by the DataBlade Module you are using: either Excalibur Text Search (ETX) or Basic Text Search (BTS) |
There is no default value set for this parameter. If you are using the Excalibur Text Search DataBlade Module, settings such as the following would be used: CHAR_SET='ISO',PHRASE_SUPPORT='MAXIMUM'Consult the Excalibur Text Search DataBlade Module User's Guide for valid character set and phrase support settings and what they mean. When using the Basic Text Search (BTS) DataBlade Module, an example setting is as follows:
delete='deferred' |
XML_IDX_FULLTEXT_STORAGE |
Indicates the smart BLOB space or Extspace in which the text index will be stored |
When using the ETX DataBlade Module, specify the name of a logged smart BLOB space in which the ETX full-text index will be created. For further details, see the ETX DataBlade Module documentation. When using the BTS DataBlade Module, specify the name of an Extspace in which the BTS full-text index will be created. For further details, see the BTS DataBlade Module documentation. |
XML_IDX_FULLTEXT_TYPE |
The type of text index used |
If you are using the ETX DataBlade Module, set to etx. If using the BTS DataBlade Module, set this parameter to bts. |
XML_IDX_INDEX_DOUBLE |
Storage clause for the xmlix<n>_db index on the double_tag column of the sde_xml_idx<n> table |
See your Informix documentation for CREATE INDEX parameters. |
XML_IDX_INDEX_ID |
Storage clause for the xmlix<n>_id index on the ID column of the xml_idx<n> table |
See your Informix documentation for CREATE INDEX parameters. |
XML_IDX_INDEX_STRING |
Storage clause for xmlix<n>_st index on the string_tag column of the sde_xml_idx<n> table |
See your Informix documentation for CREATE INDEX parameters. |
XML_IDX_INDEX_TAG |
Storage clause for the xmlix<n>_tg index on the tag_id column of the sde_xml_idx<n> table |
See your Informix documentation for CREATE INDEX parameters. |
XML_IDX_STORAGE |
Storage clause for sde_xml_idx<n> table (the index table of an XML column) |
See your Informix documentation for CREATE TABLE parameters. |
XML_IDX_TEXT_TAG_STORAGE |
Storage and access information for the contents of the text_tag column in the sde_xml_idx<n> table (the index table of an XML column) |
Provide the name of a Smart BLOB space where the LOB data will be stored, "<SBLOBspace_name>" |
XML_INDEX_TAGS_INDEX |
Storage clause for xml_indextags_pk index of the sde_xml_indexes table |
See your Informix documentation for CREATE INDEX parameters. |
XML_INDEX_TAGS_TABLE |
Storage clause for sde_xml_index_tags table and the xml_indextags_ix1 and xml_indextags_ix2 indexes on the tag_name and tag_alias columns, respectively |
See your Informix documentation for CREATE TABLE parameters. |
For the XML parameters, <n> refers to the xml_column_id associated with a specific XML column.
Functional descriptions of parameters
Business table and index storage parameters
A business table is any Informix table created by an ArcSDE client, the sdetable administration command, or the ArcSDE C API SE_table_create function.
Use the dbtune table's B_STORAGE parameter to define the storage configuration of a business table.
Four index parameters exist to support the creation of business table indexes. The B_INDEX_USER parameter holds the storage configuration for user-defined indexes created with the C API function SE_table_create_index and the create_index operation of the sdetable command. The B_INDEX_ROWID parameter holds the storage configuration of the index ArcSDE creates on the registered table's objectid column, commonly referred to as the rowid. A registered table can be created with the alter_reg operation of the sdetable command or from the ArcGIS Desktop interface. The B_RTREE parameter holds the storage configuration of the spatial column index ArcSDE creates when a spatial column is added to a business table. This index is created by the ArcSDE C API function SE_layer_create. This function is called by ArcGIS when it creates a feature class and by the add operation of the sdelayer command. The B_INDEX_TO_DATE parameter specifies the storage for the index R<registration_id>_sde_todate. This index is created when archiving is enabled on a business table and is used when updating the history table during an archive operation.
ArcSDE registers all tables that it creates. Tables not created by ArcSDE can also be registered with the sdetable or sdelayer commands. The table_registry system table maintains a list of the currently registered tables.
Adds and deletes tables storage parameters
Registering a business table or feature class as versioned allows multiple users to maintain and edit an object. ArcSDE creates two tables—the adds table and the deletes table—for each table that is registered as versioned.
At appropriate intervals, the users merge the changes they have made with the changes made by other users and reconcile any conflicts that arise when the same features are modified.
Adds table parameters
The A_STORAGE parameter maintains the storage configuration of the adds table. The adds table is named a<n>, where <n> is the registration ID listed in the table_registry system table. For instance, if the business table roads is listed with a registration ID of 10, ArcSDE creates the adds table as a10.
Four other parameters hold the storage configuration of the indexes of the adds table:
- The A_INDEX_ROWID storage parameter holds the storage configuration of the index that ArcSDE creates on the versioned objectid column, commonly referred to as the rowid. The adds table rowid index is named a<n>_rowid_ix1, where <n> is the business table's registration ID with which the adds table is associated.
- The A_INDEX_STATEID parameter holds the storage configuration of the index that ArcSDE creates on the adds table's sde_state_id column. The sde_state_id column index is called a<n>_state_ix2, where <n> is the business table's registration ID with which the adds table is associated.
- The A_RTREE storage parameter holds the storage configuration of the index that ArcSDE creates on the adds table's spatial column. If the business table contains a spatial column, the column and its index are duplicated in the adds table.
- The A_INDEX_USER storage parameter holds the storage configuration of user-defined indexes that ArcSDE creates on the adds table. The user-defined indexes on the business tables are duplicated on the adds table.
Deletes table parameters
The D_STORAGE storage parameter holds the storage configuration of the deletes table. The deletes table is named d<n>, where <n> is the registration ID listed in the table_registry system table. For instance, if the business table roads is listed with a registration ID of 10, ArcSDE creates the deletes table as d10.
Two other parameters hold the storage configuration of the indexes that ArcSDE creates on the deletes table:
- The D_INDEX_STATE_ROWID storage parameter holds the storage configuration of the d<n>_idx1 index that ArcSDE creates on the deletes table's sde_state_id and sde_deletes_row_id columns.
- The D_INDEX_DELETED_AT storage parameter holds the storage configuration of the d<n>_idx2 index that ArcSDE creates on the deletes table's sde_deleted_at column.
For more information on the structure of adds and deletes tables and how they are used, see Versioned tables in a geodatabase in Informix.
Raster table and index storage parameters
A raster column added to a business table is actually a foreign key reference to raster data stored in a schema consisting of four tables and five supporting indexes.
- The RAS_STORAGE parameter holds the Informix CREATE TABLE storage configuration of the ras table.
- The RAS_INDEX_ID storage parameter holds the Informix CREATE INDEX storage configuration of the ras table index. The BND_STORAGE parameter holds the Informix CREATE TABLE storage configuration of the bnd table.
- The BND_INDEX_COMPOSITE storage parameter holds the Informix CREATE INDEX storage configuration of the bnd table's composite column index.
- The BND_INDEX_ID storage parameter holds the Informix CREATE INDEX storage configuration of the bnd table's rid column index.
- The AUX_STORAGE parameter holds the Informix CREATE TABLE storage configuration of the aux table.
- The AUX_INDEX_COMPOSITE storage parameter holds the Informix CREATE INDEX storage configuration of the aux table's index.
- The BLK_STORAGE parameter holds the Informix CREATE TABLE storage configuration of the blk table.
- The BLK_INDEX_COMPOSITE storage parameter holds the Informix CREATE TABLE storage configuration of the blk table's index.
There is an additional type of raster table—the raster attribute table. These tables store attribute values based on cell values in the raster. The B_STORAGE parameter defines the storage of these tables. If you need to define a different storage location for these tables than you do for other feature class business tables, be sure to create a raster keyword you can use when creating raster datasets and raster catalogs that specifies different storage information for the raster attribute tables.
To learn more about raster attribute tables, see Raster dataset attribute tables. To learn about custom configuration keywords, see Custom configuration keywords.
For more information on how rasters are stored, see Raster datasets and raster catalogs in a geodatabase in Informix.
XML storage parameters
XML configuration parameters are used to specify storage information for the tables and indexes used to track and store XML documents. There are three XML configuration parameters specific to Informix that must have proper values specified for them: XML_IDX_FULLTEXT_TYPE, XML_IDX_FULLTEXT_PARAMS, and XML_IDX_FULLTEXT_STORAGE.
The XML_IDX_FULLTEXT_TYPE parameter specifies the secondary index access method provided by the full-text search DataBlade Module you are using. When using the Excalibur Text Search DataBlade Module, the value for this parameter should be specified as follows:
XML_IDX_FULLTEXT_TYPE "etx"
When using the Basic Text Search DataBlade Module, the value for this parameter should be specified as shown here:
XML_IDX_FULLTEXT_TYPE "bts"
The XML_IDX_FULLTEXT_PARAMS parameter specifies a comma-separated list of secondary access method parameter-value pairs as required by the DataBlade Module you are using. When using the Excalibur Text Search DataBlade Module, the value for this parameter should be specified as follows:
XML_IDX_FULLTEXT_PARAMS "CHAR_SET='ISO',PHRASE_SUPPORT='MAXIMUM'"
When using the Basic Text Search DataBlade Module, the value for this parameter should be specified as shown here:
XML_IDX_FULLTEXT_PARAMS "delete='deferred'"
The XML_IDX_FULLTEXT_STORAGE parameter names the storage space where the full-text index will be created. When using the Excalibur Text Search DataBlade Module, the value for this parameter should name a logged Smart BLOB Space, as shown in the following example:
XML_IDX_FULLTEXT_STORAGE "sbspace2"
When using version 1.00 of the Basic Text Search (BTS) DataBlade Module (bundled with Informix Dynamic Server (IDS) version 11.10), the value for this parameter should name an Extspace, as shown in this example:
XML_IDX_FULLTEXT_STORAGE "bts_extspace"
If you are using version 2.00 of the BTS DataBlade Module (bundled with IDS version 11.50), this parameter may name an Extspace as shown in the previous example, or it may name a logged Smart BLOB Space, as shown in the following example:
XML_IDX_FULLTEXT_STORAGE "sbspace2"
The following is an example CREATE INDEX statement that matches the settings for these three configuration parameters when using the Excalibur Text Search DataBlade Module:
CREATE INDEX xmldoc1_txt ON sde_xml_doc1 (xml_doc_val etx_clob_ops) USING etx ( CHAR_SET='ISO',PHRASE_SUPPORT='MAXIMUM' ) IN sbspace2
The following is an example CREATE INDEX statement that matches the settings for these three configuration parameters when using the Basic Text Search DataBlade Module:
CREATE INDEX xmldoc1_txt ON sde_xml_doc1 (xml_doc_val bts_clob_ops) USING bts ( delete='deferred' ) IN bts_extspace
The next three configuration parameters are used by Informix to specify the Smart BLOB space in which to store large object data (BLOB or CLOB) for the sde_xml_doc<id#> and sde_xml_idx<id#> tables:
XML_DOC_LOB_STORAGE "<SBLOBspace name>" XML_DOC_VAL_LOB_STORAGE "<SBLOBspace name>" XML_IDX_TEXT_TAG_STORAGE "<SBLOBspace name>"
These values of the parameters can be modified to specify a DB space name for table and index storage as follows. Be sure to replace the <DBspace name> with the name of the DB space in which you want the tables and indexes to be stored.
XML_INDEX_TAGS_TABLE "IN <DBspace name> EXTENT SIZE 16 NEXT SIZE 16 LOCK MODE ROW" XML_INDEX_TAGS_INDEX "FILLFACTOR 90 IN <DBspace name>" XML_DOC_STORAGE "IN <DBspace name> EXTENT SIZE 16 NEXT SIZE 16 LOCK MODE ROW" XML_IDX_STORAGE "IN <DBspace name> EXTENT SIZE 16 NEXT SIZE 16 LOCK MODE ROW" XML_IDX_INDEX_ID "FILLFACTOR 90 IN <DBspace name>" XML_IDX_INDEX_TAG "FILLFACTOR 90 IN <DBspace name>" XML_IDX_INDEX_DOUBLE "FILLFACTOR 90 IN <DBspace name>" XML_IDX_INDEX_STRING "FILLFACTOR 90 IN <DBspace name>"
See Configuring an Informix database to support ArcSDE XML columns for information on using XML columns in your geodatabase.
Log file table parameters
Log file tables are used by ArcSDE to maintain sets of selected records. Log file parameters affect log file and log file data tables and indexes. They begin with the letter L or SESSION. The defaults are as follows:
- LF_STORAGE defines the configuration for the sde_logfiles table.
- LF_INDEXES configures creation of indexes on the sde_logfiles table.
- LD_STORAGE defines configuration for the sde_logfile_data and sde_logpool_<sde_id> tables.
- LD_INDEX_DATA_ID configures the creation of the sde_logfile_data_idx2 index on the sde_logfile_data table and of the sde_logpool_<sde_id>_idx1 index on the sde_logpool_<sde_id>.
- LD_INDEX_ROWID configures creation of the index sde_log file_data_idx1 on the sde_log file_data table and the index sde_logpool_<sde_id>_idx1 on the sde_logpool_<sde_id> table.
- SESSION_STORAGE defines the storage of the session-based and stand-alone log file tables.
- SESSION_INDEX defines the storage of the session-based and stand-alone log file table indexes.
- SESSION_TEMP_TABLE is not used in Informix databases.
For more information on how log file tables are used in the geodatabase, see ArcSDE log file table configuration options for Informix.
User interface parameters
User interface parameters begin with UI and indicate whether their associated configuration keyword will be available through the ArcGIS user interface and ArcObjects. UI_TEXT is used for noncomposite configuration keywords. UI_TOPOLOGY_TEXT is used for topology keywords. UI_TERRAIN_TEXT is used for terrain keywords. UI_NETWORK_TEXT is used for network keywords. See Making configuration keywords available in ArcGIS for more information on how to use UI parameters.
Comments
You can add a COMMENT parameter in the dbtune.sde file if you want by adding a line beginning with a single pound sign (#). You might do this if you create your own custom keywords and want to add comments on how or when the keyword should be used. For example, you could add a comment to a user's log file keyword:
#COMMENT "This keyword is used by ArcSDE to create log file tables for all users logged in as editor"