Skip to content
Install

Databases

Appwrite Database Management in VS Code

Overview

Section titled “Overview”

Appwrite is a backend-as-a-service platform whose data lives in TablesDB: databases containing tables, each with typed columns and rows, accessed through a REST API rather than SQL. DBCode connects directly to a project’s API so you can browse and edit that data alongside your other databases.

DBCode connects the same way to both project shapes:

  • Appwrite Cloud: managed projects at https://<region>.cloud.appwrite.io/v1
  • Self-hosted Appwrite: instances you run yourself, at your own endpoint’s /v1 path

Connecting

Section titled “Connecting”

To connect to Appwrite in DBCode:

  1. Open the DBCode extension and select Add Connection.
  2. Select Appwrite as the database type.
  3. Enter the Endpoint: https://<region>.cloud.appwrite.io/v1 for Appwrite Cloud, or your self-hosted instance’s address.
  4. Enter the Project ID, found in the Appwrite console under Project Settings.
  5. Enter an API Key with database scopes, found in the Appwrite console under Project Settings, then API Keys.
  6. Optionally, turn on Enable SSL/TLS to connect over HTTPS, even when the endpoint starts with http://, and to set how DBCode checks the server’s certificate: choose the Certificate Verification mode, add an SSL Server Certificate for a private or self-signed CA, and add an SSL Client Certificate and SSL Client Key when a proxy in front of Appwrite requires a client certificate.
  7. Save the connection and open it from the DB Explorer.

Without these settings, an https:// endpoint is encrypted and verified against your system’s trusted certificates, which suits Appwrite Cloud. Use them for a self-hosted instance behind a certificate your system does not trust, or behind a proxy that asks for a client certificate.

Each Appwrite database in the project appears as a database in DBCode, with its tables listed underneath.

Working with Appwrite

Section titled “Working with Appwrite”
  • Browse databases, tables, and rows in the DB Explorer.
  • Open a table to load its rows into the grid.
  • Insert, update, and delete rows, and edit cells inline.
  • Create and drop databases, and create, rename, and drop tables.
  • See each table’s indexes, and the relationship columns that reference a single row as foreign keys.
  • Connect read-only when you only need to look.

Every row carries $id and other Appwrite-managed fields alongside its own columns, and a table’s $id can differ from the display name shown in the DB Explorer.

For more information about Appwrite, check out Appwrite.