Calculate Fields (multiple) (Data Management)

Summary

Calculates the values of two or more fields for a feature class, feature layer, or raster.

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.

  • To learn more about Python expressions, see Calculate Field Python examples.

    To learn more about Arcade expressions, see the ArcGIS Arcade guide.

    To learn more about SQL expressions, see Calculate field values.

    To learn more about VBScript expressions, see Calculate Field VBScript examples.

  • When used with a selected set of features, such as those created from a query using the Make Feature Layer or Select Layer By Attribute tool, this tool will only update the selected records.

  • Existing field values will be overwritten. Make a copy of the input table if you want to preserve the original values.

  • For Python calculations, field names must be enclosed in exclamation points (for example, !fieldname!).

    For Arcade calculations, field names must be prefixed with $feature. (for example, $feature.fieldname).

  • To calculate strings to text or character fields, on the dialog box, the string must use double quotation marks (for example, "string"), or in scripting, the string using double quotation marks must also be enclosed in single quotation marks (for example, '"string"').

  • To calculate a field to be a numeric value, enter the numeric value in the Expression parameter with no quotation marks around the value.

  • You can create complex expressions using the Code Block parameter. Enter the code block either directly on the dialog box or as a string in scripting. The expression and code block are connected. The code block must relate back to the expression; the result of the code block must be passed to the expression.

    The Code Block parameter is only supported for Python expressions.

  • You can use the Python math module and formatting in the Code Block parameter. You can also import additional modules. The math module provides number-theoretic and representation functions, power and logarithmic functions, trigonometric functions, angular conversion functions, hyperbolic functions, and mathematical constants. To learn more about the math module, see the Python help.

  • To calculate geometry information in Python, use Geometry object properties. For example, use an expression of !shape.pointCount! to calculate the number of vertices in a feature.

    Note:

    The Calculate Geometry Attributes tool supports similar calculations.

    To calculate area and length in Python, use the getArea and getLength methods with a method and unit type.

    • To calculate the geodesic area of polygons in square kilometers, use the following expression:
      !shape.getArea('GEODESIC', 'SQUAREKILOMETERS')!
    • To calculate the planar length of polylines (or polygons) in yards, use the following expression:
      !shape.getArea('PLANAR', 'YARDS')

    See the Polygon and Polyline objects for more information.

    Learn more about geoprocessing tools and linear and areal units

  • When working with joined data, you can only update fields from the origin table. You cannot update fields from the joined table. To perform a calculation on the joined table, perform the calculation directly on that table.

  • Python expressions that attempt to concatenate string fields that include a null or divide by zero value will return null for that field value.

  • SQL expressions support faster calculations for feature services and enterprise geodatabases. Instead of performing calculations one feature or row at a time, a single request is sent to the server or database, resulting in faster calculations.

    Only feature services and enterprise geodatabases support SQL expressions. For other formats, use Python or Arcade expressions.

    Using the SQL option for the Expression Type parameter has the following limitations:

    • The option is only supported for Db2, Oracle, PostgreSQL, SAP HANA, and SQL Server enterprise geodatabases.
    • Calculating field values on joined tables is not supported.
    • Versioned and archived enterprise geodatabase data is not supported.
    • Undoing geoprocessing operations is not supported.

    See your database vendor documentation for SQL expression help.

Parameters

LabelExplanationData Type
Input Table

The table containing the fields that will be updated with the new calculations.

Table View; Raster Layer; Mosaic Layer
Expression Type

Specifies the type of expression that will be used.

If the input is a feature service, the default expression type is SQL. For any other type of input, the default expression type is Python.

To learn more about Python expressions, see Calculate Field Python examples.

To learn more about Arcade expressions, see the ArcGIS Arcade guide.

To learn more about SQL expressions, see Calculate field values.

To learn more about VBScript expressions, see Calculate Field VBScript examples.

  • PythonThe Python expression type will be used.
  • ArcadeThe Arcade expression type will be used.
  • SQLThe SQL expression type will be used.
  • VBScriptThe VBScript expression type will be used.
