UpdateCursor

Resumen

UpdateCursor establece acceso de lectura y escritura a los registros devueltos de una tabla o clase de entidad.

Devuelve un iterador de listas. El orden de los valores en la lista coincide con el orden de los campos especificados por el argumento field_names.

Más información sobre el acceso a los datos mediante cursores

Debate

Es posible iterar los cursores de actualización mediante un bucle for. Los cursores de actualización también admiten sentencias with para restablecer la iteración y ayudar en la eliminación de bloqueos. Sin embargo, se debería tener en cuenta el utilizar una sentencia del para eliminar el objeto o ajustar el cursor en una función para que el objeto de cursor quede fuera del alcance, a fin de protegerse contra todos los casos de bloqueo.

La apertura de operaciones de inserción o actualización simultáneas en el mismo espacio de trabajo con distintos cursores requiere que se inice una sesión de edición.

A continuación, se incluyen algunos tipos de datasets que solo se pueden editar en una sesión de edición:

• Clases de entidad que forman parte de una topología
• Clases de entidad que forman parte de una red geométrica
• Clases de entidad que forman parte de un dataset de red
• Datasets versionados en geodatabases corporativas
• Algunas clases de entidad y objetos con extensiones de clase

En Python 2, UpdateCursor admite el método next de iterador para recuperar la siguiente fila fuera de un bucle. En Python 3, se realiza lo equivalente mediante la función Python integrada de next.

Nota:

Las herramientas Calcular campo y Calcular campos también se pueden utilizar para actualizar valores de campo.

Nota:

No se admite el uso de un UpdateCursor en una capa con una tabla unida.

Sintaxis

 UpdateCursor (in_table, field_names, {where_clause}, {spatial_reference}, {explode_to_points}, {sql_clause}, {datum_transformation}, {explicit}, {spatial_filter}, {spatial_relationship}, {search_order})

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: ANNO@—Un Annotation objeto para la entidad. Esta opción solamente es válida para las clases de entidad de anotación de ArcGIS Pro. 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 (WKT) 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. CREATED@—Un objeto datetime de cuándo se creó la entidad. Este campo es de solo lectura. CREATOR@—Una cadena del nombre de usuario que creó la entidad. Este campo es de solo lectura. EDITED@—Un objeto datetime de cuándo se editó la entidad por última vez. Este campo es de solo lectura. EDITOR@—Una cadena del nombre de usuario que editó la entidad por última vez. Este campo es de solo lectura. GLOBALID@—Una cadena de caracteres del identificador único universal de la entidad. Este campo es de solo lectura. OID@—El valor del campo Id. de objeto. SUBTYPE@—Un entero del código de subtipo.	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 for a table located in a file geodatabase. DISTINCT is not honored in a relational database. 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 to 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
explicit [explicit,...]	Si un campo tiene un valor predeterminado y el campo puede ser nulo, utilizar un valor de True invalidará explícitamente el valor predeterminado e insertará valores nulos en el registro. Si se utiliza un valor False, se insertará el valor predeterminado en lugar de nulo. Apply the explicit rule to all fields: with arcpy.da.UpdateCursor(table, [field1, field2, field3], explicit=True) as cursor: ... La regla explícita también se puede aplicar a campos individuales mediante una lista de valores booleanos. La lista de valores debe tener la misma longitud que la lista de campos. Apply the explicit rule to only the first two fields: with arcpy.da.UpdateCursor(table, [field1, field2, field3], explicit=[True, True, False]) as cursor: ... (El valor predeterminado es False)	Boolean
spatial_filter	Objeto de geometría utilizado para filtrar entidades espacialmente. Cuando se especifica este argumento, el cursor limita las entidades devueltas basándose en la geometría especificada y el valor de spatial_relationship. (El valor predeterminado es None)	Geometry
spatial_relationship	Relación espacial entre la entrada y la geometría de consulta del argumento spatial_filter. Este argumento solo se aplica cuando se especifica el argumento spatial_filter. INTERSECTS— Rows are only returned when the spatial_filter geometry intersects the input row's geometry. ENVELOPE_INTERSECTS— Rows are only returned when the spatial_filter geometry's envelope intersects the input row's geometry. INDEX_INTERSECTS— Rows are only returned when the spatial_filter geometry's envelope intersects the index entry for the input row's geometry. Because it uses the underlying index grid, rather than the envelope of the feature, it is faster and is commonly used for return features for display purposes. TOUCHES— Rows are only returned when the spatial_filter geometry touches the input row's geometry. OVERLAPS— Rows are only returned when the spatial_filter geometry overlaps the input row's geometry. CROSSES— Rows are only returned when the spatial_filter geometry crosses the input row's geometry. WITHIN— Rows are only returned when the spatial_filter geometry is within the input row's geometry. CONTAINS— Rows are only returned when the spatial_filter geometry contains the input row's geometry. (El valor predeterminado es INTERSECTS)	String
search_order	Orden en que el RDBMS aplica las búsquedas espaciales. Esta propiedad solo afecta a los datos de las geodatabases corporativas y se aplica cuando se especifica el argumento spatial_filter exclusivamente. ATTRIBUTEFIRST—The attribute query will be applied first. SPATIALFIRST— The spatial query will be applied first. (El valor predeterminado es ATTRIBUTEFIRST)	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

Ejemplo 1 de UpdateCursor

Use UpdateCursor para actualizar un valor de campo evaluando los valores de otros campos.

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)

Ejemplo 2 de UpdateCursor

Use UpdateCursor para actualizar un campo de distancias de zona de influencia para su uso con la función Zona de influencia.

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.analysis.Buffer(fc, 'roads_buffer', 'BUFFER_DISTANCE')

Ejemplo 3 de UpdateCursor

Use UpdateCursor con un filtro espacial para actualizar los valores de campo.

import arcpy

arr = arcpy.Array(
    [arcpy.Point(342917.4, 553980.8), arcpy.Point(366915.9, 594749.1)]
)
new_road = arcpy.Polyline(arr, spatial_reference=arcpy.SpatialReference(26971))

fc = r"C:\data\chicago.gdb\houses"
fields = ["OCCUPIED"]

with arcpy.da.UpdateCursor(
    fc, fields, where_clause="OCCUPIED != 'Vacant'", spatial_filter=new_road
) as cursor:
    for row in cursor:
        row[0] = 'Vacant'
        cursor.updateRow(row)