Python ArcGIS MapFeatureLayer.query用法及代码示例

本文简要介绍 python 语言中 arcgis.mapping.MapFeatureLayer.query 的用法。

用法:

query(where='1=1', text=None, out_fields='*', time_filter=None, geometry_filter=None, return_geometry=True, return_count_only=False, return_ids_only=False, return_distinct_values=False, return_extent_only=False, group_by_fields_for_statistics=None, statistic_filter=None, result_offset=None, result_record_count=None, object_ids=None, distance=None, units=None, max_allowable_offset=None, out_sr=None, geometry_precision=None, gdb_version=None, order_by_fields=None, out_statistics=None, return_z=False, return_m=False, multipatch_option=None, quantization_parameters=None, return_centroid=False, return_all_records=True, result_type=None, historic_moment=None, sql_format=None, return_true_curves=False, return_exceeded_limit_features=None, as_df=False, datum_transformation=None, range_values=None, parameter_values=None, **kwargs)

返回：

A FeatureSet 包含与查询匹配的特征，除非另一个

query 方法基于 sql 语句查询Map要素图层。

Parameter	Description
where	可选字符串。默认值为 1=1。选择sql语句。
text	可选字符串。文字搜索文本。如果图层具有与之关联的显示字段，则服务器会在此字段中搜索此文本。
out_fields	可选的要返回的字段名称列表。字段名称可以指定为字段名称列表或逗号分隔的字符串。默认值为“*”，它返回所有字段。
object_ids	可选字符串。要查询的该图层或表的对象ID。对象 ID 值应该是逗号分隔的字符串。
distance	可选整数。输入几何的缓冲距离。距离单位由单位指定。例如，如果距离为 100，则查询几何是一个点，单位设置为米，并返回该点 100 米内的所有点。
units	可选字符串。计算缓冲距离的单位。如果未指定单位，则单位来自几何空间参考。如果未指定几何空间参考，则单位派生自要素服务数据空间参考。此参数仅在 supportsQueryWithDistance 为 true 时适用。 值选择： esriSRUnit_Meter | esriSRUnit_StatuteMile | esriSRUnit_Foot | esriSRUnit_Kilometer | esriSRUnit_NauticalMile | esriSRUnit_USNauticalMile
time_filter	startTime 和 endTime 值的可选列表。 ：句法： >>> time_filter=[<startTime>, <endTime>] 注意： 指定为 datetime.date 、 datetime.datetime 或 timestamp 以毫秒为单位
geometry_filter	可选的 filter 对象。允许根据与另一个几何的空间关系过滤信息。
max_allowable_offset	可选浮点数。此选项可用于指定 max_allowable_offset 用于以 out_sr 为单位对查询操作返回的几何进行概括。如果未指定out_sr，则该值以图层的空间参考为单位。
out_sr	可选整数。返回几何的空间参考的 WKID。
geometry_precision	可选整数。此选项可用于指定查询操作返回的响应几何中的小数位数。这仅适用于 X 和 Y 值(不适用于 m 或 z-values)。
gdb_version	可选字符串。要查询的地理数据库版本。仅当图层的 isDataVersioned 属性为 true 时，此参数才适用。如果未指定，查询将应用于已发布Map的版本。
return_geometry	可选的布尔值。如果 true ，几何图形将与查询一起返回。默认为 true 。
return_distinct_values	可选的布尔值。如果 True ，它会根据 out_fields 中指定的字段返回不同的值。仅当图层的 supportsAdvancedQueries 属性为 true 时，此参数才适用。
return_ids_only	可选的布尔值。默认为 False 。如果 True ，则响应仅包含对象 ID 数组。否则，响应为 FeatureSet 。
return_count_only	可选布尔值。如果 True ，则响应仅包含满足查询的要素/记录的计数。否则，响应是 FeatureSet 。默认为 False 。此选项取代returns_ids_only 参数。如果是 returnCountOnly = True ，响应将返回计数和范围。
return_extent_only	可选的布尔值。如果 True ，响应仅包括满足查询的特征的范围。如果 returnCountOnly=true ，响应将返回计数和范围。默认值为 False 。仅当图层的 supportsReturningQueryExtent 属性为 true 时，此参数才适用。
order_by_fields	可选字符串。一个或多个用于对结果进行排序的字段名称。在要排序的每个字段之后，分别使用 ASC 或 DESC 进行升序或降序： >>> order_by_fields = "STATE_NAME ASC, RACE DESC, GENDER ASC"
group_by_fields_for_statistics	可选字符串。一个或多个字段名称，用于对结果进行分组以计算统计信息。 >>> group_by_fields_for_statiscits = "STATE_NAME, GENDER"
out_statistics	可选列表。要计算的一个或多个基于字段的统计数据的定义。 用法 >>> out_statistics = [ { "statisticType": "<count | sum | min | max | avg | stddev | var>", "onStatisticField": "Field1", "outStatisticFieldName": "Out_Field_Name1" }, { "statisticType": "<count | sum | min | max | avg | stddev | var>", "onStatisticField": "Field2", "outStatisticFieldName": "Out_Field_Name2" } ]
return_z	可选的布尔值。如果 True ，如果要素具有 Z 值，则 Z 值将包含在结果中。否则，不返回 Z 值。默认值为 False 。
return_m	可选的布尔值。如果 True ，如果特征具有 M 个值，则 M 个值包含在结果中。否则，不返回 M 值。默认值为 False 。
multipatch_option	可选的 x/y 足迹。此选项规定如何返回多面体要素的几何。
result_offset	可选整数。该选项可用于通过跳过指定数量的记录并从下一条记录(即resultOffset + ith值)开始获取查询结果。如果 return_all_records 为 True(即默认情况下)，则忽略此选项。
result_record_count	可选整数。此选项可用于获取最多指定 result_record_count 的查询结果。当指定 result_offset 但未指定此参数时，Map服务会将其默认为 max_record_count 。此参数的最大值是图层的maxRecordCount 属性的值。如果 return_all_records 为 True(即默认情况下)，则忽略此选项。
quantization_parameters	可选字典。用于将几何体投影到虚拟网格上，可能代表屏幕上的像素。
return_centroid	可选的布尔值。用于返回与返回的每个特征关联的几何质心。如果 True ，则结果包括几何质心。默认值为 False 。
return_all_records	可选的布尔值。当 True 时，查询操作将调用该服务，直到返回所有满足 where_clause 的记录。 注意： result_offset 和 result_record_count 如果设置为 True 将被忽略。如果 return_count_only 、 return_ids_only 或 return_extent_only 是 True ，则忽略此参数。
result_type	可选字符串。控制操作返回的特征数。选项：None | standard | tile 注意： 有关完整说明，请参阅Query (Feature Service/Layer)。
historic_moment	可选整数。历史性时刻查询。此参数仅在图层启用归档且 supportsQueryWithHistoricMoment 属性设置为 true 时适用。该属性在图层的 properties 资源中提供。如果未指定，则查询将应用于当前函数。
sql_format	可选字符串。 sql_format 参数可以是标准 SQL92，也可以使用底层数据存储的本机 SQL。默认值为 None ，这意味着它取决于 useStandardizedQuery 图层属性。值：None | standard | native
return_true_curves	可选的布尔值。当设置为 True 时，返回输出几何图形中的真实曲线。当设置为 False 时，曲线将转换为致密的多段线或多边形。
return_exceeded_limit_features	可选的布尔值。可选参数，默认为 true。设置为 true 时，即使结果包含 exceededTransferLimit: True 属性，也会返回特征。 当设置为 False 并使用 resultType = tile 查询时，如果结果包括 exceededTransferLimit: True ，则不会返回特征。这允许客户端在不进行多次调用的情况下找到不再超过传输限制的分辨率。
as_df	可选的布尔值。如果 True ，结果将返回为 DataFrame 而不是 FeatureSet 。
datum_transformation	可选整数/字典。当out_sr 与图层的空间参考不同时，此参数在投影结果中的几何图形时应用基准面变换。指定转换时，您需要考虑哪种基准面转换最适合将图层(而非要素服务)投影到图层属性中的 outSR 和 sourceSpatialReference 属性。有关有效基准面转换 ID 值和已知文本字符串的列表，请参阅Coordinate systems and transformations。有关基准转换的更多信息，请参阅Project operation 中的转换参数。 例子： Inputs Description WKID 整数。 >>> datum_transformation=4326 WKT 字典。 >>> datum_transformation = {"wkt": "<WKT>"} Composite 字典。 >>> datum_transformation = {"geoTransforms" : [ {"wkid" : "<id>", "forward" : True | False}, {"wkt" : "WKT", "forward" : True: False} ] }
range_values	可选列表。允许您从图层中过滤指定范围瞬间或范围内的要素。 >>> range_values = [ { "name": "range name" , # single value or a value-range "value": <value> or [ <value1>, <value2> ] }, { "name": "range name 2", "value": <value> or [ <value3>, <value4> ] } ] 注意： None 允许在 value-range 情况下表示无穷大 # all features with values <= 1500 >>> range_values = [ {"name" : "range name", "value" : [None, 1500]} ] # all features with values >= 1000 >>> range_values = [ {"name" : "range name", "value" : [1000, None]} ]
parameter_values	可选字典。允许您通过为这些图层指定一组预先编写的参数化过滤器的值来过滤这些图层。如果没有为请求中的任何参数指定值，则会使用在创作期间分配的默认值。 当 parameterInfo 允许多个值时，您必须在数组中传递它们。 注意： 检查 layer resources 中的 parameterInfos 以获取可用的参数化过滤器、它们的默认值和预期的数据类型。
kwargs	可选字典。可以传递给查询函数的可选参数。这将允许用户传递未在函数上明确实现的附加参数。 Query (Feature Service/Layer) 记录了可用函数的完整列表。

指定返回类型，例如 count 。

例子：

# USAGE EXAMPLE

>>> from arcgis.mapping import MapImageLayer, MapFeatureLayer
>>> from arcgis.gis import GIS

# connect to your GIS and get the web map item
>>> gis = GIS(url, username, password)

>>> map_image_item = gis.content.get("2aaddab96684405880d27f5261125061")
>>> map_feature_layer = MapFeatureLayer.fromitem(item = map_image_item,
                                                 layer_id = 2)
>>> query_count = map_feature_layer.query(where "1=1",
                            text = "Hurricane Data",
                            units = "esriSRUnit_Meter",
                            return_count_only = True,
                            out_statistics = [
                                                {
                                                "statisticType": "count",
                                                "onStatisticField": "Field1",
                                                "outStatisticFieldName": "Out_Field_Name1"
                                                },
                                                {
                                                "statisticType": "avg",
                                                "onStatisticField": "Field2",
                                                "outStatisticFieldName": "Out_Field_Name2"
                                                }
                                            ],
                            range_values= [
                                    {
                                      "name": "range name",
                                      "value": [None, 1500]
                                      },
                                      {
                                        "name": "range name 2",
                                        "value":[1000, None]
                                      }
                                    }
                                ]
                            )
>>> query_count
<149>