Collection class

Constructors

Collection({required String name, required String id, required bool isSystem, required int type, required int status, required String globallyUniqueId, required ArangoClient client})

Properties

client ↔ ArangoClient
getter/setter pair
globallyUniqueId → String
final
hashCode → int
The hash code for this object.
no setterinherited
id → String
final
isSystem → bool
final
name → String
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status → int
final
type → int
final

Methods

checksum() → FutureOr<Map<String, dynamic>?>
Returns a checksum for the specified collection
count() → FutureOr<Map<String, dynamic>?>
Count document of the collection
document({String? document_handle}) → Document
Return a document of the collection
drop() → FutureOr<Map<String, dynamic>?>
Drop a collection
figures() → FutureOr<Map<String, dynamic>?>
Fetch the statistics of a collection
info() → FutureOr<String>
Returns info of the collection
load() → FutureOr<Map<String, dynamic>?>
Loads a collection
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
properties({Map<String, dynamic>? prop}) → FutureOr<Map<String, dynamic>?>
Returns properties of a collection
recalculateCount() → FutureOr<Map<String, dynamic>?>
rename(String new_name) → FutureOr<Map<String, dynamic>?>
Rename a collection
responsibleShard() → FutureOr<Map<String, dynamic>?>
Return the responsible shard for a document
revision() → FutureOr<Map<String, dynamic>?>
Retrieve the collections revision id
rotate() → FutureOr<Map<String, dynamic>?>
Rotate a collection
shards() → FutureOr<Map<String, dynamic>?>
Return the shard ids of a collection
toString() → String
A string representation of this object.
inherited
truncate() → FutureOr<Map<String, dynamic>?>
Truncate a collection
unload() → FutureOr<Map<String, dynamic>?>
Unloads a collection

Operators

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