UpdateCursor

Resumen

UpdateCursor establishes read-write access to records returned from a feature class or table.

Returns an iterator of lists. The order of values in the list matches the order of fields specified by the field_names argument.

Debate

Update cursors can be iterated using a for loop. Update cursors also support with statements to reset iteration and aid in removal of locks. However, using a del statement to delete the object or wrapping the cursor in a function to have the cursor object go out of scope should be considered to guard against all locking cases.

Opening simultaneous insert or update operations on the same workspace using different cursors requires the start of an edit session.

The following includes some dataset types that can only be edited within an edit session:

• Feature classes participating in a topology
• Feature classes participating in a geometric network
• Feature classes participating in a network dataset
• Versioned datasets in enterprise geodatabases
• Some object and feature classes with class extensions

In Python 2, UpdateCursor supports the iterator next method to retrieve the next row outside of a loop. In Python 3, the equivalent is performed by using the Python built-in next function.

Nota:

The Calculate Field and Calculate Fields tools can also be used to update field values.

Nota:

Using an UpdateCursor on a layer with a joined table is not supported.

Sintaxis

UpdateCursor (in_table, field_names, {where_clause}, {spatial_reference}, {explode_to_points}, {sql_clause}, {datum_transformation})

Parámetro	Explicación	Tipo de datos
in_table	La clase de entidad, capa, tabla o vista de tabla.	String
field_names [field_names,...]	Una lista (o tupla) de nombres de campo. Para un único campo, puede utilizar una cadena en lugar de una lista de cadenas. Use un asterisco (*) en lugar de una lista de campos para acceder a todos los campos de la tabla de entrada (se excluyen los campos BLOB). Sin embargo, para un rendimiento más rápido y un orden de campo fiable, se recomienda que la lista de campos se acote a solo aquellos que se necesitan realmente. Los campos ráster no se admiten. Es posible acceder a información adicional con tokens (como OID@) en lugar de nombres de campo: SHAPE@XY—Una tupla de las coordenadas x,y del centroide de la entidad. SHAPE@XYZ—Una tupla de las coordenadas x, y, z del centroide de la entidad. SHAPE@TRUECENTROID—Una tupla de las coordenadas x,y del centroide de la entidad. Devuelve el mismo valor que SHAPE@XY. SHAPE@X—Un doble de la coordenada x de la entidad. SHAPE@Y—Un doble de la coordenada y de la entidad. SHAPE@Z—Un doble de la coordenada z de la entidad. SHAPE@M—Un doble del valor m de la entidad. SHAPE@JSON—La cadena de caracteres JSON de Esri que representa la geometría. SHAPE@WKB—Representación binaria conocida (WKB) para geometría OGC. Ofrece una representación portátil de un valor de geometría como una transmisión contigua de bytes.Los valores se devuelven como un objeto bytearray, pero se pueden actualizar como un objeto bytearray o bytes. SHAPE@WKT—Representación en texto conocida (WKB) para geometría OGC. Ofrece una representación portátil de un valor de geometría como cadena de caracteres. SHAPE@—Objeto de geometría para la entidad. SHAPE@AREA—Un doble del área de la entidad. SHAPE@LENGTH—Un doble de la longitud de la entidad. OID@—El valor del campo Id. de objeto.	String
where_clause	Una expresión opcional que limita los registros que se devuelven. Para obtener más información sobre cláusulas WHERE y sentencias SQL, consulte Referencia de SQL para las expresiones de consulta utilizadas en ArcGIS. (El valor predeterminado es None)	String
spatial_reference	La referencia espacial de la clase de entidad. Cuando se especifica este argumento, la entidad se proyectará (o transformará) a partir de la referencia espacial de la entrada. Si no se especifica, se utilizará la referencia espacial de las clases de entidad de entrada. Los valores válidos para este argumento son un objeto de SpatialReference o un equivalente de cadena. (El valor predeterminado es None)	SpatialReference
explode_to_points	Deconstruya una entidad en sus puntos o vértices individuales. Si explode_to_points se define como True, una entidad multipunto con cinco puntos, por ejemplo, se representa con cinco filas. (El valor predeterminado es False)	Boolean
sql_clause	Un par de cláusulas prefix y postfix de SQL organizadas en una lista o tupla. Una cláusula prefix de SQL admite None, DISTINCT y TOP. Una cláusula postfix de SQL admite None, ORDER BY y GROUP BY. Use DISTINCT in a prefix clause. with arcpy.da.UpdateCursor( in_features, ["OID@", "STREET_NAME"], sql_clause=("DISTINCT STREET_NAME", None) ) as cur: Use TOP in a prefix clause, and ORDER BY in a postfix clause. with arcpy.da.UpdateCursor( in_features, ['OID@', "ELEVATION"], sql_clause=("TOP 5", "ORDER BY ELEVATION DESC") ) as cur: Use GROUP BY in a postfix clause. with arcpy.da.UpdateCursor( in_features, ['STREET_NAME'], sql_clause=(None, "GROUP BY STREET_NAME") ) as cur: Una cláusula prefix de SQL se ubica en la primera posición y se insertará entre la palabra clave SELECT y SELECT COLUMN LIST. La cláusula prefix de SQL se suele utilizar para cláusulas como DISTINCT o ALL. Una cláusula postfix de SQL se ubica en la segunda posición y se incorporará a la sentencia SELECT, tras la cláusula WHERE. La cláusula postfix de SQL se suele utilizar para cláusulas como ORDER BY. Nota: DISTINCT, ORDER BY y ALL solo se admiten al trabajar con bases de datos. Otras fuentes de datos no las admiten (como las tablas INFO o dBASE). TOP solo es compatible con bases de datos SQL Server. (El valor predeterminado es (None, None))	tuple
datum_transformation	Cuando el cursor proyecta las entidades de una referencia espacial a otra, si las referencias espaciales no comparten el mismo datum, se debería especificar una transformación de datum adecuada. An update cursor can perform a projection or transformation at two stages: when reading the features from the feature class on disk, and when writing the updated features into the feature class. La función ListTransformations se puede utilizar para proporcionar una lista de transformaciones de datum válidas entre dos referencias espaciales. Más información sobre las transformaciones de datum	String

