UpdateCursor

Résumé

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.

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 tool can also be used to update field values.

Syntaxe

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

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 si vous voulez accéder à tous les champs de la table d'entrée (les champs raster et 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 : 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é. Ce jeton est pris en charge uniquement lorsque la géométrie est de type z. SHAPE@TRUECENTROID —Tuple des coordonnées x,y du centroïde de l’entité. La valeur renvoyée est la même que 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 d’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. 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é. OID@ —Valeur du champ IdObjet.	String
where_clause	Expression optionnelle qui limite les enregistrements retournés. Pour en savoir plus sur les clauses WHERE et les instructions SQL, consultez Construction d'une expression de la requête. (La valeur par défaut est None)	String
spatial_reference	The spatial reference of the feature class can be specified with either a SpatialReference object or string equivalent. (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 optionnelle de clauses de préfixes et suffixes SQL organisées dans une liste ou un tuple. An SQL prefix clause supports None, DISTINCT, and TOP. An SQL postfix clause supports None, ORDER BY, and GROUP BY. Une clause de préfixe SQL est placée en première position et sera insérée entre le mot-clé SELECT et la commande 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 commandes DISTINCT, ORDER BY et ALL ne sont prises en charge que lorsqu'on travaille avec des bases de données. Elles ne sont pas prises en charge par d'autres sources de données (telles que les tables dBASE ou INFO). La commande TOP ne peut être utilisée qu'avec les bases de données SQL Server et MS Access. (La valeur par défaut est (None, None))	tuple

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.
next ()	Returns the next row as a tuple. The order of fields will be returned in the order they were specified when creating the cursor.
reset ()	Resets the cursor back to the first row.
updateRow (row)	Updates the current row in the table.

Méthodes

deleteRow ()

next ()

Valeur renvoyée

Type de données	Explication
tuple	The next row as a tuple.

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