update: docs.

This commit is contained in:
Darshan 2025-07-27 16:31:10 +05:30
parent 1ed45def9d
commit ba79c5d9df
102 changed files with 124 additions and 58 deletions

View file

@ -0,0 +1 @@
Create a boolean column.

View file

@ -0,0 +1 @@
Create a new Database.

View file

@ -0,0 +1 @@
Create a date time column according to the ISO 8601 standard.

View file

@ -0,0 +1 @@
Create an email column.

View file

@ -0,0 +1 @@
Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.

View file

@ -0,0 +1 @@
Create a float column. Optionally, minimum and maximum values can be provided.

View file

@ -0,0 +1,2 @@
Creates an index on the columns listed. Your index should include all the columns you will query in a single request.
Columns can be `key`, `fulltext`, and `unique`.

View file

@ -0,0 +1 @@
Create an integer column. Optionally, minimum and maximum values can be provided.

View file

@ -0,0 +1 @@
Create IP address column.

View file

@ -0,0 +1 @@
Create relationship column. [Learn more about relationship columns](https://appwrite.io/docs/databases-relationships#relationship-columns).

View file

@ -0,0 +1 @@
Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateTable) API or directly from your database console.

View file

@ -0,0 +1 @@
Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateTable) API or directly from your database console.

View file

@ -0,0 +1 @@
Create a string column.

View file

@ -0,0 +1 @@
Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateTable) API or directly from your database console.

View file

@ -0,0 +1 @@
Create a URL column.

View file

@ -0,0 +1 @@
Decrement a specific column of a row by a given value.

View file

@ -0,0 +1 @@
Deletes a column.

View file

@ -0,0 +1 @@
Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.

View file

@ -0,0 +1 @@
Delete an index.

View file

@ -0,0 +1 @@
Delete a row by its unique ID.

View file

@ -0,0 +1 @@
Bulk delete rows using queries, if no queries are passed then all rows are deleted.

View file

@ -0,0 +1 @@
Delete a table by its unique ID. Only users with write permissions have access to delete this resource.

View file

@ -0,0 +1 @@
Get column by ID.

View file

@ -0,0 +1 @@
Get usage metrics and statistics for a database. You can view the total number of tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.

View file

@ -0,0 +1 @@
Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.

View file

@ -0,0 +1 @@
Get index by ID.

View file

@ -0,0 +1 @@
Get the database activity logs list by its unique ID.

View file

@ -0,0 +1 @@
Get the row activity logs list by its unique ID.

View file

@ -0,0 +1 @@
Get a row by its unique ID. This endpoint response returns a JSON object with the row data.

View file

@ -0,0 +1 @@
Get the table activity logs list by its unique ID.

View file

@ -0,0 +1 @@
Get usage metrics and statistics for a table. Returning the total number of rows. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.

View file

@ -0,0 +1 @@
Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.

View file

@ -0,0 +1 @@
Increment a specific column of a row by a given value.

View file

@ -0,0 +1 @@
List columns in the table.

View file

@ -0,0 +1 @@
List usage metrics and statistics for all databases in the project. You can view the total number of databases, tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.

View file

@ -0,0 +1 @@
Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.

View file

@ -0,0 +1 @@
List indexes in the table.

View file

@ -0,0 +1 @@
Get a list of all the user's rows in a given table. You can use the query params to filter your results.

View file

@ -0,0 +1 @@
Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.

View file

@ -0,0 +1 @@
Update a boolean column. Changing the `default` value will not update already existing rows.

View file

@ -0,0 +1 @@
Update a database by its unique ID.

View file

@ -0,0 +1 @@
Update a date time column. Changing the `default` value will not update already existing rows.

View file

@ -0,0 +1 @@
Update an email column. Changing the `default` value will not update already existing rows.

View file

@ -0,0 +1 @@
Update an enum column. Changing the `default` value will not update already existing rows.

View file

@ -0,0 +1 @@
Update a float column. Changing the `default` value will not update already existing rows.

View file

@ -0,0 +1 @@
Update an integer column. Changing the `default` value will not update already existing rows.

View file

@ -0,0 +1 @@
Update an ip column. Changing the `default` value will not update already existing rows.

View file

@ -0,0 +1 @@
Update relationship column. [Learn more about relationship columns](https://appwrite.io/docs/databases-relationships#relationship-columns).

View file

@ -0,0 +1 @@
Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.

View file

@ -0,0 +1 @@
Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.

View file

@ -0,0 +1 @@
Update a string column. Changing the `default` value will not update already existing rows.

View file

@ -0,0 +1 @@
Update a table by its unique ID.

View file

@ -0,0 +1 @@
Update an url column. Changing the `default` value will not update already existing rows.

View file

@ -0,0 +1 @@
Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateTable) API or directly from your database console.

