Skip to content
This repository was archived by the owner on Sep 29, 2023. It is now read-only.

Commit 9834085

Browse files
Merge branch '0.15.x' of https://github.com/appwrite/docs into feat-upgrade-web-syntax
2 parents b3cd345 + b81ffd0 commit 9834085

File tree

8 files changed

+307
-220
lines changed

8 files changed

+307
-220
lines changed

app/views/docs/command-line.phtml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -286,13 +286,13 @@ brew install --HEAD appwrite</code></pre>
286286
<p>To get a list of all your collections, you can use the `listCollections` command. To successfully view the list, make sure your API key is granted with the scope "collections.read".</p>
287287

288288
<div class="ide margin-bottom" data-lang="bash" data-lang-label="CLI">
289-
<pre class="line-numbers"><code class="prism language-bash" data-prism>appwrite database listCollections</code></pre>
289+
<pre class="line-numbers"><code class="prism language-bash" data-prism>appwrite databases listCollections</code></pre>
290290
</div>
291291

292292
<p>If you wish to parse the output from the CLI, you can request the CLI output in JSON format using the <span class="tag">--json</span> flag</p>
293293

294294
<div class="ide margin-bottom" data-lang="bash" data-lang-label="CLI">
295-
<pre class="line-numbers"><code class="prism language-bash" data-prism>appwrite database listCollections --json</code></pre>
295+
<pre class="line-numbers"><code class="prism language-bash" data-prism>appwrite databases listCollections --json</code></pre>
296296
</div>
297297
<!-- Attach image of output -->
298298

@@ -301,15 +301,15 @@ brew install --HEAD appwrite</code></pre>
301301
<p>To get more information on a particular collection, you can make use of the `getCollection` command and pass in the `collectionId`. To successfully fetch the collection, make sure your API key is granted with the scope "collections.read".</p>
302302

303303
<div class="ide margin-bottom" data-lang="bash" data-lang-label="CLI">
304-
<pre class="line-numbers"><code class="prism language-bash" data-prism>appwrite database getCollection --collectionId 5ff468cfa32a0</code></pre>
304+
<pre class="line-numbers"><code class="prism language-bash" data-prism>appwrite databases getCollection --collectionId 5ff468cfa32a0</code></pre>
305305
</div>
306306

307307
<p><b>Create Document</b></p>
308308

309309
<p>To create a new document in an existing collection, use the `createDocument` command.</p>
310310

311311
<div class="ide margin-bottom" data-lang="bash" data-lang-label="CLI">
312-
<pre class="line-numbers"><code class="prism language-bash" data-prism>appwrite database createDocument --collectionId <ID> --documentId 'unique()' --data '{ "Name": "Iron Man" }' --read role:all team:abc</code></pre>
312+
<pre class="line-numbers"><code class="prism language-bash" data-prism>appwrite databases createDocument --collectionId <ID> --documentId 'unique()' --data '{ "Name": "Iron Man" }' --read role:all team:abc</code></pre>
313313
</div>
314314

315315
<h3><a href="/docs/command-line#configuration" id="configuration">Configuration</a></h3>

app/views/docs/database.phtml renamed to app/views/docs/databases.phtml

Lines changed: 75 additions & 54 deletions
Large diffs are not rendered by default.

