SearchRelatedRecords—ArcGIS AllSource

サマリー

The SearchRelatedRecords object retrieves related records based on the relationship between the origin and destination feature class or table defined in a relationship class.

The object returns an iterator of tuples. Each tuple contains two items: the first item is a row (tuple) from the origin table and the second item is a row (tuple) from the destination table.

説明

The SearchRelatedRecords class can be iterated using a for loop. The order that records are yielded may not match the order of the ObjectID values passed to the oids_to_search parameter. The SearchRelatedRecords object also supports with statements to aid in the removal of data locks.

The exact fields returned from each table can be controlled with the origin_fields and destination_fields parameters. Either origin_fields or destination_fields can be omitted individually, but at least one of them must be provided an argument. If one of these parameters is not provided an argument, the other must be provided an argument.

Origin and destination feature class Geometry object properties can be accessed by providing the SHAPE@ token in the respective list of fields. However, accessing full geometry with the SHAPE@ token is a computationally intensive 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.

By default, the relationship is read in the forward direction. This means that the provided ObjectID values apply to the origin table and are used to find related records in the destination table. To reverse the direction, set the backward parameter to True. Now the provided ObjectID values apply to the destination table and are used to find related records in the origin table.

If no related records are found for a provided ObjectID value, no results will be yielded for that record.

構文

SearchRelatedRecords (relationship_class, {oids_to_search}, {origin_fields}, {destination_fields}, {backward})

パラメーター	説明	データタイプ
relationship_class	The path to the relationship class.	String
oids_to_search [oids_to_search,...]	A list of ObjectID values that will be used to search for related records. Use an asterisk () instead of a list of ObjectID values to search for all related records. (デフォルト値は次のとおりです "")	Integer
origin_fields [origin_fields,...]	フィールド名のリスト (またはタプル)。単一フィールドの場合、文字列のリストの代わりに文字列を使用できます。フィールドのリストの代わりにアスタリスク (*) を使用すると、入力テーブルのすべてのフィールドにアクセスできます (BLOB フィールドは除きます)。ただし、パフォーマンスとフィールドの順序の信頼性を高めるために、フィールドのリストは実際に必要なフィールドのみに絞り込むことをお勧めします。その他の情報には、フィールド名の代わりにトークン (OID@ など) を使用してアクセスできます。 If no argument is passed to origin_fields, you must pass an argument to destination_fields. 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@—サブタイプコードの整数。 (デフォルト値は次のとおりです None)	String
destination_fields [destination_fields,...]	フィールド名のリスト (またはタプル)。単一フィールドの場合、文字列のリストの代わりに文字列を使用できます。フィールドのリストの代わりにアスタリスク (*) を使用すると、入力テーブルのすべてのフィールドにアクセスできます (BLOB フィールドは除きます)。ただし、パフォーマンスとフィールドの順序の信頼性を高めるために、フィールドのリストは実際に必要なフィールドのみに絞り込むことをお勧めします。その他の情報には、フィールド名の代わりにトークン (OID@ など) を使用してアクセスできます。 If no argument is passed to destination_fields, you must pass an argument to origin_fields. 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@—サブタイプコードの整数。 (デフォルト値は次のとおりです None)	String
backward	The directionality of the related record search. Set to False to search the relationship from the origin table to the destination table. Set to True to search the relationship from the destination table to the origin table. (デフォルト値は次のとおりです False)	Boolean

方法の概要

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

方法

reset ()

コードのサンプル

SearchRelatedRecords example 1

Use the SearchRelatedRecords class to find all the Buildings related to a set of Parcels.

import arcpy

relc = os.path.join(arcpy.env.workspace, "Parcel_Building_Rel")
oids = [2710, 1010]

with arcpy.da.SearchRelatedRecords(relc, oids, origin_fields="APN", destination_fields="BUILDING_NUMBER") as related_records:
    for record in related_records:
        print(record)

SearchRelatedRecords example 2

Use the SearchRelatedRecords class in the backward direction to find Parcels related to a set of Buildings

import arcpy

relc = os.path.join(arcpy.env.workspace, "Parcel_Building_Rel")
oids = [850, 921, 1018, 2301]

with arcpy.da.SearchRelatedRecords(relc, oids, origin_fields="APN", destination_fields="BUILDING_NUMBER", backward=True) as related_records:
    for record in related_records:
        print(record)

SearchRelatedRecords example 3

Use the SearchRelatedRecords class to retrieve attributes using tokens. This example also demonstrates omitting one of the field parameters, which can be useful when you're only interested in the related records.

import arcpy

relc = os.path.join(arcpy.env.workspace, "Parcel_Building_Rel")
oids = [2710]

with arcpy.da.SearchRelatedRecords(relc, oids, destination_fields=["OID@", "SHAPE@AREA"]) as related_records:
    for record in related_records:
        print(record)

SearchRelatedRecords example 4

Use the Python sorted function to sort records returned by SearchRelatedRecords. This example also demonstrates omitting the oids_to_search parameter, which will cause the SearchRelatedRecords class to return all related records.

import arcpy

relc = os.path.join(arcpy.env.workspace, "Parcel_Building_Rel")

for record in sorted(arcpy.da.SearchRelatedRecords(relc, origin_fields="APN", destination_fields=["BUILDING_NUMBER", "POPULATION"])):
    print(record)

このトピックへのフィードバック

サマリー

説明

構文

方法の概要

方法

コードのサンプル

このトピックの内容