Search
ctrl/
Ask AI
Light
Dark
System

EdgeDB Cloud

EdgeDB Cloud is a fully managed, effortless cloud database service, engineered to let you deploy your database instantly and connect from anywhere with near-zero configuration.

Connecting your app

Try a guide for connecting your app running on your platform of choice:

To connect your apps running on other platforms, generate a dedicated secret key for your instance with edgedb cloud secretkey create or via the web UI's “Secret Keys” pane in your instance dashboard. Create two environment variables accessible to your production application:

  • EDGEDB_SECRET_KEY - contains the secret key you generated
  • EDGEDB_INSTANCE - the name of your EdgeDB Cloud instance (<org-name>/<instance-name>)

Two ways to use EdgeDB Cloud

1. CLI

Log in to EdgeDB Cloud via the CLI:

Copy
$ 
edgedb cloud login

This will open a browser window and allow you to log in via GitHub. Now, create your EdgeDB Cloud instance the same way you would create a local instance:

Copy
$ 
edgedb instance create <org-name>/<instance-name>

or

Copy
$ 
  
edgedb project init \
--server-instance <org-name>/<instance-name>

2. GUI

Create your instance at cloud.edgedb.com by clicking on “Create new instance” in the “Instances” tab.

Complete the following form to configure your instance. You can access your instance via the CLI using the name <org-name>/<instance-name> or via the GUI.

Useful EdgeDB Cloud commands

Get REPL

Copy
$ 
  
edgedb \
-I <org-name>/<instance-name>

Run migrations

Copy
$ 
  
edgedb migrate \
-I <org-name>/<instance-name>

Update your instance

Copy
$ 
  
  
edgedb instance upgrade \
--to-version <target-version> \
-I <org-name>/<instance-name>

Manual full backup

Copy
$ 
  
  
  
edgedb dump \
--all --format dir \
-I <org-name>/<instance-name> \
<local-dump-path>

Full restore

Copy
$ 
  
  
  
edgedb restore \
--all \
-I <org-name>/<instance-name> \
<local-dump-path>

Restoring works only to an empty database.

Questions? Problems? Bugs?

  • Please join us on our Discord to ask questions.
  • If you're experiencing a service interruption, check our status page for information on what may be causing it.
  • Report any bugs you find by submitting a support ticket. Note: when using EdgeDB Cloud through the CLI, setting the RUST_LOG environment variable to info, debug, or trace may provide additional debugging information which will be useful to include with your ticket.