Merge pull request #120 from appwrite/dev

abnegate · web-flow · commit 726cb3270ea3 · 2025-10-09T23:18:20.000+13:00
feat: Python SDK update for version 13.4.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Change Log
 
+## 13.4.0
+
+* Add transaction support for Databases and TablesDB
+
 ## 13.3.0
 
 * Deprecate `createVerification` method in `Account` service
diff --git a/appwrite/client.py b/appwrite/client.py
@@ -15,11 +15,11 @@ def __init__(self):
         self._endpoint = 'https://cloud.appwrite.io/v1'
         self._global_headers = {
             'content-type': '',
-            'user-agent' : f'AppwritePythonSDK/13.3.0 ({platform.uname().system}; {platform.uname().version}; {platform.uname().machine})',
+            'user-agent' : f'AppwritePythonSDK/13.4.0 ({platform.uname().system}; {platform.uname().version}; {platform.uname().machine})',
             'x-sdk-name': 'Python',
             'x-sdk-platform': 'server',
             'x-sdk-language': 'python',
-            'x-sdk-version': '13.3.0',
+            'x-sdk-version': '13.4.0',
             'X-Appwrite-Response-Format' : '1.8.0',
         }
 
diff --git a/appwrite/services/databases.py b/appwrite/services/databases.py
diff --git a/appwrite/services/tables_db.py b/appwrite/services/tables_db.py
diff --git a/docs/examples/databases/create-document.md b/docs/examples/databases/create-document.md
@@ -19,5 +19,6 @@ result = databases.create_document(
         "age": 30,
         "isAdmin": False
     },
