Merge pull request #46 from appwrite/dev

abnegate · web-flow · commit ca1e48d260ec · 2025-10-09T23:18:26.000+13:00
feat: Ruby SDK update for version 19.2.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Change Log
 
+## 19.2.0
+
+* Add transaction support for Databases and TablesDB
+
 ## 19.1.0
 
 * Deprecate `createVerification` method in `Account` service
diff --git a/appwrite.gemspec b/appwrite.gemspec
@@ -1,7 +1,7 @@
 Gem::Specification.new do |spec|
 
   spec.name = 'appwrite'
-  spec.version = '19.1.0'
+  spec.version = '19.2.0'
   spec.license = 'BSD-3-Clause'
   spec.summary = 'Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API'
   spec.author = 'Appwrite Team'
diff --git a/docs/examples/databases/create-document.md b/docs/examples/databases/create-document.md
@@ -20,5 +20,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
@@ -12,5 +12,6 @@ databases = Databases.new(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,25 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+databases = Databases.new(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,14 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+databases = Databases.new(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
@@ -15,5 +15,6 @@ result = databases.decrement_document_attribute(
     document_id: '<DOCUMENT_ID>',
     attribute: '',
     value: null, # optional
-    min: null # optional
+    min: null, # optional
+    transaction_id: '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/databases/delete-document.md b/docs/examples/databases/delete-document.md
@@ -12,5 +12,6 @@ databases = Databases.new(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
@@ -12,5 +12,6 @@ databases = Databases.new(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,14 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+databases = Databases.new(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
@@ -13,5 +13,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,14 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+databases = Databases.new(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
@@ -15,5 +15,6 @@ result = databases.increment_document_attribute(
     document_id: '<DOCUMENT_ID>',
     attribute: '',
     value: null, # optional
-    max: null # optional
+    max: null, # optional
+    transaction_id: '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/databases/list-documents.md b/docs/examples/databases/list-documents.md
@@ -12,5 +12,6 @@ databases = Databases.new(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,14 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+databases = Databases.new(client)
+
+result = databases.list_transactions(
+    queries: [] # optional
+)
diff --git a/docs/examples/databases/update-document.md b/docs/examples/databases/update-document.md
@@ -14,5 +14,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
@@ -13,5 +13,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,16 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+databases = Databases.new(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
@@ -14,5 +14,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
@@ -12,5 +12,6 @@ databases = Databases.new(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
@@ -18,7 +18,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
@@ -18,7 +18,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,25 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+tables_db = TablesDB.new(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
@@ -20,5 +20,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
@@ -12,5 +12,6 @@ tables_db = TablesDB.new(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,14 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+tables_db = TablesDB.new(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
@@ -15,5 +15,6 @@ result = tables_db.decrement_row_column(
     row_id: '<ROW_ID>',
     column: '',
     value: null, # optional
-    min: null # optional
+    min: null, # optional
+    transaction_id: '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/tablesdb/delete-row.md b/docs/examples/tablesdb/delete-row.md
@@ -12,5 +12,6 @@ tables_db = TablesDB.new(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
@@ -12,5 +12,6 @@ tables_db = TablesDB.new(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,14 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+tables_db = TablesDB.new(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
@@ -13,5 +13,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,14 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+tables_db = TablesDB.new(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
@@ -15,5 +15,6 @@ result = tables_db.increment_row_column(
     row_id: '<ROW_ID>',
     column: '',
     value: null, # optional
-    max: null # optional
+    max: null, # optional
+    transaction_id: '<TRANSACTION_ID>' # optional
 )
diff --git a/docs/examples/tablesdb/list-rows.md b/docs/examples/tablesdb/list-rows.md
@@ -12,5 +12,6 @@ tables_db = TablesDB.new(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,14 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+tables_db = TablesDB.new(client)
+
+result = tables_db.list_transactions(
+    queries: [] # optional
+)
diff --git a/docs/examples/tablesdb/update-row.md b/docs/examples/tablesdb/update-row.md
@@ -14,5 +14,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
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/lib/appwrite.rb b/lib/appwrite.rb
diff --git a/lib/appwrite/client.rb b/lib/appwrite/client.rb
diff --git a/lib/appwrite/models/transaction.rb b/lib/appwrite/models/transaction.rb
diff --git a/lib/appwrite/models/transaction_list.rb b/lib/appwrite/models/transaction_list.rb
diff --git a/lib/appwrite/services/databases.rb b/lib/appwrite/services/databases.rb
diff --git a/lib/appwrite/services/tables_db.rb b/lib/appwrite/services/tables_db.rb

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