Provides CRUD operations for databases, collections, documents, attributes, and indexes. More...

#include <Databases.hpp>

Collaboration diagram for Databases:

Public Member Functions
std::string	create (const std::string &databaseId, const std::string &name, bool enabled)
	Create a new database.

std::string	createBooleanAttribute (const std::string &databaseId, const std::string &collectionId, const std::string &attributeId, bool defaultValue, bool required)
	Create a boolean attribute.

std::string	createCollection (const std::string &databaseId, const std::string &collectionId, const std::string &name, bool enabled)
	Create a new collection.

std::string	createDocument (const std::string &databaseId, const std::string &collectionId, const std::string &documentId, const std::string &rawData)
	Create a document in a collection.

std::string	createEmailAttribute (const std::string &databaseId, const std::string &collectionId, const std::string &attributeId, bool required, const std::string &defaultValue)
	Create an email attribute.

std::string	createEnumAttribute (const std::string &databaseId, const std::string &collectionId, const std::string &attributeId, bool required, const std::string &defaultValue, const std::vector< std::string > &elements)
	Create an enum attribute.

std::string	createFloatAttribute (const std::string &databaseId, const std::string &collectionId, const std::string &attributeId, bool required, double min, double max, const std::string &defaultValue)
	Create a float attribute.

std::string	createIndexes (const std::string &databaseId, const std::string &collectionId, const std::string &key, const std::string &type, const std::vector< std::string > &attributes)
	Create a new index.

std::string	createIntegerAttribute (const std::string &databaseId, const std::string &collectionId, const std::string &attributeId, bool required, int min, int max, const std::string &defaultValue)
	Create an integer attribute.

std::string	createIPaddressAttribute (const std::string &databaseId, const std::string &collectionId, const std::string &attributeId, bool required, const std::string &defaultValue)
	Create an IP address attribute.

std::string	createStringAttribute (const std::string &databaseId, const std::string &collectionId, const std::string &attributeId, bool required, const std::string &defaultValue, const std::vector< std::string > &elements, int size)
	Create a string attribute.

	Databases (const std::string &projectId, const std::string &apiKey)
	Constructor for Databases class.

std::string	deleteCollection (const std::string &databaseId, const std::string &collectionId)
	Delete a collection by ID.

std::string	deleteDocument (const std::string &databaseId, const std::string &collectionId, const std::string &documentId)
	Delete a document by ID.

std::string	deleteIndexes (const std::string &databaseId, const std::string &collectionId, const std::string &key)
	Delete an index.

std::string	get (const std::string &databaseId)
	Get a database by ID.

std::string	getCollection (const std::string &databaseId, const std::string &collectionId)
	Get a collection by ID.

std::string	getCollectionUsage (const std::string &databaseId, const std::string &collectionId, const std::string &range)
	Get usage stats of a collection.

std::string	getDatabaseUsage (const std::string &databaseId, const std::string &range)
	Get usage statistics of a database.

std::string	getDocument (const std::string &databaseId, const std::string &collectionId, const std::string &documentId)
	Get a document by ID.

std::string	getIndexes (const std::string &databaseId, const std::string &collectionId, const std::string &key)
	Get details of an index.

std::string	list ()
	List all databases.

std::string	listAttributes (const std::string &databaseId, const std::string &collectionId)
	List all attributes in a collection.

std::string	listCollection (const std::string &databaseId)
	List all collections in a database.

std::string	listDocument (const std::string &databaseId, const std::string &collectionId, Queries &queries)
	List documents using queries.

std::string	listIndexes (const std::string &databaseId, const std::string &collectionId)
	List all indexes in a collection.

std::string	update (const std::string &databaseId, const std::string &name, bool enabled)
	Update an existing database.

std::string	updateBooleanAttribute (const std::string &databaseId, const std::string &collectionId, const std::string &attributeId, bool defaultValue, bool required, const std::string &new_key)
	Update a boolean attribute.

std::string	updateCollection (const std::string &databaseId, const std::string &collectionId, const std::string &name, bool enabled)
	Update collection metadata.

std::string	updateEmailAttribute (const std::string &databaseId, const std::string &collectionId, const std::string &attributeId, bool required, const std::string &defaultValue, std::string &new_key)
	Update an email attribute.