View file

@ -0,0 +1 @@
Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateTable) API or directly from your database console.

View file

@ -40,7 +40,7 @@ class Create extends BooleanCreate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/create-boolean-column.md',
description: '/docs/references/grids/create-boolean-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -42,7 +42,7 @@ class Update extends BooleanUpdate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/update-boolean-column.md',
description: '/docs/references/grids/update-boolean-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -42,7 +42,7 @@ class Create extends DatetimeCreate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/create-datetime-column.md',
description: '/docs/references/grids/create-datetime-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -44,7 +44,7 @@ class Update extends DatetimeUpdate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/update-datetime-column.md',
description: '/docs/references/grids/update-datetime-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -41,7 +41,7 @@ class Delete extends AttributesDelete
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/delete-column.md',
description: '/docs/references/grids/delete-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -41,7 +41,7 @@ class Create extends EmailCreate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/create-email-column.md',
description: '/docs/references/grids/create-email-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -43,7 +43,7 @@ class Update extends EmailUpdate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/update-email-column.md',
description: '/docs/references/grids/update-email-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -43,7 +43,7 @@ class Create extends EnumCreate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/create-enum-column.md',
description: '/docs/references/grids/create-enum-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -45,7 +45,7 @@ class Update extends EnumUpdate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/update-enum-column.md',
description: '/docs/references/grids/update-enum-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -41,7 +41,7 @@ class Create extends FloatCreate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/create-float-column.md',
description: '/docs/references/grids/create-float-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -43,7 +43,7 @@ class Update extends FloatUpdate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/update-float-column.md',
description: '/docs/references/grids/update-float-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -47,7 +47,7 @@ class Get extends AttributesGet
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/get-column.md',
description: '/docs/references/grids/get-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -41,7 +41,7 @@ class Create extends IPCreate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/create-ip-column.md',
description: '/docs/references/grids/create-ip-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -43,7 +43,7 @@ class Update extends IPUpdate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/update-ip-column.md',
description: '/docs/references/grids/update-ip-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -41,7 +41,7 @@ class Create extends IntegerCreate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/create-integer-column.md',
description: '/docs/references/grids/create-integer-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -43,7 +43,7 @@ class Update extends IntegerUpdate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/update-integer-column.md',
description: '/docs/references/grids/update-integer-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -42,7 +42,7 @@ class Create extends RelationshipCreate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/create-relationship-column.md',
description: '/docs/references/grids/create-relationship-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -42,7 +42,7 @@ class Update extends RelationshipUpdate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/update-relationship-column.md',
description: '/docs/references/grids/update-relationship-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -43,7 +43,7 @@ class Create extends StringCreate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/create-string-column.md',
description: '/docs/references/grids/create-string-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -45,7 +45,7 @@ class Update extends StringUpdate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/update-string-column.md',
description: '/docs/references/grids/update-string-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -41,7 +41,7 @@ class Create extends URLCreate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/create-url-column.md',
description: '/docs/references/grids/create-url-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -43,7 +43,7 @@ class Update extends URLUpdate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/update-url-column.md',
description: '/docs/references/grids/update-url-column.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -36,7 +36,7 @@ class XList extends AttributesXList
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/list-attributes.md',
description: '/docs/references/grids/list-attributes.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -43,7 +43,7 @@ class Create extends CollectionCreate
namespace: $this->getSdkNamespace(),
group: null,
name: self::getName(),
description: '/docs/references/databases/create-table.md',
description: '/docs/references/grids/create-table.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -39,7 +39,7 @@ class Delete extends CollectionDelete
namespace: $this->getSdkNamespace(),
group: null,
name: self::getName(),
description: '/docs/references/databases/delete-table.md',
description: '/docs/references/grids/delete-table.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -36,7 +36,7 @@ class Get extends CollectionGet
namespace: $this->getSdkNamespace(),
group: null,
name: self::getName(),
description: '/docs/references/databases/get-table.md',
description: '/docs/references/grids/get-table.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -45,7 +45,7 @@ class Create extends IndexCreate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: 'createIndex', // getName needs to be different from parent action to avoid conflict in path name
description: '/docs/references/databases/create-index.md',
description: '/docs/references/grids/create-index.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -44,7 +44,7 @@ class Delete extends IndexDelete
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: 'deleteIndex', // getName needs to be different from parent action to avoid conflict in path name
description: '/docs/references/databases/delete-index.md',
description: '/docs/references/grids/delete-index.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -37,7 +37,7 @@ class Get extends IndexGet
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: 'getIndex', // getName needs to be different from parent action to avoid conflict in path name
description: '/docs/references/databases/get-index.md',
description: '/docs/references/grids/get-index.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -37,7 +37,7 @@ class XList extends IndexXList
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: 'listIndexes', // getName needs to be different from parent action to avoid conflict in path name
description: '/docs/references/databases/list-indexes.md',
description: '/docs/references/grids/list-indexes.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -33,7 +33,7 @@ class XList extends CollectionLogXList
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/get-table-logs.md',
description: '/docs/references/grids/get-table-logs.md',
auth: [AuthType::ADMIN],
responses: [
new SDKResponse(

View file

@ -43,7 +43,7 @@ class Delete extends DocumentsDelete
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/delete-rows.md',
description: '/docs/references/grids/delete-rows.md',
auth: [AuthType::ADMIN, AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -44,7 +44,7 @@ class Update extends DocumentsUpdate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/update-rows.md',
description: '/docs/references/grids/update-rows.md',
auth: [AuthType::ADMIN, AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -44,7 +44,7 @@ class Upsert extends DocumentsUpsert
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/upsert-rows.md',
description: '/docs/references/grids/upsert-rows.md',
auth: [AuthType::ADMIN, AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -44,7 +44,7 @@ class Decrement extends DecrementDocumentAttribute
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/decrement-row-column.md',
description: '/docs/references/grids/decrement-row-column.md',
auth: [AuthType::ADMIN, AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -44,7 +44,7 @@ class Increment extends IncrementDocumentAttribute
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/increment-row-column.md',
description: '/docs/references/grids/increment-row-column.md',
auth: [AuthType::ADMIN, AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -53,7 +53,7 @@ class Create extends DocumentCreate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/create-row.md',
description: '/docs/references/grids/create-row.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
responses: [
new SDKResponse(
@ -74,7 +74,7 @@ class Create extends DocumentCreate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: $this->getBulkActionName(self::getName()),
description: '/docs/references/databases/create-rows.md',
description: '/docs/references/grids/create-rows.md',
auth: [AuthType::ADMIN, AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -48,7 +48,7 @@ class Delete extends DocumentDelete
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/delete-row.md',
description: '/docs/references/grids/delete-row.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
responses: [
new SDKResponse(

View file

@ -38,7 +38,7 @@ class Get extends DocumentGet
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/get-row.md',
description: '/docs/references/grids/get-row.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
responses: [
new SDKResponse(

View file

@ -33,7 +33,7 @@ class XList extends DocumentLogXList
namespace: $this->getSdkNamespace(),
group: 'logs',
name: self::getName(),
description: '/docs/references/databases/get-row-logs.md',
description: '/docs/references/grids/get-row-logs.md',
auth: [AuthType::ADMIN],
responses: [
new SDKResponse(

View file

@ -45,7 +45,7 @@ class Update extends DocumentUpdate
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/update-row.md',
description: '/docs/references/grids/update-row.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
responses: [
new SDKResponse(

View file

@ -46,7 +46,7 @@ class Upsert extends DocumentUpsert
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/upsert-row.md',
description: '/docs/references/grids/upsert-row.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
responses: [
new SDKResponse(

View file

@ -38,7 +38,7 @@ class XList extends DocumentXList
namespace: $this->getSdkNamespace(),
group: $this->getSdkGroup(),
name: self::getName(),
description: '/docs/references/databases/list-rows.md',
description: '/docs/references/grids/list-rows.md',
auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
responses: [
new SDKResponse(

View file

@ -42,7 +42,7 @@ class Update extends CollectionUpdate
namespace: $this->getSdkNamespace(),
group: null,
name: self::getName(),
description: '/docs/references/databases/update-table.md',
description: '/docs/references/grids/update-table.md',
auth: [AuthType::KEY],
responses: [
new SDKResponse(

View file

@ -37,7 +37,7 @@ class Get extends CollectionUsageGet
namespace: $this->getSdkNamespace(),
group: null,
name: self::getName(),
description: '/docs/references/databases/get-table-usage.md',
description: '/docs/references/grids/get-table-usage.md',
auth: [AuthType::ADMIN],
responses: [
new SDKResponse(

Some files were not shown because too many files have changed in this diff Show more