geoprox-client 0.5.0

An HTTP client library for interacting with the Geoprox search engine
Documentation 
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

# \GeoshardApiApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_index**](GeoshardApiApi.md#create_index) | **POST** /api/v1/shard/{index} | Create geospatial index
[**drop_index**](GeoshardApiApi.md#drop_index) | **DELETE** /api/v1/shard/{index} | Deletes geospatial index
[**insert_key**](GeoshardApiApi.md#insert_key) | **PUT** /api/v1/shard/{index} | Insert key into index
[**insert_key_batch**](GeoshardApiApi.md#insert_key_batch) | **PUT** /api/v1/shard/{index}/batch | Insert multiple keys into index
[**query_range**](GeoshardApiApi.md#query_range) | **GET** /api/v1/shard/{index} | Search index for objects nearby
[**query_range_many**](GeoshardApiApi.md#query_range_many) | **GET** /api/v1/shard | Search multiple indices for objects nearby
[**remove_key**](GeoshardApiApi.md#remove_key) | **PATCH** /api/v1/shard/{index} | Remove key from index
[**remove_key_batch**](GeoshardApiApi.md#remove_key_batch) | **PATCH** /api/v1/shard/{index}/batch | Remove multiple keys from index



## create_index

> models::CreateIndexResponse create_index(index)
Create geospatial index

Creates an in-memory index within this geoshard

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**index** | **String** | Geospatial index name | [required] |

### Return type

[**models::CreateIndexResponse**](CreateIndexResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## drop_index

> models::DropIndexResponse drop_index(index)
Deletes geospatial index

Drop index. All keys will be lost

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**index** | **String** | Geospatial index name | [required] |

### Return type

[**models::DropIndexResponse**](DropIndexResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## insert_key

> models::InsertKeyResponse insert_key(index, insert_key)
Insert key into index

Inserts key into geospatial index

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**index** | **String** | Geospatial index name | [required] |
**insert_key** | [**InsertKey**](InsertKey.md) |  | [required] |

### Return type

[**models::InsertKeyResponse**](InsertKeyResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## insert_key_batch

> models::InsertKeyBatchResponse insert_key_batch(index, insert_key_batch)
Insert multiple keys into index

Inserts multiple keys into geospatial index

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**index** | **String** | Geospatial index name | [required] |
**insert_key_batch** | [**InsertKeyBatch**](InsertKeyBatch.md) |  | [required] |

### Return type

[**models::InsertKeyBatchResponse**](InsertKeyBatchResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## query_range

> models::QueryRangeResponse query_range(index, lat, lng, range, count, sorted)
Search index for objects nearby

Search geospatial index for all keys within some distance

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**index** | **String** | Geospatial index name | [required] |
**lat** | **f64** | Latitude | [required] |
**lng** | **f64** | Longitude | [required] |
**range** | **i32** | Search radius in kilometers | [required] |
**count** | Option<**i32**> | Maximum number of neighbors that can be returned (default 100) |  |
**sorted** | Option<**bool**> | If enabled neighbors will be sorted by distance, nearest to furthest (default false) |  |

### Return type

[**models::QueryRangeResponse**](QueryRangeResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## query_range_many

> models::QueryRangeManyResponse query_range_many(indices, lat, lng, range, count, sorted)
Search multiple indices for objects nearby

Search geospatial many indices for all keys within some distance

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**indices** | [**Vec<String>**](String.md) | List of indices to search | [required] |
**lat** | **f64** | Latitude | [required] |
**lng** | **f64** | Longitude | [required] |
**range** | **i32** | Search radius in kilometers | [required] |
**count** | Option<**i32**> | Maximum number of neighbors that can be returned (default 100) |  |
**sorted** | Option<**bool**> | If enabled neighbors will be sorted by distance, nearest to furthest (default false) |  |

### Return type

[**models::QueryRangeManyResponse**](QueryRangeManyResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## remove_key

> models::RemoveKeyResponse remove_key(index, remove_key)
Remove key from index

Removes key from geospatial index

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**index** | **String** | Geospatial index name | [required] |
**remove_key** | [**RemoveKey**](RemoveKey.md) |  | [required] |

### Return type

[**models::RemoveKeyResponse**](RemoveKeyResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## remove_key_batch

> models::RemoveKeyBatchResponse remove_key_batch(index, remove_key_batch)
Remove multiple keys from index

Removes multiple keys from geospatial index

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**index** | **String** | Geospatial index name | [required] |
**remove_key_batch** | [**RemoveKeyBatch**](RemoveKeyBatch.md) |  | [required] |

### Return type

[**models::RemoveKeyBatchResponse**](RemoveKeyBatchResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)