Databases class

The Databases service allows you to create structured collections of documents, query and filter lists of documents

Constructors

Databases(Client client)

Properties

client → Client

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

create({required String databaseId, required String name, bool? enabled}) → Future<Database>

Create database

createBooleanAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, bool? xdefault, bool? array}) → Future<AttributeBoolean>

Create boolean attribute

createCollection({required String databaseId, required String collectionId, required String name, List<String>? permissions, bool? documentSecurity, bool? enabled}) → Future<Collection>

Create collection

createDatetimeAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) → Future<AttributeDatetime>

Create datetime attribute

createDocument({required String databaseId, required String collectionId, required String documentId, required Map data, List<String>? permissions}) → Future<Document>

Create document

createEmailAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) → Future<AttributeEmail>

Create email attribute

createEnumAttribute({required String databaseId, required String collectionId, required String key, required List<String> elements, required bool xrequired, String? xdefault, bool? array}) → Future<AttributeEnum>

Create enum attribute

createFloatAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, double? min, double? max, double? xdefault, bool? array}) → Future<AttributeFloat>

Create float attribute

createIndex({required String databaseId, required String collectionId, required String key, required IndexType type, required List<String> attributes, List<String>? orders}) → Future<Index>

Create index

createIntegerAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, int? min, int? max, int? xdefault, bool? array}) → Future<AttributeInteger>

Create integer attribute

createIpAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) → Future<AttributeIp>

Create IP address attribute

createRelationshipAttribute({required String databaseId, required String collectionId, required String relatedCollectionId, required RelationshipType type, bool? twoWay, String? key, String? twoWayKey, RelationMutate? onDelete}) → Future<AttributeRelationship>

Create relationship attribute

createStringAttribute({required String databaseId, required String collectionId, required String key, required int size, required bool xrequired, String? xdefault, bool? array, bool? encrypt}) → Future<AttributeString>

Create string attribute

createUrlAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) → Future<AttributeUrl>

Create URL attribute

delete({required String databaseId}) → Future

Delete database

deleteAttribute({required String databaseId, required String collectionId, required String key}) → Future

Delete attribute

deleteCollection({required String databaseId, required String collectionId}) → Future

Delete collection

deleteDocument({required String databaseId, required String collectionId, required String documentId}) → Future

Delete document

deleteIndex({required String databaseId, required String collectionId, required String key}) → Future

Delete index

get({required String databaseId}) → Future<Database>

Get database

getAttribute({required String databaseId, required String collectionId, required String key}) → Future

Get attribute

getCollection({required String databaseId, required String collectionId}) → Future<Collection>

Get collection

getDocument({required String databaseId, required String collectionId, required String documentId, List<String>? queries}) → Future<Document>

Get document

getIndex({required String databaseId, required String collectionId, required String key}) → Future<Index>

Get index

list({List<String>? queries, String? search}) → Future<DatabaseList>

List databases

listAttributes({required String databaseId, required String collectionId, List<String>? queries}) → Future<AttributeList>

List attributes

listCollections({required String databaseId, List<String>? queries, String? search}) → Future<CollectionList>

List collections

listDocuments({required String databaseId, required String collectionId, List<String>? queries}) → Future<DocumentList>

List documents

listIndexes({required String databaseId, required String collectionId, List<String>? queries}) → Future<IndexList>

List indexes

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

update({required String databaseId, required String name, bool? enabled}) → Future<Database>

Update database

updateBooleanAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required bool? xdefault}) → Future<AttributeBoolean>

Update boolean attribute

updateCollection({required String databaseId, required String collectionId, required String name, List<String>? permissions, bool? documentSecurity, bool? enabled}) → Future<Collection>

Update collection

updateDatetimeAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault}) → Future<AttributeDatetime>

Update dateTime attribute

updateDocument({required String databaseId, required String collectionId, required String documentId, Map? data, List<String>? permissions}) → Future<Document>

Update document

updateEmailAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault}) → Future<AttributeEmail>

Update email attribute

updateEnumAttribute({required String databaseId, required String collectionId, required String key, required List<String> elements, required bool xrequired, required String? xdefault}) → Future<AttributeEnum>

Update enum attribute

updateFloatAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required double min, required double max, required double? xdefault}) → Future<AttributeFloat>

Update float attribute

updateIntegerAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required int min, required int max, required int? xdefault}) → Future<AttributeInteger>

Update integer attribute

updateIpAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault}) → Future<AttributeIp>

Update IP address attribute

updateRelationshipAttribute({required String databaseId, required String collectionId, required String key, RelationMutate? onDelete}) → Future<AttributeRelationship>

Update relationship attribute

updateStringAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault}) → Future<AttributeString>

Update string attribute

updateUrlAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault}) → Future<AttributeUrl>

Update URL attribute

Operators

operator ==(Object other) → bool

The equality operator.

inherited