API
#github.com/xulang-org/packages/elasticsearchElasticsearch / OpenSearch driver package for Xu. Features Compatible with Elasticsearch 7.x/8.x and OpenSearch 1.x/2.x. Pure HTTP REST communication via Xu standard library. Full index lifecycle: create, delete, check exists, refresh. Full document CRUD: index, get, update, delete. Search Query DSL support with total hit count tracking.
github.com/xulang-org/packages · 0.1.1 · Install and use
openpub fn open(endpoint string) ClientElasticsearch / OpenSearch driver package for Xu. Features Compatible with Elasticsearch 7.x/8.x and OpenSearch 1.x/2.x. Pure HTTP REST communication via Xu standard library. Full index lifecycle: create, delete, check exists, refresh. Full document CRUD: index, get, update, delete. Search Query DSL support with total hit count tracking.
endpoint stringClient — a value of this type
open_poolpub fn open_pool(endpoint string, max_idle int) PoolOpen pool.
endpoint stringmax_idle intPool — a value of this type
struct Responsepub struct Response {
pub status_code int
pub body string
}Public struct `Response`.
status_code intbody stringstruct Clientpub struct Client {
pub host string
pub port int
}Public struct `Client`.
host stringport intnew_clientpub fn new_client(endpoint string) ClientConstruct client.
endpoint stringClient — a value of this type
(&mut Client) requestpub fn (c &mut Client) request(method string, path string, body string) ResponseCall `request` on `&mut Client`. Throws on failure.
c &mut Clientmethod stringpath stringbody stringResponse — a value of this type
(&mut Client) pingpub fn (c &mut Client) ping() boolCall `ping` on `&mut Client`.
c &mut Clientbool — true or false
(&mut Client) infopub fn (c &mut Client) info() stringCall `info` on `&mut Client`. Throws on failure.
c &mut Clientstring — result string
(&mut Client) index_docpub fn (c &mut Client) index_doc(index string, id string, doc_json string) stringMethod on `&mut Client`: index doc. Throws on failure.
c &mut Clientindex stringid stringdoc_json stringstring — result string
(&mut Client) get_docpub fn (c &mut Client) get_doc(index string, id string) stringMethod on `&mut Client`: read doc. Throws on failure.
c &mut Clientindex stringid stringstring — result string
(&mut Client) delete_docpub fn (c &mut Client) delete_doc(index string, id string) boolMethod on `&mut Client`: delete doc. Throws on failure.
c &mut Clientindex stringid stringbool — true or false
(&mut Client) update_docpub fn (c &mut Client) update_doc(index string, id string, doc_json string) boolMethod on `&mut Client`: update doc. Throws on failure.
c &mut Clientindex stringid stringdoc_json stringbool — true or false
(&mut Client) create_indexpub fn (c &mut Client) create_index(index string, mapping_json string) boolMethod on `&mut Client`: create index. Throws on failure.
c &mut Clientindex stringmapping_json stringbool — true or false
(&mut Client) delete_indexpub fn (c &mut Client) delete_index(index string) boolMethod on `&mut Client`: delete index. Throws on failure.
c &mut Clientindex stringbool — true or false
(&mut Client) index_existspub fn (c &mut Client) index_exists(index string) boolMethod on `&mut Client`: index exists.
c &mut Clientindex stringbool — true or false
(&mut Client) refreshpub fn (c &mut Client) refresh(index string) boolCall `refresh` on `&mut Client`. Throws on failure.
c &mut Clientindex stringbool — true or false
struct Poolpub struct Pool {
pub host string
pub port int
pub endpoint string
pub state chan pool.State
pub max_idle int
}Connection Pool for Elasticsearch & OpenSearch. Manages reusable TCP/HTTP socket connections.
host stringport intendpoint stringstate chan pool.Statemax_idle intnew_poolpub fn new_pool(endpoint string, max_idle int) PoolConstruct pool.
endpoint stringmax_idle intPool — a value of this type
(&Pool) getpub fn (p &Pool) get() ClientCall `get` on `&Pool`.
p &PoolClient — a value of this type
(&Pool) duppub fn (p &Pool) dup() PoolShares sockets and close state; clones configuration strings.
p &PoolPool — a value of this type
(&Pool) get_connpub fn (p &Pool) get_conn() intMethod on `&Pool`: read conn.
p &Poolint — a value of this type
(&Pool) put_connpub fn (p &Pool) put_conn(fd int)Method on `&Pool`: put connection.
p &Poolfd int(&Pool) discard_connpub fn (p &Pool) discard_conn(fd int)Method on `&Pool`: discard connection.
p &Poolfd int(&Pool) searchpub fn (p &Pool) search(index string, query_dsl string) SearchResultMethod on `&Pool`: binary search. Throws on failure.
p &Poolindex stringquery_dsl stringSearchResult — a value of this type
(&Pool) search_matchpub fn (p &Pool) search_match(index string, field string, query_text string) SearchResultMethod on `&Pool`: binary search match. Throws on failure.
p &Poolindex stringfield stringquery_text stringSearchResult — a value of this type
(&Pool) get_docpub fn (p &Pool) get_doc(index string, id string) stringMethod on `&Pool`: read doc. Throws on failure.
p &Poolindex stringid stringstring — result string
(&Pool) index_docpub fn (p &Pool) index_doc(index string, id string, doc_json string) stringMethod on `&Pool`: index doc. Throws on failure.
p &Poolindex stringid stringdoc_json stringstring — result string
(&Pool) delete_docpub fn (p &Pool) delete_doc(index string, id string) boolMethod on `&Pool`: delete doc. Throws on failure.
p &Poolindex stringid stringbool — true or false
(&Pool) pingpub fn (p &Pool) ping() boolCall `ping` on `&Pool`.
p &Poolbool — true or false
(&Pool) closepub fn (p &Pool) close()Method on `&Pool`: close the resource.
p &Poolstruct SearchHitpub struct SearchHit {
pub id string
pub score string
pub source string
}Public struct `SearchHit`.
id stringscore stringsource stringstruct SearchResultpub struct SearchResult {
pub total int
pub raw_json string
pub hits []SearchHit
}Public struct `SearchResult`.
total intraw_json stringhits []SearchHit(&mut Client) searchpub fn (c &mut Client) search(index string, query_dsl string) SearchResultMethod on `&mut Client`: binary search. Throws on failure.
c &mut Clientindex stringquery_dsl stringSearchResult — a value of this type
(&mut Client) search_matchpub fn (c &mut Client) search_match(index string, field string, query_text string) SearchResultMethod on `&mut Client`: binary search match. Throws on failure.
c &mut Clientindex stringfield stringquery_text stringSearchResult — a value of this type