EdgeDB v4​

Upgrading​

Local and Cloud instances

To upgrade a local project, first ensure that your CLI is up to date with edgedb cli upgrade. Then run the following command inside the project directory.

$ 

edgedb project upgrade

Alternatively, specify an instance name if you aren’t using a project.

$ 

edgedb instance upgrade -I my_instance

The CLI will first check to see if your schema will migrate cleanly to EdgeDB 4.0. If the upgrade check finds any problems, it will report them back to you.

Hosted instances

To upgrade a remote (hosted) instance, we recommend the following dump-and-restore process.

1. EdgeDB v4.0 only supports PostgreSQL 14 (or above). So check the version of PostgreSQL you are using before upgrading EdgeDB. If you’re using Postgres 13 or below, you should upgrade Postgres first.

2. Spin up an empty 4.0 instance. You can use one of our deployment guides.

   Under Debian/Ubuntu, when adding the EdgeDB package repository, use this command instead:

   Copy

   $ 
     
     
     

   echo deb [signed-by=/usr/local/share/keyrings/edgedb-keyring.gpg] \
     https://packages.edgedb.com/apt \
     $(grep "VERSION_CODENAME=" /etc/os-release | cut -d= -f2) main \
     | sudo tee /etc/apt/sources.list.d/edgedb.list

   Use this command for installation under Debian/Ubuntu:

   Copy

   $ 

   sudo apt-get update && sudo apt-get install edgedb-4

   Under CentOS/RHEL, use this installation command:

   Copy

   $ 

   sudo yum install edgedb-4

   In any required systemctl commands, replace edgedb-server-3 with edgedb-server-4.

   Under any Docker setups, supply the 4.0 tag.

3. Take your application offline, then dump your v3.x database with the CLI

   Copy

   $ 

   edgedb dump --dsn <old dsn> --all --format dir my_database.dump/

   This will dump the schema and contents of your current database to a directory on your local disk called my_database.dump. The directory name isn’t important.

4. Restore the empty v4.x instance from the dump

   Copy

   $ 

   edgedb restore --all my_database.dump/ --dsn <new dsn>

   Once the restore is complete, update your application to connect to the new instance.

   This process will involve some downtime, specifically during steps 2 and 3.

New features​

type Item {
  required available: bool {
    default := false;
  };
  required name: str;
  required description: str;

  index fts::index on (
    fts::with_options(
      .name,
      language := fts::Language.eng
    )
  );
}

db> 

select fts::search(Item, 'candy corn', language := 'eng');

{
  (
    object := default::Item {id: 9da06b18-69b2-11ee-96b9-1bedbe75ad4f},
    score := 0.30396354,
  ),
  (
    object := default::Item {id: 92375624-69b2-11ee-96b9-675b9b87ac70},
    score := 0.6079271,
  ),
}

db> 
... 
... 
... 
... 

with res := (
  select fts::search(Item, 'candy corn', language := 'eng')
)
select res.object {name, score := res.score}
order by res.score desc;

{
  default::Item {name: 'Candy corn', score: 0.6079271},
  default::Item {name: 'Canned corn', score: 0.30396354},
}

type Item {
  required available: bool {
    default := false;
  };
  required name: str;
  required description: str;

  index fts::index on ((
    fts::with_options(
      .name,
      language := fts::Language.eng
    ),
    fts::with_options(
      .description,
      language := fts::Language.eng
    )
  ));
}

db> 
... 
... 
... 
... 

with res := (
  select fts::search(Item, 'trick or treat', language := 'eng')
)
select res.object {name, description, score := res.score}
order by res.score desc;

{
  default::Item {
    name: 'Candy corn',
    description: 'A great Halloween treat',
    score: 0.30396354,
  },
}

db> 

select multirange([range(8, 10)]) + range(1, 5) - range(3, 4);

{[range(1, 3), range(4, 5), range(8, 10)]}

GraphQL and HTTP authentication​

Starting in rc1, the EdgeQL over HTTP and GraphQL endpoints support (and by default require) authentication.

By default, HTTP Basic Authentication is used.

Full details are available in the EdgeQL over HTTP documentation.

This is a backwards-incompatible change. It is possible to opt-in to the old behavior, but not recommended.

Extensions​

using extension auth;

module default {
    global current_customer := (
        assert_single((
            select Customer
            filter .identity = global ext::auth::ClientTokenIdentity
        ))
    );

    type Customer {
        required text: str;
        required identity: ext::auth::Identity;
    }

    type Item {
        required sku: str;
        required description: str;
    }

    type Cart {
        required customer: Customer;
        multi items: Item {
            quantity: int32;
        };

        access policy customer_has_full_access
            allow all
            using (global current_customer ?= .customer);
    }
}

import { createClient } from "edgedb";

declare const tokenFromAuthServer: string;
const client = createClient()
  .withGlobals({
    "ext::auth::client_token": tokenFromAuthServer
  });

const carts = await client.query(`select Cart { * };`);

db> 

select ext::pgcrypto::digest('encrypt this', 'sha1');

{b'\x05\x82\xd8YLF\xe7\xd4\x12\x91\n\xdb$\xf1!v\xf9\xd4\x89\xc4'}

db> 

select ext::pgcrypto::gen_salt('md5');

{'$1$FjNlXgX7'}

db> 
... 
... 