std::string	updateEnumAttribute (const std::string &databaseId, const std::string &collectionId, const std::string &attributeId, bool required, const std::string &defaultValue, const std::vector< std::string > &elements, std::string &new_key)
	Update an enum attribute.

std::string	updateFloatAttribute (const std::string &databaseId, const std::string &collectionId, const std::string &attributeId, bool required, double min, double max, const std::string &defaultValue, std::string &new_key)
	Update a float attribute.

std::string	updateIntegerAttribute (const std::string &databaseId, const std::string &collectionId, const std::string &attributeId, bool required, int min, int max, const std::string &defaultValue, std::string &new_key)
	Update an integer attribute.

std::string	updateIPaddressAttribute (const std::string &databaseId, const std::string &collectionId, const std::string &attributeId, bool required, const std::string &defaultValue, const std::string &new_key)
	Update an IP address attribute.

std::string	updateStringAttribute (const std::string &databaseId, const std::string &collectionId, const std::string &attributeId, bool required, const std::string &defaultValue, const std::vector< std::string > &elements, int size, std::string &new_key)
	Update a string attribute.

Detailed Description

Provides CRUD operations for databases, collections, documents, attributes, and indexes.

Definition at line 19 of file Databases.hpp.

Constructor & Destructor Documentation

◆ Databases()

Databases::Databases	(	const std::string &	projectId,
		const std::string &	apiKey
	)

Constructor for Databases class.

Parameters

projectId	Appwrite project ID.
apiKey	Appwrite API key.

Member Function Documentation

◆ create()

std::string Databases::create	(	const std::string &	databaseId,
		const std::string &	name,
		bool	enabled
	)

Create a new database.

Parameters

databaseId	Unique ID for the new database.
name	Name of the database.
enabled	Whether the database is active.

Returns: JSON response of created database.

◆ createBooleanAttribute()

std::string Databases::createBooleanAttribute	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	attributeId,
		bool	defaultValue,
		bool	required
	)

Create a boolean attribute.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
attributeId	Unique ID for the attribute.
defaultValue	Default value of the attribute.
required	Whether this field is required.

Returns: JSON response.

◆ createCollection()

std::string Databases::createCollection	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	name,
		bool	enabled
	)

Create a new collection.

Parameters

databaseId	ID of the database.
collectionId	Unique ID for the collection.
name	Name of the collection.
enabled	Whether the collection is enabled.

Returns: JSON response.

◆ createDocument()

std::string Databases::createDocument	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	documentId,
		const std::string &	rawData
	)

Create a document in a collection.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
documentId	Document ID.
rawData	JSON string of document data.

Returns: JSON response.

◆ createEmailAttribute()

std::string Databases::createEmailAttribute	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	attributeId,
		bool	required,
		const std::string &	defaultValue
	)

Create an email attribute.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
attributeId	Attribute ID.
required	Required field.
defaultValue	Default email.

Returns: JSON response.

◆ createEnumAttribute()

std::string Databases::createEnumAttribute	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	attributeId,
		bool	required,
		const std::string &	defaultValue,
		const std::vector< std::string > &	elements
	)

Create an enum attribute.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
attributeId	Attribute ID.
required	Required field.
defaultValue	Default value.
elements	Valid enum values.

Returns: JSON response.

◆ createFloatAttribute()

std::string Databases::createFloatAttribute	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	attributeId,
		bool	required,
		double	min,
		double	max,
		const std::string &	defaultValue
	)

Create a float attribute.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
attributeId	Attribute ID.
required	Required field.
min	Minimum value.
max	Maximum value.
defaultValue	Default float value.

Returns: JSON response.

◆ createIndexes()

std::string Databases::createIndexes	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	key,
		const std::string &	type,
		const std::vector< std::string > &	attributes
	)

Create a new index.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
key	Index key name.
type	Index type.
attributes	Fields to index.

Returns: JSON response.

◆ createIntegerAttribute()

std::string Databases::createIntegerAttribute	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	attributeId,
		bool	required,
		int	min,
		int	max,
		const std::string &	defaultValue
	)

