Client class

Client to connect to ElasticSearch.

Constructors

Client(Transport _transport)

Client to connect to ElasticSearch using a Transport.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addAlias({required String alias, required String index}) → Future<bool>

Add index to alias.

bulk({List<Doc>? updateDocs, List<Doc>? deleteDocs, String? index, String? type, int batchSize = 100}) → Future<bool>

Bulk update of the index.

clearScrollId({required String scrollId}) → Future<ClearScrollResult>

Clear scroll ids.

clearScrollIds({required List<String> scrollIds}) → Future<ClearScrollResult>

Clear scroll ids.

count({required String index, Map? query}) → Future<int>

Count the total items for the given index.

deleteDoc({required String index, required String id, String? type}) → Future<int>

Deletes id from index.

deleteDocs({required String index, required Map query}) → Future<int>

Deletes documents from index using query.

deleteIndex({required String index}) → Future<bool>

Delete index.

flushIndex({required String index}) → Future<void>

Flush index.

getAliases({List<String> aliases = const <String>[]}) → Future<List<Alias>>

List aliases.

index({required String name, String? type}) → IndexRef

Shorthand operations for index.

indexExists({required String index}) → Future<bool>

Returns weather index exists.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeAlias({required String alias, required String index}) → Future<bool>

Remove index from alias.

scroll({required String scrollId, required Duration duration}) → Future<SearchResult>

Continue search using the scroll API.

search({String? index, String? type, Map? query, int? offset, int? limit, List<Object>? fields, dynamic source, Map? suggest, List<Map>? sort, Map? aggregations, Duration? scroll, HighlightOptions? highlight, bool? trackTotalHits, int? size, double? minScore, Map? knn}) → Future<SearchResult>

Search :-)

swapAlias({required String alias, required String from, required String to}) → Future<bool>

Changes alias instead of pointing to from, it will point to to.

termsEnum({String? index, String? type, required String field, String? string, bool? caseInsensitive, int? size}) → Future<TermsEnumResult>

Discover terms in the index that match a partial String https://www.elastic.co/guide/en/elasticsearch/reference/8.1/search-terms-enum.html

toString() → String

A string representation of this object.

inherited

updateDoc({required String index, required Map<String, dynamic> doc, String? type, String? id, bool merge = false}) → Future<bool>

Update doc in index.

updateDocs({required List<Doc> docs, String? index, String? type, int batchSize = 100}) → Future<bool>

Bulk update docs in index.

updateIndex({required String index, Map<String, dynamic>? content}) → Future<void>

Updates index definition with content.

Operators

operator ==(Object other) → bool

The equality operator.

inherited