UpdateCursor

Synthèse

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

Discussion

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.

Ouvrir simultanément des opérations d'insertion et de mise à jour dans le même espace de travail à l'aide de différents curseurs requiert l'ouverture d'une session de mise à jour.

À continuation, vous trouverez certains des types de jeu de données qui peuvent uniquement être mis à jour dans une session de mise à jour :

• Classes d'entités faisant partie d'une topologie
• Classes d'entités faisant partie d'un réseau géométrique
• Classes d’entités faisant partie d’un jeu de données réseau
• Jeux de données des géodatabases d'entreprise
• Certains objets et classes d'entités avec des extensions de classe

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.

Remarque :

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

Remarque :

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

Syntaxe

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

Paramètre	Explication	Type de données
in_table	Classe d’entités, couche, table ou vue tabulaire.	String
field_names [field_names,...]	Liste (ou tuple) de noms de champs. Pour un champ unique, vous pouvez utiliser une chaîne de caractères au lieu d’une liste de chaînes. Utilisez un astérisque (*) au lieu d’une liste de champs pour accéder à tous les champs de la table en entrée (les champs BLOB sont exclus). Toutefois, pour obtenir des performances plus rapides et un ordre des champs fiable, il est recommandé de limiter la liste des champs à ceux qui sont réellement nécessaires. Les champs raster ne sont pas pris en charge. Il est possible d’accéder à des informations supplémentaires en utilisant des jetons (tels que OID@) à la place des noms de champs : ANNO@—Objet Annotation pour l’entité. Cette option est uniquement valide pour les classes d’entités annotations ArcGIS Pro. SHAPE@XY—Tuple des coordonnées x,y du centroïde de l’entité. SHAPE@XYZ—Tuple des coordonnées x,y,z du centroïde de l’entité. SHAPE@TRUECENTROID—Tuple des coordonnées x,y du centroïde de l’entité. La valeur renvoyée est la même que celle renvoyée par SHAPE@XY. SHAPE@X—Double de la coordonnée x de l’entité. SHAPE@Y—Double de la coordonnée y de l’entité. SHAPE@Z—Double de la coordonnée z de l’entité. SHAPE@M—Double de la valeur m de l’entité. SHAPE@JSON—Chaîne JSON Esri représentant la géométrie. SHAPE@WKB—Représentation binaire connue (WKB) de la géométrie de l’OGC. Cette représentation constitue une représentation portable d’une valeur de géométrie sous la forme d’un flux contigu d’octets.Les valeurs sont renvoyées en tant qu’objet bytearray mais peuvent être mises à jour en tant qu’objet bytearray ou bytes. SHAPE@WKT—Représentation textuelle connue (WKT) de la géométrie de l’OGC. Cette représentation constitue une représentation portable d’une valeur de géométrie sous la forme d’une chaîne de texte. SHAPE@—Objet géométrie de l’entité. SHAPE@AREA—Double de la surface de l’entité. SHAPE@LENGTH—Double de la longueur de l’entité. CREATED@—Objet datetime correspondant à la date et à l’heure de création de l’entité. Ce champ est en lecture seule. CREATOR@—Chaîne du nom de l’utilisateur ayant créé l’entité. Ce champ est en lecture seule. EDITED@—Objet datetime correspondant à la date et à l’heure de la dernière modification de l’entité. Ce champ est en lecture seule. EDITOR@—Chaîne du nom du dernier utilisateur ayant modifié l’entité. Ce champ est en lecture seule. GLOBALID@—Chaîne de l’identifiant unique universel de l’entité. Ce champ est en lecture seule. OID@—Valeur du champ ID d’objet. SUBTYPE@—Entier du code de sous-type.	String
where_clause	Expression optionnelle qui limite les enregistrements retournés. Pour plus d’informations sur les clauses WHERE et les instructions SQL, reportez-vous à la rubrique Référence SQL pour les expressions de requête utilisées dans ArcGIS. (La valeur par défaut est None)	String
spatial_reference	Référence spatiale de la classe d’entités. Lorsque cet argument est spécifié, l’entité est projetée (ou transformée) à partir de la référence spatiale de l’entrée. Lorsqu’il n’est pas spécifié, la référence spatiale des classes d’entité en entrée est utilisée. Un objet SpatialReference ou une chaîne équivalente constitue une valeur valide. (La valeur par défaut est None)	SpatialReference
explode_to_points	Déconstruire une entité en ses différents points ou sommets. Si explode_to_points est défini sur True, une entité multi-points avec cinq points, par exemple, est représentée par cinq lignes. (La valeur par défaut est False)	Boolean
sql_clause	Une paire de clauses de préfixe et de suffixe SQL organisées dans une liste ou un tuple. Une clause de préfixe SQL prend en charge None, DISTINCT et TOP. Une clause de suffixe SQL prend en charge None, ORDER BY et 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: 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') Une clause de préfixe SQL est placée en première position et sera insérée entre le mot-clé SELECT et l’instruction SELECT COLUMN LIST. La clause de préfixe SQL est le plus souvent utilisée pour des clauses telles que DISTINCT ou ALL. Une clause de suffixe SQL est placée en deuxième position et sera ajoutée à l’instruction SELECT à la suite de la clause WHERE. La clause de suffixe SQL est le plus souvent utilisée pour des clauses telles que ORDER BY. Remarque : Les clauses DISTINCT, ORDER BY et ALL ne sont prises en charge que lorsque des bases de données sont utilisées. Elles ne sont pas prises en charge par d’autres sources de données (telles que les tables dBASE ou INFO). La clause TOP est prise en charge par les bases de données SQL Server uniquement. (La valeur par défaut est (None, None))	tuple
datum_transformation	Lorsque le curseur projette les entités d’une référence spatiale vers une autre, si les références spatiales ne partagent pas les mêmes datums, une transformation de datum appropriée doit être spécifiée. 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 fonction ListTransformations peut servir à fournir une liste de transformations de datum valides entre deux références spatiales. En savoir plus sur les transformations de datum	String
explicit [explicit,...]	Si un champ comporte une valeur par défaut et qu’il accepte les valeurs nulles, utiliser une valeur True remplace explicitement la valeur par défaut et insère des valeurs nulles dans l’enregistrement. Lorqu’une valeur False est utilisée, la valeur par défaut est insérée à la place d’une valeur nulle. Apply the explicit rule to all fields: with arcpy.da.UpdateCursor(table, [field1, field2, field3], explicit=True) as cursor: print('Additional code') La règle explicite peut également être appliquée à des champs spécifiques en utilisant une liste de valeurs booléennes. La liste de valeurs doit avoir la même longueur que la liste de champs. 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') (La valeur par défaut est False)	Boolean
spatial_filter	Objet géométrie permettant de filtrer spatialement les entités. Si cet argument est spécifié, le curseur limite les entités renvoyées en fonction de la géométrie spécifiée et de la valeur spatial_relationship. (La valeur par défaut est None)	Geometry
spatial_relationship	Relation spatiale entre la géométrie en entrée et la géométrie de requête dans l’argument spatial_filter. Cet argument n’est applicable que si l’argument spatial_filter est spécifié. 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. (La valeur par défaut est INTERSECTS)	String
search_order	Ordre dans lequel les recherches spatiales sont appliquées par le SGDBR. Cette propriété n’affecte que les données de géodatabase d’entreprise et n’est applicable que si l’argument spatial_filter est spécifié. ATTRIBUTEFIRST—The attribute query will be applied first. SPATIALFIRST— The spatial query will be applied first. (La valeur par défaut est ATTRIBUTEFIRST)	String

Propriétés

Propriété	Explication	Type de données
fields (Lecture seule)	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

Vue d’ensemble des méthodes

Méthode	Explication
deleteRow ()	Deletes the current row.
reset ()	Resets the cursor back to the first row.
updateRow (row)	Updates the current row in the table.

Méthodes

deleteRow ()

reset ()

updateRow (row)

Paramètre	Explication	Type de données
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

Exemple de code

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)