EdgeDB Release Candidate 3

First: upgrade the CLI​

As always, the first step is upgrading to the latest version of our CLI. If an older version is already installed, run edgedb cli upgrade to upgrade. Otherwise follow the instructions in the Quickstart to install it and spin up your first instance.

Identifying out-of-date instances​

To see a list of all local instances running on an older (non-portable) build of EdgeDB, run edgedb instance list --deprecated-install-methods. This list will include all previously-created instances running RC2 or earlier.

The upgrade flow differs slightly for project-linked and standalone instances.

Upgrading project-linked instances​

Upgrade project-linked instances with the following commands. Instead of a single edgedb {project|instance} upgrade command (as with previous releases), we are recommending “dump and restore” workflow that’s more explicit and less error prone. Future releases.

$ cd /path/to/project
$ edgedb dump --all --format=dir ./dump_dir
$ edgedb project unlink --destroy-server-instance
$ edgedb project upgrade --to-latest
$ edgedb project init --no-migrations
$ edgedb restore --all --admin ./dump_dir
$ edgedb instance reset-password <instance_name>

This process dumps the contents of the database, unlinks the project, destroys its associated instance, updates the edgedb.toml to reflect the latest version, initializes a new project/instance running RC3, restores from dump, and resets the instance password.

If you need to keep the same password, pass the --password flag to edgedb instance reset-password and enter the previous password at the prompt.

The --all flag instructs the CLI to dump the contents of all databases, not just the default database (called edgedb). The project should be re-initialized with the --no-migrations flag to prevent the CLI from auto-executing the migrations found in dbschema/migrations; edgedb restore can only be executed against a fresh, schema-less instance.

Note that no explicit edgedb server install command is required; the CLI will install RC3 on-demand during the edgedb project init flow.

Upgrading standalone instances​

For standalone (non-project-linked) instances, follow the following steps. The <name> is the name of the instance; to see a list of all local instances run edgedb instance list --deprecated-install-methods.

$ edgedb dump --all --format=dir -I <name> ./dump_dir
$ edgedb instance destroy <name>
$ edgedb instance create <name>
$ edgedb restore --all --admin -I <name> ./dump_dir
$ edgedb instance reset-password <name>

This process dumps the schema/contents of the instance, destroys it, creates a fresh instance running RC3, restores the instance from the dump, and resets the password to a new, generated value. If you need to keep the same password, pass the --password flag to edgedb instance reset-password and enter the previous password at the prompt.

An explicit edgedb server install command isn’t required here. Instead, the CLI will install the latest version of EdgeDB on-demand during the edgedb instance create command.

Uninstalling old versions​

Once all instances have been upgraded to RC3’s portable builds, you can uninstall the now-deprecated native packages.

$ edgedb server uninstall --all --deprecated-install-methods

This command will skip any installation that is still in use by an existing instance. You’ll need to destroy or upgrade those instances before uninstallation can occur.

Linux​

To construct portable builds for Linux, EdgeDB is compiled in a container running a stock CentOS 6 image (first released in 2011) containing glibc v2.17. The resulting build is audited to guarantee no recent or non-standard dependencies have been linked. Because glibc follows a strict backwards-compatible symbol versioning scheme, the resulting build will run in any environment containing glibc v2.17 or later.

macOS​

Similarly, macOS packages have been built against Apple’s implementation of C (a variant of BSD libc). This implementation also has strong backwards compatibility guarantees; using the mmacosx-version-min build flag, we can guarantee compatibility with OSX Yosemite and later.

For the moment, all builds are x86-based; a native ARM build is in the works. These can be run on M1 Macs with Rosetta emulation with minimal performance overhead.

Windows​

There’s no native build for Windows at the moment, though we plan to distrubute one in the future. Instead, we recommend running local instances using Docker and the official EdgeDB image.

Previously, running edgedb instance create in Windows used Docker behind the scenes to run the new instance; this “magical” behavior is no longer supported, as it was difficult to debug and configure. Instead, we suggest using your preferred Docker workflow (docker run, Docker Compose, etc) to spin up instances manually, then pass the appropriate connection information into your application via environment variables.