Create an integer attribute.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
attributeId	Attribute ID.
required	Required field.
min	Minimum value.
max	Maximum value.
defaultValue	Default integer value.

Returns: JSON response.

◆ createIPaddressAttribute()

std::string Databases::createIPaddressAttribute	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	attributeId,
		bool	required,
		const std::string &	defaultValue
	)

Create an IP address attribute.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
attributeId	Attribute ID.
required	Required field.
defaultValue	Default IP address.

Returns: JSON response.

◆ createStringAttribute()

std::string Databases::createStringAttribute	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	attributeId,
		bool	required,
		const std::string &	defaultValue,
		const std::vector< std::string > &	elements,
		int	size
	)

Create a string attribute.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
attributeId	Attribute ID.
required	Required field.
defaultValue	Default string value.
elements	Allowed string values (for enum-like behavior).
size	Maximum length of the string.

Returns: JSON response.

◆ deleteCollection()

std::string Databases::deleteCollection	(	const std::string &	databaseId,
		const std::string &	collectionId
	)

Delete a collection by ID.

Parameters

databaseId	ID of the database.
collectionId	ID of the collection.

Returns: JSON response.

◆ deleteDocument()

std::string Databases::deleteDocument	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	documentId
	)

Delete a document by ID.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
documentId	Document ID.

Returns: JSON response.

◆ deleteIndexes()

std::string Databases::deleteIndexes	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	key
	)

Delete an index.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
key	Index key.

Returns: JSON response.

◆ get()

std::string Databases::get ( const std::string & databaseId )

Get a database by ID.

Parameters

databaseId Unique ID of the database.

Returns: JSON string of the database.

◆ getCollection()

std::string Databases::getCollection	(	const std::string &	databaseId,
		const std::string &	collectionId
	)

Get a collection by ID.

Parameters

databaseId	ID of the database.
collectionId	ID of the collection.

Returns: JSON string of collection details.

◆ getCollectionUsage()

std::string Databases::getCollectionUsage	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	range
	)

Get usage stats of a collection.

Parameters

databaseId	ID of the database.
collectionId	ID of the collection.
range	Time range for usage.

Returns: JSON usage data.

◆ getDatabaseUsage()

std::string Databases::getDatabaseUsage	(	const std::string &	databaseId,
		const std::string &	range
	)

Get usage statistics of a database.

Parameters

databaseId	ID of the database.
range	Time range for usage stats.

Returns: JSON usage data.

◆ getDocument()

std::string Databases::getDocument	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	documentId
	)

Get a document by ID.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
documentId	Document ID.

Returns: JSON string of document.

◆ getIndexes()

std::string Databases::getIndexes	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	key
	)

Get details of an index.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
key	Index key.

Returns: JSON string of index details.

◆ list()

std::string Databases::list ( )

List all databases.

Returns: JSON string of database list.

◆ listAttributes()

std::string Databases::listAttributes	(	const std::string &	databaseId,
		const std::string &	collectionId
	)

List all attributes in a collection.

Parameters

databaseId	ID of the database.
collectionId	ID of the collection.

Returns: JSON list of attributes.

◆ listCollection()

std::string Databases::listCollection ( const std::string & databaseId )

List all collections in a database.

Parameters

databaseId ID of the database.

Returns: JSON string of collections.

◆ listDocument()

std::string Databases::listDocument	(	const std::string &	databaseId,
		const std::string &	collectionId,
		Queries &	queries
	)

List documents using queries.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
queries	Filter and sort queries.

Returns: JSON string of documents.

◆ listIndexes()

std::string Databases::listIndexes	(	const std::string &	databaseId,
		const std::string &	collectionId
	)

List all indexes in a collection.

Parameters

databaseId	Database ID.
collectionId	Collection ID.

Returns: JSON string of indexes.

◆ update()

std::string Databases::update	(	const std::string &	databaseId,
		const std::string &	name,
		bool	enabled
	)

Update an existing database.

Parameters

databaseId	ID of the database to update.
name	New name of the database.
enabled	Enable or disable the database.

Returns: JSON response.

◆ updateBooleanAttribute()

