Configuration keywords for ArcSDE geodatabases
There are many options for configuration keywords in an ArcSDE geodatabase licensed with ArcGIS Server at the Enterprise level. For each database management system (DBMS), a specific set of configuration keywords is created by default in the DBTUNE table of the geodatabase. In addition, the ArcSDE administrator can add custom keywords.
What are configuration keywords in an ArcSDE geodatabase?
Configuration keywords are used to group parameters and parameter values under one heading (the keyword). The parameters and parameter values specify storage options for datasets in the geodatabase. The configuration keywords and their associated parameters and parameter values are stored in the DBTUNE system table in the geodatabase. In the DBTUNE table, the parameter values are config_strings. The following is a portion of the DBTUNE table in a SQL Server database, showing some of the TOPOLOGY_DEFAULTS parameters and their values.
How are configuration keywords used?
By grouping a set of parameters and values, configuration keywords let you designate one keyword that affects multiple storage options of a particular dataset. You choose what configuration keyword to use when you create a dataset in the geodatabase. If you do not specify a different keyword, the DEFAULTS keyword is used for the data.
The ArcSDE administrator can alter the parameter values to change the way different components of a feature class or raster dataset are stored. For example, for ArcSDE for DB2, the values for the business table and delta table parameters under the DEFAULTS configuration keyword can specify that they be stored in different table spaces. The following example shows part of the DEFAULTS configuration keyword parameter list as it is seen in the dbtune.sde file. In this example, the business table is stored in the table space FEATS, and the delta tables are stored in the table space VERSIONS.
##DEFAULTS B_STORAGE "IN FEATS INDEX IN FEATSIDX LONG IN FEATSLONG" A_STORAGE "IN VERSIONS INDEX IN VERSIONSIDX LONG IN VERSIONSL" D_STORAGE "IN VERSIONS INDEX IN VERSIONSIDX LONG IN VERSIONSL"
It is also possible for the ArcSDE administrator to create custom configuration keywords. The ArcSDE administrator is responsible for making sure the necessary configuration keywords exist in the DBTUNE table and are available for use in ArcGIS Desktop. Your ArcSDE administrator can tell you if any custom configuration keywords are available and, if so, when you should use them.
Not all the configuration keywords used by the system are exposed for use in the ArcGIS Desktop interface. For some configuration keywords—such as the DATA_DICTIONARY keyword, which specifies the storage location of ArcSDE repository tables—there is no reason for you to ever choose them in the ArcGIS Desktop interface.
What configuration keyword should you use?
In most cases, the DEFAULTS configuration keyword is sufficient. The ArcSDE administrator should have made any necessary changes to the parameter values of the DEFAULTS configuration keyword so that it reflects the configuration needed the majority of the time.
There may be special circumstances in which you choose a configuration keyword other than DEFAULTS when creating or importing data. Some suggested scenarios are offered in the following sections.
Geometry storage configuration keywords
All geodatabases store geometry (hence the geo in geodatabase). Each DBMS product used for ArcSDE geodatabases provides specific geometry storage mechanisms. For DB2 DBMSs, geometry is stored using Spatial Extender. In Informix DBMSs, geometry is stored using Spatial DataBlade. Oracle, SQL Server, and PostgreSQL DBMSs allow you to choose from different geometry storage options.
For SQL Server databases, you can use either ArcSDE compressed binary (the default); the Open Geospatial Consortium, Inc. (OGC), well-known binary (WKB) storage method; or Microsoft's geometry or geography spatial types. For Oracle databases, you can use either ArcSDE compressed binary, OGC WKB, ST_Geometry, or Oracle Spatial. For PostgreSQL, you can use ST_Geometry or the PostGIS geometry type.
The configuration keywords associated with each of these storage types are as follows:
Configuration keyword |
Geometry storage |
---|---|
WKB_GEOMETRY |
OGC well-known binary type |
SDELOB |
ArcSDE compressed binary stored as a binary large object (BLOB) |
SDEBINARY |
ArcSDE compressed binary |
ST_GEOMETRY |
Spatial type for Oracle or PostgreSQL |
SDO_GEOMETRY |
Oracle Spatial (including GeoRaster) |
PG_GEOMETRY |
PostGIS geometry type |
GEOMETRY |
Microsoft geometry type |
GEOGRAPHY |
Microsoft geography type |
The ArcSDE administrator sets the DEFAULTS geometry storage to the type you will use for most datasets. If the storage type you want to use is not the one set under the DEFAULTS keyword, you might specify a different geometry storage configuration keyword and, therefore, use a different geometry storage type for data in the following situations:
- You are using either SQL Server or Oracle; you are only storing simple features, such as points, lines, and polygons, that will not participate in topology, a network, or relationship classes; and you do not need to have ArcSDE compression.
For feature classes that fit this description, you could specify the WKB_GEOMETRY configuration keyword to store the data in OGC WKB format.
- You are using an Oracle database, you want to use LOB storage, the total size of the data plus the storage locator is less than 4,000 bytes, and the Oracle ENABLE STORAGE IN ROW clause is specified.
If your data and database settings meet these qualifications, you might want to specify the SDELOB configuration keyword. Note that you can use SDELOB if the total size exceeds 4,000 bytes and/or the DISABLE STORAGE IN ROW clause is specified; however, query performance for that data will be negatively affected.
- You are using Oracle; you want to access the feature class's attributes using Structured Query Language (SQL); and you are only storing simple features, such as points, lines, and polygons, that do not participate in topology, a network, or relationship classes.
For feature classes that fit this description, you could specify the ST_GEOMETRY configuration keyword to store the data in the SQL ST_Geometry type for Oracle.
- You have Oracle Spatial or Oracle Locator enabled, but you only want to store some of your feature classes in SDO_GEOMETRY format.
In this case, you could specify the SDO_GEOMETRY configuration keyword when creating feature classes or raster datasets that meet these criteria.
- You have installed PostGIS, but you only want to store some of your feature classes in PostGIS geometry storage.
In this case, you could specify the PG_GEOMETRY configuration keyword when creating feature classes you want to store in the PostGIS geometry type.
- You are using SQL Server and you want to store your data in a SQL spatial type and projected coordinate system.
To create feature classes that meet these requirements, you can specify the GEOMETRY configuration keyword when the feature class is created.
- You are using SQL Server and you want to store data in a SQL spatial type that uses latitude and longitude coordinates.
For this, you can specify the GEOGRAPHY configuration keyword when you create the feature class.
- You are doing a prototype for your geodatabase and you want to test the relative performance of each storage type for a particular dataset.
When you are designing your geodatabase, you might want to try different storage types to see which ones fit your needs for particular datasets. In that case, you could store the same dataset (with a different name) using different geometry storage configuration keywords, then systematically test the performance of each dataset.
Your ArcSDE administrator may have created other, custom configuration keywords for you to use. In that case, the ArcSDE administrator should provide you with that information.
Raster storage configuration keywords
All geodatabases can store spatially referenced raster data.
Different storage types are available to store rasters in each DBMS. See Raster storage types in an ArcSDE geodatabase for a list of these data types.
The ArcSDE administrator sets the DEFAULTS raster storage to the type you will use for most datasets. If the storage type you want to use is not the one set under the DEFAULTS keyword, you have Oracle Spatial or Oracle Locator enabled, and you want to store some of your raster datasets in SDO_GEORASTER to access the raster using SQL, then you could specify the SDO_GEOMETRY configuration keyword when creating raster datasets that meet these criteria.
Your ArcSDE administrator may also have created custom keywords to specify other raster data types. Contact your ArcSDE administrator to find out if this is the case at your site.
Network configuration keywords
Network configuration keywords are used when you create networks.
Network configuration keywords are composite configuration keywords—three separate network keywords that work together to store tables from the same network class in different places. The network keywords present by default are as follows:
NETWORK_DEFAULTS NETWORK_DEFAULTS::DESC NETWORK_DEFAULTS::NETWORK
See Types of configuration keywords for information on composite keywords.
If you do not specify a configuration keyword for your network, the NETWORK_DEFAULTS keywords are used to define the storage for your network.
If you want to create a network class, the components of which you want to store using values different from the default values, create your own set of network keywords. For example, if you are going to create a network for your bus routes that you expect to be much larger than the networks for your rivers and railroads, the ArcSDE administrator could create a set of network configuration keywords to store the bus routes network in a different location in your geodatabase. The ArcSDE administrator could create keywords with the following names:
NETWORK_BUS NETWORK_BUS::DESC NETWORK_BUS::NETWORK
For each of these keywords, the administrator could specify config_string values different from those in the NETWORK_DEFAULTS keywords.
If NETWORK_DEFAULTS has the following parameters:
Keyword |
Parameter_name |
Config_string |
---|---|---|
NETWORK_DEFAULTS |
A_STORAGE |
PCTFREE 0 INITRANS 4 TABLESPACE CITY |
NETWORK_DEFAULTS |
D_STORAGE |
PCTFREE 0 INITRANS 4 TABLESPACE CITY |
NETWORK_BUS, an alteration of NETWORK_DEFAULTS, could have these parameters:
Keyword |
Parameter_name |
Config_string |
---|---|---|
NETWORK_BUS |
A_STORAGE |
PCTFREE 0 INITRANS 4 TABLESPACE BUS |
NETWORK_BUS |
D_STORAGE |
PCTFREE 0 INITRANS 4 TABLESPACE BUS |
If NETWORK_DEFAULTS::DESC has the following parameter settings:
Keyword |
Parameter_name |
Config_string |
---|---|---|
NETWORK_DEFAULTS::DESC |
A_STORAGE |
PCTFREE 0 INITRANS 4 TABLESPACE CITY |
NETWORK_DEFAULTS::DESC |
D_STORAGE |
PCTFREE 0 INITRANS 4 TABLESPACE CITY |
NETWORK_BUS::DESC, an altered copy of NETWORK_DEFAULTS::DESC, could have these settings:
Keyword |
Parameter_name |
Config_string |
---|---|---|
NETWORK_BUS::DEFAULTS |
A_STORAGE |
PCTFREE 0 INITRANS 4 TABLESPACE BUS |
NETWORK_BUS::DEFAULTS |
D_STORAGE |
PCTFREE 0 INITRANS 4 TABLESPACE BUS |
Finally, if NETWORK_DEFAULTS::NETWORK has these parameter values:
Keyword |
Parameter_name |
Config_string |
---|---|---|
NETWORK_DEFAULTS::NETWORK |
A_STORAGE |
PCTFREE 0 INITRANS 4 TABLESPACE CITY |
NETWORK_DEFAULTS::NETWORK |
D_STORAGE |
PCTFREE 0 INITRANS 4 TABLESPACE CITY |
NETWORK_BUS::NETWORK, an altered copy of NETWORK_DEFAULTS::NETWORK, could have the following parameter values:
Keyword |
Parameter_name |
Config_string |
---|---|---|
NETWORK_BUS::NETWORK |
A_STORAGE |
PCTFREE 0 INITRANS 4 TABLESPACE BUS |
NETWORK_BUS::NETWORK |
D_STORAGE |
PCTFREE 0 INITRANS 4 TABLESPACE BUS |
Topology configuration keywords
Whenever you create a topology, a topology configuration keyword is used to control the storage of the topology tables.
Topology configuration keywords are composite keywords. The default TOPOLOGY composite keywords are
TOPOLOGY_DEFAULTS TOPOLOGY_DEFAULTS::DIRTYAREAS
TOPOLOGY_DEFAULTS::DIRTYAREAS designates storage for the DIRTYAREAS topology table.
If you do not choose a different topology keyword when you create a topology, the TOPOLOGY_DEFAULTS and TOPOLOGY_DEFAULTS::DIRTYAREAS keywords are used to designate the storage of your topology tables.
To use a topology keyword other than the default, the ArcSDE administrator creates new topology keywords that designate different storage parameters from those in the defaults.
This process is described in the following example:
- You are using ArcSDE for Oracle.
- The majority of your data is stored using ArcSDE Compressed Binary (SDELOB) in the table space MAIN. All topologies created on this data are also stored in the table space MAIN. Some of the parameter values for TOPOLOGY_DEFAULTS are as follows:
TOPOLOGY_DEFAULTS exampleKeyword
Parameter_name
Config_string
TOPOLOGY_DEFAULTS
B_INDEX_ROWID
PCTFREE 0 INITRANS 4 TABLESPACE MAIN STORAGE (INITIAL 409600) NOLOGGING
TOPOLOGY_DEFAULTS
B_INDEX_SHAPE
PCTFREE 0 INITRANS 4 TABLESPACE MAIN STORAGE (INITIAL 409600) NOLOGGING
TOPOLOGY_DEFAULTS
B_INDEX_USER
PCTFREE 0 INITRANS 4 TABLESPACE MAIN STORAGE (INITIAL 409600) NOLOGGING
TOPOLOGY_DEFAULTS
B_STORAGE
PCTFREE 0 INITRANS 4 TABLESPACE MAIN STORAGE (INITIAL 409600)
- Some of your data is stored in the Oracle Spatial format (SDO_GEOMETRY) and in the table space SDO.
- All your data that participates in the same topology uses the same geometry storage type, as recommended.
- Since all your SDO_GEOMETRY data is stored in the table space SDO, you want the topology tables used with the SDO data to also be stored in the SDO table space.
- You ask the ArcSDE administrator to create custom topology keywords to designate this storage. The ArcSDE administrator creates and configures these keywords:
TOPOLOGY_SDO TOPOLOGY_SDO::DIRTYAREAS
Some of the parameter values for TOPOLOGY_SDO are as follows:
Keyword
Parameter_name
Config_string
TOPOLOGY_SDO
B_INDEX_ROWID
PCTFREE 0 INITRANS 4 TABLESPACE SDO STORAGE (INITIAL 409600) NOLOGGING
TOPOLOGY_SDO
B_INDEX_SHAPE
PCTFREE 0 INITRANS 4 TABLESPACE SDO STORAGE (INITIAL 409600) NOLOGGING
TOPOLOGY_SDO
B_INDEX_USER
PCTFREE 0 INITRANS 4 TABLESPACE SDO STORAGE (INITIAL 409600) NOLOGGING
TOPOLOGY_SDO
B_STORAGE
PCTFREE 0 INITRANS 4 TABLESPACE SDO STORAGE (INITIAL 409600)
- When you create topologies for your SDO_GEOMETRY data, specify the TOPOLOGY_SDO configuration keyword, thus storing all your topology tables in the SDO table space.
Terrain configuration keywords
Whenever you create a terrain, a terrain configuration keyword is used to control the storage of the terrain tables.
Terrain configuration keywords are composite keywords. The default TERRAIN composite keywords are
TERRAIN_DEFAULTS TERRAIN_DEFAULTS::EMBEDDED
TERRAIN_DEFAULTS::EMBEDDED controls the default storage of the DTM_<ID>_DISCONNECT_ <OID> table. TERRAIN_DEFAULTS controls the storage of all the other tables that make up a terrain dataset.
As with the network and topology keywords, your ArcSDE administrator can create custom keywords that specify different storage information.