Rebuild Indexes (Data Management Tools)

Summary

Rebuilds existing attribute or spatial indexes in an enterprise geodatabase. Indexes can also be rebuilt on states and state_lineage geodatabase system tables and the delta tables of datasets that are registered to participate in traditional versioning. Out-of-date indexes can lead to poor query performance.

Usage

Data must be from a database or an enterprise geodatabase. This tool does not work with file geodatabases.
After data loading, deleting, updating, and compressing operations, it is important to rebuild indexes.
This tool rebuilds the attribute and spatial indexes of base tables, delta tables, and archive tables in versioned and archive-enabled geodatabases.
The Include System Tables parameter determines if indexes are rebuilt on the states and state lineages tables in the specified geodatabase. When the option is unselected, the indexes on these tables are not rebuilt. If the Include System Tables parameter is unchecked, at least one dataset needs to be selected in the Datasets to Rebuild Indexes For to run the tool.
This tool is not supported with SAP HANA.
This tool cannot be used to rebuild full-text indexes.

Label	Explanation	Data type
Input Database Connection	The connection (`.sde` file) to the database or geodatabase that contains the data for which you want to rebuild indexes.	Workspace
Include System Tables	Specifies whether indexes will be rebuilt on the states and state lineages tables. Note: You must connect as the geodatabase administrator in the connection file you specified for the Input Database Connection parameter value. This option only applies to geodatabases. This option is ignored if you connect to a database. Checked—Indexes will be rebuilt on the states and state lineages tables. Unchecked—Indexes will not be rebuilt on the states and state lineages table. This is the default.	Boolean
Datasets to Rebuild Indexes For (Optional)	Names of the datasets that will have their indexes rebuilt. Only datasets that are owned by the connected user are displayed.	String
Rebuild Delta Tables Only (Optional)	Specifies how the indexes will be rebuilt on the selected datasets. This parameter has no effect when the Datasets to Rebuild Indexes For parameter value is unspecified. This option only applies to geodatabases. If the input workspace is a database, this parameter will be ignored. Checked—Indexes will only be rebuilt for the delta tables of the selected datasets. This option can be used for cases where the business tables for the selected datasets are not updated often and there is a high volume of edits in the delta tables. This is the default. Unchecked—Indexes will be rebuilt on all indexes for the selected datasets. This includes spatial indexes as well as user-created attribute indexes and any geodatabase-maintained indexes for the dataset.	Boolean

Derived output

Label	Explanation	Data type
Updated Workspace	The updated workspace.	Workspace

arcpy.management.RebuildIndexes(input_database, include_system, {in_datasets}, {delta_only})

Name	Explanation	Data type
input_database	The connection (`.sde` file) to the database or geodatabase that contains the data for which you want to rebuild indexes.	Workspace
include_system	Specifies whether indexes will be rebuilt on the states and state lineages tables. Note: You must connect as the geodatabase administrator in the connection file you specified for the `input_database` parameter value. This option only applies to geodatabases. This option is ignored if you connect to a database. `SYSTEM`—Indexes will be rebuilt on the states and state lineages tables. `NO_SYSTEM`—Indexes will not be rebuilt on the states and state lineages table. This is the default.	Boolean
in_datasets [in_datasets,...] (Optional)	Names of the datasets that will have their indexes rebuilt. Dataset names use paths relative to the `input_database`; full paths are not accepted as input.	String
delta_only (Optional)	Specifies how the indexes will be rebuilt on the selected datasets. This parameter has no effect when the `in_datasets` parameter value is unspecified. This option only applies to geodatabases. If the input workspace is a database, this option will be ignored. `ONLY_DELTAS`—Indexes will only be rebuilt for the delta tables of the selected datasets. This option can be used for cases where the business tables for the selected datasets are not updated often and there is a high volume of edits in the delta tables. This is the default. `ALL`—Indexes will be rebuilt on all indexes for the selected datasets. This includes spatial indexes as well as user-created attribute indexes and any geodatabase-maintained indexes for the dataset.	Boolean

Derived output

Name	Explanation	Data type
out_workspace	The updated workspace.	Workspace

Code sample

RebuildIndexes example 1 (Python window)

The following example demonstrates how to rebuild indexes using the Python window.

# Import system modules
import arcpy

arcpy.management.RebuildIndexes("c:/Connections/GDB@DC@server.sde", "NO_SYSTEM", "db1.GDB.Roads;db1.GDB.Parcels", "ALL")

RebuildIndexes example 2 (stand-alone script)

The following example demonstrates how to rebuild indexes in a stand-alone script.

# Name: RebuildIndexes.py
# Description: rebuilds indexes on delta tables for all datasets in an
# enterprise geodatabase that belong to the connected user

# Import system modules
import arcpy
import os

# set workspace
workspace = "C:/MyProject/mySDEConnection.sde"

# set the workspace environment
arcpy.env.workspace = workspace

# NOTE: Rebuild indexes can accept a Python list of datasets.

# Get a list of all the datasets the user has access to.
# First, get all the stand alone tables, feature classes and rasters.
dataList = arcpy.ListTables() + arcpy.ListFeatureClasses() + arcpy.ListRasters()

# Next, for feature datasets get all of the datasets and featureclasses
# from the list and add them to the master list.
for dataset in arcpy.ListDatasets("", "Feature"):
    arcpy.env.workspace = os.path.join(workspace,dataset)
    dataList += arcpy.ListFeatureClasses() + arcpy.ListDatasets()

# reset the workspace
arcpy.env.workspace = workspace

# Get the user name for the workspace
userName = arcpy.Describe(workspace).connectionProperties.user.lower()

# remove any datasets that are not owned by the connected user.
userDataList = [ds for ds in dataList if ds.lower().find(f".{userName}.") > -1]

# Run rebuild indexes
# Note: to use the "SYSTEM" option the workspace user must be an administrator.
arcpy.management.RebuildIndexes(workspace, "NO_SYSTEM", userDataList, "ALL")
print('Rebuild Complete')

Environments

Current Workspace

Licensing information

Basic: No
Standard: Yes
Advanced: Yes

Rebuild Indexes (Data Management Tools)

Summary

Usage

Parameters

Note:

Derived output

Environments

Licensing information

Related topics