Skip to content

Commit 986a604

Browse files
ChiragAgg5kChiragAgg5k
committed
update changelog etc
1 parent fee8e6c commit 986a604

23 files changed

Lines changed: 1734 additions & 0 deletions

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
## 20.0.0
44

55
* Add array-based enum parameters (e.g., `permissions: array<BrowserPermission>`).
6+
* Breaking change: `Output` enum has been removed; use `ImageFormat` instead.
7+
* Add `getQueueAudits` support to `Health` service.
68

79
## 19.1.0
810

‎docs/databases.md‎

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -560,6 +560,82 @@ PATCH https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectio
560560
| newKey | string | New attribute key. | |
561561

562562

563+
```http request
564+
POST https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectionId}/attributes/longtext
565+
```
566+
567+
** Create a longtext attribute.
568+
**
569+
570+
### Parameters
571+
572+
| Field Name | Type | Description | Default |
573+
| --- | --- | --- | --- |
574+
| databaseId | string | **Required** Database ID. | |
575+
| collectionId | string | **Required** Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). | |
576+
| key | string | Attribute Key. | |
577+
| required | boolean | Is attribute required? | |
578+
| default | string | Default value for attribute when not provided. Cannot be set when attribute is required. | |
579+
| array | boolean | Is attribute an array? | |
580+
581+
582+
```http request
583+
PATCH https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectionId}/attributes/longtext/{key}
584+
```
585+
586+
** Update a longtext attribute. Changing the `default` value will not update already existing documents.
587+
**
588+
589+
### Parameters
590+
591+
| Field Name | Type | Description | Default |
592+
| --- | --- | --- | --- |
593+
| databaseId | string | **Required** Database ID. | |
594+
| collectionId | string | **Required** Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). | |
595+
| key | string | **Required** Attribute Key. | |
596+
| required | boolean | Is attribute required? | |
597+
| default | string | Default value for attribute when not provided. Cannot be set when attribute is required. | |
598+
| newKey | string | New Attribute Key. | |
599+
600+
601+
```http request
602+
POST https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectionId}/attributes/mediumtext
603+
```
604+
605+
** Create a mediumtext attribute.
606+
**
607+
608+
### Parameters
609+
610+
| Field Name | Type | Description | Default |
611+
| --- | --- | --- | --- |
612+
| databaseId | string | **Required** Database ID. | |
613+
| collectionId | string | **Required** Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). | |
614+
| key | string | Attribute Key. | |
615+
| required | boolean | Is attribute required? | |
616+
| default | string | Default value for attribute when not provided. Cannot be set when attribute is required. | |
617+
| array | boolean | Is attribute an array? | |
618+
619+
620+
```http request
621+
PATCH https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectionId}/attributes/mediumtext/{key}
622+
```
623+
624+
** Update a mediumtext attribute. Changing the `default` value will not update already existing documents.
625+
**
626+
627+
### Parameters
628+
629+
| Field Name | Type | Description | Default |
630+
| --- | --- | --- | --- |
631+
| databaseId | string | **Required** Database ID. | |
632+
| collectionId | string | **Required** Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). | |
633+
| key | string | **Required** Attribute Key. | |
634+
| required | boolean | Is attribute required? | |
635+
| default | string | Default value for attribute when not provided. Cannot be set when attribute is required. | |
636+
| newKey | string | New Attribute Key. | |
637+
638+
563639
```http request
564640
POST https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectionId}/attributes/point
565641
```
@@ -692,6 +768,44 @@ PATCH https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectio
692768
| newKey | string | New Attribute Key. | |
693769

694770

