SearchCursor

Resumen

SearchCursor establece acceso de solo lectura a los registros devueltos de una tabla o clase de entidad.

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

Debate

Geometry es posible acceder a las propiedades especificando el token SHAPE@ en la lista de campos.

Es posible iterar los cursores de búsqueda mediante un bucle for. Los cursores de búsqueda también admiten sentencias with para restablecer la iteración y ayudar en la eliminación de 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 que devuelve SearchCursor se pueden restringir para que coincidan con los criterios de atributos o espaciales.

Acceder a la geometría completa con SHAPE@ es una operación costosa. Si solo se requiere información de geometría sencilla, 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 eficiente.

En Python 2, SearchCursor admite el método next de iterador para recuperar la siguiente fila fuera de un bucle. En Python 3, se realiza lo equivalente mediante la función next integrada de Python.

Sintaxis

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

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 si desea acceder a todos los campos desde la tabla de entrada (se excluyen los campos ráster y 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. Los campos ráster no se admiten. Es posible acceder a información adicional con tokens (como OID@) en lugar de nombres de campo: 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. Este token solo se admite cuando la geometría está habilitada para z. 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. SHAPE@WKT —Representación en texto conocida (WKB) 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. OID@ —Valor del campo ObjectID.	String
where_clause	Una expresión opcional que limita los registros que se devuelven. Para obtener más información sobre las cláusulas WHERE y sentencias SQL, consulte Referencia SQL para los elementos utilizados en las expresiones de consulta. (El valor predeterminado es None)	String
spatial_reference	La referencia espacial de la clase de entidad. Se puede especificar con un objeto SpatialReference o un equivalente de cadena. (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 opcional de cláusulas prefix y postfix de SQL organizadas en una lista o tupla. An SQL prefix clause supports None, DISTINCT, and TOP. An SQL postfix clause supports None, ORDER BY, and GROUP BY. 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 se admite en bases de datos de SQL Server. (El valor predeterminado es (None, None))	tuple

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. 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

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

Use SearchCursor para recorrer 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(u'{0}, {1}, {2}'.format(row[0], row[1], row[2]))

Ejemplo 2 de SearchCursor

Use 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)]
uniqueValues = set(values)

print(uniqueValues)

Ejemplo 3 de SearchCursor

Use SearchCursor para devolver atributos con 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('Feature {} has an area of {}'.format(row[0], row[1]))

Ejemplo 4 de SearchCursor

Use SearchCursor con una cláusula WHERE para identificar entidades que cumplen criterios concretos.

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

Ejemplo 5A de SearchCursor

Use SearchCursor y el método de ordenación de Python para ordenar 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(u'{0}, {1}'.format(row[0], row[1]))

Ejemplo 5B de SearchCursor

Como alternativa, ordene con sql_clause si los datos admiten ORDER BY de SQL.

Nota:

ORDER BY solo se admite al trabajar con bases de datos. Ninguna otra fuente de datos lo admite (como las tablas INFO o dBASE).

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

Ejemplo 6 de SearchCursor

Use TOP de SQL para limitar el número de registros que se devuelven.

Nota:

TOP solo se admite en bases de datos de SQL Server y MS Access.

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