@@ -13,6 +13,7 @@ def __init__(self, client) -> None:
1313 def list (self , queries : List [str ] = None , search : str = None ) -> Dict [str , Any ]:
1414 """
1515 Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.
16+
1617 Parameters
1718 ----------
1819 queries : List[str]
@@ -45,6 +46,7 @@ def create(self, database_id: str, name: str, enabled: bool = None) -> Dict[str,
4546 """
4647 Create a new Database.
4748
49+
4850 Parameters
4951 ----------
5052 database_id : str
@@ -85,6 +87,7 @@ def create(self, database_id: str, name: str, enabled: bool = None) -> Dict[str,
8587 def get (self , database_id : str ) -> Dict [str , Any ]:
8688 """
8789 Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.
90+
8891 Parameters
8992 ----------
9093 database_id : str
@@ -116,6 +119,7 @@ def get(self, database_id: str) -> Dict[str, Any]:
116119 def update (self , database_id : str , name : str , enabled : bool = None ) -> Dict [str , Any ]:
117120 """
118121 Update a database by its unique ID.
122+
119123 Parameters
120124 ----------
121125 database_id : str
@@ -156,6 +160,7 @@ def update(self, database_id: str, name: str, enabled: bool = None) -> Dict[str,
156160 def delete (self , database_id : str ) -> Dict [str , Any ]:
157161 """
158162 Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.
163+
159164 Parameters
160165 ----------
161166 database_id : str
@@ -187,6 +192,7 @@ def delete(self, database_id: str) -> Dict[str, Any]:
187192 def list_collections (self , database_id : str , queries : List [str ] = None , search : str = None ) -> Dict [str , Any ]:
188193 """
189194 Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.
195+
190196 Parameters
191197 ----------
192198 database_id : str
@@ -224,6 +230,7 @@ def list_collections(self, database_id: str, queries: List[str] = None, search:
224230 def create_collection (self , database_id : str , collection_id : str , name : str , permissions : List [str ] = None , document_security : bool = None , enabled : bool = None ) -> Dict [str , Any ]:
225231 """
226232 Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
233+
227234 Parameters
228235 ----------
229236 database_id : str
@@ -276,6 +283,7 @@ def create_collection(self, database_id: str, collection_id: str, name: str, per
276283 def get_collection (self , database_id : str , collection_id : str ) -> Dict [str , Any ]:
277284 """
278285 Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.
286+
279287 Parameters
280288 ----------
281289 database_id : str
@@ -313,6 +321,7 @@ def get_collection(self, database_id: str, collection_id: str) -> Dict[str, Any]
313321 def update_collection (self , database_id : str , collection_id : str , name : str , permissions : List [str ] = None , document_security : bool = None , enabled : bool = None ) -> Dict [str , Any ]:
314322 """
315323 Update a collection by its unique ID.
324+
316325 Parameters
317326 ----------
318327 database_id : str
@@ -365,6 +374,7 @@ def update_collection(self, database_id: str, collection_id: str, name: str, per
365374 def delete_collection (self , database_id : str , collection_id : str ) -> Dict [str , Any ]:
366375 """
367376 Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.
377+
368378 Parameters
369379 ----------
370380 database_id : str
@@ -402,6 +412,7 @@ def delete_collection(self, database_id: str, collection_id: str) -> Dict[str, A
402412 def list_attributes (self , database_id : str , collection_id : str , queries : List [str ] = None ) -> Dict [str , Any ]:
403413 """
404414 List attributes in the collection.
415+
405416 Parameters
406417 ----------
407418 database_id : str
@@ -443,6 +454,7 @@ def create_boolean_attribute(self, database_id: str, collection_id: str, key: st
443454 """
444455 Create a boolean attribute.
445456
457+
446458 Parameters
447459 ----------
448460 database_id : str
@@ -498,6 +510,7 @@ def create_boolean_attribute(self, database_id: str, collection_id: str, key: st
498510 def update_boolean_attribute (self , database_id : str , collection_id : str , key : str , required : bool , default : bool , new_key : str = None ) -> Dict [str , Any ]:
499511 """
500512 Update a boolean attribute. Changing the `default` value will not update already existing documents.
513+
501514 Parameters
502515 ----------
503516 database_id : str
@@ -553,6 +566,7 @@ def update_boolean_attribute(self, database_id: str, collection_id: str, key: st
553566 def create_datetime_attribute (self , database_id : str , collection_id : str , key : str , required : bool , default : str = None , array : bool = None ) -> Dict [str , Any ]:
554567 """
555568 Create a date time attribute according to the ISO 8601 standard.
569+
556570 Parameters
557571 ----------
558572 database_id : str
@@ -608,6 +622,7 @@ def create_datetime_attribute(self, database_id: str, collection_id: str, key: s
608622 def update_datetime_attribute (self , database_id : str , collection_id : str , key : str , required : bool , default : str , new_key : str = None ) -> Dict [str , Any ]:
609623 """
610624 Update a date time attribute. Changing the `default` value will not update already existing documents.
625+
611626 Parameters
612627 ----------
613628 database_id : str
@@ -664,6 +679,7 @@ def create_email_attribute(self, database_id: str, collection_id: str, key: str,
664679 """
665680 Create an email attribute.
666681
682+
667683 Parameters
668684 ----------
669685 database_id : str
@@ -720,6 +736,7 @@ def update_email_attribute(self, database_id: str, collection_id: str, key: str,
720736 """
721737 Update an email attribute. Changing the `default` value will not update already existing documents.
722738
739+
723740 Parameters
724741 ----------
725742 database_id : str
@@ -776,6 +793,7 @@ def create_enum_attribute(self, database_id: str, collection_id: str, key: str,
776793 """
777794 Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute.
778795
796+
779797 Parameters
780798 ----------
781799 database_id : str
@@ -838,6 +856,7 @@ def update_enum_attribute(self, database_id: str, collection_id: str, key: str,
838856 """
839857 Update an enum attribute. Changing the `default` value will not update already existing documents.
840858
859+
841860 Parameters
842861 ----------
843862 database_id : str
@@ -900,6 +919,7 @@ def create_float_attribute(self, database_id: str, collection_id: str, key: str,
900919 """
901920 Create a float attribute. Optionally, minimum and maximum values can be provided.
902921
922+
903923 Parameters
904924 ----------
905925 database_id : str
@@ -962,6 +982,7 @@ def update_float_attribute(self, database_id: str, collection_id: str, key: str,
962982 """
963983 Update a float attribute. Changing the `default` value will not update already existing documents.
964984
985+
965986 Parameters
966987 ----------
967988 database_id : str
@@ -1024,6 +1045,7 @@ def create_integer_attribute(self, database_id: str, collection_id: str, key: st
10241045 """
10251046 Create an integer attribute. Optionally, minimum and maximum values can be provided.
10261047
1048+
10271049 Parameters
10281050 ----------
10291051 database_id : str
@@ -1086,6 +1108,7 @@ def update_integer_attribute(self, database_id: str, collection_id: str, key: st
10861108 """
10871109 Update an integer attribute. Changing the `default` value will not update already existing documents.
10881110
1111+
10891112 Parameters
10901113 ----------
10911114 database_id : str
@@ -1148,6 +1171,7 @@ def create_ip_attribute(self, database_id: str, collection_id: str, key: str, re
11481171 """
11491172 Create IP address attribute.
11501173
1174+
11511175 Parameters
11521176 ----------
11531177 database_id : str
@@ -1204,6 +1228,7 @@ def update_ip_attribute(self, database_id: str, collection_id: str, key: str, re
12041228 """
12051229 Update an ip attribute. Changing the `default` value will not update already existing documents.
12061230
1231+
12071232 Parameters
12081233 ----------
12091234 database_id : str
@@ -1260,6 +1285,7 @@ def create_relationship_attribute(self, database_id: str, collection_id: str, re
12601285 """
12611286 Create relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
12621287
1288+
12631289 Parameters
12641290 ----------
12651291 database_id : str
@@ -1322,6 +1348,7 @@ def create_string_attribute(self, database_id: str, collection_id: str, key: str
13221348 """
13231349 Create a string attribute.
13241350
1351+
13251352 Parameters
13261353 ----------
13271354 database_id : str
@@ -1387,6 +1414,7 @@ def update_string_attribute(self, database_id: str, collection_id: str, key: str
13871414 """
13881415 Update a string attribute. Changing the `default` value will not update already existing documents.
13891416
1417+
13901418 Parameters
13911419 ----------
13921420 database_id : str
@@ -1446,6 +1474,7 @@ def create_url_attribute(self, database_id: str, collection_id: str, key: str, r
14461474 """
14471475 Create a URL attribute.
14481476
1477+
14491478 Parameters
14501479 ----------
14511480 database_id : str
@@ -1502,6 +1531,7 @@ def update_url_attribute(self, database_id: str, collection_id: str, key: str, r
15021531 """
15031532 Update an url attribute. Changing the `default` value will not update already existing documents.
15041533
1534+
15051535 Parameters
15061536 ----------
15071537 database_id : str
@@ -1557,6 +1587,7 @@ def update_url_attribute(self, database_id: str, collection_id: str, key: str, r
15571587 def get_attribute (self , database_id : str , collection_id : str , key : str ) -> Dict [str , Any ]:
15581588 """
15591589 Get attribute by ID.
1590+
15601591 Parameters
15611592 ----------
15621593 database_id : str
@@ -1600,6 +1631,7 @@ def get_attribute(self, database_id: str, collection_id: str, key: str) -> Dict[
16001631 def delete_attribute (self , database_id : str , collection_id : str , key : str ) -> Dict [str , Any ]:
16011632 """
16021633 Deletes an attribute.
1634+
16031635 Parameters
16041636 ----------
16051637 database_id : str
@@ -1644,6 +1676,7 @@ def update_relationship_attribute(self, database_id: str, collection_id: str, ke
16441676 """
16451677 Update relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
16461678
1679+
16471680 Parameters
16481681 ----------
16491682 database_id : str
@@ -1693,6 +1726,7 @@ def update_relationship_attribute(self, database_id: str, collection_id: str, ke
16931726 def list_documents (self , database_id : str , collection_id : str , queries : List [str ] = None ) -> Dict [str , Any ]:
16941727 """
16951728 Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
1729+
16961730 Parameters
16971731 ----------
16981732 database_id : str
@@ -1734,6 +1768,7 @@ def create_document(self, database_id: str, collection_id: str, document_id: str
17341768 """
17351769 Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
17361770
1771+
17371772 Parameters
17381773 ----------
17391774 database_id : str
@@ -1786,6 +1821,7 @@ def create_document(self, database_id: str, collection_id: str, document_id: str
17861821 def get_document (self , database_id : str , collection_id : str , document_id : str , queries : List [str ] = None ) -> Dict [str , Any ]:
17871822 """
17881823 Get a document by its unique ID. This endpoint response returns a JSON object with the document data.
1824+
17891825 Parameters
17901826 ----------
17911827 database_id : str
@@ -1832,6 +1868,7 @@ def get_document(self, database_id: str, collection_id: str, document_id: str, q
18321868 def update_document (self , database_id : str , collection_id : str , document_id : str , data : dict = None , permissions : List [str ] = None ) -> Dict [str , Any ]:
18331869 """
18341870 Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.
1871+
18351872 Parameters
18361873 ----------
18371874 database_id : str
@@ -1881,6 +1918,7 @@ def update_document(self, database_id: str, collection_id: str, document_id: str
18811918 def delete_document (self , database_id : str , collection_id : str , document_id : str ) -> Dict [str , Any ]:
18821919 """
18831920 Delete a document by its unique ID.
1921+
18841922 Parameters
18851923 ----------
18861924 database_id : str
@@ -1924,6 +1962,7 @@ def delete_document(self, database_id: str, collection_id: str, document_id: str
19241962 def list_indexes (self , database_id : str , collection_id : str , queries : List [str ] = None ) -> Dict [str , Any ]:
19251963 """
19261964 List indexes in the collection.
1965+
19271966 Parameters
19281967 ----------
19291968 database_id : str
@@ -1965,6 +2004,7 @@ def create_index(self, database_id: str, collection_id: str, key: str, type: Ind
19652004 """
19662005 Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.
19672006 Attributes can be `key`, `fulltext`, and `unique`.
2007+
19682008 Parameters
19692009 ----------
19702010 database_id : str
@@ -2023,6 +2063,7 @@ def create_index(self, database_id: str, collection_id: str, key: str, type: Ind
20232063 def get_index (self , database_id : str , collection_id : str , key : str ) -> Dict [str , Any ]:
20242064 """
20252065 Get index by ID.
2066+
20262067 Parameters
20272068 ----------
20282069 database_id : str
@@ -2066,6 +2107,7 @@ def get_index(self, database_id: str, collection_id: str, key: str) -> Dict[str,
20662107 def delete_index (self , database_id : str , collection_id : str , key : str ) -> Dict [str , Any ]:
20672108 """
20682109 Delete an index.
2110+
20692111 Parameters
20702112 ----------
20712113 database_id : str
0 commit comments