-    permissions = ["read("any")"] # optional
+    permissions = ["read("any")"], # optional
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/databases/create-documents.md b/docs/examples/databases/create-documents.md
@@ -11,5 +11,6 @@ databases = Databases(client)
 result = databases.create_documents(
     database_id = '<DATABASE_ID>',
     collection_id = '<COLLECTION_ID>',
-    documents = []
+    documents = [],
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/databases/create-operations.md b/docs/examples/databases/create-operations.md
@@ -0,0 +1,24 @@
+from appwrite.client import Client
+from appwrite.services.databases import Databases
+
+client = Client()
+client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+client.set_project('<YOUR_PROJECT_ID>') # Your project ID
+client.set_key('<YOUR_API_KEY>') # Your secret API key
+
+databases = Databases(client)
+
+result = databases.create_operations(
+    transaction_id = '<TRANSACTION_ID>',
+    operations = [
+	    {
+	        "action": "create",
+	        "databaseId": "<DATABASE_ID>",
+	        "collectionId": "<COLLECTION_ID>",
+	        "documentId": "<DOCUMENT_ID>",
+	        "data": {
+	            "name": "Walter O'Brien"
+	        }
+	    }
+	] # optional
+)
diff --git a/docs/examples/databases/create-transaction.md b/docs/examples/databases/create-transaction.md
@@ -0,0 +1,13 @@
+from appwrite.client import Client
+from appwrite.services.databases import Databases
+
+client = Client()
+client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+client.set_project('<YOUR_PROJECT_ID>') # Your project ID
+client.set_key('<YOUR_API_KEY>') # Your secret API key
+
+databases = Databases(client)
+
+result = databases.create_transaction(
+    ttl = 60 # optional
+)
diff --git a/docs/examples/databases/decrement-document-attribute.md b/docs/examples/databases/decrement-document-attribute.md
@@ -14,5 +14,6 @@ result = databases.decrement_document_attribute(
     document_id = '<DOCUMENT_ID>',
     attribute = '',
     value = None, # optional
-    min = None # optional
+    min = None, # optional
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/databases/delete-document.md b/docs/examples/databases/delete-document.md
@@ -11,5 +11,6 @@ databases = Databases(client)
 result = databases.delete_document(
     database_id = '<DATABASE_ID>',
     collection_id = '<COLLECTION_ID>',
-    document_id = '<DOCUMENT_ID>'
+    document_id = '<DOCUMENT_ID>',
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/databases/delete-documents.md b/docs/examples/databases/delete-documents.md
@@ -11,5 +11,6 @@ databases = Databases(client)
 result = databases.delete_documents(
     database_id = '<DATABASE_ID>',
     collection_id = '<COLLECTION_ID>',
-    queries = [] # optional
+    queries = [], # optional
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/databases/delete-transaction.md b/docs/examples/databases/delete-transaction.md
@@ -0,0 +1,13 @@
+from appwrite.client import Client
+from appwrite.services.databases import Databases
+
+client = Client()
+client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+client.set_project('<YOUR_PROJECT_ID>') # Your project ID
+client.set_key('<YOUR_API_KEY>') # Your secret API key
+
+databases = Databases(client)
+
+result = databases.delete_transaction(
+    transaction_id = '<TRANSACTION_ID>'
+)
diff --git a/docs/examples/databases/get-document.md b/docs/examples/databases/get-document.md
@@ -12,5 +12,6 @@ result = databases.get_document(
     database_id = '<DATABASE_ID>',
     collection_id = '<COLLECTION_ID>',
     document_id = '<DOCUMENT_ID>',
-    queries = [] # optional
+    queries = [], # optional
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/databases/get-transaction.md b/docs/examples/databases/get-transaction.md
@@ -0,0 +1,13 @@
+from appwrite.client import Client
+from appwrite.services.databases import Databases
+
+client = Client()
+client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+client.set_project('<YOUR_PROJECT_ID>') # Your project ID
+client.set_key('<YOUR_API_KEY>') # Your secret API key
+
+databases = Databases(client)
+
+result = databases.get_transaction(
+    transaction_id = '<TRANSACTION_ID>'
+)
diff --git a/docs/examples/databases/increment-document-attribute.md b/docs/examples/databases/increment-document-attribute.md
@@ -14,5 +14,6 @@ result = databases.increment_document_attribute(
     document_id = '<DOCUMENT_ID>',
     attribute = '',
     value = None, # optional
-    max = None # optional
+    max = None, # optional
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/databases/list-documents.md b/docs/examples/databases/list-documents.md
@@ -11,5 +11,6 @@ databases = Databases(client)
 result = databases.list_documents(
     database_id = '<DATABASE_ID>',
     collection_id = '<COLLECTION_ID>',
-    queries = [] # optional
+    queries = [], # optional
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/databases/list-transactions.md b/docs/examples/databases/list-transactions.md
@@ -0,0 +1,13 @@
+from appwrite.client import Client
+from appwrite.services.databases import Databases
+
+client = Client()
+client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+client.set_project('<YOUR_PROJECT_ID>') # Your project ID
+client.set_key('<YOUR_API_KEY>') # Your secret API key
+
+databases = Databases(client)
+
+result = databases.list_transactions(
+    queries = [] # optional
+)
diff --git a/docs/examples/databases/update-document.md b/docs/examples/databases/update-document.md
@@ -13,5 +13,6 @@ result = databases.update_document(
     collection_id = '<COLLECTION_ID>',
     document_id = '<DOCUMENT_ID>',
     data = {}, # optional
-    permissions = ["read("any")"] # optional
+    permissions = ["read("any")"], # optional
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/databases/update-documents.md b/docs/examples/databases/update-documents.md
@@ -12,5 +12,6 @@ result = databases.update_documents(
     database_id = '<DATABASE_ID>',
     collection_id = '<COLLECTION_ID>',
     data = {}, # optional
-    queries = [] # optional
+    queries = [], # optional
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/databases/update-transaction.md b/docs/examples/databases/update-transaction.md
@@ -0,0 +1,15 @@
+from appwrite.client import Client
+from appwrite.services.databases import Databases
+
+client = Client()
+client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+client.set_project('<YOUR_PROJECT_ID>') # Your project ID
+client.set_key('<YOUR_API_KEY>') # Your secret API key
+
+databases = Databases(client)
+
+result = databases.update_transaction(
+    transaction_id = '<TRANSACTION_ID>',
+    commit = False, # optional
+    rollback = False # optional
+)
diff --git a/docs/examples/databases/upsert-document.md b/docs/examples/databases/upsert-document.md
@@ -13,5 +13,6 @@ result = databases.upsert_document(
     collection_id = '<COLLECTION_ID>',
     document_id = '<DOCUMENT_ID>',
     data = {},
-    permissions = ["read("any")"] # optional
+    permissions = ["read("any")"], # optional
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/databases/upsert-documents.md b/docs/examples/databases/upsert-documents.md
@@ -11,5 +11,6 @@ databases = Databases(client)
 result = databases.upsert_documents(
     database_id = '<DATABASE_ID>',
     collection_id = '<COLLECTION_ID>',
-    documents = []
+    documents = [],
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/messaging/create-push.md b/docs/examples/messaging/create-push.md
@@ -17,7 +17,7 @@ result = messaging.create_push(
     targets = [], # optional
     data = {}, # optional
     action = '<ACTION>', # optional
-    image = '[ID1:ID2]', # optional
+    image = '<ID1:ID2>', # optional
     icon = '<ICON>', # optional
     sound = '<SOUND>', # optional
     color = '<COLOR>', # optional
diff --git a/docs/examples/messaging/update-push.md b/docs/examples/messaging/update-push.md
@@ -17,7 +17,7 @@ result = messaging.update_push(
     body = '<BODY>', # optional
     data = {}, # optional
     action = '<ACTION>', # optional
-    image = '[ID1:ID2]', # optional
+    image = '<ID1:ID2>', # optional
     icon = '<ICON>', # optional
     sound = '<SOUND>', # optional
     color = '<COLOR>', # optional
diff --git a/docs/examples/tablesdb/create-operations.md b/docs/examples/tablesdb/create-operations.md
@@ -0,0 +1,24 @@
+from appwrite.client import Client
+from appwrite.services.tables_db import TablesDB
+
+client = Client()
+client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+client.set_project('<YOUR_PROJECT_ID>') # Your project ID
+client.set_key('<YOUR_API_KEY>') # Your secret API key
+
+tables_db = TablesDB(client)
+
+result = tables_db.create_operations(
+    transaction_id = '<TRANSACTION_ID>',
+    operations = [
+	    {
+	        "action": "create",
+	        "databaseId": "<DATABASE_ID>",
+	        "tableId": "<TABLE_ID>",
+	        "rowId": "<ROW_ID>",
+	        "data": {
+	            "name": "Walter O'Brien"
+	        }
+	    }
+	] # optional
+)
diff --git a/docs/examples/tablesdb/create-row.md b/docs/examples/tablesdb/create-row.md
@@ -19,5 +19,6 @@ result = tables_db.create_row(
         "age": 30,
         "isAdmin": False
     },
-    permissions = ["read("any")"] # optional
+    permissions = ["read("any")"], # optional
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/tablesdb/create-rows.md b/docs/examples/tablesdb/create-rows.md
@@ -11,5 +11,6 @@ tables_db = TablesDB(client)
 result = tables_db.create_rows(
     database_id = '<DATABASE_ID>',
     table_id = '<TABLE_ID>',
-    rows = []
+    rows = [],
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/tablesdb/create-transaction.md b/docs/examples/tablesdb/create-transaction.md
@@ -0,0 +1,13 @@
+from appwrite.client import Client
+from appwrite.services.tables_db import TablesDB
+
+client = Client()
+client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+client.set_project('<YOUR_PROJECT_ID>') # Your project ID
+client.set_key('<YOUR_API_KEY>') # Your secret API key
+
+tables_db = TablesDB(client)
+
+result = tables_db.create_transaction(
+    ttl = 60 # optional
+)
diff --git a/docs/examples/tablesdb/decrement-row-column.md b/docs/examples/tablesdb/decrement-row-column.md
@@ -14,5 +14,6 @@ result = tables_db.decrement_row_column(
     row_id = '<ROW_ID>',
     column = '',
     value = None, # optional
-    min = None # optional
+    min = None, # optional
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/tablesdb/delete-row.md b/docs/examples/tablesdb/delete-row.md
@@ -11,5 +11,6 @@ tables_db = TablesDB(client)
 result = tables_db.delete_row(
     database_id = '<DATABASE_ID>',
     table_id = '<TABLE_ID>',
-    row_id = '<ROW_ID>'
+    row_id = '<ROW_ID>',
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/tablesdb/delete-rows.md b/docs/examples/tablesdb/delete-rows.md
@@ -11,5 +11,6 @@ tables_db = TablesDB(client)
 result = tables_db.delete_rows(
     database_id = '<DATABASE_ID>',
     table_id = '<TABLE_ID>',
-    queries = [] # optional
+    queries = [], # optional
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/tablesdb/delete-transaction.md b/docs/examples/tablesdb/delete-transaction.md
@@ -0,0 +1,13 @@
+from appwrite.client import Client
+from appwrite.services.tables_db import TablesDB
+
+client = Client()
+client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+client.set_project('<YOUR_PROJECT_ID>') # Your project ID
+client.set_key('<YOUR_API_KEY>') # Your secret API key
+
+tables_db = TablesDB(client)
+
+result = tables_db.delete_transaction(
+    transaction_id = '<TRANSACTION_ID>'
+)
diff --git a/docs/examples/tablesdb/get-row.md b/docs/examples/tablesdb/get-row.md
@@ -12,5 +12,6 @@ result = tables_db.get_row(
     database_id = '<DATABASE_ID>',
     table_id = '<TABLE_ID>',
     row_id = '<ROW_ID>',
-    queries = [] # optional
+    queries = [], # optional
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/tablesdb/get-transaction.md b/docs/examples/tablesdb/get-transaction.md
@@ -0,0 +1,13 @@
+from appwrite.client import Client
+from appwrite.services.tables_db import TablesDB
+
+client = Client()
+client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+client.set_project('<YOUR_PROJECT_ID>') # Your project ID
+client.set_key('<YOUR_API_KEY>') # Your secret API key
+
+tables_db = TablesDB(client)
+
+result = tables_db.get_transaction(
+    transaction_id = '<TRANSACTION_ID>'
+)
diff --git a/docs/examples/tablesdb/increment-row-column.md b/docs/examples/tablesdb/increment-row-column.md
@@ -14,5 +14,6 @@ result = tables_db.increment_row_column(
     row_id = '<ROW_ID>',
     column = '',
     value = None, # optional
-    max = None # optional
+    max = None, # optional
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/tablesdb/list-rows.md b/docs/examples/tablesdb/list-rows.md
@@ -11,5 +11,6 @@ tables_db = TablesDB(client)
 result = tables_db.list_rows(
     database_id = '<DATABASE_ID>',
     table_id = '<TABLE_ID>',
-    queries = [] # optional
+    queries = [], # optional
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/tablesdb/list-transactions.md b/docs/examples/tablesdb/list-transactions.md
@@ -0,0 +1,13 @@
+from appwrite.client import Client
+from appwrite.services.tables_db import TablesDB
+
+client = Client()
+client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+client.set_project('<YOUR_PROJECT_ID>') # Your project ID
+client.set_key('<YOUR_API_KEY>') # Your secret API key
+
+tables_db = TablesDB(client)
+
+result = tables_db.list_transactions(
+    queries = [] # optional
+)
diff --git a/docs/examples/tablesdb/update-row.md b/docs/examples/tablesdb/update-row.md
@@ -13,5 +13,6 @@ result = tables_db.update_row(
     table_id = '<TABLE_ID>',
     row_id = '<ROW_ID>',
     data = {}, # optional
-    permissions = ["read("any")"] # optional
+    permissions = ["read("any")"], # optional
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/tablesdb/update-rows.md b/docs/examples/tablesdb/update-rows.md
@@ -12,5 +12,6 @@ result = tables_db.update_rows(
     database_id = '<DATABASE_ID>',
     table_id = '<TABLE_ID>',
     data = {}, # optional
-    queries = [] # optional
+    queries = [], # optional
+    transaction_id = '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/tablesdb/update-transaction.md b/docs/examples/tablesdb/update-transaction.md
diff --git a/docs/examples/tablesdb/upsert-row.md b/docs/examples/tablesdb/upsert-row.md
diff --git a/docs/examples/tablesdb/upsert-rows.md b/docs/examples/tablesdb/upsert-rows.md
diff --git a/setup.py b/setup.py

Original file line number	Diff line number	Diff line change
`@@ -19,5 +19,6 @@ result = databases.create_document(`
`19`	`19`	`"age": 30,`
`20`	`20`	`"isAdmin": False`
`21`	`21`	`},`
`22`		`- permissions = ["read("any")"] # optional`
	`22`	`+ permissions = ["read("any")"], # optional`
	`23`	`+ transaction_id = '<TRANSACTION_ID>' # optional`
`23`	`24`	`)`
Original file line number	Diff line number	Diff line change
`@@ -11,5 +11,6 @@ databases = Databases(client)`
`11`	`11`	`result = databases.create_documents(`
`12`	`12`	`database_id = '<DATABASE_ID>',`
`13`	`13`	`collection_id = '<COLLECTION_ID>',`
`14`		`- documents = []`
	`14`	`+ documents = [],`
	`15`	`+ transaction_id = '<TRANSACTION_ID>' # optional`
`15`	`16`	`)`
Original file line number	Diff line number	Diff line change
`@@ -14,5 +14,6 @@ result = databases.decrement_document_attribute(`
`14`	`14`	`document_id = '<DOCUMENT_ID>',`
`15`	`15`	`attribute = '',`
`16`	`16`	`value = None, # optional`
`17`		`- min = None # optional`
	`17`	`+ min = None, # optional`
	`18`	`+ transaction_id = '<TRANSACTION_ID>' # optional`
`18`	`19`	`)`