SearchCursor

Zusammenfassung

SearchCursor richtet schreibgeschützten Zugriff auf die Datensätze ein, die aus einer Feature-Class oder Tabelle zurückgegeben werden.

Es wird ein Tupel-Iterator zurückgegeben. Die Reihenfolge der Werte im Tupel stimmt mit der Reihenfolge der Felder überein, die durch das field_names-Argument angegeben ist.

Auswertung

Geometry Auf -Eigenschaften kann durch die Angabe des Token SHAPE@ in der Liste der Felder zugegriffen werden.

Such-Cursor können mit einer for-Schleife durchlaufen werden. Such-Cursor unterstützen auch with-Anweisungen zum Zurücksetzen von Iterationen und für die Entfernung von Sperren. Jedoch sollten Sie zum Schutz vor Sperrszenarien aller Art die Verwendung einer del-Anweisung in Betracht ziehen, um das Objekt zu löschen oder den Cursor in einer Funktion umzubrechen, damit das Cursor-Objekt über den üblichen Bereich hinaus angewendet wird.

Die von SearchCursor zurückgegebenen Datensätze können eingeschränkt werden, um Attributkriterien oder räumlichen Kriterien zu entsprechen.

Der Zugriff per SHAPE@ auf die vollständige Geometrie ist ein aufwändiger Vorgang. Werden nur Informationen zu einer einfachen Geometrie benötigt, z. B. die XY-Koordinaten eines Punktes, erhalten Sie mit den Token SHAPE@XY, SHAPE@Z und SHAPE@M schneller und effizienter Zugriff.

In Python 2 wird von SearchCursor die Iteratormethode next unterstützt, um die nächste Zeile außerhalb der Schleife abzurufen. In Python 3 erzielen Sie dasselbe Ergebnis mit der integrierten Python-Funktion next.

Syntax

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

Parameter	Erklärung	Datentyp
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. (Der Standardwert ist 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. (Der Standardwert ist 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. (Der Standardwert ist 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. Hinweis: 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. (Der Standardwert ist (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 (Der Standardwert ist None)	String

Eigenschaften

Eigenschaft	Erklärung	Datentyp
fields (Nur lesen)	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

Methodenübersicht

Methode	Erklärung
reset ()	Resets the cursor back to the first row.

Methoden

reset ()

Codebeispiel

SearchCursor – Beispiel 1

Mit SearchCursor wird eine Feature-Class durchlaufen, und es werden bestimmte Feldwerte sowie die XY-Koordinaten des Punktes gedruckt.

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

SearchCursor – Beispiel 2

Mit SearchCursor wird eine Reihe von einzelnen Feldwerten zurückgegeben.

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)

SearchCursor – Beispiel 3

Mit SearchCursor werden unter Verwendung von Token Attribute zurückgegeben.

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

SearchCursor – Beispiel 4

Durch die Verwendung von SearchCursor mit einer WHERE-Klausel werden Features ermittelt, die bestimmte Kriterien erfüllen.

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

SearchCursor – Beispiel 5A

Mit SearchCursor und der Python-Methode "sorted" werden Zeilen sortiert.

Weitere Sortieroptionen finden Sie in der Python-Dokumentation unter 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(u'{0}, {1}'.format(row[0], row[1]))

SearchCursor – Beispiel 5B

Wenn die Daten die SQL-Option "ORDER BY" unterstützen, kann alternativ für die Sortierung sql_clause verwendet werden.

Hinweis:

ORDER BY wird nur bei der Arbeit mit Datenbanken unterstützt. Für andere Datenquellen (beispielsweise dBASE- oder INFO-Tabellen) wird sie nicht unterstützt.

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

SearchCursor – Beispiel 6

Mit der SQL-Option "TOP" wird die maximale Anzahl der zurückzugebenden Ergebnisse festgelegt.

Hinweis:

TOP wird nur von SQL Server- und MS Access-Datenbanken unterstützt.

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