SearchCursor

Résumé

SearchCursor établit un accès en lecture seule aux enregistrements renvoyés par une classe d'entités ou une table.

Renvoie un itérateur de tuples. L'ordre des valeurs dans le tuple correspond à l'ordre des champs spécifiés par l'argument field_names.

Discussion

Geometry on peut accéder aux propriétés en spécifiant le jeton SHAPE@ dans la liste des champs.

Une boucle for peut être utilisée pour itérer les curseurs de recherche. Les curseurs de recherche prennent également en charge les instructions with pour réinitialiser l'itération et aider à supprimer les verrouillages. Toutefois, l'utilisation d'une instruction del pour supprimer l'objet ou renvoyer le curseur dans une fonction afin de mettre l'objet curseur hors de portée doit être pris en compte afin de prévenir tout cas de verrouillage.

Les enregistrements renvoyés par SearchCursor peuvent être restreints afin de répondre aux critères attributaires ou spatiaux.

Accéder à l'ensemble de la géométrie avec SHAPE@ est une opération onéreuse. Lorsque seules des informations de géométrie simples sont requises, telles que les coordonnées x, y d'un point, utilisez des jetons, tels que SHAPE@XY, SHAPE@Z, et SHAPE@M pour un accès plus rapide et plus efficace.

Dans Python 2, SearchCursor prend en charge la méthode next d'itérateur pour récupérer la prochaine ligne d'une boucle. Dans Python 3, ceci est effectué à l'aide de la fonction Python next intégrée.

Syntaxe

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

Paramètre	Explication	Type de données
in_table	The feature class, layer, table, or table view.	String
field_names [field_names,...]	A list (or tuple) of field names. For a single field, you can use a string instead of a list of strings. Use an asterisk (*) instead of a list of fields to access all fields from the input table (raster and BLOB fields are excluded). However, for faster performance and reliable field order, it is recommended that the list of fields be narrowed to only those that are actually needed. Raster fields are not supported. Additional information can be accessed using tokens (such as OID@) in place of field names: SHAPE@XY —A tuple of the feature's centroid x,y coordinates. SHAPE@XYZ —A tuple of the feature's centroid x,y,z coordinates. SHAPE@TRUECENTROID —A tuple of the feature's centroid x,y coordinates. This returns the same value as SHAPE@XY. SHAPE@X —A double of the feature's x-coordinate. SHAPE@Y —A double of the feature's y-coordinate. SHAPE@Z —A double of the feature's z-coordinate. SHAPE@M —A double of the feature's m-value. SHAPE@JSON — The Esri JSON string representing the geometry. SHAPE@WKB —The well-known binary (WKB) representation for OGC geometry. It provides a portable representation of a geometry value as a contiguous stream of bytes. SHAPE@WKT —The well-known text (WKT) representation for OGC geometry. It provides a portable representation of a geometry value as a text string. SHAPE@ —A geometry object for the feature. SHAPE@AREA —A double of the feature's area. SHAPE@LENGTH —A double of the feature's length. OID@ —The value of the Object ID field.	String
where_clause	An optional expression that limits the records returned. For more information on WHERE clauses and SQL statements, see SQL reference for query expressions used in ArcGIS. (La valeur par défaut est None)	String
spatial_reference	The spatial reference of the feature class. When this argument is specified, the feature will be projected (or transformed) from the input's spatial reference. If unspecified, the input feature classes' spatial reference will be used. Valid values for this argument are a SpatialReference object or string equivalent. If a spatial reference is specified, but the input feature class has an unknown spatial reference, neither a projection nor transformation can be completed. The geometry returned by the cursor will have coordinates matching the input, with a spatial reference updated to the one specified. (La valeur par défaut est None)	SpatialReference
explode_to_points	Deconstruct a feature into its individual points or vertices. If explode_to_points is set to True, a multipoint feature with five points, for example, is represented by five rows. (La valeur par défaut est False)	Boolean
sql_clause	An optional pair of SQL prefix and postfix clauses organized in a list or tuple. An SQL prefix clause supports None, DISTINCT, and TOP. An SQL postfix clause supports None, ORDER BY, and GROUP BY. An SQL prefix clause is positioned in the first position and will be inserted between the SELECT keyword and the SELECT COLUMN LIST. The SQL prefix clause is most commonly used for clauses such as DISTINCT or ALL. An SQL postfix clause is positioned in the second position and will be appended to the SELECT statement, following the where clause. The SQL postfix clause is most commonly used for clauses such as ORDER BY. Remarque : DISTINCT, ORDER BY, and ALL are only supported when working with databases. They are not supported by other data sources (such as dBASE or INFO tables). TOP is only supported by SQL Server databases. (La valeur par défaut est (None, None))	tuple
datum_transformation	When the cursor projects the features from one spatial reference to another, if the spatial references do not share the same datum, an appropriate datum transformation should be specified. The ListTransformations function can be used to provide a list of valid datum transformations between two spatial references. Learn more about datum transformations (La valeur par défaut est None)	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. If the field_names argument is set to *, the fields property will include all fields used by the cursor. When using *, geometry values will be returned in a tuple of the x,y-coordinates (equivalent to the SHAPE@XY token). The order of the field names on the fields property will be the same as passed in with the field_names argument.	tuple

