Synthèse
Établit un accès en lecture seule aux enregistrements d’une classe d’entités ou d’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
On peut accéder aux propriétés d’objet Geometry 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, vous pouvez envisager d’utiliser une instruction del pour supprimer l’objet ou renvoyer le curseur dans une fonction afin de mettre l’objet curseur hors de portée afin de prévenir toute situation 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.
Syntaxe
SearchCursor (in_table, field_names, {where_clause}, {spatial_reference}, {explode_to_points}, {sql_clause}, {datum_transformation}, {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. Il est possible d’accéder à des informations supplémentaires en utilisant des jetons (tels que OID@) à la place des noms de champs :
| 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. 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 | 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.
Use TOP in a prefix clause, and ORDER BY in a postfix clause.
Use GROUP BY in a postfix clause.
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. 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 (La valeur par défaut est None) | String |
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é.
(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é.
(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 |
reset () | Resets the cursor back to the first row. |
Méthodes
reset ()
Exemple de code
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(f'{row[0]}, {row[1]}, {row[2]}')
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)]
unique_values = set(values)
print(unique_values)
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(f'Feature {row[0]} has an area of {row[1]}')
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
delimited_field = arcpy.AddFieldDelimiters(fc, name_field)
expression = f'{delimited_field} = 2'
# 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])
Utilisez SearchCursor et la méthode Python sorted 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(f'{row[0]}, {row[1]}')
Vous pouvez également trier à l’aide de sql_clause si les données prennent en charge la clause SQL ORDER BY.
Remarque :
La clause ORDER BY n’est prise en charge que si des bases de données sont utilisées. Elle n’est pas prise en charge par les autres sources de données (telles que dBASE).
import arcpy
fc = 'c:/data/base.gdb/well'
fields = ['WELL_ID', 'WELL_TYPE']
# Use ORDER BY sql clause to sort field values
with arcpy.da.SearchCursor(fc, fields, sql_clause=(None, "ORDER BY WELL_ID, WELL_TYPE")) as cursor:
for row in cursor:
print(f'{row[0]}, {row[1]}')
Utilisez la clause SQL TOP pour limiter le nombre d’enregistements à renvoyer.
Remarque :
La clause TOP n’est prise en charge que par les bases de données SQL Server.
import arcpy
fc = 'c:/data/base.mdb/well'
fields = ['WELL_ID', 'WELL_TYPE']
# Use SQL TOP to sort field values
with arcpy.da.SearchCursor(fc, fields, sql_clause=('TOP 3', None)):
for row in cursor:
print(f'{row[0]}, {row[1]}')
Utilisez SearchCursor à l’aide d’un filtre spatial avec un objet géométrie.
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 = ["ADDRESS", "OCCUPIED"]
with arcpy.da.SearchCursor(
fc, fields, where_clause="OCCUPIED != 'Vacant'", spatial_filter=new_road
) as cursor:
for row in cursor:
print(f'{row[0]}: {row[1]}')
Utilisez SearchCursor à l’aide d’un filtre spatial avec un objet géométrie d’une autre classe d’entités.
import arcpy
fc = r"c:\connections\sqlserver.sde\DBO.ShipPositions"
fields = ["OBJECTID", "SHIP_NAME"]
searchPoly = [row[0] for row in arcpy.da.SearchCursor("searchArea", ["SHAPE@"])][0]
with arcpy.da.SearchCursor(
fc, fields, spatial_filter=searchPoly, search_order="SPATIALFIRST"
) as cursor:
for row in cursor:
print(f'{row[0]}: {row[1]}')
Rubriques connexes
Vous avez un commentaire à formuler concernant cette rubrique ?