sdedbtune

The sdedbtune command manages parameters of the DBTUNE table (SDE_dbtune table in SQL Server and PostgreSQL databases).

Usage syntax

sdedbtune -o alter -k <keyword_name> -P <parameter_name> -v <parameter_value>
[-i {<service> | <port#> | <direct connection>}] [-s <server_name>]
[-D <database_name>] -u <ArcSDE_admin_user_name> [-p <ArcSDE_admin_password]
[-N] [-q]

sdedbtune -o delete_data -k <keyword_name> -P <parameter_name>
[-i {<service> | <port#> | <direct connection>}] [-s <server_name>]
[-D <database_name>] -u <ArcSDE_admin_user_name>
[-p <ArcSDE_admin_password>] [-N] [-q]

sdedbtune -o export -f <DBTune file> [-s <server_name>]
[-i {<service> | <port#> | <direct connection>}] [-D <database_name>]
-u <DB_user_name> [-p <DB_user_password>] [-N] [-q]

sdedbtune -o import -f <DBTune file> [-s <server_name>]
[-i {<service> | <port#> | <direct connection>}] [-D <database_name>]
-u <ArcSDE_admin_user_name> [-p <ArcSDE_admin_password>] [-N] [-q]

sdedbtune -o insert -k <keyword_name> -P <parameter_name> -v <parameter_value>
[-i {<service> | <port#> | <direct connection>}] [-s <server_name>] [-D <database_name>]
-u <ArcSDE_admin_user_name> [-p <ArcSDE_admin_password>] [-N] [-q]

sdedbtune -o list {[-l <keywords|parameters>]|[-k <keyword_name>]}
[-P <parameter_name>] [-i {<service> | <port#> | <direct connection>}]
[-s <server_name>] [-D <database_name>][-u <DB_user_name>]
[-p <DB_user_password>][-q]

sdedbtune -h

sdedbtune -?

Operations

Operation	Description	Example
alter	Allows you to alter the value of a configuration parameter in the DBTUNE table	Change a configuration string value
delete_data	Deletes a configuration keyword or keyword/parameter combination from the DBTUNE table	Delete a configuration keyword and its parameters
export	Exports entire DBTUNE table to the specified dbtune file on the local machine	Export the contents of the DBTUNE table
import	Imports dbtune file into the DBTUNE table for the specified database	Import a dbtune file
insert	Inserts a configuration parameter and configuration string value or a configuration keyword, parameter, and configuration string value to the DBTUNE table	Insert new keywords or parameters
list	Returns all parameters for a specified keyword, a list of all keywords, or a list of allowed parameters	List keywords and parameters

Options

Options	Description
-D	Database name (not supported in Oracle)
-f	DBTUNE file name and path to file If no directory is specified with the path name, the file is exported to and imported from whichever directory the command is issued.
-h or -?	Use either of these options to see the usage and options for the command. Note: If using a C shell, use -h or "-\?".
-i	ArcSDE service name, port number, or direct connection information (default: esri_sde or 5151)
-k	Configuration keyword present in the DBTUNE (or sde_dbtune) table
-l	List options
-N	No verification is performed; the operation begins immediately after being invoked.
-o	Operation
-p	DBMS user password for ArcSDE administrator (for list and export, can be password of a nonadminstrative DBMS user)
-P	DBTUNE configuration parameter name
-q	Quiet—all titles and warnings are suppressed.
-s	ArcSDE server host name (default: localhost)
-u	DBMS user name for ArcSDE administrator (for the list and export operations, can be a nonadministrative DBMS user)
-v	The value to assign to a configuration parameter

Discussion

The DBTUNE table (SDE_dbtune in SQL Server and PostgreSQL databases) contains configuration keyword and parameter name/configuration string pairs that control how data is stored in your database. You should edit values in the DBTUNE table either by using the alter or delete_data operations. To add new keywords or parameters, you can use the insert operation or the export and import operations.

In ArcSDE 9.1 or lower, the only way to edit the contents of the DBTUNE table was to export its contents to a dbtune file in the SDEHOME/etc directory, alter the file with a text editor, and import it back to the table. Beginning with release 9.2, the dbtune file doesn't have to be in the SDEHOME/etc directory.

If you want to delete a keyword and its parameters or just specific parameters for a particular keyword, you must use the delete_data operation, not export/import.

sdedbtune –o delete_data -k <keyword_name> [-P <parameter_name]

For more information regarding the DBTUNE configuration keywords and parameters, refer to the topic "What is the dbtune file?", "What is the DBTUNE table", and "What are configuration keywords and parameters?" in the ArcGIS Desktop or ArcGIS Server on-line help, which can be accessed from the ESRI Resource Center.

Examples

Change a configuration string value

The alter operation can be used by the ArcSDE administrator to change the configuration string value of a given configuration parameter for a specific configuration keyword. Since configuration parameters can be used with multiple configuration keywords, you must specify the keyword and parameter name in the command.

The following example alters the A_STORAGE parameter under the DEFAULTS keyword in the DBTUNE table of an Oracle database.

sdedbtune -o alter -k DEFAULTS -P A_STORAGE -v "TABLESPACE GIS_DATA PCTFREE 0 INITRANS 4" -u sde -N

Enter Database User password:

Attribute Administration Utility
----------------------------------------------------

Successfully altered dbtune data.

Delete a configuration keyword and its parameters

To delete an entire configuration keyword and its parameters or a specific parameter associated with a keyword, the ArcSDE administrative user would use the delete_data operation. Be sure the keyword is truly no longer needed by other users or applications, such as an ArcIMS Map Service, before you delete it.

In the first example below, the entire keyword is being deleted. In the next example, only the UI_TEXT parameter of the WKB_GEOMETRY keyword is being deleted.

sdedbtune -o delete_data -k DEFAULTS_ARCHIVE -u sde -p sdepswd

Attribute Administration Utility
----------------------------------------------------
Delete DBTUNE data. Are you sure? (Y/N): y

Successfully deleted data from dbtune table.

sdedbtune -o delete_data -k WKB_GEOMETRY -P UI_TEXT -u sde -p sdepswd

ArcSDE for SQL Server           Mon Aug 1 16:00:45 2005
Attribute           Administration Utility
----------------------------------------------------
Delete DBTUNE data. Are you sure? (Y/N): y

              Successfully deleted data from dbtune table.

Export the contents of the DBTUNE table

The export operation exports the entire DBTUNE table to a file for editing. The file can then be edited with a file-based editor, such as vi or Microsoft's Notepad, and imported back into the DBTUNE table using the import operation. You might do this if you have a number of keywords or parameters you want to add to the DBTUNE table.

Any database user can export the contents of the DBTUNE table; however, only the ArcSDE administrative user can import the dbtune file.

In this example, the dbtune file dbtune3.sde is exported to the ArcSDE directory located in c:\GISfiles. If no directory had been included with the -f option, the file would have been saved to c:\ because that is the directory from which the command was executed.

sdedbtune -o export -f c:\GISfiles\ArcSDE\dbtune3.sde -N -u sde -i 7200

Enter Database User password:

Attribute               Administration Utility
-------------------------------------------------------------------------------------------

            Successfully exported to file "c:\GISfiles\ArcSDE\dbtune3.sde"
            from server rocky

Note that since the -p <password> option is not specified in the command, the password prompt appears. Also note that in ArcSDE 9.1 and prior releases, the dbtune file had to be exported to SDEHOME\etc.

When you export the DBTUNE table from a database on a remote server, the dbtune file is created on the machine from which you execute the sdedbtune -o export command. So in the preceding example, if you were executing the command from your PC but the database is on a server named rocky, the exported file would be in the c:\GISfiles\ArcSDE directory on your PC.

Import a dbtune file

The import operation imports the contents of the dbtune file into the DBTUNE table for the specified database. Only the values present in the dbtune file will be imported back into the DBTUNE table after the table is initially created. Only the ArcSDE administrator can import the dbtune file.

Note: Do not attempt to import the file while tables or layers are being created or altered.

sdedbtune -o import -f c:\GISfiles\ArcSDE\dbtune3.sde -u sde

Enter Database User password:

Attribute Administration Utility
----------------------------------------------------
Import DBTUNE Table. Are you sure? (Y/N): y

Successfully imported from file "c:\GISfiles\ArcSDE\dbtune3.sde"

Since -N was not specified in the preceding example, the verification prompt appears and "y" must be typed before the import completes.

Insert new keywords or parameters

Use the insert operation to insert a new keyword to the DBTUNE table, insert a new keyword and a parameter for that keyword, or insert a a parameter to an existing keyword. Only the ArcSDE administrative user can insert keywords or parameters to the DBTUNE table.

In this example, a new keyword, ST_GEOMETRY, and a parameter, GEOMETRY_STORAGE, is inserted to the DBTUNE table of a PostgreSQL geodatabase.

sdedbtune -o insert -k ST_GEOMETRY -P GEOMETRY_STORAGE -v "ST_GEOMETRY" -i 5000 -D pg -u sde

If you specify an invalid parameter, you will receive an error message. (Remember, you cannot invent new parameters and values; you can only add valid parameters. For a list of these parameters, see the ArcGIS Server or ArcGIS Desktop help topic "DBTUNE configuration parameter name-configuration string pairs".)

To make the newly added ST_GEOMETRY keyword available for ArcGIS Desktop users, a UI_TEXT parameter is added to the ST_GEOMETRY keyword.

sdedbtune -o insert -k ST_GEOMETRY -P UI_TEXT -v "User-interface parameter" -i 5000 -D pg -u sde

Since this keyword only needs two parameters, you could use the insert operation as shown in this example. If, instead, you added a new keyword that required a large number of parameters, it might be more expedient to export the DBTUNE table with the export operation, alter the file, and import it with the import operation.

Only the ArcSDE administrator can insert a configuration keyword or parameter.

List keywords and parameters

The list operation returns either all parameters for a specified keyword, all of the allowed parameters, all of the keywords in the DBTUNE table, or, if no keywords are specified, list returns the entire contents of the DBTUNE table. Any database user can use the list operation. The example below lists the parameters for the WKB_GEOMETRY keyword to ensure that the UI_TEXT parameter was actually deleted when the previous example was executed.

sdedbtune -o list -k WKB_GEOMETRY

Enter Database User password:

Attribute Administration Utility
----------------------------------------------------
##WKB_GEOMETRY

GEOMETRY_STORAGE "OGCWKB"

END

Note that the -u option didn't need to be specified in the command, but a database user's password was still required. For the list operation, the password provided can be that of any valid database user.

When you specify the -l parameters option, a list of the parameters allowed for your DBTUNE table is returned.

sdedbtune -o list -l parameters

Enter Database User password:

Attribute           Administration Utility
----------------------------------------------------
Allowed parameters for DBTUNE table are:

     F_STORAGE
     F_INDEX_AREA
     F_INDEX_LEN
     F_INDEX_FID
     S_STORAGE
     S_INDEX_SP_FID
     S_INDEX_ALL
     B_STORAGE

     ...the rest of the parameters...

When you specify the -l keywords option, a list of the keywords currently found in the DBTUNE table is returned.

sdedbtune -o list -l keywords

Enter Database User password:

Attribute           Administration Utility
----------------------------------------------------
Keywords found in DBTUNE table are:

     DATA_DICTIONARY
     DEFAULTS
     LOGFILE_DEFAULTS
     NETWORK_DEFAULTS
     NETWORK_DEFAULTS::DESC
     NETWORK_DEFAULTS::NETWORK
     SURVEY_MULTI_BINARY
     TERRAIN_DEFAULTS
     TERRAIN_DEFAULTS::EMBEDDED
     TOPOLOGY_DEFAULTS
     TOPOLOGY_DEFAULTS::DIRTYAREAS
     WKB_GEOMETRY

If you specify only the list operation, all keywords and parameters will be returned. This list is usually long, however, and in most cases when using the MS-DOS cmd window, you will not be able to scroll back through the entire list.

sdedbtune -o list
Enter Database User password:

Home