IndexRef class

Shorthand for index-related operations.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

name → String

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

type → String?

final

Methods

addToAlias({required String alias}) → Future<bool>

Add index to alias.

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

Bulk update of the current index.

count({Map? query}) → Future<int>

Count the total items.

delete() → Future<bool>

Delete index.

deleteDoc({required String id}) → Future<int>

Deletes id from index.

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

Deletes documents from index using query.

exists() → Future<bool>

Returns weather the index exists.

flush() → Future<void>

Flush index.

getMapping() → Future<Map<String, dynamic>>

Get the index mapping.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeFromAlias({required String alias}) → Future<bool>

Remove index from alias.

search({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 :-)

toString() → String

A string representation of this object.

inherited

update({Map<String, dynamic>? content}) → Future<void>

Updates index definition with content.

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

Update doc in index.

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

Bulk update docs in index.

Operators

operator ==(Object other) → bool

The equality operator.

inherited