SearchCursor

Zusammenfassung

Establishes read-only access to the records of a feature class or table.

It returns an iterator of tuples. The order of values in the tuple matches the order of fields specified by the field_names argument.

Learn more about data access using cursors

Diskussion

Geometry object properties can be accessed by specifying the token SHAPE@ in the list of fields.

Search cursors can be iterated using a for loop. Search 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.

The records returned by SearchCursor can be constrained to match attribute criteria or spatial criteria.

Accessing full geometry with SHAPE@ is an expensive operation. If only simple geometry information is required, such as the x,y coordinates of a point, use tokens such as SHAPE@XY, SHAPE@Z, and SHAPE@M for faster, more efficient access.

Syntax

SearchCursor (in_table, field_names, {where_clause}, {spatial_reference}, {explode_to_points}, {sql_clause}, {datum_transformation}, {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. Anstelle von Feldnamen kann auf zusätzliche Informationen auch über Token (z. B. OID@) zugegriffen werden: 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. 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. 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. (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. with arcpy.da.SearchCursor( in_features, ["OID@", "STREET_NAME"], sql_clause=("DISTINCT STREET_NAME", None) ) as cur: Use TOP in a prefix clause, and ORDER BY in a postfix clause. with arcpy.da.SearchCursor( in_features, ['OID@', "ELEVATION"], sql_clause=("TOP 5", "ORDER BY ELEVATION DESC") ) as cur: Use GROUP BY in a postfix clause. with arcpy.da.SearchCursor( in_features, ['STREET_NAME'], sql_clause=(None, "GROUP BY STREET_NAME") ) as cur: 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. Mit der Funktion ListTransformations kann eine Liste von gültigen Datumstransformationen zwischen zwei Raumbezügen angegeben werden. Weitere Informationen zu Datumstransformationen (Der Standardwert ist None)	String
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
reset ()	Resets the cursor back to the first row.

Methoden

reset ()

Codebeispiel

SearchCursor example 1

Use SearchCursor to step through a feature class and print specific field values and the x,y coordinates of the 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]}')

SearchCursor example 2

Use SearchCursor to return a set of unique field values.

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)

SearchCursor example 3

Use SearchCursor to return attributes using tokens.

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]}')

SearchCursor example 4

Use SearchCursor with a where clause to identify features that meet specific criteria.

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])

SearchCursor example 5

Use SearchCursor and the Python sorted method to sort rows.

For additional sorting options, see the Python Sorting Mini-HOW TO.

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]}')

SearchCursor example 6

Alternatively, sort using sql_clause if the data supports the SQL ORDER BY clause.

Hinweis:

The ORDER BY clause is only supported when working with databases. It is not supported by other data sources (such as 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]}')

SearchCursor example 7

Use the SQL TOP clause to limit the number of records to return.

Hinweis:

The TOP clause is only supported by SQL Server databases.

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]}')

SearchCursor example 8

Use SearchCursor using a spatial filter with a geometry object.

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]}')

SearchCursor example 9

Use SearchCursor using a spatial filter with a geometry object from another feature class.

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]}')