String
Fields

The fields that will be calculated, their expressions, and a where clause.

The optional SQL expression will be used to select a subset of records. Only records that match this where clause will be calculated. If the where clause is left blank, all records will be calculated. For more information about SQL syntax, see SQL reference for query expressions used in ArcGIS.

Value Table
Code Block
(Optional)

A block of code that will be used for complex expressions.

A function cannot be used to return multiple values.

String
Enforce Domains
(Optional)

Specifies whether field domain rules will be enforced.

  • Checked—Field domain rules will be enforced. If a field cannot be updated, the field value will remain unchanged, and the tool messages will include a warning message.
  • Unchecked—Field domain rules will not be enforced. This is the default
Boolean

Derived Output

LabelExplanationData Type
Output Table

The updated table.

Table View; Raster Layer; Mosaic Layer

arcpy.management.CalculateFields(in_table, expression_type, fields, {code_block}, {enforce_domains})
NameExplanationData Type
in_table

The table containing the fields that will be updated with the new calculations.

Table View; Raster Layer; Mosaic Layer
expression_type

Specifies the type of expression that will be used.

  • PYTHON3The Python expression type will be used.
  • ARCADEThe Arcade expression type will be used.
  • SQLThe SQL expression type will be used.
  • VBThe VBScript expression type will be used.

If the input is a feature service, the default expression type is SQL. For any other type of input, the default expression type is PYTHON3.

To learn more about Python expressions, see Calculate Field Python examples.

To learn more about Arcade expressions, see the ArcGIS Arcade guide.

To learn more about SQL expressions, see Calculate field values.

To learn more about VBScript expressions, see Calculate Field VBScript examples.

String
fields
[[Field Name, Expression, {Where Clause}],...]

The fields that will be calculated, their expressions, and a where clause.

The optional SQL expression will be used to select a subset of records. Only records that match this where clause will be calculated. If the where clause is left blank, all records will be calculated. For more information about SQL syntax, see SQL reference for query expressions used in ArcGIS.

Value Table
code_block
(Optional)

A block of code that will be used for complex expressions.

A function cannot be used to return multiple values.

String
enforce_domains
(Optional)

Specifies whether field domain rules will be enforced.

  • ENFORCE_DOMAINSField domain rules will be enforced.
  • NO_ENFORCE_DOMAINSField domain rules will not be enforced. This is the default.
Boolean

Derived Output

NameExplanationData Type
out_table

The updated table.

Table View; Raster Layer; Mosaic Layer

Code sample

CalculateFields example 1 (Python window)

The following Python window script demonstrates how to use the CalculateFields function in immediate mode with the Python expression type.

import arcpy
arcpy.env.workspace = "C:/data/airport.gdb"
arcpy.management.CalculateFields("parcels", "PYTHON3", 
                                 [["xCentroid", "!SHAPE.CENTROID.X!"], 
                                  ["yCentroid", "!SHAPE.CENTROID.Y!"]])
CalculateFields example 2 (Python window)

The following Python window script demonstrates how to use the CalculateFields function in immediate mode with the SQL expression type.

import arcpy
arcpy.management.CalculateFields("<a feature service url>", "SQL", 
                                 [["ceiling_field", "CEILING(field1)"], 
                                  ["floor_field", "FLOOR(field1)"]])
CalculateFields example 3 (Python window)

The following Python window script demonstrates how to use the CalculateFields function in immediate mode with the Arcade expression type.

import arcpy
arcpy.env.workspace = "C:/data/airport.gdb"
arcpy.management.CalculateFields(
    "parcels", "ARCADE", 
    [["max_value", "Max($feature.field1, $feature.field2)"], 
     ["min_value", "Min($feature.field1, $feature.field2)"]])

Licensing information

  • Basic: Yes
  • Standard: Yes
  • Advanced: Yes

Related topics