appwrite/app/sdks/php/docs/database.md

Database Service

List Collections

GET https://appwrite.io/v1/database/collections

** Get a list of all the user collections. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project collections. Learn more about different API modes. **

Parameters

Field Name	Type	Description	Default
search	string	Search term to filter your list results.
limit	integer	Results limit value. By default will return maximum 25 results. Maximum of 100 results allowed per request.	25
offset	integer	Results offset. The default value is 0. Use this param to manage pagination.	0
orderType	string	Order result by ASC or DESC order.	ASC

Create Collection

POST https://appwrite.io/v1/database/collections

** Create a new Collection. **

Parameters

Field Name	Type	Description	Default
name	string	Collection name.
read	array	An array of strings with read permissions. By default no user is granted with any read permissions. learn more about permissions and get a full list of available permissions.
write	array	An array of strings with write permissions. By default no user is granted with any write permissions. learn more about permissions and get a full list of available permissions.
rules	array	Array of rule objects. Each rule define a collection field name, data type and validation

Get Collection

GET https://appwrite.io/v1/database/collections/{collectionId}

** Get collection by its unique ID. This endpoint response returns a JSON object with the collection metadata. **

Parameters

Field Name	Type	Description	Default
collectionId	string	Required Collection unique ID.

Update Collection

PUT https://appwrite.io/v1/database/collections/{collectionId}

** Update collection by its unique ID. **

Parameters

Field Name	Type	Description	Default
collectionId	string	Required Collection unique ID.
name	string	Collection name.
read	array	An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions(/docs/permissions) and get a full list of available permissions.
write	array	An array of strings with write permissions. By default no user is granted with any write permissions. learn more about permissions and get a full list of available permissions.
rules	array	Array of rule objects. Each rule define a collection field name, data type and validation	[]

Delete Collection

DELETE https://appwrite.io/v1/database/collections/{collectionId}

** Delete a collection by its unique ID. Only users with write permissions have access to delete this resource. **

Parameters

Field Name	Type	Description	Default
collectionId	string	Required Collection unique ID.

List Documents

GET https://appwrite.io/v1/database/collections/{collectionId}/documents

** Get a list of all the user documents. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project documents. Learn more about different API modes. **

Parameters

Field Name	Type	Description	Default
collectionId	string	Required Collection unique ID.
filters	array	Array of filter strings. Each filter is constructed from a key name, comparison operator (=, !=, >, <, <=, >=) and a value. You can also use a dot (.) separator in attribute names to filter by child document attributes. Examples: 'name=John Doe' or 'category.$uid>=5bed2d152c362'	[]
offset	integer	Offset value. Use this value to manage pagination.	0
limit	integer	Maximum number of documents to return in response. Use this value to manage pagination.	50
order-field	string	Document field that results will be sorted by.	$uid
order-type	string	Order direction. Possible values are DESC for descending order, or ASC for ascending order.	ASC
order-cast	string	Order field type casting. Possible values are int, string, date, time or datetime. The database will attempt to cast the order field to the value you pass here. The default value is a string.	string
search	string	Search query. Enter any free text search. The database will try to find a match against all document attributes and children.
first	integer	Return only first document. Pass 1 for true or 0 for false. The default value is 0.	0
last	integer	Return only last document. Pass 1 for true or 0 for false. The default value is 0.	0

Create Document

POST https://appwrite.io/v1/database/collections/{collectionId}/documents

** Create a new Document. **

Parameters

Field Name	Type	Description	Default
collectionId	string	Required Collection unique ID.
data	string	Document data as JSON string.
read	array	An array of strings with read permissions. By default no user is granted with any read permissions. learn more about permissions and get a full list of available permissions.
write	array	An array of strings with write permissions. By default no user is granted with any write permissions. learn more about permissions and get a full list of available permissions.
parentDocument	string	Parent document unique ID. Use when you want your new document to be a child of a parent document.
parentProperty	string	Parent document property name. Use when you want your new document to be a child of a parent document.
parentPropertyType	string	Parent document property connection type. You can set this value to assign, append or prepend, default value is assign. Use when you want your new document to be a child of a parent document.	assign

Get Document

GET https://appwrite.io/v1/database/collections/{collectionId}/documents/{documentId}

** Get document by its unique ID. This endpoint response returns a JSON object with the document data. **

Parameters

Field Name	Type	Description	Default
collectionId	string	Required Collection unique ID
documentId	string	Required Document unique ID

Update Document

PATCH https://appwrite.io/v1/database/collections/{collectionId}/documents/{documentId}

Parameters

Field Name	Type	Description	Default
collectionId	string	Required Collection unique ID
documentId	string	Required Document unique ID
data	string	Document data as JSON string
read	array	An array of strings with read permissions. By default no user is granted with any read permissions. learn more about permissions and get a full list of available permissions.
write	array	An array of strings with write permissions. By default no user is granted with any write permissions. learn more about permissions and get a full list of available permissions.

Delete Document

DELETE https://appwrite.io/v1/database/collections/{collectionId}/documents/{documentId}

** Delete document by its unique ID. This endpoint deletes only the parent documents, his attributes and relations to other documents. Child documents will not be deleted. **

Parameters

Field Name	Type	Description	Default
collectionId	string	Required Collection unique ID
documentId	string	Required Document unique ID