Configuration Parameters
There are a number of configuration parameters in the SDE30_DEF
line that are used to define spatial column characteristics. They are described in the following table.
Note: The values populated in the Parameter box set values for configuration parameters.
Parameter |
Contents |
SDE_LAYER |
This defines the name of the spatial column within the table being defined. The spatial column is the column that contains the geometry of the feature. The following example gives the spatial column a name of SHAPE. It is recommended that SHAPE be used as the name. |
SDE_PRECISION |
This optional field specifies whether to set the precision to 32-bit or 64-bit. If not specified in a workspace/mapping file, then it will be set to 32-bit; however, all newly created workspaces/mapping files specify this field and set it to 64-bit. |
SDE_COORD_SYS_ID |
This optional field specifies the coordinate system of the spatial column. This is only used during the initial creation of a spatial column. The value is an integer value that corresponds to one of the predefined coordinate systems specified in ESRI’s Projection Engine documentation which is shipped with every SDE 30. Either SDE_COORD_SYS_ID or SDE_COORD_SYS_DESCRIPTION can be specified, but not both. If it is not specified, then the coordinate system will taken from the first feature written to each table. |
SDE_COORD_SYS_ |
This optional field specifies the coordinate system of the spatial column. This approach enables the entire projection to be specified using a description as defined in the Esri Projection Engine documentation that is shipped with every SDE 30. As mentioned above, you specify either SDE_COORD_SYS_ID or SDE_COORD_SYS_DESCRIPTION, but not both. If it is not specified, then the coordinate system will taken from the first feature written to each table. |
SDE_GRID{0} |
This is specified as part of a spatial column definition. It gives the size of the spatial index in the coordinate system of the layer (vector spatial column). Setting SDE_GRID{0} to certain special values can influence what grid type is created for a given DBMS, which can affect performance. For more information, see the Esri (Legacy) ArcSDE documentation (http://edndoc.esri.com/arcsde/9.3/api/capi/schemaobjects/layers/layerinfoSetGridSizes.htm). After the translation, the “Calculate Default Spatial Grid Index” tool (from ArcToolbox > Data Management Tools > Feature Class) can be used to calculate a valid spatial index. The following example defines the grid size of 200: SDE_GRID{0} 200 |
SDE_GRID{1} |
This optional parameter defines the level 2 grid element size. This is not needed for the majority of spatial columns. If specified, this must be at least 3 times the size of SDE_Grid{0}. If it is not desired, then either the value should not be specified or it should be given a value of 0. The following example defines a grid size of 600 for level 1 grid: |
SDE_GRID{2} |
This optional parameter defines the level 3 grid element size. This level grid is rarely required. If specified, this must be at least 3 times the SDE_GRID{1}. If it is not desired, then either the value should not be specified or it should be given a value of 0. The following example defines a grid size of 4000 for the level 2 grid: |
SDE_DIMENSION |
The SDE requires that all features within a feature class have the same dimension. This parameter defines the dimension of the layer (vector spatial column). Currently, the dimension can be either 2 or 3. The example below defines the layer to have a dimension of 2: |
SDE_UPDATE_FIELDS |
The list of field names that are used by the SDE Writer when it is operating in UPDATE mode. If the table is either registered as multi-versioned or contains a spatial column, then this configuration parameter is optional. In general, this should identify a unique feature but can also be used to update multiple features if desired. The following example sets the update fields to be country and capital: |
SDE_XORIGIN |
The minimum x value of the spatial column being defined. No coordinate values can be less than the value specified here. This parameter corresponds to the Min X property of the Feature Class’s domain in ArcGIS. For raster catalogs, this value should be calculated from the lower left corner of the lower-leftmost raster to be added to the catalog. If the value is unspecified, the footprint column will not be created; however, the footprint column will automatically be created when the table is registered with Geodatabase. The example below defines the lower extent of a spatial column to be -180: |
SDE_YORIGIN |
The minimum y value of the spatial column being defined. No coordinate values can be less than the value specified here. This parameter corresponds to the Min Y property of the Feature Class’s domain in ArcGIS. For raster catalogs, this value should be calculated from the lower left corner of the lower-leftmost raster to be added to the catalog. If the value is unspecified, the footprint column will not be created; however, the footprint column will automatically be created when the table is registered with Geodatabase. The example below defines the lower extent of a spatial column to be -90: |
SDE_SCALE |
The scale of the spatial column. This defines the number of units per user coordinate stored within the spatial column. For raster catalogs, if this value is unspecified, the footprint column will not be created; however, the footprint column will automatically be created when the table is registered with Geodatabase. The example below defines the scale to be 100: This is equivalent to 2 decimal places to the right of the decimal in user coordinates. |
SDE_ZORIGIN |
The minimum z value stored within the spatial column. This parameter corresponds to the Min Z property of the Feature Class’s domain in ArcGIS. The example below defines the minimum z value to be 0: |
SDE_ZSCALE |
The scale of the spatial column z coordinate. This defines the number of units per user coordinate stored within the spatial column. This parameter corresponds to the inverse of a Feature Class's Z resolution in ArcGIS. The example below defines the z scale to be 100: This is equivalent to 2 decimal places to the right of the decimal in user coordinates. |
SDE_MEASURED_ORIGIN |
The minimum measure value that is stored within the spatial column. The example below defines the minimum measure value to be 0: |
SDE_MEASURED_SCALE |
The scale of the spatial column measured value. This defines the number of units per user coordinate that are stored within the spatial column. The example below defines the measured scale to be 100: This is equivalent to 2 decimal places to the right of the decimal in user coordinates. |
SDE_DESCRIPTION |
The description of the spatial column, which is just free text. |
SDE_MINIMUM_FID |
The minimum feature ID assigned to shapes stored in the layer (vector spatial column). When the SDE stores shapes in a table, each shape is given an ID number that is unique throughout the table. If not specified, then the Feature ID starts at 1 for each spatial column. The only time this value needs to be specified is when tricks are being performed using the underlying RDBMS in which you want the Feature ID to be unique through a set of tables rather than throughout a single table. The example below results in the feature IDs starting at 100000 for the table upon which the statement is specified: |
SDE_CONFIG_KEYWORD |
The SDE configuration keyword specifies the storage parameters for the layer (vector spatial column) or raster column. If not specified, the keyword DEFAULTS will be used. For more information, search parameter name-configuration string pairs in Esri ArcGIS Server help files. The example below uses a configuration keyword of TEST: |
SDE_MEASURED |
Y – The spatial column allows measures to be specified on each coordinate of the features. N – The spatial column does not allow measures. |
SDE_ANNOTATED |
Y – The spatial column allows annotation to be specified. N – The spatial column does not allow annotations. |
SDE_AREA |
Y – The spatial column allows area features to be stored. N – The spatial column does not allow area features to be stored. |
SDE_LINE |
Y – The spatial column allows linear features to be stored. Line features are those linear features that may touch or cross over themselves. N – The spatial column does not allow linear features to be stored. |
SDE_POINT |
Y – The spatial column allows point features to be stored. N – The spatial column does not allow points. |
SDE_SIMPLE_LINE |
Y – The spatial column allows simple lines to be stored. Simple lines are lines that do not touch or cross over themselves. N – The spatial column does not allow simple lines. |
SDE_NIL |
Y – The spatial column allows NIL features to be stored. NIL features are features that have a shape object with no coordinates. N – The spatial column does not allow NIL features. |
SDE_MULTIPART |
Y – The spatial column allows features that have multiple parts. Multi-part features must be homogeneous. That is, all parts must be either area, linear, or point within a single feature. N – The spatial column does not allow features which have multiple parts. |
SDE_CAD |
Y – The layer (vector spatial column) allows CAD data to be stored with it. This is for CAD client layers. FME is not capable of storing data in the CAD blob associated with the layer. N – The layer does not allow CAD data. |
SDE_STORAGE_TYPE |
SDE_BINARY – the feature geometry for the layer (vector spatial column) is stored in SDE binary mode. WKB – the feature geometry for the layer is stored in SDE using the OGC Well Known Binary form. ArcSDE 8.x only. SQL – Stored as SQL or well known text format. ArcSDE 8.x only. NORMALIZED – Normalized format (used for Oracle Spatial Only). ArcSDE8.x only. |
SDE_DROP_TABLE |
Specifies that the SDE writer drop the table before writing, and create a new one. For raster tables, the associated raster column and band information tables will be dropped as well. If the table does not exist, it will be created when the data is written. The writer expects that the general table type (i.e. raster, feature class/vector, business/non-spatial) of the new table will be the same as the table being deleted, with the exception of business tables where it is possible to delete a business table but create a feature class. The following example sets the drop table flag to false. Note: This parameter is valid only if the feature reaches the writer. SDE_DROP_TABLE NO Default: NO Values: YES |NO |
SDE_TRUNCATE_TABLE |
Specifies that the SDE writer truncate the table before writing. For raster tables, the associated raster column and band information tables will be truncated as well. If the table does not exist, it will be created when the data is written. The following example sets the truncate table flag to false. Note: This parameter is valid only if the feature reaches the writer. SDE_TRUNCATE_TABLE NO Default: NO Values: YES |NO |
SDE_TOLERANCE |
The cluster tolerance of the XY values in the spatial column. This value represents an extremely small distance used to resolve inexact intersection locations of coordinates during clustering operations. The XY tolerance is the minimum distance allowed between XY coordinates before they are considered equal. It is used in clustering operations such as topology validation, buffer generation, polygon overlay and for some editing operations. Tolerance is not used for raster data. If a tolerance value is not specified, a default value will be used based on a conversion of 0.001 meters in the unit of the source coordinate system. The example below defines the xy tolerance to be 0.001: |
SDE_MEASURED_TOLERANCE |
The cluster tolerance of the measured values in the spatial column. This value represents an extremely small distance used to resolve inexact intersection locations of coordinates during clustering operations. The measured tolerance is the minimum distance allowed between M values before they are considered equal. It is used in clustering operations such as topology validation, buffer generation, polygon overlay and for some editing operations. If a tolerance value is not specified, a default value will be used based on a conversion of 0.001 meters in the unit of the source coordinate system. The example below defines the measured tolerance to be 0.001: |
SDE_ZTOLERANCE |
The cluster tolerance of the Z values in the spatial column. This value represents an extremely small distance used to resolve inexact intersection locations of coordinates during clustering operations. The Z tolerance is the minimum distance allowed between Z values before they are considered equal. It is used in clustering operations such as topology validation, buffer generation, polygon overlay and for some editing operations. Tolerance is not used for raster data. If a tolerance value is not specified, a default value will be used based on a conversion of 0.001 meters in the unit of the source coordinate system. The example below defines the Z tolerance to be 0.001: |
SDE_RASTER |
This defines the name of the raster column within the table being defined. The raster column is the column that defines the geometry of the table as raster and contains the geometry of the features in the table. If a table definition has both a spatial and a raster column, the spatial column will be ignored. The following example gives the raster column a name of RASTER. It is recommended that RASTER be used as the name. |
SDE_COMPRESS_TYPE |
This defines the type of compression to for the raster table being defined. The following example gives the raster column a compression type of LZ77. Default: NONE Values: NONE | LZ77 | JPEG | JPEG2000 Note: LZ77 is the only valid compression option for images with a colormap. Also, JPEG2000 compression is only available on rasters with an 8-bit pixel depth and no colormap. |
SDE_PYRAMID_INTERPOLATION |
This defines the interpolation type of pyramid creation for the table being defined. The following example gives the raster column a pyramid interpolation type NEAREST_NEIGHBOR. Default: NONE Values: NONE | NEAREST_NEIGHBOR | BILINEAR | BICUBIC Note: A value of NONE disables pyramid creation and disregards the other pyramid settings. Also note that nearest neighbor is the only valid pyramid setting for classified raster data. |
SDE_PYRAMID_LEVEL_TYPE |
This defines the way the maximum pyramid level is set for the raster table being defined. The following example gives the raster column sets a maximum pyramid level to be automatically calculated. Default: NONE Values: NONE | AUTO | CUSTOM Note: A value of NONE disables pyramid creation and disregards the other pyramid settings. |
SDE_PYRAMID_MAX_LEVEL |
This defines the maximum pyramid level to be created for the table being defined. The following example gives the raster column sets a maximum pyramid level to be automatically calculated. Note: This setting is only used if the pyramid level type is set to the value CUSTOM. |
SDE_RASTER_STATS_TYPE |
This defines the type of statistics calculation for the raster table being defined. The following example gives the user automatic determination of a statistics calculation function. Default: NONE Values: NONE | AUTO Note: A value of NONE turns statistics calculation off for this table. |
SDE_RASTER_MOSAIC_ |
Specifies the mosaic mode that will be used when mosaicking data to an SDE rastermap. The default is MERGE. A value of NONE means that new data will completely replace existing raster data, and no mosaic is applied. MERGE causes the data to be mosaicked, replacing existing pixel values with new pixel values where they overlap, and leaving all other data untouched. The NoData values in the existing raster are not altered. DELETE mode does not mosaic any new data, but rather has the sole purpose of deleting data in the existing raster. This is accomplished by deleting pixel data where the new raster overlaps the existing raster and the value for that pixel location in the new raster is nodata. MERGE and DELETE modes are ignored on insert, and are only valid for a mosaic operation. The following example sets the mosaic mode to merge. SDE_RASTER_MOSAIC_MODE MERGE Default: MERGE Values: NONE | MERGE | DELETE |
SDE_RASTER_COMPRESS_ |
This is used with palette colored rasters written to a raster map in SDE. It specifies whether the colormap is to be compressed or untouched. Compressing a colormap will remove any invalid entries, and possibly make future mosaic operations to the same table faster and less likely to approximate colors. The following example sets the compress colormap flag to true: SDE_RASTER_COMPRESS_COLORMAP YES Default: YES Values: YES | NO |