SearchCursor

Resumen

Establece el acceso de solo lectura a los registros de una tabla o clase de entidad.

Devuelve un iterador de tuplas. El orden de los valores de la tupla coincide con el orden de los campos especificado por el argumento field_names.

Más información sobre el acceso a los datos mediante cursores

Debate

Se puede acceder a las propiedades del objeto Geometry especificando el token SHAPE@ en la lista de campos.

Los cursores de búsqueda se pueden recorrer en un bucle for. Los cursores de búsqueda también admiten instrucciones de with para restablecer la iteración y ayudar a eliminar los bloqueos. Sin embargo, se debería tener en cuenta el utilizar una sentencia del para eliminar el objeto o ajustar el cursor en una función para que el objeto de cursor quede fuera del alcance, a fin de protegerse contra todos los casos de bloqueo.

Los registros devueltos por SearchCursor se pueden limitar para que coincidan con los criterios de atributos o con los criterios espaciales.

Acceder a la geometría completa con SHAPE@ es una operación costosa. Si solo se requiere información de geometría simple, como las coordenadas x,y de un punto, utilice tokens como SHAPE@XY, SHAPE@Z y SHAPE@M para un acceso más rápido y eficaz.

Sintaxis

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

Parámetro	Explicación	Tipo de datos
in_table	La clase de entidad, capa, tabla o vista de tabla.	String
field_names [field_names,...]	Una lista (o tupla) de nombres de campo. Para un único campo, puede utilizar una cadena en lugar de una lista de cadenas. Use un asterisco (*) en lugar de una lista de campos para acceder a todos los campos de la tabla de entrada (se excluyen los campos BLOB). Sin embargo, para un rendimiento más rápido y un orden de campo fiable, se recomienda que la lista de campos se acote a solo aquellos que se necesitan realmente. Es posible acceder a información adicional con tokens (como OID@) en lugar de nombres de campo: ANNO@—Un Annotation objeto para la entidad. Esta opción solamente es válida para las clases de entidad de anotación de ArcGIS Pro. SHAPE@XY—Una tupla de las coordenadas x,y del centroide de la entidad. SHAPE@XYZ—Una tupla de las coordenadas x, y, z del centroide de la entidad. SHAPE@TRUECENTROID—Una tupla de las coordenadas x,y del centroide de la entidad. Devuelve el mismo valor que SHAPE@XY. SHAPE@X—Un doble de la coordenada x de la entidad. SHAPE@Y—Un doble de la coordenada y de la entidad. SHAPE@Z—Un doble de la coordenada z de la entidad. SHAPE@M—Un doble del valor m de la entidad. SHAPE@JSON—La cadena de caracteres JSON de Esri que representa la geometría. SHAPE@WKB—Representación binaria conocida (WKB) para geometría OGC. Ofrece una representación portátil de un valor de geometría como una transmisión contigua de bytes.Los valores se devuelven como un objeto bytearray. SHAPE@WKT—Representación en texto conocida (WKT) para geometría OGC. Ofrece una representación portátil de un valor de geometría como cadena de caracteres. SHAPE@—Objeto de geometría para la entidad. SHAPE@AREA—Un doble del área de la entidad. SHAPE@LENGTH—Un doble de la longitud de la entidad. CREATED@—Un objeto datetime de cuándo se creó la entidad. Este campo es de solo lectura. CREATOR@—Una cadena del nombre de usuario que creó la entidad. Este campo es de solo lectura. EDITED@—Un objeto datetime de cuándo se editó la entidad por última vez. Este campo es de solo lectura. EDITOR@—Una cadena del nombre de usuario que editó la entidad por última vez. Este campo es de solo lectura. GLOBALID@—Una cadena de caracteres del identificador único universal de la entidad. Este campo es de solo lectura. OID@—El valor del campo Id. de objeto. SUBTYPE@—Un entero del código de subtipo.	String
where_clause	Una expresión opcional que limita los registros que se devuelven. Para obtener más información sobre cláusulas WHERE y sentencias SQL, consulte Referencia de SQL para las expresiones de consulta utilizadas en ArcGIS. (El valor predeterminado es None)	String
spatial_reference	La referencia espacial de la clase de entidad. Cuando se especifica este argumento, la entidad se proyectará (o transformará) a partir de la referencia espacial de la entrada. Si no se especifica, se utilizará la referencia espacial de las clases de entidad de entrada. Los valores válidos para este argumento son un objeto de SpatialReference o un equivalente de cadena. 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. (El valor predeterminado es None)	SpatialReference
explode_to_points	Deconstruya una entidad en sus puntos o vértices individuales. Si explode_to_points se define como True, una entidad multipunto con cinco puntos, por ejemplo, se representa con cinco filas. (El valor predeterminado es False)	Boolean
sql_clause	Un par de cláusulas prefix y postfix de SQL organizadas en una lista o tupla. Una cláusula prefix de SQL admite None, DISTINCT y TOP. Una cláusula postfix de SQL admite None, ORDER BY y GROUP BY. 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: Una cláusula prefix de SQL se ubica en la primera posición y se insertará entre la palabra clave SELECT y SELECT COLUMN LIST. La cláusula prefix de SQL se suele utilizar para cláusulas como DISTINCT o ALL. Una cláusula postfix de SQL se ubica en la segunda posición y se incorporará a la sentencia SELECT, tras la cláusula WHERE. La cláusula postfix de SQL se suele utilizar para cláusulas como ORDER BY. Nota: DISTINCT, ORDER BY y ALL solo se admiten al trabajar con bases de datos. Otras fuentes de datos no las admiten (como las tablas INFO o dBASE). TOP solo es compatible con bases de datos SQL Server. (El valor predeterminado es (None, None))	tuple
datum_transformation	Cuando el cursor proyecta las entidades de una referencia espacial a otra, si las referencias espaciales no comparten el mismo datum, se debería especificar una transformación de datum adecuada. La función ListTransformations se puede utilizar para proporcionar una lista de transformaciones de datum válidas entre dos referencias espaciales. Más información sobre las transformaciones de datum (El valor predeterminado es None)	String
spatial_filter	Objeto de geometría utilizado para filtrar entidades espacialmente. Cuando se especifica este argumento, el cursor limita las entidades devueltas basándose en la geometría especificada y el valor de spatial_relationship. (El valor predeterminado es None)	Geometry
spatial_relationship	Relación espacial entre la entrada y la geometría de consulta del argumento spatial_filter. Este argumento solo se aplica cuando se especifica el argumento spatial_filter. 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. (El valor predeterminado es INTERSECTS)	String
search_order	Orden en que el RDBMS aplica las búsquedas espaciales. Esta propiedad solo afecta a los datos de las geodatabases corporativas y se aplica cuando se especifica el argumento spatial_filter exclusivamente. ATTRIBUTEFIRST—The attribute query will be applied first. SPATIALFIRST— The spatial query will be applied first. (El valor predeterminado es ATTRIBUTEFIRST)	String