Vue d’ensemble des méthodes

Méthode	Explication
reset ()	Resets the cursor back to the first row.

Méthodes

reset ()

Exemple de code

Exemple 1 d'utilisation de la fonction SearchCursor

Utilisez SearchCursor pour parcourir une classe d'entités et imprimer les valeurs de certains champs spécifiques et les coordonnées x, y du point.

import arcpy

fc = 'c:/data/base.gdb/well'
fields = ['WELL_ID', 'WELL_TYPE', 'SHAPE@XY']

# For each row, print the WELL_ID and WELL_TYPE fields, and
# the feature's x,y coordinates
with arcpy.da.SearchCursor(fc, fields) as cursor:
    for row in cursor:
        print(u'{0}, {1}, {2}'.format(row[0], row[1], row[2]))

Exemple 2 d'utilisation de la fonction SearchCursor

Utilisez SearchCursor pour renvoyer un jeu de valeurs de champs uniques.

import arcpy

fc = 'c:/data/base.gdb/well'
field = 'Diameter'

# Use SearchCursor with list comprehension to return a
# unique set of values in the specified field
values = [row[0] for row in arcpy.da.SearchCursor(fc, field)]
uniqueValues = set(values)

print(uniqueValues)

Exemple 3 d'utilisation de la fonction SearchCursor

Utilisez SearchCursor pour renvoyer des attributs à l'aide de jetons.

import arcpy

fc = 'c:/data/base.gdb/well'

# For each row, print the Object ID field, and use the SHAPE@AREA
#  token to access geometry properties
with arcpy.da.SearchCursor(fc, ['OID@', 'SHAPE@AREA']) as cursor:
    for row in cursor:
        print('Feature {} has an area of {}'.format(row[0], row[1]))

Exemple 4 d'utilisation de la fonction SearchCursor

Utilisez SearchCursor avec une clause WHERE pour identifier les entités qui répondent à des critères précis.

import arcpy

fc = 'c:/base/data.gdb/roads'
class_field = 'Road Class'
name_field = 'Name'

# Create an expression with proper delimiters
expression = u'{} = 2'.format(arcpy.AddFieldDelimiters(fc, name_field))

# Create a search cursor using an SQL expression
with arcpy.da.SearchCursor(fc, [class_field, name_field],
                           where_clause=expression) as cursor:
    for row in cursor:
        # Print the name of the residential road
        print(row[1])

Exemple 5A d'utilisation de la fonction SearchCursor

Utilisez SearchCursor et la méthode de tri Python pour trier les lignes.

Pour plus d'options de tri, consultez le Mini guide d'utilisation du tri Python.

import arcpy

fc = 'c:/data/base.gdb/well'
fields = ['WELL_ID', 'WELL_TYPE']

# Use Python's sorted method to sort rows
for row in sorted(arcpy.da.SearchCursor(fc, fields)):
    print(u'{0}, {1}'.format(row[0], row[1]))

Exemple 5B d'utilisation de la fonction SearchCursor

Vous pouvez également trier à l'aide de sql_clause si les données permettent d'utiliser la commande SQL ORDER BY.

Remarque :

La commande ORDER BY n'est prise en charge que lorsqu'on travaille avec des bases de données. Cette commande ne peut pas être utilisée lorsqu'on utilise d'autres sources de données ( comme les tables dBASE ou INFO).

import arcpy

fc = 'c:/data/base.gdb/well'
fields = ['WELL_ID', 'WELL_TYPE']

# Use ORDER BY sql clause to sort field values
for row in arcpy.da.SearchCursor(
        fc, fields, sql_clause=(None, 'ORDER BY WELL_ID, WELL_TYPE')):
    print(u'{0}, {1}'.format(row[0], row[1]))

Exemple 6 d'utilisation de la fonction SearchCursor

Utilisez la commande SQL TOP pour limiter le nombre d'enregistements à renvoyer.

Remarque :

La commande TOP ne peut être utilisée qu'avec les bases de données SQL Server et MS Access.

import arcpy

fc = 'c:/data/base.mdb/well'
fields = ['WELL_ID', 'WELL_TYPE']

# Use SQL TOP to sort field values
for row in arcpy.da.SearchCursor(fc, fields, sql_clause=('TOP 3', None)):
    print(u'{0}, {1}'.format(row[0], row[1]))