Add Incrementing ID Field (Data Management)

Summary

Adds a database-maintained, incrementing ID field to an existing table or feature class in a Dameng, IBM Db2, Microsoft Azure SQL Database, Microsoft SQL Server, Oracle, or PostgreSQL database. A database-maintained ID field is required for all feature classes or tables you plan to edit through a feature service.

Usage

    Caution:

    This tool modifies the input data. See Tools that modify or update the input data for more information and strategies to avoid undesired data changes.

  • You cannot run this tool on tables or feature classes that are registered with the geodatabase.

  • You must be the owner of the table or feature class to add an ID field to it.

  • If you do not specify a name for the field, ObjectID is used by default. If a field named ObjectID already exists, the tool will not run until you provide a different name.

  • If a database-maintained, incrementing ID field already exists, this tool will not add another one.

  • The following field types will be added:

    DBMSData type

    Dameng

    int32 with identity property

    Db2

    integer as identity

    Oracle

    number with identity

    PostgreSQL

    serial

    SQL Server

    integer with identity property

Parameters

LabelExplanationData Type
Input Table

The location and name of the table or feature class to which an ID field will be added.

Table View
Field Name
(Optional)

The name to be used for the ID field. If no input is provided, the default ObjectID will be used.

String

Derived Output

LabelExplanationData Type
Updated Input Table

The input table that is updated to include an incrementing ID field.

Table

arcpy.management.AddIncrementingIDField(in_table, {field_name})
NameExplanationData Type
in_table

The location and name of the table or feature class to which an ID field will be added.

Table View
field_name
(Optional)

The name to be used for the ID field. If no input is provided, the default ObjectID will be used.

String

Derived Output

NameExplanationData Type
out_table

The input table that is updated to include an incrementing ID field.

Table

Code sample

AddIncrementingIDField example (Python window)

Adds an ID field—FSID—to a table named violations owned by user insp when run from the Python window.


import arcpy
arcpy.management.AddIncrementingIDField("C:/Data/DatabaseConnections/mydb.sde/insp.violations", "FSID")

Environments

This tool does not use any geoprocessing environments.

Related topics