771+
```http request
772+
POST https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectionId}/attributes/text
773+
```
774+
775+
** Create a text attribute.
776+
**
777+
778+
### Parameters
779+
780+
| Field Name | Type | Description | Default |
781+
| --- | --- | --- | --- |
782+
| databaseId | string | **Required** Database ID. | |
783+
| collectionId | string | **Required** Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). | |
784+
| key | string | Attribute Key. | |
785+
| required | boolean | Is attribute required? | |
786+
| default | string | Default value for attribute when not provided. Cannot be set when attribute is required. | |
787+
| array | boolean | Is attribute an array? | |
788+
789+
790+
```http request
791+
PATCH https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectionId}/attributes/text/{key}
792+
```
793+
794+
** Update a text attribute. Changing the `default` value will not update already existing documents.
795+
**
796+
797+
### Parameters
798+
799+
| Field Name | Type | Description | Default |
800+
| --- | --- | --- | --- |
801+
| databaseId | string | **Required** Database ID. | |
802+
| collectionId | string | **Required** Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). | |
803+
| key | string | **Required** Attribute Key. | |
804+
| required | boolean | Is attribute required? | |
805+
| default | string | Default value for attribute when not provided. Cannot be set when attribute is required. | |
806+
| newKey | string | New Attribute Key. | |
807+
808+
695809
```http request
696810
POST https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectionId}/attributes/url
697811
```
@@ -730,6 +844,46 @@ PATCH https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectio
730844
| newKey | string | New Attribute Key. | |
731845

732846

847+
```http request
848+
POST https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectionId}/attributes/varchar
849+
```
850+
851+
** Create a varchar attribute.
852+
**
853+
854+
### Parameters
855+
856+
| Field Name | Type | Description | Default |
857+
| --- | --- | --- | --- |
858+
| databaseId | string | **Required** Database ID. | |
859+
| collectionId | string | **Required** Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). | |
860+
| key | string | Attribute Key. | |
861+
| size | integer | Attribute size for varchar attributes, in number of characters. Maximum size is 16381. | |
862+
| required | boolean | Is attribute required? | |
863+
| default | string | Default value for attribute when not provided. Cannot be set when attribute is required. | |
864+
| array | boolean | Is attribute an array? | |
865+
866+
867+
```http request
868+
PATCH https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectionId}/attributes/varchar/{key}
869+
```
870+
871+
** Update a varchar attribute. Changing the `default` value will not update already existing documents.
872+
**
873+
874+
### Parameters
875+
876+
| Field Name | Type | Description | Default |
877+
| --- | --- | --- | --- |
878+
| databaseId | string | **Required** Database ID. | |
879+
| collectionId | string | **Required** Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). | |
880+
| key | string | **Required** Attribute Key. | |
881+
| required | boolean | Is attribute required? | |
882+
| default | string | Default value for attribute when not provided. Cannot be set when attribute is required. | |
883+
| size | integer | Maximum size of the varchar attribute. | |
884+
| newKey | string | New Attribute Key. | |
885+
886+
733887
```http request
734888
GET https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectionId}/attributes/{key}
735889
```

‎docs/examples/databases/create-longtext-attribute.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<?php
2+
3+
use Appwrite\Client;
4+
use Appwrite\Services\Databases;
5+
6+
$client = (new Client())
7+
->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
8+
->setProject('<YOUR_PROJECT_ID>') // Your project ID
9+
->setKey('<YOUR_API_KEY>'); // Your secret API key
10+
11+
$databases = new Databases($client);
12+
13+
$result = $databases->createLongtextAttribute(
14+
databaseId: '<DATABASE_ID>',
15+
collectionId: '<COLLECTION_ID>',
16+
key: '',
17+
required: false,
18+
default: '<DEFAULT>', // optional
19+
array: false // optional
20+
);

‎docs/examples/databases/create-mediumtext-attribute.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<?php
2+
3+
use Appwrite\Client;
4+
use Appwrite\Services\Databases;
5+
6+
$client = (new Client())
7+
->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
8+
->setProject('<YOUR_PROJECT_ID>') // Your project ID
9+
->setKey('<YOUR_API_KEY>'); // Your secret API key
10+
11+
$databases = new Databases($client);
12+
13+
$result = $databases->createMediumtextAttribute(
14+
databaseId: '<DATABASE_ID>',
15+
collectionId: '<COLLECTION_ID>',
16+
key: '',
17+
required: false,
18+
default: '<DEFAULT>', // optional
19+
array: false // optional
20+
);