Propiedades

Propiedad	Explicación	Tipo de datos
fields (Sólo lectura)	A tuple of field names used by the cursor. The tuple will include all fields and tokens specified by the field_names argument. The order of the field names on the fields property will be the same as passed in with the field_names argument. If the field_names argument is set to *, the fields property will include all fields used by the cursor. A value of * will return geometry in a tuple of x,y coordinates (equivalent to the SHAPE@XY token).	tuple

Descripción general del método

Método	Explicación
deleteRow ()	Deletes the current row.
reset ()	Resets the cursor back to the first row.
updateRow (row)	Updates the current row in the table.

Métodos

deleteRow ()

reset ()

updateRow (row)

Parámetro	Explicación	Tipo de datos
row	A list or tuple of values. The order of values should be in the same order as the fields. When updating fields, if the incoming values match the type of field, the values will be cast as necessary. For example, a value of 1.0 to a string field will be added as "1.0", and a value of "25" added to a float field will be added as 25.0.	tuple

Muestra de código

UpdateCursor example 1

Use UpdateCursor to update a field value by evaluating the values of other fields.

import arcpy

fc = 'c:/data/base.gdb/well'
fields = ['WELL_YIELD', 'WELL_CLASS']

# Create update cursor for feature class 
with arcpy.da.UpdateCursor(fc, fields) as cursor:
    # For each row, evaluate the WELL_YIELD value (index position 
    # of 0), and update WELL_CLASS (index position of 1)
    for row in cursor:
        if (row[0] >= 0 and row[0] <= 10):
            row[1] = 1
        elif (row[0] > 10 and row[0] <= 20):
            row[1] = 2
        elif (row[0] > 20 and row[0] <= 30):
            row[1] = 3
        elif (row[0] > 30):
            row[1] = 4

        # Update the cursor with the updated list
        cursor.updateRow(row)

UpdateCursor example 2

Use UpdateCursor to update a field of buffer distances for use with the Buffer function.

import arcpy

arcpy.env.workspace = 'c:/data/output.gdb'
fc = 'c:/data/base.gdb/roads'
fields = ['ROAD_TYPE', 'BUFFER_DISTANCE']

# Create update cursor for feature class 
with arcpy.da.UpdateCursor(fc, fields) as cursor:
    # Update the field used in Buffer so the distance is based on road 
    # type. Road type is either 1, 2, 3, or 4. Distance is in meters. 
    for row in cursor:
        # Update the BUFFER_DISTANCE field to be 100 times the 
        # ROAD_TYPE field.
        row[1] = row[0] * 100
        cursor.updateRow(row) 

# Buffer feature class using updated field values
arcpy.Buffer_analysis(fc, 'roads_buffer', 'BUFFER_DISTANCE')