app/views/docs/functions.phtml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -688,7 +688,7 @@ class MainActivity : AppCompatActivity() {
688688

689689
<p>Appwrite provides multiple code runtimes to execute your custom functions. Each runtime uses a Docker image tied to a specific language version to provide a safe, isolated playground to run your team's code.</p>
690690

691-
<p>Below is a list of supported Cloud Functions runtimes. The Appwrite team continually adds support for new runtimes. You can easily change which runtimes your Appwrite setup supports by editing your server <a href="/docs/environment-variables#functions">environment variables</a>.</p>
691+
<p>Below is a list of supported Cloud Functions runtimes. The Appwrite team continually adds support for new runtimes.</p>
692692

693693
<table cellspacing="0" cellpadding="0" border="0" class="full margin-bottom-large">
694694
<thead>
@@ -711,6 +711,8 @@ class MainActivity : AppCompatActivity() {
711711
</tbody>
712712
</table>
713713

714+
<p>By default, the following runtimes are enabled: "node-16.0, php-8.0, python-3.9, ruby-3.0". To enable or disable runtimes, you can edit the <span class="tag">_APP_FUNCTIONS_RUNTIMES</span> <a href="/docs/functions#environmentVariables">environment variable</a>.</p>
715+
714716
<h2><a href="/docs/functions#environmentVariables" id="environmentVariables">Environment Variables</a></h2>
715717

716718
<p>Environment variables supplied by Appwrite in addition to your own defined environment variables that you can access from your function code. These variables give you information about your execution runtime environment.</p>
@@ -747,6 +749,12 @@ class MainActivity : AppCompatActivity() {
747749
</td>
748750
<td>Either 'event' when triggered by one of the selected scopes, 'http' when triggered by an HTTP request or the Appwrite Console, or 'schedule' when triggered by the cron schedule.</td>
749751
</tr>
752+
<tr>
753+
<td>
754+
_APP_FUNCTIONS_RUNTIMES
755+
</td>
756+
<td>Enables function runtimes. Pass a list of runtime names separated by a comma, for example "node-16.0,php-8.0,python-3.9,ruby-3.0".</td>
757+
</tr>
750758
<tr>
751759
<td>
752760
APPWRITE_FUNCTION_RUNTIME_NAME

app/views/docs/index.phtml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ $cols = [
5858
<li><a href="/docs/client/account<?php echo $this->escape($clientSDK); ?>">Account</a></li>
5959
<li><a href="/docs/server/users<?php echo $this->escape($serverSDK); ?>">Users</a></li>
6060
<li><a href="/docs/client/teams<?php echo $this->escape($clientSDK); ?>">Teams</a></li>
61-
<li><a href="/docs/client/database<?php echo $this->escape($clientSDK); ?>">Database</a></li>
61+
<li><a href="/docs/client/databases<?php echo $this->escape($clientSDK); ?>">Databases</a></li>
6262
<li><a href="/docs/client/storage<?php echo $this->escape($clientSDK); ?>">Storage</a></li>
6363
<li><a href="/docs/client/functions<?php echo $this->escape($serverSDK); ?>">Functions</a></li>
6464
<li><a href="/docs/client/locale<?php echo $this->escape($clientSDK); ?>">Localization</a></li>
@@ -72,7 +72,7 @@ $cols = [
7272

7373
<ul class="margin-bottom">
7474
<li><a href="/docs/realtime">Realtime</a></li>
75-
<li><a href="/docs/database">Database</a></li>
75+
<li><a href="/docs/databases">Databases</a></li>
7676
<li><a href="/docs/storage">Storage</a></li>
7777
<li><a href="/docs/functions">Functions</a></li>
7878
<li><a href="/docs/keys">API Keys</a></li>

app/views/docs/realtime.phtml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<?php
22
$channels = [
33
'account' => 'All account related events (session create, name update...)',
4-
'collections.[ID].documents' => 'Any create/update/delete events to any document in a collection',
4+
'databases.[ID].collections.[ID].documents' => 'Any create/update/delete events to any document in a collection',
55
'documents' => 'Any create/update/delete events to any document',
6-
'collections.[ID].documents.[ID]' => 'Any update/delete events to a given document',
6+
'databases.[ID].collections.[ID].documents.[ID]' => 'Any update/delete events to a given document',
77
'files' => 'Any create/update/delete events to any file',
88
'buckets.[ID].files.[ID]' => 'Any update/delete events to a given file of the given bucket',
99
'buckets.[ID].files' => 'Any update/delete events to any file of the given bucket',
@@ -190,7 +190,7 @@ realtime.subscribe(channel: "account", callback: { param in
190190
<h3><a href="/docs/realtime#subscribe-to-multiple-channels" id="subscribe-to-multiple-channels">Subscribe to Multiple Channels</a></h3>
191191

192192
<p>You can also listen to multiple <a href="/docs/realtime#channels">channels</a> at once by passing an array of channels. This will trigger the callback for any events for all channels passed.</p>
193-
<p>In this example we are listening to the document A and all files by subscribing to the <span class="tag">collections.A.documents.A</span> and <span class="tag">files</span> channels.</p>
193+
<p>In this example we are listening to the document A and all files by subscribing to the <span class="tag">databases.A.collections.A.documents.A</span> and <span class="tag">files</span> channels.</p>
194194

195195
<ul class="phases clear" data-ui-phases>
196196
<li>
@@ -215,7 +215,7 @@ client.subscribe(['collections.A.documents.A', 'files'], response => {
215215
<div class="ide margin-bottom" data-lang="dart" data-lang-label="Flutter SDK">
216216
<pre class="line-numbers"><code class="prism language-dart" data-prism>final client = Client();
217217
final realtime = Realtime(client);
218-
final subscription = realtime.subscribe(['collections.A.documents.A', 'files']);
218+
final subscription = realtime.subscribe(['databases.A.collections.A.documents.A', 'files']);
219219

220220
subscription.stream.listen((response) {
221221
// Callback will be executed on changes for documents A and all files.
@@ -229,7 +229,7 @@ subscription.stream.listen((response) {
229229
<pre class="line-numbers"><code class="prism language-kotlin" data-prism>val client = Client(context)
230230
val realtime = Realtime(client)
231231

232-
realtime.subscribe("collections.A.documents.A", "files", callback = { param ->
232+
realtime.subscribe("databases.A.collections.A.documents.A", "files", callback = { param ->
233233
// Callback will be executed on changes for documents A and all files.
234234
print(param.toString())
235235
})</code></pre>
@@ -241,7 +241,7 @@ realtime.subscribe("collections.A.documents.A", "files", callback = { param ->
241241
<pre class="line-numbers"><code class="prism language-swift" data-prism>let client = Client()
242242
let realtime = Realtime(client)
243243

244-
realtime.subscribe(channels: ["collections.A.documents.A", "files"], callback: { param in
244+
realtime.subscribe(channels: ["databases.A.collections.A.documents.A", "files"], callback: { param in
245245
// Callback will be executed on changes for documents A and all files.
246246
print(String(describing: param))
247247
})</code></pre>

app/views/docs/storage.phtml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
<h2><a href="/docs/storage#bucket" id="bucket">Buckets</a></h2>
55

6-
<p>With version 0.13 of Appwrite, we also have introduced storage buckets. Storage buckets are similar to collections we have in our <a href="/docs/database">Database</a> service. The difference is buckets also provide more power to decide what kinds of files, what sizes you want to allow in that bucket, whether or not to encrypt the files, scan with antivirus, and more. Let's look at how we can create a bucket and configure it to your needs.</p>
6+
<p>With version 0.13 of Appwrite, we also have introduced storage buckets. Storage buckets are similar to collections we have in our <a href="/docs/databases">Databases</a> service. The difference is buckets also provide more power to decide what kinds of files, what sizes you want to allow in that bucket, whether or not to encrypt the files, scan with antivirus, and more. Let's look at how we can create a bucket and configure it to your needs.</p>
77

88
<h3><a href="/docs/storage#createBucket" id="createBucket">Create Bucket</a></h3>
99

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"ext-imagick": "*",
1616
"ext-mbstring": "*",
1717
"ext-json": "*",
18-
18+
"erusev/parsedown": "1.7.4",
1919
"utopia-php/framework": "0.*.*"
2020
},
2121
"require-dev": {

0 commit comments

Comments
 (0)