‎docs/examples/databases/create-text-attribute.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<?php
2+
3+
use Appwrite\Client;
4+
use Appwrite\Services\Databases;
5+
6+
$client = (new Client())
7+
->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
8+
->setProject('<YOUR_PROJECT_ID>') // Your project ID
9+
->setKey('<YOUR_API_KEY>'); // Your secret API key
10+
11+
$databases = new Databases($client);
12+
13+
$result = $databases->createTextAttribute(
14+
databaseId: '<DATABASE_ID>',
15+
collectionId: '<COLLECTION_ID>',
16+
key: '',
17+
required: false,
18+
default: '<DEFAULT>', // optional
19+
array: false // optional
20+
);

‎docs/examples/databases/create-varchar-attribute.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<?php
2+
3+
use Appwrite\Client;
4+
use Appwrite\Services\Databases;
5+
6+
$client = (new Client())
7+
->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
8+
->setProject('<YOUR_PROJECT_ID>') // Your project ID
9+
->setKey('<YOUR_API_KEY>'); // Your secret API key
10+
11+
$databases = new Databases($client);
12+
13+
$result = $databases->createVarcharAttribute(
14+
databaseId: '<DATABASE_ID>',
15+
collectionId: '<COLLECTION_ID>',
16+
key: '',
17+
size: 1,
18+
required: false,
19+
default: '<DEFAULT>', // optional
20+
array: false // optional
21+
);

‎docs/examples/databases/update-longtext-attribute.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<?php
2+
3+
use Appwrite\Client;
4+
use Appwrite\Services\Databases;
5+
6+
$client = (new Client())
7+
->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
8+
->setProject('<YOUR_PROJECT_ID>') // Your project ID
9+
->setKey('<YOUR_API_KEY>'); // Your secret API key
10+
11+
$databases = new Databases($client);
12+
13+
$result = $databases->updateLongtextAttribute(
14+
databaseId: '<DATABASE_ID>',
15+
collectionId: '<COLLECTION_ID>',
16+
key: '',
17+
required: false,
18+
default: '<DEFAULT>',
19+
newKey: '' // optional
20+
);

‎docs/examples/databases/update-mediumtext-attribute.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<?php
2+
3+
use Appwrite\Client;
4+
use Appwrite\Services\Databases;
5+
6+
$client = (new Client())
7+
->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
8+
->setProject('<YOUR_PROJECT_ID>') // Your project ID
9+
->setKey('<YOUR_API_KEY>'); // Your secret API key
10+
11+
$databases = new Databases($client);
12+
13+
$result = $databases->updateMediumtextAttribute(
14+
databaseId: '<DATABASE_ID>',
15+
collectionId: '<COLLECTION_ID>',
16+
key: '',
17+
required: false,
18+
default: '<DEFAULT>',
19+
newKey: '' // optional
20+
);

‎docs/examples/databases/update-text-attribute.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<?php
2+
3+
use Appwrite\Client;
4+
use Appwrite\Services\Databases;
5+
6+
$client = (new Client())
7+
->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
8+
->setProject('<YOUR_PROJECT_ID>') // Your project ID
9+
->setKey('<YOUR_API_KEY>'); // Your secret API key
10+
11+
$databases = new Databases($client);
12+
13+
$result = $databases->updateTextAttribute(
14+
databaseId: '<DATABASE_ID>',
15+
collectionId: '<COLLECTION_ID>',
16+
key: '',
17+
required: false,
18+
default: '<DEFAULT>',
19+
newKey: '' // optional
20+
);

‎docs/examples/databases/update-varchar-attribute.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<?php
2+
3+
use Appwrite\Client;
4+
use Appwrite\Services\Databases;
5+
6+
$client = (new Client())
7+
->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
8+
->setProject('<YOUR_PROJECT_ID>') // Your project ID
9+
->setKey('<YOUR_API_KEY>'); // Your secret API key
10+
11+
$databases = new Databases($client);
12+
13+
$result = $databases->updateVarcharAttribute(
14+
databaseId: '<DATABASE_ID>',
15+
collectionId: '<COLLECTION_ID>',
16+
key: '',
17+
required: false,
18+
default: '<DEFAULT>',
19+
size: 1, // optional
20+
newKey: '' // optional
21+
);

0 commit comments

Comments
 (0)