SearchCursor—ArcGIS Pro | ドキュメント

サマリー

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

説明

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.

構文

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

パラメーター	説明	データタイプ
in_table	フィーチャクラス、レイヤー、テーブル、またはテーブルビュー。	String
field_names [field_names,...]	フィールド名のリスト (またはタプル)。単一フィールドの場合、文字列のリストの代わりに文字列を使用できます。フィールドのリストの代わりにアスタリスク (*) を使用すると、入力テーブルのすべてのフィールドにアクセスできます (BLOB フィールドは除きます)。ただし、パフォーマンスとフィールドの順序の信頼性を高めるために、フィールドのリストは実際に必要なフィールドのみに絞り込むことをお勧めします。その他の情報には、フィールド名の代わりにトークン (OID@ など) を使用してアクセスできます。 SHAPE@XY—フィーチャの重心を表す X 座標と Y 座標の組み合わせ SHAPE@XYZ—フィーチャの重心を表す XYZ 座標の組み合わせ SHAPE@TRUECENTROID—フィーチャの重心を表す X 座標と Y 座標の組み合わせ SHAPE@XY と同じ値が返されます。 SHAPE@X—フィーチャの X 座標 (Double) SHAPE@Y—フィーチャの Y 座標 (Double) SHAPE@Z—フィーチャの Z 座標 (Double) SHAPE@M—フィーチャの M 値 (Double) SHAPE@JSON—ジオメトリを表す Esri JSON 文字列 SHAPE@WKB—OGC ジオメトリの WKB (Well-Known Binary) 表現。ジオメトリ値の汎用的な表現が、連続的なバイトストリームとして提供されます。値は bytearray オブジェクトとして返されます。 SHAPE@WKT—OGC ジオメトリの WKT (Well-Known Text) 表現。ジオメトリ値の汎用的な表現が、テキスト文字列として提供されます。 SHAPE@—フィーチャのジオメトリオブジェクト SHAPE@AREA—フィーチャの面積 (Double) SHAPE@LENGTH—フィーチャの長さ (Double) CREATED@—フィーチャが作成されたときの datetime オブジェクト。このフィールドは読み取り専用です。 CREATOR@—フィーチャを作成したユーザー名の文字列。このフィールドは読み取り専用です。 EDITED@—フィーチャが最後に編集されたときの datetime オブジェクト。このフィールドは読み取り専用です。 EDITOR@—フィーチャを最後に編集したユーザー名の文字列。このフィールドは読み取り専用です。 GLOBALID@—フィーチャのユニバーサルに一意な識別子の文字列。このフィールドは読み取り専用です。 OID@—Object ID フィールドの値 SUBTYPE@—サブタイプコードの整数。	String
where_clause	返されるレコードを制限するオプションの式。 WHERE 句と SQL ステートメントの詳細については、「ArcGIS で使用されるクエリ式への SQL リファレンス」をご参照ください。 (デフォルト値は次のとおりです None)	String
spatial_reference	フィーチャクラスの空間参照。この引数を指定すると、フィーチャが入力の空間参照から投影 (または変換) されます。指定しないと、入力フィーチャクラスの空間参照が使用されます。この引数に有効な値は、SpatialReference オブジェクトまたはそれに相当する文字列です。 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. (デフォルト値は次のとおりです None)	SpatialReference
explode_to_points	フィーチャを個々のポイントまたは頂点に分解します。 explode_to_points が True に設定されている場合、たとえば 5 つのポイントがあるマルチポイントフィーチャは 5 つの行で表現されます。 (デフォルト値は次のとおりです False)	Boolean
sql_clause	リストまたはタプルに編成された、SQL の接頭辞句と接尾辞句のペア。 SQL 接頭辞句は None、DISTINCT、TOP をサポートしています。 SQL 接尾辞句は None、ORDER BY、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:` SQL 接頭辞句は最初の位置に配置され、SELECT キーワードと SELECT COLUMN LIST との間に挿入されます。 SQL 接頭辞句は、DISTINCT や ALL などの句で最も多く使用されます。 SQL 接尾辞句は 2 番目の位置に配置され、Where 句に続く SELECT ステートメントに追加されます。 SQL 接尾辞句は、ORDER BY などの句で最も多く使用されます。注意: DISTINCT、ORDER BY、ALL は、データベースを操作する場合のみサポートされています。他のデータソース (dBASE や INFO テーブルなど) ではサポートされていません。 TOP は、SQL Server データベースでのみサポートされています。 (デフォルト値は次のとおりです (None, None))	tuple
datum_transformation	カーソルでフィーチャを 1 つの空間参照から別の空間参照に投影する際に、これらの空間参照が同じ測地基準系を共有していない場合は、適切な測地基準系変換を指定する必要があります。 ListTransformations 関数を使用すると、2 つの空間参照の間で有効な測地基準系変換のリストを表示できます。測地基準系変換の詳細 (デフォルト値は次のとおりです None)	String
spatial_filter	フィーチャを空間的にフィルター処理するために使用されるジオメトリオブジェクト。この引数を指定すると、カーソルは指定したジオメトリと [spatial_relationship] の値に基づいて、返されるフィーチャを制限します。 (デフォルト値は次のとおりです None)	Geometry
spatial_relationship	spatial_filter 引数の入力ジオメトリとクエリジオメトリ間の空間リレーションシップ。この引数は、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. (デフォルト値は次のとおりです INTERSECTS)	String
search_order	RDBMS によって空間検索が適用される順序。このプロパティはエンタープライズジオデータベースデータにのみ影響し、spatial_filter 引数を指定した場合にのみ適用されます。 ATTRIBUTEFIRST—The attribute query will be applied first. SPATIALFIRST— The spatial query will be applied first. (デフォルト値は次のとおりです ATTRIBUTEFIRST)	String

プロパティ

プロパティ	説明	データタイプ
fields (読み取り専用)	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

説明

データタイプ

fields

(読み取り専用)

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

方法の概要

方法	説明
reset ()	Resets the cursor back to the first row.

方法

reset ()

コードのサンプル

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.

注意:

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.

注意:

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

サマリー

説明

構文

注意:

プロパティ

方法の概要

方法

コードのサンプル

注意:

注意:

関連トピック

このトピックの内容

関連トピック