UpdateCursor

Zusammenfassung

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.

Learn more about data access using cursors

Diskussion

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.

Beim Öffnen von gleichzeitigen Einfüge- oder Aktualisierungsoperationen in demselben Workspace unter Verwendung unterschiedlicher Cursors muss eine Editiersitzung gestartet werden.

Nachstehend sind einige Dataset-Typen aufgeführt, die nur innerhalb einer Editiersitzung bearbeitet werden können:

• Feature-Classes, die Teil einer Topologie sind
• Feature-Classes, die an einem geometrischen Netzwerk beteiligt sind
• Feature-Classes, die Teil eines Netzwerk-Datasets sind
• Versionierte Datasets in Enterprise-Geodatabases
• Einige Objekte und Feature-Classes mit Klassenerweiterungen

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.

Hinweis:

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

Hinweis:

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

Syntax

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

Parameter	Erläuterung	Datentyp
in_table	Die Feature-Class, der Layer, die Tabelle oder die Tabellensicht	String
field_names [field_names,...]	Eine Liste (oder ein Tupel) von Feldnamen. Für ein einzelnes Feld kann eine Zeichenfolge statt einer Zeichenfolgenliste verwendet werden. Geben Sie anstelle einer Felderliste ein Sternchen (*) an, um auf alle Felder der Eingabetabelle zuzugreifen (BLOB-Felder werden ausgeschlossen). Um die Performance zu verbessern und eine zuverlässige Feldreihenfolge zu erzielen, wird jedoch empfohlen, die Liste der Felder lediglich auf die tatsächlich benötigten Felder zu beschränken. Raster-Felder werden nicht unterstützt. Anstelle von Feldnamen kann auf zusätzliche Informationen auch über Token (z. B. OID@) zugegriffen werden: ANNO@—Das Annotation-Objekt des Features. Diese Option ist nur für ArcGIS Pro-Annotation-Feature-Classes gültig. SHAPE@XY—Ein Tupel von XY-Koordinaten für den Feature-Schwerpunkt. SHAPE@XYZ—Ein Tupel von XYZ-Koordinaten für den Feature-Schwerpunkt. SHAPE@TRUECENTROID—Ein Tupel von XY-Koordinaten für den Feature-Schwerpunkt. Dies gibt denselben Wert zurück wie SHAPE@XY. SHAPE@X—X-Koordinate des Features als Zahlenwert (Double). SHAPE@Y—Y-Koordinate des Features als Zahlenwert (Double). SHAPE@Z—Z-Koordinate des Features als Zahlenwert (Double). SHAPE@M—M-Wertes des Features als Zahlenwert (Double). SHAPE@JSON—Die Esri JSON-Zeichenfolge für die Geometrie. SHAPE@WKB—Das Well-known Binary (WKB)-Format für OGC-Geometrie. Es bietet eine übertragbare Darstellung eines Geometriewertes in Form eines zusammenhängenden Datenstroms.Werte werden als bytearray-Objekt zurückgegeben, können aber als bytearray- oder bytes-Objekt aktualisiert werden. SHAPE@WKT—Das Well-Known Text (WKT)-Format für OGC-Geometrie. Es bietet eine übertragbare Darstellung eines Geometriewertes in Form einer Textzeichenfolge. SHAPE@—Ein Geometrie-Objekt für das Feature. SHAPE@AREA—Fläche des Features als Zahlenwert (Double). SHAPE@LENGTH—Länge des Features als Zahlenwert (Double). CREATED@—Ein datetime-Objekt für den Zeitpunkt der Erstellung des Features. Dieses Feld ist schreibgeschützt. CREATOR@—Eine Zeichenfolge für den Benutzernamen des Benutzers, der das Feature erstellt hat. Dieses Feld ist schreibgeschützt. EDITED@—Ein datetime-Objekt für den Zeitpunkt der letzten Bearbeitung des Features. Dieses Feld ist schreibgeschützt. EDITOR@—Eine Zeichenfolge für den Benutzernamen des Benutzers, der das Feature zuletzt bearbeitet hat. Dieses Feld ist schreibgeschützt. GLOBALID@—Eine Zeichenfolge für die UUID (Universally Unique Identifier) des Features. Dieses Feld ist schreibgeschützt. OID@—Der Wert des Objekt-ID-Feldes. SUBTYPE@—Der Subtype-Code als ganze Zahl.	String
where_clause	Ein optionaler Ausdruck zur Begrenzung der zurückgegebenen Datensätze. Weitere Informationen zu WHERE-Klauseln und SQL-Anweisungen finden Sie unter SQL-Referenz für in ArcGIS verwendete Abfrageausdrücke. (Der Standardwert ist None)	String
spatial_reference	Der Raumbezug der Feature-Class. Wird dieses Argument angegeben, erfolgt für das Feature eine Projektion (Transformation) aus dem Raumbezug der Eingabe. Bei keiner Angabe wird der Raumbezug der Eingabe-Feature-Class verwendet. Gültige Werte für dieses Argument sind SpatialReference-Objekte oder Zeichenfolgenentsprechungen. (Der Standardwert ist None)	SpatialReference
explode_to_points	Zerlegen eines Features in die einzelnen Punkte bzw. Stützpunkte. Wenn explode_to_points auf True festgelegt ist, wird beispielsweise ein Multipoint-Feature mit fünf Punkten durch fünf Zeilen dargestellt. (Der Standardwert ist False)	Boolean
sql_clause	Ein Paar von SQL-Präfix- und Postfix-Klauseln, die in einer Liste oder einem Tupel organisiert sind In einer SQL-Präfix-Klausel werden None, DISTINCT und TOP unterstützt. In einer SQL-Postfix-Klausel werden None, ORDER BY und GROUP BY unterstützt. 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: print('Additional code') 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: print('Additional code') Use GROUP BY in a postfix clause. with arcpy.da.UpdateCursor( in_features, ['STREET_NAME'], sql_clause=(None, "GROUP BY STREET_NAME") ) as cur: print('Additional code') Eine SQL-Präfix-Klausel wird an der ersten Position platziert und zwischen dem Schlüsselwort SELECT und SELECT COLUMN LIST eingefügt. Die SQL-Präfix-Klausel wird meist für Klauseln wie DISTINCT oder ALL verwendet. Eine SQL-Postfix-Klausel wird an der zweiten Position platziert und nach der WHERE-Klausel an die Anweisung SELECT angehängt. Die SQL-Postfix-Klausel wird meist für Klauseln wie ORDER BY verwendet. Hinweis: DISTINCT, ORDER BY und ALL werden nur bei der Arbeit mit Datenbanken unterstützt. Für andere Datenquellen (beispielsweise dBASE- oder INFO-Tabellen) werden sie nicht unterstützt. TOP wird nur in SQL Server-Datenbanken unterstützt. (Der Standardwert ist (None, None))	tuple
datum_transformation	Wenn die Features durch den Cursor von einem Raumbezug in einen anderen projiziert werden, die Raumbezüge jedoch nicht dasselbe Datum aufweisen, muss eine geeignete Datumstransformation angegeben werden. 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. Mit der Funktion ListTransformations kann eine Liste von gültigen Datumstransformationen zwischen zwei Raumbezügen angegeben werden. Weitere Informationen zu Datumstransformationen	String
explicit [explicit,...]	Wenn ein Feld einen Standardwert hat und für das Feld NULL-Werte zulässig sind, wird mit dem Wert True der Standardwert explizit außer Kraft gesetzt, und es werden NULL-Werte in den Datensatz eingefügt. Bei Verwendung des Wertes False wird anstelle von Null der Standardwert eingefügt. Apply the explicit rule to all fields: with arcpy.da.UpdateCursor(table, [field1, field2, field3], explicit=True) as cursor: print('Additional code') Die explizite Regel kann auch mit einer Liste boolescher Werte auf einzelne Felder angewendet werden. Die Länge der Liste der Werte muss mit der der Liste der Felder übereinstimmen. Apply the explicit rule to only the first two fields: with arcpy.da.UpdateCursor(table, [field1, field2, field3], explicit=[True, True, False]) as cursor: print('Additional code') (Der Standardwert ist False)	Boolean
spatial_filter	Ein Geometrieobjekt zum räumlichen Filtern von Features. Wenn dieses Argument angegeben wird, begrenzt der Curser die zurückgegebenen Features basierend auf der angegebenen Geometie und dem Wert spatial_relationship. (Der Standardwert ist None)	Geometry
spatial_relationship	Die räumliche Beziehung zwischen der Eingabe- und der Abfrage-Geometrie im spatial_filter-Argument. Dieses Argument ist nur bei Angabe des Arguments spatial_filter anwendbar. 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. (Der Standardwert ist INTERSECTS)	String
search_order	Die Reihenfolge, in der die räumlichen Suchen von dem RDBMS verwendet werden. Diese Eigenschaft betrifft nur Enterprise-Geodatabase-Daten und ist nur bei Angabe des Arguments spatial_filter anwendbar. ATTRIBUTEFIRST—The attribute query will be applied first. SPATIALFIRST— The spatial query will be applied first. (Der Standardwert ist ATTRIBUTEFIRST)	String

Eigenschaften

Eigenschaft	Erläuterung	Datentyp
fields (Schreibgeschützt)	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

Methodenübersicht

Methode	Erläuterung
deleteRow ()	Deletes the current row.
reset ()	Resets the cursor back to the first row.
updateRow (row)	Updates the current row in the table.

Methoden

deleteRow ()

reset ()

updateRow (row)

Parameter	Erläuterung	Datentyp
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

Codebeispiel

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

UpdateCursor example 3

Use UpdateCursor with a spatial filter to update field values.

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)