Add Full-Text Index (Data Management Tools)

Summary

Adds a full-text index to specified text fields to support searching by an individual column or by multiple columns.

The input table or feature class must be stored in a database, or a SQLite or mobile geodatabase. File geodatabases are not supported. Full-text indexes are supported for the following database platforms:
- Db2
- PostgreSQL
- SAP HANA
- SQL Server
- Oracle
This tool does not support views or tables that are registered as traditional versioned.
For tables stored in SQL Server, SQLite, or mobile geodatabases, the full-text index name will be generated and managed by ArcGIS.
For tables stored in Oracle, consider the following:
- You may need to run the Migrate Text Field tool before this tool to convert the text field type to a compatible non-Unicode string type before adding a full-text index.
- ArcGIS creates a full-text index with auto sync off. For the full-text index to pick up the latest updates, sync or rebuild the full-text index in the database. Refer to the Oracle documentation for instructions on how to complete these operations.

Label	Explanation	Data type
Input Table	The table containing the fields that will be indexed.	Table View
Fields To Index	The text fields that will be indexed. Some databases only support a single field for full-text index creation. Support for creation of a multiple field full-text index varies based on the database.	Field
Full-Text Index Name (Optional)	The name of the index that will be created. For SQL Server, SQLite, and mobile geodatabases, this parameter will be ignored.	String
Full-Text Catalog Name (Optional)	The existing full-text catalog name. This parameter is only applicable for SQL Server. When the SQL Server database has a default full-text catalog defined, the tool will use the default catalog, and this parameter will be optional. When the SQL Server database does not have a default full-text catalog defined, provide the name of the existing full-text catalog.	String
Synchronize On Commit (Optional)	Specifies whether a full-text index will be updated automatically when edits are saved or an ArcGIS sync operation is performed. This parameter is only applicable for Oracle databases. Checked—The full-text index will be updated automatically when edits are saved or an ArcGIS sync operation is performed. Unchecked—The full-text index will not be updated automatically when edits are saved or an ArcGIS sync operation is performed.	Boolean

Label	Explanation	Data type
Updated Table	The updated table with a full-text index added.	Table View

arcpy.management.AddFullTextIndex(in_table, fields, {index_name}, {catalog_name}, {sync_on_commit})

Name	Explanation	Data type
in_table	The table containing the fields that will be indexed.	Table View
fields [fields,...]	The text fields that will be indexed. Some databases only support a single field for full-text index creation. Support for creation of a multiple field full-text index varies based on the database.	Field
index_name (Optional)	The name of the index that will be created. For SQL Server, SQLite, and mobile geodatabases, this parameter will be ignored.	String
catalog_name (Optional)	The existing full-text catalog name. This parameter is only applicable for SQL Server. When the SQL Server database has a default full-text catalog defined, the tool will use the default catalog, and this parameter will be optional. When the SQL Server database does not have a default full-text catalog defined, provide the name of the existing full-text catalog.	String
sync_on_commit (Optional)	Specifies whether a full-text index will be updated automatically when edits are saved or an ArcGIS sync operation is performed. This parameter is only applicable for Oracle databases. `SYNC_ON_COMMIT`—The full-text index will be updated automatically when edits are saved or an ArcGIS sync operation is performed. `NOT_SYNC_ON_COMMIT`—The full-text index will not be updated automatically when edits are saved or an ArcGIS sync operation is performed.	Boolean

Name	Explanation	Data type
out_table	The updated table with a full-text index added.	Table View

AddFullTextIndex example 1 (Python window)

The following code demonstrates how to create a full-text index for multiple fields in a table stored in a SQL Server geodatabase.

import arcpy
arcpy.management.AddFullTextIndex("C:/MyProject/mySQLConn.sde/user1.lakes", ["NAME", "geoID"], "", "catalog_name")

AddFullTextIndex example 2 (Python window)

The following code demonstrates how to create a full-text index for a single field in a table stored in a PostgreSQL geodatabase.

import arcpy
arcpy.management.AddFullTextIndex("C:/MyProject/myPGConn.sde/mygdb.user1.lakes", "geoID", "myfulltextindex")

This tool does not use any geoprocessing environments.