Class: ElasticSearch

SuperMap.ElasticSearch

ElasticSearch服务类。

new SuperMap.ElasticSearch(url, options)

common/thirdparty/elasticsearch/ElasticSearch.js, line 9
Name Type Description
url string

ElasticSearch服务地址。

options Object

参数。

Name Type Default Description
change function 可选

服务器返回数据后执行的函数。废弃,不建议使用。使用search或msearch方法。

openGeoFence boolean false 可选

是否开启地理围栏验证,默认为不开启。

outOfGeoFence function 可选

数据超出地理围栏后执行的函数。

geoFence Object 可选

地理围栏。

Members

changefunction

服务器返回数据后执行的函数。废弃,不建议使用。使用search或msearch方法。

Deprecated
  • Yes

clientObject

client ES客户端

eventListenersObject

听器对象,在构造函数中设置此参数(可选),对 MapService 支持的两个事件 processCompleted 、processFailed 进行监听, 相当于调用 SuperMap.Events.on(eventListeners)。

事件

geoFenceObject

地理围栏

Example
{
   radius: 1000,//单位是m
   center: [104.40, 30.43],
   unit: 'meter|degree'
 }

openGeoFenceboolean

是否开启地理围栏验证,默认为不开启。

outOfGeoFencefunction

数据超出地理围栏后执行的函数

urlstring

ElasticSearch服务地址

Methods

bulk(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 101
Name Type Description
params Object

参数。

callback function

回调函数。

clearScroll(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 113
Name Type Description
params Object

参数。

callback function

回调函数。

count(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 125
Name Type Description
params Object

参数。

callback function

回调函数。

count(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 137

在特定索引中添加一个类型化的JSON文档,使其可搜索。如果具有相同index,type且id已经存在的文档将发生错误。
参数设置参考 https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-create 更多信息参考 https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html

Name Type Description
params Object

参数。

callback function

回调函数。

delete(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 149
Name Type Description
params Object

参数。

callback function

回调函数。

delete(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 173
Name Type Description
params Object

参数。

callback function

回调函数。

delete(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 161
Name Type Description
params Object

参数。

callback function

回调函数。

deleteTemplate(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 185
Name Type Description
params Object

参数。

callback function

回调函数。

exists(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 197
Name Type Description
params Object

参数。

callback function

回调函数。

existsSource(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 209
Name Type Description
params Object

参数。

callback function

回调函数。

explain(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 222

提供与特定查询相关的特定文档分数的详细信息。它还会告诉您文档是否与指定的查询匹配。
参数设置参考 https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-explain
更多信息参考 https://www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html

Name Type Description
params Object

参数。

callback function

回调函数。

fieldCaps(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 234

允许检索多个索引之间的字段的功能。(实验性API,可能会在未来版本中删除)
参数设置参考 https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-fieldcaps
更多信息参考 https://www.elastic.co/guide/en/elasticsearch/reference/current/search-field-caps.html

Name Type Description
params Object

参数。

callback function

回调函数。

get(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 247
Name Type Description
params Object

参数。

callback function

回调函数。

getScript(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 259
Name Type Description
params Object

参数。

callback function

回调函数。

getSource(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 271
Name Type Description
params Object

参数。

callback function

回调函数。

getTemplate(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 283
Name Type Description
params Object

参数。

callback function

回调函数。

index(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 295
Name Type Description
params Object

参数。

callback function

回调函数。

info(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 307
Name Type Description
params Object

参数。

callback function

回调函数。

mget(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 319

根据索引,类型(可选)和ids来获取多个文档。mget所需的主体可以采用两种形式:文档位置数组或文档ID数组。
参数设置参考 https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-mget
更多信息参考 https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html

Name Type Description
params Object

参数。

callback function

回调函数。

msearch(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 331
Name Type Description
params Object

参数。

callback function

请求返回的回调函数。也可以使用then表达式获取返回结果。 回调参数:error,response。结果存储在response.responses中

msearchTemplate(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 354
Name Type Description
params Object

参数。

callback function

回调函数。

mtermvectors(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 366
Name Type Description
params Object

参数。

callback function

回调函数。

ping(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 378
Name Type Description
params Object

参数。

callback function

回调函数。

putScript(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 390
Name Type Description
params Object

参数。

callback function

回调函数。

putTemplate(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 402
Name Type Description
params Object

参数。

callback function

回调函数。

reindex(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 414
Name Type Description
params Object

参数。

callback function

回调函数。

reindexRessrottle(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 426
Name Type Description
params Object

参数。

callback function

回调函数。

renderSearchTemplate(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 438
Name Type Description
params Object

参数。

callback function

回调函数。

scroll(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 450

在search()调用中指定滚动参数之后,滚动搜索请求(检索下一组结果)。
参数设置参考 https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-scroll
更多信息参考 https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html

Name Type Description
params Object

参数。

callback function

回调函数。

common/thirdparty/elasticsearch/ElasticSearch.js, line 462

在search()调用中指定滚动参数之后,滚动搜索请求(检索下一组结果)。 参数设置参考 https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-search
更多信息参考 https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html

Name Type Description
params Object

参数。

callback function

请求返回的回调函数。也可以使用then表达式获取返回结果。 回调参数:error,response,结果存储在response.responses中

searchShards(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 484
Name Type Description
params Object

参数。

callback function

回调函数。

searchTemplate(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 496
Name Type Description
params Object

参数。

callback function

回调函数。

setGeoFence(geoFence)

common/thirdparty/elasticsearch/ElasticSearch.js, line 91

设置地理围栏,openGeoFence参数为true的时候,设置的地理围栏才生效。

Name Type Description
geoFence SuperMap.Geometry

地理围栏。

suggest(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 508

该建议功能通过使用特定的建议者,基于所提供的文本来建议类似的术语。 参数设置参考 https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-suggest
更多信息参考 https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html

Name Type Description
params Object

参数。

callback function

回调函数。

termvectors(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 520
Name Type Description
params Object

参数。

callback function

回调函数。

update(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 544
Name Type Description
params Object

参数。

callback function

回调函数。

update(params, callback)

common/thirdparty/elasticsearch/ElasticSearch.js, line 532
Name Type Description
params Object

参数。

callback function

回调函数。