ArangoDBClient class

Available Extensions

Constructors

ArangoDBClient({String scheme = 'http', String host = 'localhost', int port = 8529, String db = '_system', String? user, String? pass, String realm = ''})

Properties

credentials HttpClientBasicCredentials
getter/setter pair
db String
final
dbUrl Uri
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
host String
final
httpClient HttpClient
getter/setter pair
pass String?
final
port int
final
realm String
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scheme String
final
user String?
final

Methods

allCollections() Future
Reads all collections https://www.arangodb.com/docs/3.4/http/collection-getting.html#reads-all-collections
collectionChecksum(String collectionName) Future
Returns checksum for the collection https://www.arangodb.com/docs/3.4/http/collection-getting.html#return-checksum-for-the-collection
collectionInfo(String name) Future
Gets id, name, status of collection https://www.arangodb.com/docs/3.4/http/collection-getting.html#return-information-about-a-collection
collectionProperties(String name) Future
Get collection properties See https://www.arangodb.com/docs/3.4/http/collection-getting.html#read-properties-of-a-collection for details
collectionRevisionId(String collectionName) Future
Returns collection revision id https://www.arangodb.com/docs/3.4/http/collection-getting.html#return-collection-revision-id
collectionStatistics(String collectionName) Future
Returns statistics for a collection https://www.arangodb.com/docs/3.4/http/collection-getting.html#return-statistics-for-a-collection
createCollection(Map<String, Object> data) Future
Creates a collection See https://www.arangodb.com/docs/3.4/http/collection-creating.html for details.
createDatabase(Map<String, Object> data) Future
Creates a database. The data with these properties is required:
createDocument(String collectionName, dynamic data) Future
Creates document https://www.arangodb.com/docs/3.4/http/document-working-with-documents.html#create-document
currentDatabase() Future
Retrieves information about the current database https://www.arangodb.com/docs/devel/http/database-database-management.html#information-of-the-database
documentsCount(String collectionName) Future
Returns number of documents in a collection https://www.arangodb.com/docs/3.4/http/collection-getting.html#return-number-of-documents-in-a-collection
dropCollection(String name, {bool isSystem = false}) Future
Drops a collection https://www.arangodb.com/docs/stable/http/collection-creating.html#drops-a-collection
dropDatabase(String name) Future
Drops the database along with all data stored in it. https://www.arangodb.com/docs/devel/http/database-database-management.html#drop-database
existingDatabases() Future
Retrieves the list of all existing databases (availabe or not) https://www.arangodb.com/docs/devel/http/database-database-management.html#list-of-databases
fetchNextBatch(int cursorId) Future
getDocumentByKey(String collection, String documentKey, {String? ifNoneMatchRevision, String? ifMatchRevision}) Future
Reads a single document https://www.arangodb.com/docs/3.4/http/document-working-with-documents.html#read-document
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
queryFirstBatch(Map<String, Object> data) Future
queryToList(Map<String, dynamic> data) Future<List>
Makes query to ArangoDB batabase, collect results in memory and return as List. If result has error - throws error.
queryToStream(Map<String, Object> data) Stream
Makes query to ArangoDB batabase.
removeDocument(String collectionName, String documentKey, {String? ifMatchRevision, Map<String, dynamic>? queryParams}) Future
Removes a document https://www.arangodb.com/docs/3.4/http/document-working-with-documents.html#removes-a-document
removeDocuments(String collectionName, List<Map<String, dynamic>> data, {Map<String, dynamic>? queryParams}) Future
td: Removes multiple documents https://www.arangodb.com/docs/3.4/http/document-working-with-documents.html#removes-multiple-documents
replaceDocument(String collectionName, String documentKey, Map<String, dynamic> data, {String? ifMatchRevision, Map<String, dynamic>? queryParams}) Future
Replaces document https://www.arangodb.com/docs/3.4/http/document-working-with-documents.html#replace-document
replaceDocuments(String collectionName, List<Map<String, dynamic>> data, {Map<String, dynamic>? queryParams}) Future
Replaces multiple documents https://www.arangodb.com/docs/3.4/http/document-working-with-documents.html#replace-documents
toString() String
A string representation of this object.
inherited
truncateCollection(String name) Future
Truncates a collection
updateDocument(String collectionName, String documentKey, Map<String, dynamic> data, {String? ifMatchRevision, Map<String, dynamic>? queryParams}) Future
Updates a document https://www.arangodb.com/docs/3.4/http/document-working-with-documents.html#update-document
userDatabases() Future
List of accessible databases for current user https://www.arangodb.com/docs/devel/http/database-database-management.html#list-of-accessible-databases

Operators

operator ==(Object other) bool
The equality operator.
inherited