File tree 1 file changed +113
-0
lines changed
src/routes/docs/references/cloud/client-web/databases
1 file changed +113
-0
lines changed Original file line number Diff line number Diff line change
1
+ ---
2
+ title: 'Databases'
3
+ description: 'Appwrite Databases API Reference'
4
+ ---
5
+
6
+ # Databases
7
+
8
+ The Databases service allows you to create, read, update, and delete documents in your databases.
9
+
10
+ ## Request
11
+
12
+ {% tabs %}
13
+ {% tab label="Web" %}
14
+
15
+ ```typescript
16
+ import { Client, Databases } from 'appwrite';
17
+
18
+ const client = new Client()
19
+ .setEndpoint('https://cloud.appwrite.io/v1')
20
+ .setProject('YOUR_PROJECT_ID');
21
+
22
+ const databases = new Databases(client);
23
+ ```
24
+
25
+ {% /tab %}
26
+ {% /tabs %}
27
+
28
+ ## Learn More
29
+
30
+ - [Learn more about permissions](https://appwrite.io/docs/products/databases/permissions)
31
+ - [Learn more about queries](https://appwrite.io/docs/products/databases/queries)
32
+
33
+ ## Methods
34
+
35
+ ### Create Database
36
+
37
+ Create a new database.
38
+
39
+ {% tabs %}
40
+ {% tab label="Web" %}
41
+
42
+ ```typescript
43
+ const promise = databases.create(
44
+ '[DATABASE_ID]',
45
+ '[NAME]'
46
+ );
47
+ ```
48
+
49
+ {% /tab %}
50
+ {% /tabs %}
51
+
52
+ ### List Databases
53
+
54
+ Get a list of all databases.
55
+
56
+ {% tabs %}
57
+ {% tab label="Web" %}
58
+
59
+ ```typescript
60
+ const promise = databases.list();
61
+ ```
62
+
63
+ {% /tab %}
64
+ {% /tabs %}
65
+
66
+ ### Get Database
67
+
68
+ Get a database by its unique ID.
69
+
70
+ {% tabs %}
71
+ {% tab label="Web" %}
72
+
73
+ ```typescript
74
+ const promise = databases.get(
75
+ '[DATABASE_ID]'
76
+ );
77
+ ```
78
+
79
+ {% /tab %}
80
+ {% /tabs %}
81
+
82
+ ### Update Database
83
+
84
+ Update a database by its unique ID.
85
+
86
+ {% tabs %}
87
+ {% tab label="Web" %}
88
+
89
+ ```typescript
90
+ const promise = databases.update(
91
+ '[DATABASE_ID]',
92
+ '[NAME]'
93
+ );
94
+ ```
95
+
96
+ {% /tab %}
97
+ {% /tabs %}
98
+
99
+ ### Delete Database
100
+
101
+ Delete a database by its unique ID.
102
+
103
+ {% tabs %}
104
+ {% tab label="Web" %}
105
+
106
+ ```typescript
107
+ const promise = databases.delete(
108
+ '[DATABASE_ID]'
109
+ );
110
+ ```
111
+
112
+ {% /tab %}
113
+ {% /tabs %}
You can’t perform that action at this time.
0 commit comments