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

Parameter	Erklärung	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. Verwenden Sie ein Sternchen (*) statt einer Liste von Feldern, wenn Sie über die Eingabetabelle auf alle Felder zugreifen möchten (Raster- und BLOB-Felder sind ausgenommen). 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. Raster-Felder werden nicht unterstützt. Der Zugriff auf zusätzliche Informationen kann mit Token (z. B. OID@) statt Feldnamen erfolgen: SHAPE@XY —Ein Tupel von XY-Koordinaten für den Feature-Schwerpunkt. SHAPE@XYZ —Ein Tupel von XYZ-Koordinaten für den Feature-Schwerpunkt. Dieses Token wird nur unterstützt, wenn die Geometrie Z-aktiviert ist. SHAPE@TRUECENTROID —Ein Tupel von XY-Koordinaten für den Feature-Schwerpunkt. Dies gibt denselben Wert zurück wie SHAPE@XY. SHAPE@X —Duplikat der X-Koordinate des Features. SHAPE@Y —Duplikat der Y-Koordinate des Features. SHAPE@Z —Duplikat der Z-Koordinate des Features. SHAPE@M —Duplikat des M-Wertes des Features. 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. 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 —Duplikat der Fläche des Features. SHAPE@LENGTH —Duplikat der Länge des Features. OID@ —Der Wert des ObjectID-Feldes.	String
where_clause	Ein optionaler Ausdruck zur Begrenzung der zurückgegebenen Datensätze. Weitere Informationen zu WHERE-Klauseln und SQL-Anweisungen finden Sie unter Erstellen von Abfrageausdrücken. (Der Standardwert ist None)	String
spatial_reference	Der Raumbezug der Feature-Class. Er kann mit einem SpatialReference-Objekt oder einer Zeichenfolgenentsprechung angegeben werden. (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 wird, wird ein Multipoint-Feature mit fünf Punkten beispielsweise durch fünf Zeilen dargestellt. (Der Standardwert ist False)	Boolean
sql_clause	Ein optionales Paar von SQL-Präfix- und Postfix-Klauseln, die in einer Liste oder einem Tupel organisiert sind. An SQL prefix clause supports None, DISTINCT, and TOP. An SQL postfix clause supports None, ORDER BY, and GROUP BY. 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 von SQL Server- und MS Access-Datenbanken unterstützt. (Der Standardwert ist (None, None))	tuple

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. 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	Erklärung
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.

Methoden

next ()

Rückgabewert

Datentyp	Erklärung
tuple	The next row as a tuple.

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.

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.

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