std::string Databases::updateBooleanAttribute	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	attributeId,
		bool	defaultValue,
		bool	required,
		const std::string &	new_key
	)

Update a boolean attribute.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
attributeId	Attribute ID.
defaultValue	New default value.
required	Required field.
new_key	New key for the attribute.

Returns: JSON response.

◆ updateCollection()

std::string Databases::updateCollection	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	name,
		bool	enabled
	)

Update collection metadata.

Parameters

databaseId	ID of the database.
collectionId	ID of the collection.
name	New name of the collection.
enabled	New status of the collection.

Returns: JSON response.

◆ updateEmailAttribute()

std::string Databases::updateEmailAttribute	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	attributeId,
		bool	required,
		const std::string &	defaultValue,
		std::string &	new_key
	)

Update an email attribute.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
attributeId	Attribute ID.
required	Required field.
defaultValue	New default email.
new_key	New key for the attribute.

Returns: JSON response.

◆ updateEnumAttribute()

std::string Databases::updateEnumAttribute	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	attributeId,
		bool	required,
		const std::string &	defaultValue,
		const std::vector< std::string > &	elements,
		std::string &	new_key
	)

Update an enum attribute.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
attributeId	Attribute ID.
required	Required field.
defaultValue	New default value.
elements	Allowed values.
new_key	New key for the attribute.

Returns: JSON response.

◆ updateFloatAttribute()

std::string Databases::updateFloatAttribute	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	attributeId,
		bool	required,
		double	min,
		double	max,
		const std::string &	defaultValue,
		std::string &	new_key
	)

Update a float attribute.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
attributeId	Attribute ID.
required	Required field.
min	Minimum value.
max	Maximum value.
defaultValue	New default value.
new_key	New key for the attribute.

Returns: JSON response.

◆ updateIntegerAttribute()

std::string Databases::updateIntegerAttribute	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	attributeId,
		bool	required,
		int	min,
		int	max,
		const std::string &	defaultValue,
		std::string &	new_key
	)

Update an integer attribute.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
attributeId	Attribute ID.
required	Required field.
min	Minimum value.
max	Maximum value.
defaultValue	New default value.
new_key	New key for the attribute.

Returns: JSON response.

◆ updateIPaddressAttribute()

std::string Databases::updateIPaddressAttribute	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	attributeId,
		bool	required,
		const std::string &	defaultValue,
		const std::string &	new_key
	)

Update an IP address attribute.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
attributeId	Attribute ID.
required	Required field.
defaultValue	New default IP address.
new_key	New key for the attribute.

Returns: JSON response.

◆ updateStringAttribute()

std::string Databases::updateStringAttribute	(	const std::string &	databaseId,
		const std::string &	collectionId,
		const std::string &	attributeId,
		bool	required,
		const std::string &	defaultValue,
		const std::vector< std::string > &	elements,
		int	size,
		std::string &	new_key
	)

Update a string attribute.

Parameters

databaseId	Database ID.
collectionId	Collection ID.
attributeId	Attribute ID.
required	Required field.
defaultValue	New default value.
elements	Allowed string values.
size	Maximum length.
new_key	New key for the attribute.

Returns: JSON response.

The documentation for this class was generated from the following file:

Databases.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Databases()

Member Function Documentation

◆ create()

◆ createBooleanAttribute()

◆ createCollection()

◆ createDocument()

◆ createEmailAttribute()

◆ createEnumAttribute()

◆ createFloatAttribute()

◆ createIndexes()

◆ createIntegerAttribute()

◆ createIPaddressAttribute()

◆ createStringAttribute()

◆ deleteCollection()

◆ deleteDocument()

◆ deleteIndexes()

◆ get()

◆ getCollection()

◆ getCollectionUsage()

◆ getDatabaseUsage()

◆ getDocument()

◆ getIndexes()

◆ list()

◆ listAttributes()

◆ listCollection()

◆ listDocument()

◆ listIndexes()

◆ update()

◆ updateBooleanAttribute()

◆ updateCollection()

◆ updateEmailAttribute()

◆ updateEnumAttribute()

◆ updateFloatAttribute()

◆ updateIntegerAttribute()

◆ updateIPaddressAttribute()

◆ updateStringAttribute()