UpdateCursor—ArcGIS Pro | ドキュメント

サマリー

UpdateCursor establishes read-write access to records returned from a feature class or table.

Returns an iterator of lists. The order of values in the list matches the order of fields specified by the field_names argument.

Learn more about data access using cursors

説明

Update cursors can be iterated using a for loop. Update 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.

異なるカーソルを使用して、同じワークスペースで同時に挿入または更新操作を開くには、編集セッションの開始が必要です。

編集セッション内でのみ編集できるデータセットタイプの一部を次に示します。

トポロジに属しているフィーチャクラス
ジオメトリックネットワークに属しているフィーチャクラス
ネットワークデータセットに属しているフィーチャクラス
エンタープライズジオデータベース内のバージョン対応データセット
クラスエクステンションを持つ一部のオブジェクトとフィーチャクラス

In Python 2, UpdateCursor supports the iterator next method to retrieve the next row outside of a loop. In Python 3, the equivalent is performed by using the Python built-in next function.

注意:

The Calculate Field and Calculate Fields tools can also be used to update field values.

注意:

Using an UpdateCursor on a layer with a joined table is not supported.

構文

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

パラメーター	説明	データタイプ
in_table	フィーチャクラス、レイヤー、テーブル、またはテーブルビュー。	String
field_names [field_names,...]	フィールド名のリスト (またはタプル)。単一フィールドの場合、文字列のリストの代わりに文字列を使用できます。フィールドのリストの代わりにアスタリスク (*) を使用すると、入力テーブルのすべてのフィールドにアクセスできます (BLOB フィールドは除きます)。ただし、パフォーマンスとフィールドの順序の信頼性を高めるために、フィールドのリストは実際に必要なフィールドのみに絞り込むことをお勧めします。ラスターフィールドはサポートされていません。その他の情報には、フィールド名の代わりにトークン (OID@ など) を使用してアクセスできます。 ANNO@—フィーチャの Annotation オブジェクト。このオプションは、ArcGIS Pro アノテーションフィーチャクラスのみで有効です。 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 オブジェクトとして返されますが、bytearray または bytes オブジェクトとして更新できます。 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 オブジェクトまたはそれに相当する文字列です。 (デフォルト値は次のとおりです 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 for a table located in a file geodatabase. DISTINCT is not honored in a relational database. `with arcpy.da.UpdateCursor( in_features, ["OID@", "STREET_NAME"], sql_clause=("DISTINCT STREET_NAME", None) ) as cur: print('Additional code')` Use TOP in a prefix clause and ORDER BY in a postfix clause. `with arcpy.da.UpdateCursor( in_features, ['OID@', "ELEVATION"], sql_clause=("TOP 5", "ORDER BY ELEVATION DESC") ) as cur: print('Additional code')` Use GROUP BY in a postfix clause. `with arcpy.da.UpdateCursor( in_features, ['STREET_NAME'], sql_clause=(None, "GROUP BY STREET_NAME") ) as cur: print('Additional code')` 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 つの空間参照から別の空間参照に投影する際に、これらの空間参照が同じ測地基準系を共有していない場合は、適切な測地基準系変換を指定する必要があります。 An update cursor can perform a projection or transformation at two stages: when reading the features from the feature class on disk and when writing the updated features to the feature class. ListTransformations 関数を使用すると、2 つの空間参照の間で有効な測地基準系変換のリストを表示できます。測地基準系変換の詳細	String
explicit [explicit,...]	フィールドにデフォルト値があり、フィールドで NULL 値が許可されている場合、True の値を使用すると、デフォルト値が明示的にオーバーライドされ、NULL 値がレコードに挿入されます。値として False を使用すると、NULL の代わりにデフォルト値が挿入されます。 Apply the explicit rule to all fields: `with arcpy.da.UpdateCursor(table, [field1, field2, field3], explicit=True) as cursor: print('Additional code')` ブール値のリストを使用して、フィールドごとに明示的なルールを適用することもできます。値のリストの長さはフィールドのリストと揃える必要があります。 Apply the explicit rule to only the first two fields: `with arcpy.da.UpdateCursor(table, [field1, field2, field3], explicit=[True, True, False]) as cursor: print('Additional code')` (デフォルト値は次のとおりです False)	Boolean
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

方法の概要

方法	説明
deleteRow ()	Deletes the current row.
reset ()	Resets the cursor back to the first row.
updateRow (row)	Updates the current row in the table.

方法

deleteRow ()

reset ()

updateRow (row)

パラメーター	説明	データタイプ
row	A list or tuple of values. The order of values should be in the same order as the fields. When updating fields, if the incoming values match the type of field, the values will be cast as necessary. For example, a value of 1.0 to a string field will be added as "1.0", and a value of "25" added to a float field will be added as 25.0.	tuple

パラメーター

説明

データタイプ

row

A list or tuple of values. The order of values should be in the same order as the fields.

When updating fields, if the incoming values match the type of field, the values will be cast as necessary. For example, a value of 1.0 to a string field will be added as "1.0", and a value of "25" added to a float field will be added as 25.0.

tuple

コードのサンプル

UpdateCursor example 1

Use UpdateCursor to update a field value by evaluating the values of other fields.

import arcpy

fc = 'c:/data/base.gdb/well'
fields = ['WELL_YIELD', 'WELL_CLASS']

# Create update cursor for feature class 
with arcpy.da.UpdateCursor(fc, fields) as cursor:
    # For each row, evaluate the WELL_YIELD value (index position 
    # of 0), and update WELL_CLASS (index position of 1)
    for row in cursor:
        if (row[0] >= 0 and row[0] <= 10):
            row[1] = 1
        elif (row[0] > 10 and row[0] <= 20):
            row[1] = 2
        elif (row[0] > 20 and row[0] <= 30):
            row[1] = 3
        elif (row[0] > 30):
            row[1] = 4

        # Update the cursor with the updated list
        cursor.updateRow(row)

UpdateCursor example 2

Use UpdateCursor to update a field of buffer distances for use with the Buffer function.

import arcpy

arcpy.env.workspace = 'c:/data/output.gdb'
fc = 'c:/data/base.gdb/roads'
fields = ['ROAD_TYPE', 'BUFFER_DISTANCE']

# Create update cursor for feature class 
with arcpy.da.UpdateCursor(fc, fields) as cursor:
    # Update the field used in Buffer so the distance is based on road 
    # type. Road type is either 1, 2, 3, or 4. Distance is in meters. 
    for row in cursor:
        # Update the BUFFER_DISTANCE field to be 100 times the 
        # ROAD_TYPE field.
        row[1] = row[0] * 100
        cursor.updateRow(row) 

# Buffer feature class using updated field values
arcpy.analysis.Buffer(fc, 'roads_buffer', 'BUFFER_DISTANCE')

UpdateCursor example 3

Use UpdateCursor with a spatial filter to update field values.

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 = ["OCCUPIED"]

with arcpy.da.UpdateCursor(
    fc, fields, where_clause="OCCUPIED != 'Vacant'", spatial_filter=new_road
) as cursor:
    for row in cursor:
        row[0] = 'Vacant'
        cursor.updateRow(row)

サマリー

説明

注意:

注意:

構文

注意:

プロパティ

方法の概要

方法

コードのサンプル

関連トピック

このトピックの内容

関連トピック