1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
//! Query operations for the Feature Service client.
use super::super::{FeatureQueryParams, FeatureSet};
use super::FeatureServiceClient;
use crate::{LayerId, Result};
use tracing::instrument;
impl<'a> FeatureServiceClient<'a> {
/// Queries features from a specific layer with pre-built parameters.
///
/// This is a lower-level method. For most use cases, prefer the
/// [`query`](Self::query) builder method.
///
/// # Example
/// ```no_run
/// use arcgis::{ApiKeyAuth, ArcGISClient, FeatureQueryParams, FeatureServiceClient, LayerId};
///
/// # async fn example() -> arcgis::Result<()> {
/// let auth = ApiKeyAuth::new("YOUR_API_KEY");
/// let client = ArcGISClient::new(auth);
/// let feature_service = FeatureServiceClient::new(
/// "https://services.arcgis.com/org/arcgis/rest/services/Dataset/FeatureServer",
/// &client,
/// );
///
/// let params = FeatureQueryParams::builder()
/// .where_clause("POPULATION > 100000")
/// .out_fields(vec!["NAME".to_string(), "POPULATION".to_string()])
/// .build()
/// .unwrap();
///
/// let features = feature_service.query_with_params(LayerId::new(0), params).await?;
/// println!("Retrieved {} features", features.features().len());
/// # Ok(())
/// # }
/// ```
#[instrument(skip(self, params), fields(layer_id = %layer_id, base_url = %self.base_url))]
pub async fn query_with_params(
&self,
layer_id: LayerId,
params: FeatureQueryParams,
) -> Result<FeatureSet> {
tracing::debug!("Querying feature layer");
// Construct the query URL
let url = format!("{}/{}/query", self.base_url, layer_id);
tracing::debug!(url = %url, "Sending query request");
// Build request with query parameters
let mut request = self.client.http().get(&url).query(¶ms);
// Add token if required by auth provider
if let Some(token) = self.client.get_token_if_required().await? {
request = request.query(&[("token", token)]);
}
let response = request.send().await?;
// Check for HTTP errors
let status = response.status();
if !status.is_success() {
let error_text = response
.text()
.await
.unwrap_or_else(|e| format!("Failed to read error response: {}", e));
tracing::error!(status = %status, error = %error_text, "Query request failed");
return Err(crate::Error::from(crate::ErrorKind::Api {
code: status.as_u16() as i32,
message: format!("HTTP {}: {}", status, error_text),
}));
}
// Parse the response based on the requested format
let feature_set = match params.format() {
crate::ResponseFormat::Pbf => {
// PBF format - decode binary protocol buffer
let bytes = response.bytes().await?;
tracing::debug!(bytes_len = bytes.len(), "Received PBF response");
super::super::pbf::decode_feature_collection(&bytes)?
}
crate::ResponseFormat::GeoJson => {
// GeoJSON format - convert from GeoJSON to FeatureSet
let geojson_fc: geojson::FeatureCollection = response.json().await?;
tracing::debug!(
feature_count = geojson_fc.features.len(),
"Received GeoJSON response"
);
super::super::geojson::from_geojson(geojson_fc)?
}
crate::ResponseFormat::Json => {
// Standard ArcGIS JSON format
response.json().await?
}
};
tracing::debug!(
feature_count = feature_set.features().len(),
exceeded_limit = feature_set.exceeded_transfer_limit(),
format = ?params.format(),
"Query completed successfully"
);
Ok(feature_set)
}
/// Queries related records for specified object IDs.
///
/// This method retrieves records from related tables/layers based on relationship classes.
/// Results are grouped by source object ID.
///
/// # Arguments
///
/// * `layer_id` - The layer to query from
/// * `params` - Related records query parameters
///
/// # Example
///
/// ```no_run
/// use arcgis::{ApiKeyAuth, ArcGISClient, FeatureServiceClient, LayerId, ObjectId, RelatedRecordsParams};
///
/// # async fn example() -> arcgis::Result<()> {
/// let auth = ApiKeyAuth::new("YOUR_API_KEY");
/// let client = ArcGISClient::new(auth);
/// let service = FeatureServiceClient::new(
/// "https://services.arcgis.com/org/arcgis/rest/services/Dataset/FeatureServer",
/// &client,
/// );
///
/// let params = RelatedRecordsParams::builder()
/// .object_ids(vec![ObjectId::new(1), ObjectId::new(2)])
/// .relationship_id(3u32)
/// .out_fields(vec!["NAME".to_string(), "STATUS".to_string()])
/// .build()
/// .expect("Valid params");
///
/// let response = service.query_related_records(LayerId::new(0), params).await?;
/// for group in response.related_record_groups() {
/// println!("Object {}: {} related records",
/// group.object_id(),
/// group.related_records().len());
/// }
/// # Ok(())
/// # }
/// ```
#[instrument(skip(self, params), fields(layer_id = %layer_id, base_url = %self.base_url))]
pub async fn query_related_records(
&self,
layer_id: LayerId,
params: crate::RelatedRecordsParams,
) -> Result<crate::RelatedRecordsResponse> {
tracing::debug!("Querying related records");
// Construct the URL
let url = format!("{}/{}/queryRelatedRecords", self.base_url, layer_id);
tracing::debug!(url = %url, "Sending query related records request");
// Build request with query parameters
let mut request = self.client.http().get(&url).query(¶ms);
// Add token if required by auth provider
if let Some(token) = self.client.get_token_if_required().await? {
request = request.query(&[("token", token)]);
}
let response = request.send().await?;
// Check for HTTP errors
let status = response.status();
if !status.is_success() {
let error_text = response
.text()
.await
.unwrap_or_else(|e| format!("Failed to read error response: {}", e));
tracing::error!(status = %status, error = %error_text, "Query related records request failed");
return Err(crate::Error::from(crate::ErrorKind::Api {
code: status.as_u16() as i32,
message: format!("HTTP {}: {}", status, error_text),
}));
}
// Parse the response
let result: crate::RelatedRecordsResponse = response.json().await?;
tracing::debug!(
groups_count = result.related_record_groups().len(),
"Query related records completed successfully"
);
Ok(result)
}
/// Queries top features from a layer based on ranking within groups.
///
/// The queryTopFeatures operation returns features based on top features by order within a group.
/// For example, you can query the top 3 most populous cities from each state.
///
/// # Arguments
///
/// * `layer_id` - The layer to query
/// * `params` - Top features query parameters including topFilter (required)
///
/// # Example
///
/// ```no_run
/// use arcgis::{ApiKeyAuth, ArcGISClient, FeatureServiceClient, LayerId, TopFeaturesParams, TopFilter};
///
/// # async fn example() -> arcgis::Result<()> {
/// let auth = ApiKeyAuth::new("YOUR_API_KEY");
/// let client = ArcGISClient::new(auth);
/// let service = FeatureServiceClient::new(
/// "https://services.arcgis.com/org/arcgis/rest/services/Dataset/FeatureServer",
/// &client,
/// );
///
/// // Get top 3 most populous cities from each state
/// let filter = TopFilter::new(
/// vec!["State".to_string()],
/// 3,
/// vec!["Population DESC".to_string()],
/// );
///
/// let params = TopFeaturesParams::builder()
/// .top_filter(filter)
/// .out_fields(vec!["Name".to_string(), "State".to_string(), "Population".to_string()])
/// .build()
/// .expect("Valid params");
///
/// let feature_set = service.query_top_features(LayerId::new(0), params).await?;
/// for feature in feature_set.features() {
/// println!("City: {:?}", feature.attributes().get("Name"));
/// }
/// # Ok(())
/// # }
/// ```
#[instrument(skip(self, params), fields(layer_id = %layer_id, base_url = %self.base_url))]
pub async fn query_top_features(
&self,
layer_id: LayerId,
params: crate::TopFeaturesParams,
) -> Result<crate::FeatureSet> {
tracing::debug!("Querying top features");
// Construct the URL
let url = format!("{}/{}/queryTopFeatures", self.base_url, layer_id);
tracing::debug!(url = %url, "Sending query top features request");
// Build request with query parameters
let mut request = self.client.http().get(&url).query(¶ms);
// Add token if required by auth provider
if let Some(token) = self.client.get_token_if_required().await? {
request = request.query(&[("token", token)]);
}
let response = request.send().await?;
// Check for HTTP errors
let status = response.status();
if !status.is_success() {
let error_text = response
.text()
.await
.unwrap_or_else(|e| format!("Failed to read error response: {}", e));
tracing::error!(status = %status, error = %error_text, "Query top features request failed");
return Err(crate::Error::from(crate::ErrorKind::Api {
code: status.as_u16() as i32,
message: format!("HTTP {}: {}", status, error_text),
}));
}
// Parse the response based on the requested format
let result = if let Some(format_str) = params.f() {
if format_str == "pbf" {
// PBF format - decode binary protocol buffer
let bytes = response.bytes().await?;
tracing::debug!(bytes_len = bytes.len(), "Received PBF response");
super::super::pbf::decode_feature_collection(&bytes)?
} else {
// JSON or GeoJSON format - use standard JSON parsing
response.json().await?
}
} else {
// Default to JSON parsing
response.json().await?
};
tracing::debug!(
features_count = result.features().len(),
format = ?params.f(),
"Query top features completed successfully"
);
Ok(result)
}
/// Efficiently counts features matching a query without returning feature data.
///
/// This operation returns only the count of features matching the query criteria,
/// making it much more efficient than querying all features and counting them.
///
/// # Arguments
///
/// * `layer_id` - The layer to query
/// * `where_clause` - SQL WHERE clause to filter features (default: "1=1")
///
/// # Returns
///
/// The count of features matching the query.
///
/// # Example
///
/// ```no_run
/// use arcgis::{ArcGISClient, ApiKeyAuth, FeatureServiceClient, LayerId};
///
/// # async fn example() -> arcgis::Result<()> {
/// let auth = ApiKeyAuth::new("YOUR_API_KEY");
/// let client = ArcGISClient::new(auth);
/// let service = FeatureServiceClient::new("https://example.com/FeatureServer", &client);
///
/// // Count all features
/// let total_count = service.query_feature_count(LayerId::new(0), "1=1").await?;
///
/// // Count features matching criteria
/// let filtered_count = service
/// .query_feature_count(LayerId::new(0), "STATE = 'CA' AND POPULATION > 100000")
/// .await?;
/// # Ok(())
/// # }
/// ```
#[instrument(skip(self, where_clause), fields(layer_id = %layer_id))]
pub async fn query_feature_count(
&self,
layer_id: LayerId,
where_clause: impl Into<String>,
) -> Result<u32> {
tracing::debug!("Querying feature count");
let params = FeatureQueryParams::builder()
.where_clause(where_clause)
.return_count_only(true)
.return_geometry(false)
.out_fields(vec![]) // No fields needed for count
.build()
.expect("Valid query params");
let result = self.query_with_params(layer_id, params).await?;
let count = (*result.count()).unwrap_or(0);
tracing::info!(count = count, "Feature count query completed");
Ok(count)
}
}