with x := {'hello world', 'word hero', 'help the world'}
select res := (x, ext::pg_trgm::word_similarity(x, 'hello world'))
order by res.1 desc;

{('hello world', 1), ('help the world', 0.5), ('word hero', 0.35714287)}

Additional changes​

4.1​

• Fix dump and restore of auth config (#6414)

• Clear _config_cache in sys_pgcon before reloading reported config (#6427)

• Fix access policy type rewrites of std::Object (#6420)

• Fix an error message of affected refs (#6425)

• Fix DML with constraints on abstract types (#6421)

4.2​

• Fix schema delta for RESET EXPRESSION (#6463)

• Fix plain references to __old__ in rewrites (#6470)

• Fix std::range in singleton mode (#6475)

• Treat password reset as a verification event (#6504)

• Fixes to auth redirect urls (#6469)

• Fix SQL introspection of __fts_document__ (#6507)

• Type check mutation rewrites at migration time (#6466)

  Mutation rewrite’s using expression are now required to be of correct type when the rewrite is created. Up until now, it was possible to migrate to a schema that contained a rewrite rule that would always throw a type error when an object was being inserted or updated.

  This might be considered a breaking change, but as it is clearly a bug in user schema and as it could also be considered a bug in the compiler, we are fixing it in a minor version.

4.3​

• Fix non-rewritten tuple literals (#6521)

• Support connect_timeout in backend DSN (#6531)

• Fix coalesced DML in FOR loops over objects (#6526)

• Fix inserts silently failing when a json->array handles ‘null’ (#6544)

• Fix tracing of enums in type expressions (#6548)

• Fix dumps with FTS indexes (#6560)

• Allow indexes that use user-defined functions to actually get hit (#6551)

• Fix reloading readiness state and JWT *_list files in multi-tenant mode (#6562)

• Handle OPTIONS in the extension path which is needed for CORS preflight (#6577)

• Optimize the compiler and reduce time of an update test by ~52% (#6579)

• Always retry system connection on any BackendError (#6588)

• Properly support @source/@target on multi-link constraints (#6585)

• Fix constant extraction’s interaction with the new if-then-else (#6591)

• Fix migrating between aliased and non-aliased computeds (#6566)

• Improve error message for illegal casts and parameters. (#6511)

• Don’t eval ext::auth::ClientTokenIdentity on every row in a filter (#6607)

• Expose __type__ via SQL adapter (#6519)

• Fix some bugs involving union and coalescing of optional values (#6590)

• Avoid doing a join when injecting type ids (#6601)

• Generate better code for ?? with multi RHS or object type (#6532)

• Fix pgast nullability inference for subqueries and coalesce (#6529)

• Fix changing a pointer to be computed when there is a subtype (#6565)

4.4​

• Fix DML-containing FOR when the iterator is an object set with duplicates (#6609)

• Fix very slow global introspection query when there are lots of databases (#6633)

• Use correct signature for in-memory cache method (#6643)

4.5​

• Fix spurious delete/create of constraints with arguments in migrations (#6712)

• Speed up introspection of system objects like Database and Role (#6665)

• Fix some alter+rename combos on pointers in POPULATE MIGRATION (#6666)

• Fix issue with schema changes when trigger depends on a rewrite (#6706)

• Get verification data from request body (#6723)

• Make overloading a link when omitting link keyword work (#6718)

4.6​

• Fix issues with empty sets leaking out of optional scopes (#6747)

• Fix empty array literals in SQL adapter (#6806)

• Fix duration/memory config in config objects (#6827)

• Fix hanging backend pool with fast connect (#6813)

• Fix changing index expressions in migrations (#6843)

• Properly report errors involving newly created types (#6852)

• Make constraint error details contain useful information for developers (#6796)

• Fix DML coalesce inside of IF/ELSE (#6917)

• Allow trailing comma for GROUP’s BY clause (#7002)

• Fix computed single scalar globals (#6999)

• Fix query cache dbver issue with concurrent DDL (#6819)

• Several UI fixes

  • Update behaviour of datatable editor to save input by default on closing (edgedb/edgedb-ui/#325)

  • Store instance version with schema data, so schema is refreshed when instance is upgraded (edgedb/edgedb-ui/#333)

  • De-duplicate queries when navigating repl history with ctrl+up/down (edgedb/edgedb-ui/7916ee70)

  • Add max height to inline editor in dataview (edgedb/edgedb-ui/b2fedb72)

  • Always order id column first in dataview (edgedb/edgedb-ui/9a7c352e)

  • Improve rendering of long/multiline strings in dataview changes preview (edgedb/edgedb-ui/13511ebd)

  • Fix link props in visual query builder (edgedb/edgedb-ui/42492465)

  • And many more UI fixes

4.7​

• UI: revert a few changes that were meant for 5.x only.

• Revert “Compile single globals into materialized CTEs”, since it introduced multiple bugs. These bugs were already fixed in 5.x. (#6613)

• Add optional PKCE challenge in email verification (#7037)

• Fix very slow parsing performance of large files with unrecoverable errors (#7046)

• Fix update rewrites on types that are children of updated type (#7073)

4.8​

• Use SQL’s ON CONFLICT to implement UNLESS CONFLICT more often (#7472)

• Prevent dump hangups from leaving stray Postgres queries. (#7262)