MeiliSearchIndex class

Constructors

MeiliSearchIndex(MeiliSearchClient client, String uid, {String? primaryKey, DateTime? createdAt, DateTime? updatedAt})

MeiliSearchIndex.fromMap(MeiliSearchClient client, Map<String, Object?> map)

factory

Properties

client → MeiliSearchClient

final

createdAt → DateTime?

no setter

hashCode → int

The hash code for this object.

no setter, inherited

http → HttpRequest

no setter

primaryKey ↔ String?

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

uid → String

final

updatedAt → DateTime?

no setter

Methods

addDocuments(List<Map<String, Object?>> documents, {String? primaryKey}) → Future<Task>

Add a list of documents by given documents and optional primaryKey parameter.

addDocumentsCsv(String documents, {String? primaryKey, String? csvDelimiter}) → Future<Task>

Add a list of documents by given documents and optional primaryKey parameter.

addDocumentsCsvInBatches(String documents, {String? primaryKey, int batchSize = 1000, String? csvDelimiter}) → Future<List<Task>>

Add a list of documents in batches of size batchSize by given documents and optional primaryKey parameter.

addDocumentsInBatches(List<Map<String, dynamic>> documents, {int batchSize = 1000, String? primaryKey}) → Future<List<Task>>

Add a list of documents in batches of size batchSize by given documents and optional primaryKey parameter.

addDocumentsJson(String documents, {String? primaryKey}) → Future<Task>

Add a list of documents by given documents and optional primaryKey parameter.

addDocumentsNdjson(String documents, {String? primaryKey}) → Future<Task>

Add a list of documents by given documents and optional primaryKey parameter.

addDocumentsNdjsonInBatches(String documents, {String? primaryKey, int batchSize = 1000}) → Future<List<Task>>

Add a list of documents in batches of size batchSize by given documents and optional primaryKey parameter.

delete() → Future<Task>

Delete the index.

deleteAllDocuments() → Future<Task>

Delete all documents in the specified index.

deleteDocument(Object id) → Future<Task>

Delete one document by given id.

deleteDocuments(DeleteDocumentsQuery query) → Future<Task>

Delete a selection of documents by given query.

facetSearch(FacetSearchQuery query) → Future<FacetSearchResult>

fetchInfo() → Future<MeiliSearchIndex>

Get the information of the index from the Meilisearch server and return it.

fetchPrimaryKey() → Future<String?>

Update the primaryKey of the index and return it.

getDisplayedAttributes() → Future<List<String>>

Get the displayed attributes of the index.

getDistinctAttribute() → Future<String?>

Get the distinct attribute for the index.

getDocument(Object id, {List<String> fields = const []}) → Future<Map<String, dynamic>?>

Return the document in the index by given id.

getDocuments({DocumentsQuery? params}) → Future<Result<Map<String, dynamic>>>

Return a list of all existing documents in the index.

getFaceting() → Future<Faceting>

Get faceting settings of the index.

getFilterableAttributes() → Future<List<String>>

Get filterable attributes of the index.

getNonSeparatorTokens() → Future<List<String>>

Get non separator tokens of the index.

getPagination() → Future<Pagination>

Get pagination settings of the index.

getRankingRules() → Future<List<String>>

Get ranking rules of the index.

getSearchableAttributes() → Future<List<String>>

Get searchable attributes of the index.

getSeparatorTokens() → Future<List<String>>

Get separator tokens of the index.

getSettings() → Future<IndexSettings>

Get the settings of the index.

getSortableAttributes() → Future<List<String>>

Get sortable attributes of the index.

getStats() → Future<IndexStats>

Get stats of the index.

getStopWords() → Future<List<String>>

Get stop words of the index.

getSynonyms() → Future<Map<String, List<String>>>

Get synonyms of the index.

getTask(int uid) → Future<Task>

Get a task from an index specified by uid.

getTasks({TasksQuery? params}) → Future<TasksResults>

Get all tasks from the index.

getTypoTolerance() → Future<TypoTolerance>

Get typo tolerance settings of the index.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

resetDisplayedAttributes() → Future<Task>

Reset the displayed attributes of the index.

resetDistinctAttribute() → Future<Task>

Reset the distinct attribute for the index.

