Algolia class

An adapter for using Algolia.

import 'package:database/database.dart';
import 'package:database_adapter_algolia/database_adapter_algolia.dart';

Database getSearchEngine() {
  return Algolia(
    appId: 'Your application ID',
    apiKey: 'Your API key',
  );
}
Inheritance

Constructors

Algolia({@required String apiKey, @required String appId, bool allowSortersByIgnoring: false, Uri uri, HttpClient httpClient})

Properties

allowSortersByIgnoring → bool
Disables throwing of UnsupportedError if query contains sorters.
final
apiKey → String
final
appId → String
final
httpClient HttpClient
HTTP client used for requests.
final
hashCode → int
The hash code for this object.
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

performDocumentDelete(DocumentDeleteRequest request) → Future<void>
override
performDocumentInsert(DocumentInsertRequest request) → Future<void>
Inserts by using read and upsert operations inside a transaction.
override
performDocumentRead(DocumentReadRequest request) → Stream<Snapshot>
override
performDocumentSearch(DocumentSearchRequest request) → Stream<QueryResult>
override
performDocumentUpdate(DocumentUpdateRequest request) → Future<void>
Updates by using read and upsert operations inside a transaction.
override
performDocumentUpsert(DocumentUpsertRequest request) → Future<void>
override
close() → Future<void>
Closes the database adapter.
@mustCallSuper, inherited
database() Database
Returns the database.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
performCheckConnection({Duration timeout}) → Future<void>
inherited
performDocumentBatch(DocumentBatchRequest request) → Future<void>
inherited
performDocumentDeleteBySearch(DocumentDeleteBySearchRequest request) → Future<void>
inherited
performDocumentReadWatch(DocumentReadWatchRequest request) → Stream<Snapshot>
inherited
performDocumentSearchChunked(DocumentSearchChunkedRequest request) → Stream<QueryResult>
inherited
performDocumentSearchWatch(DocumentSearchWatchRequest request) → Stream<QueryResult>
inherited
performDocumentTransaction(DocumentTransactionRequest request) → Future<void>
inherited
performDocumentUpdateBySearch(DocumentUpdateBySearchRequest request) → Future<void>
inherited
performExtension(DatabaseExtensionRequest<DatabaseExtensionResponse> request) → Stream<DatabaseExtensionResponse>
inherited
performSchemaRead(SchemaReadRequest request) → Stream<DatabaseSchema>
inherited
performSqlQuery(SqlQueryRequest request) → Future<SqlIterator>
inherited
performSqlStatement(SqlStatementRequest request) → Future<SqlStatementResult>
inherited
performSqlTransaction(SqlTransactionRequest request) → Future<void>
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator.
inherited