Propiedades

Propiedad	Explicación	Tipo de datos
fields (Sólo lectura)	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

Descripción general del método

Método	Explicación
reset ()	Resets the cursor back to the first row.

Métodos

reset ()

Muestra de código

Ejemplo 1 de SearchCursor

Utilice SearchCursor para recorrer paso a paso una clase de entidad e imprimir valores de campo específicos y las coordenadas x,y del punto.

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

Ejemplo 2 de SearchCursor

Utilice SearchCursor para devolver un conjunto de valores de campo únicos.

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)

Ejemplo 3 de SearchCursor

Utilice SearchCursor para devolver atributos mediante 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]}')

Ejemplo 4 de SearchCursor

Utilice SearchCursor con una cláusula WHERE para identificar las entidades que cumplen criterios específicos.

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

Ejemplo 5 de SearchCursor

Utilice SearchCursor y el método Python sorted para ordenar las filas.

Para ver más opciones de ordenación, consulte el Miniprocedimiento de ordenación de 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]}')

Ejemplo 6 de SearchCursor

Como alternativa, ordene por sql_clause si los datos admiten la cláusula ORDER BY de SQL.

Nota:

La cláusula ORDER BY solo se admiten al trabajar con bases de datos. Ninguna otra fuente de datos lo admite (como 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]}')

Ejemplo 7 de SearchCursor

Use la cláusula TOP de SQL para limitar el número de registros que se devuelven.

Nota:

La cláusula TOP solo se admite en bases de datos de 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]}')

Ejemplo 8 de SearchCursor

Utilice SearchCursor por medio de un filtro espacial con un objeto de geometría.

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

Ejemplo 9 de SearchCursor

Utilice SearchCursor por medio de un filtro espacial con un objeto de geometría de otra clase de entidad.

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