resetFaceting() → Future<Task>

Reset faceting settings of the index.

resetFilterableAttributes() → Future<Task>

Reset filterable attributes of the index.

resetNonSeparatorTokens() → Future<Task>

Reset separator tokens of the index.

resetPagination() → Future<Task>

Reset pagination settings of the index.

resetRankingRules() → Future<Task>

Reset ranking rules of the index.

resetSearchableAttributes() → Future<Task>

Reset searchable attributes of the index.

resetSeparatorTokens() → Future<Task>

Reset separator tokens of the index.

resetSettings() → Future<Task>

Reset the settings of the index. All settings will be reset to their default value.

resetSortableAttributes() → Future<Task>

Reset sortable attributes of the index.

resetStopWords() → Future<Task>

Reset stop words of the index.

resetSynonyms() → Future<Task>

Reset synonyms of the index.

resetTypoTolerance() → Future<Task>

Reset typo tolerance settings of the index.

search(String? text, [SearchQuery? q]) → Future<Searcheable<Map<String, dynamic>>>

Search for documents matching a specific query in the index.

toString() → String

A string representation of this object.

inherited

update({String? primaryKey}) → Future<Task>

Update the primary Key of the index.

updateDisplayedAttributes(List<String> displayedAttributes) → Future<Task>

Update the displayed attributes of the index.

updateDistinctAttribute(String distinctAttribute) → Future<Task>

Update the distinct attribute for the index.

updateDocuments(List<Map<String, Object?>> documents, {String? primaryKey}) → Future<Task>

Add a list of documents or update them if they already exist by given documents and optional primaryKey parameter.

updateDocumentsCsv(String documents, {String? primaryKey, String? csvDelimiter}) → Future<Task>

Add a list of documents or update them if they already exist by given documents and optional primaryKey parameter.

updateDocumentsCsvInBatches(String documents, {String? primaryKey, int batchSize = 1000, String? csvDelimiter}) → Future<List<Task>>

Add a list of documents or update them if they already exist in batches of size batchSize by given documents and optional primaryKey parameter.

updateDocumentsInBatches(List<Map<String, Object?>> documents, {int batchSize = 1000, String? primaryKey}) → Future<List<Task>>

Add a list of documents or update them if they already exist in batches of size batchSize by given documents and optional primaryKey parameter.

updateDocumentsJson(String documents, {String? primaryKey}) → Future<Task>

Add a list of documents or update them if they already exist by given documents and optional primaryKey parameter.

updateDocumentsNdjson(String documents, {String? primaryKey}) → Future<Task>

Add a list of documents or update them if they already exist by given documents and optional primaryKey parameter.

updateDocumentsNdjsonInBatches(String documents, {String? primaryKey, int batchSize = 1000}) → Future<List<Task>>

Add a list of documents or update them if they already exist in batches of size batchSize by given documents and optional primaryKey parameter.

updateFaceting(Faceting faceting) → Future<Task>

Update faceting settings of the index.

updateFilterableAttributes(List<String> filterableAttributes) → Future<Task>

Update filterable attributes of the index.

updateNonSeparatorTokens(List<String> nonSeparatorTokens) → Future<Task>

Update separator tokens of the index.

updatePagination(Pagination pagination) → Future<Task>

Update pagination settings of the index.

updateRankingRules(List<String> rankingRules) → Future<Task>

Update ranking rules of the index.

updateSearchableAttributes(List<String> searchableAttributes) → Future<Task>

Update the searchable attributes of the index.

updateSeparatorTokens(List<String> separatorTokens) → Future<Task>

Update separator tokens of the index.

updateSettings(IndexSettings settings) → Future<Task>

Update the settings of the index. Any parameters not provided in the body will be left unchanged.

updateSortableAttributes(List<String> sortableAttributes) → Future<Task>

Update sortable attributes of the index.

updateStopWords(List<String> stopWords) → Future<Task>

Update stop words of the index

updateSynonyms(Map<String, List<String>> synonyms) → Future<Task>

Update synonyms of the index

updateTypoTolerance(TypoTolerance typoTolerance) → Future<Task>

Update typo tolerance settings of the index.

Operators

operator ==(Object other) → bool

The equality operator.

inherited