mirror of
https://github.com/appwrite/appwrite.git
synced 2026-05-26 13:51:13 +00:00
docs update
This commit is contained in:
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.create_boolean_attribute(collection_id: '[COLLECTION_ID]', key: '', required: false)
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.create_collection(collection_id: '[COLLECTION_ID]', name: '[NAME]', permission: 'document', read: ["role:all"], write: ["role:all"])
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.create_document(collection_id: '[COLLECTION_ID]', document_id: '[DOCUMENT_ID]', data: {})
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.create_email_attribute(collection_id: '[COLLECTION_ID]', key: '', required: false)
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.create_enum_attribute(collection_id: '[COLLECTION_ID]', key: '', elements: [], required: false)
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.create_float_attribute(collection_id: '[COLLECTION_ID]', key: '', required: false)
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.create_index(collection_id: '[COLLECTION_ID]', key: '', type: 'key', attributes: [])
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.create_integer_attribute(collection_id: '[COLLECTION_ID]', key: '', required: false)
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.create_ip_attribute(collection_id: '[COLLECTION_ID]', key: '', required: false)
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.create_string_attribute(collection_id: '[COLLECTION_ID]', key: '', size: 1, required: false)
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.create_url_attribute(collection_id: '[COLLECTION_ID]', key: '', required: false)
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.create(name: '[NAME]')
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.delete_attribute(collection_id: '[COLLECTION_ID]', key: '')
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.delete_collection(collection_id: '[COLLECTION_ID]')
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.delete_document(collection_id: '[COLLECTION_ID]', document_id: '[DOCUMENT_ID]')
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.delete_index(collection_id: '[COLLECTION_ID]', key: '')
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.delete()
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.get_attribute(collection_id: '[COLLECTION_ID]', key: '')
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.get_collection(collection_id: '[COLLECTION_ID]')
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.get_document(collection_id: '[COLLECTION_ID]', document_id: '[DOCUMENT_ID]')
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.get_index(collection_id: '[COLLECTION_ID]', key: '')
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.get()
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.list_attributes(collection_id: '[COLLECTION_ID]')
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.list_collections()
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.list_documents(collection_id: '[COLLECTION_ID]')
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.list_indexes(collection_id: '[COLLECTION_ID]')
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.list()
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.update_collection(collection_id: '[COLLECTION_ID]', name: '[NAME]', permission: 'document')
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.update_document(collection_id: '[COLLECTION_ID]', document_id: '[DOCUMENT_ID]')
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ client
|
||||
.set_project('5df5acd0d48c2') # Your project ID
|
||||
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
|
||||
|
||||
databases = Appwrite::Databases.new(client, '[DATABASE_ID]')
|
||||
databases = Appwrite::Databases.new(client, database_id:'[DATABASE_ID]')
|
||||
|
||||
response = databases.update(name: '[NAME]')
|
||||
|
||||
|
||||
@@ -9,6 +9,6 @@ client
|
||||
|
||||
functions = Appwrite::Functions.new(client)
|
||||
|
||||
response = functions.create_deployment(function_id: '[FUNCTION_ID]', entrypoint: '[ENTRYPOINT]', code: InputFile.fromPath('dir/file.png'), activate: false)
|
||||
response = functions.create_deployment(function_id: '[FUNCTION_ID]', entrypoint: '[ENTRYPOINT]', code: Appwrite::InputFile.from_path('dir/file.png'), activate: false)
|
||||
|
||||
puts response.inspect
|
||||
@@ -9,6 +9,6 @@ client
|
||||
|
||||
functions = Appwrite::Functions.new(client)
|
||||
|
||||
response = functions.create(function_id: '[FUNCTION_ID]', name: '[NAME]', execute: [], runtime: 'node-14.5')
|
||||
response = functions.create(function_id: '[FUNCTION_ID]', name: '[NAME]', execute: ["role:all"], runtime: 'node-14.5')
|
||||
|
||||
puts response.inspect
|
||||
@@ -9,6 +9,6 @@ client
|
||||
|
||||
functions = Appwrite::Functions.new(client)
|
||||
|
||||
response = functions.update(function_id: '[FUNCTION_ID]', name: '[NAME]', execute: [])
|
||||
response = functions.update(function_id: '[FUNCTION_ID]', name: '[NAME]', execute: ["role:all"])
|
||||
|
||||
puts response.inspect
|
||||
@@ -1,6 +1,7 @@
|
||||
require 'appwrite'
|
||||
|
||||
client = Appwrite::Client.new
|
||||
InputFile = Appwrite::InputFile
|
||||
|
||||
client
|
||||
.set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
|
||||
@@ -9,6 +10,6 @@ client
|
||||
|
||||
storage = Appwrite::Storage.new(client)
|
||||
|
||||
response = storage.create_file(bucket_id: '[BUCKET_ID]', file_id: '[FILE_ID]', file: InputFile.fromPath('dir/file.png'))
|
||||
response = storage.create_file(bucket_id: '[BUCKET_ID]', file_id: '[FILE_ID]', file: Appwrite::InputFile.from_path('dir/file.png'))
|
||||
|
||||
puts response.inspect
|
||||
Reference in New Issue
Block a user