EdgeDB v2 (Sagittarius)​

Upgrading​

Local instances

To upgrade a local project, run the following command inside the project directory.

$ 

edgedb project upgrade --to-latest

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

$ 

edgedb project upgrade --to-latest -I my_instance

Hosted instances

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

1. Spin up an empty 2.0 instance by following one of our deployment guides. These guides have been updated to 2.0. Keep the DSN of the newly created instance handy.

1. Take your application offline, then dump your v1.x database with the CLI

   Copy

   $ 

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

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

2. Restore the empty v2.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. We are working on an in-place upgrade workflow that will reduce the amount of downtime involved and avoid the need to spin up a new instance. We’ll publish that soon; join the Discord for updates. Though for most applications the dump-and-restore workflow will be simpler and less error-prone.

New features​

Integrated admin UI​

All v2 instances ship with a built-in rich admin GUI. Access it by running edgedb ui inside any EdgeDB project, or specify a local instance name with edgedb ui -I my_inst. The command opens the instance’s admin UI using the default system browser.

The current iteration of the GUI has

• a data browser and editor

• a REPL for writing and executing EdgeQL queries

• a schema introspection tool with text-based and graphical visualizations of the instance’s current schema

db> 

group Movie { title } by .release_year;

{
  {
    key: {release_year: 2017},
    grouping: {'release_year'},
    elements: {
      default::Movie {title: 'Guardians of the Galaxy Vol. 2'},
      default::Movie {title: 'Spider-Man: Homecoming'},
      default::Movie {title: 'Thor: Ragnarok'},
    },
  },
  {
    key: {release_year: 2013},
    grouping: {'release_year'},
    elements: {
      default::Movie {title: 'Iron Man 3'},
      default::Movie {title: 'Thor: The Dark World'},
    },
  },
  ...
}

global current_user -> uuid;

select User filter .id = global current_user;

import {createClient} from 'edgedb';

const client = createClient().withGlobals({
  current_user: '2141a5b4-5634-4ccc-b835-437863534c51',
});

await client.query(`select global current_user;`);

from edgedb import create_client

client = create_client().with_globals({
    'current_user': '580cc652-8ab8-4a20-8db9-4c79a4b1fd81'
})

result = client.query("""
    select global current_user;
""")

package main

import (
  "context"
  "fmt"
  "log"

  "github.com/edgedb/edgedb-go"
)

func main() {
  ctx := context.Background()
  client, err := edgedb.CreateClient(ctx, edgedb.Options{})
  if err != nil {
    log.Fatal(err)
  }
  defer client.Close()

  id, err := edgedb.ParseUUID("2141a5b4-5634-4ccc-b835-437863534c51")
  if err != nil {
    log.Fatal(err)
  }

  var result edgedb.UUID
  err = client.
    WithGlobals(map[string]interface{}{"current_user": id}).
    QuerySingle(ctx, "SELECT global current_user;", &result)
  if err != nil {
    log.Fatal(err)
  }

  fmt.Println(result)
}

global current_user -> uuid;

type User {
  required property email -> str { constraint exclusive; };
}

type BlogPost {
  required property title -> str;
  link author -> User;
  access policy own_posts allow all using (
    .author.id ?= global current_user
  )
}

db> 

select range(1, 10);

{range(1, 10, inc_lower := true, inc_upper := false)}

db> 

select range_unpack(range(1, 10))

{1, 2, 3, 4, 5, 6, 7, 8, 9}

db> select <cal::local_date>'2022-06-25' +
...   <cal::date_duration>'5 days';
{<cal::local_date>'2022-06-30'}
db> select <cal::local_date>'2022-06-30' -
...   <cal::local_date>'2022-06-25';
{<cal::date_duration>'P5D'}

type BlogPost {
  property title -> str;
}

type Person {
  multi link posts -> BlogPost {
    on source delete delete target;
  }
}

type Person {
  multi link posts -> BlogPost {
    on source delete delete target;
    on source delete delete target if orphan;
  }
}

Additional changes​

2.1​

• Fix global defaults with nontrivial computation (#4182)

• Fix migration that removes policy using clause (#4183)

• Support ELSE-less UNLESS CONFLICT on explicit id INSERT (#4185)

• Don’t create constraints on derived views when adding a pointer to a type (#4187)

• Fix a bunch of missing source contexts in declarative (#4188)

• Fix an ISE when a computed link is directly a property reference (#4193)

• Fix an ISE when using an empty shape in some contexts (#4194)

• Fix a number of error messages involving collection types in schemas (#4195)

• Avoid doing semi-joins after a sequence of single links (#4196)

• Make range() properly strict in its non-optional arguments (#4207)

• Allow multiple FDs per socket in activation (#4189)

• Add SCRAM authentication over HTTP (#4197)

• Always arm auto-shutdown timer when it’s greater than zero (#4214)

• Fix json -> array<json> cast of ‘[]’ (#4217)

2.2​

• Support UNLESS CONFLICT ON for pointers with DML in them (#4357)

• Fix cardinality in CommandDataDescription (#4347)

• Prevent access rule hidden ids from leaking when accessed directly (#4339)

• Better messages for required links hidden by policies (#4338)

• Fix access policies on DELETE of a UNION type (#4337)

• Strip out all views from DML subjects when computing what tables to use (#4336, #4333)

• Fix interaction between access policies and omitted fields in insert (#4332, #4219)

• Fix a tracer issue with reverse links and IS (#4331)

• Don’t include union types in link triggers (#4329, #4320)

  If you encounter this issue, after upgrading to a version with this patch, it can be fixed by doing a dump/restore or by adding a new link to the affected type.

• Require ON for constraints on objects (#4324, #4268)

• Fix interaction between DETACHED and aliases/globals (#4321, #4258)

• Disable access policy rewrite when compiling constraints (#4248, #4245)

• Expose --admin-ui as an environment variable and document it (#4255)

• Prevent HttpProtocol.close from crashing on closed client connection (#4238)

• Fix permitted JSON null in nested array cast (#4221)

• Fix range_unpack boundary bug.

  The range_unpack function was incorrectly excluding values close to boundary, especially when the boundary was not itself inclusive. (#4282)

• UI: Allow selection of read-only properties in data editor (edgedb/edgedb-ui/#65)

• UI: Hide subtype columns in data editor by default; add a toggle to show them. (edgedb/edgedb-ui/#43)

• UI: Add “create example database” to the database selection screen. (edgedb/edgedb-ui/#61)

• UI: Fix navigation from being reset on switching the UI panes. (edgedb/edgedb-ui/#61)

• UI: Fix rendering of range types. (edgedb/edgedb-ui/#61)

• UI: Fix the data editor UI to render types that have some properties or links masked by an access policy. (edgedb/edgedb-ui/#61)

• UI: Implement login page for remote instances. (edgedb/edgedb-ui/#40)

2.3​

• Clarify error message when UI is not enabled (#4256)

• Fix an issue with inherited computeds (#4371)

• Fix bug in diamond pattern constraint inheritance (#4379)

• When finding common parent for arrays, never use expr alias arrays (#4080)

• Properly quote numeric names when in codegen (#4344)

• Fix computed global scoping behavior (#4388)

• Fix DDL performance issues on databases with lots of data (#4401)

• Fix potentially missed constraints on DML (#4410)

• Fix slicing with an empty set (#4404)

• Fix slicing array of tuples (#4391)

• Don’t apply access policies when compiling indexes (#4420)

• Fix slicing of tuple arrays with null inputs (#4421)

• Propagate database creation and deletion events to adjacent servers (#4415)

2.4​

• Fix database initialization on hosted environments like Heroku. (#4432)

• Prevent spurious errors when using backlinks on types that have properties with the same name but different types (#4443)

• Fix some spurious errors when removing a link from the schema. (#4451)

• For query_single, only check that the last query in a script is single. (#4453)

• Catch when POPULATE MIGRATION generates incorrect DDL. This should prevent bugs where the schema can get into wedged states. (#4484)

• workflows: Publish multiarch Docker images (#4486)

• Make unused param insertion in the sql compiler more reliable (#4497)

• Properly propagate creation and deletion of extensions

• Fix potential exclusive constraint violations when doing an UPDATE on a union (#4507)

• Don’t lose type from inheritance views when rebasing (#4509)

• Make object type descriptor ids be derived from type name (#4503)

• Check for invalid arrays arguments at the protocol level (#4511)

• Fix SET REQUIRED on newly created properties with alias subtypes (#4513)

• Make newly created link properties get added to the relevant alias types (#4512)

• Fix handling of link properties named id (#4514)

• Disallow queries using conflict machinery on a link property. This prevents certain potential exclusive constraint violations that were not handled correctly. (#4515)

• Fix performing multiple deletions at once in the UI (#4523)

• Fix casting empty sets to built in enum types (#4532)

• Produce better error messages when using enum incorrectly (#4527)

• Make '\b' produce the correct value in string and bytes literals (#4535)

2.5​

• Properly infer cardinality of empty array as ONE (#4533)

• Fix several issues that manifest when using GROUP BY (#4549, #4439)

• Fix migration scripts when combined with access policies (#4553)

• Fix failure when a ALTER ... EXTENDING doesn’t change the set of ancestors (#4554)

• Fix UNLESS CONFLICT ON for a not-inserted property (#4556)

• Fix access policies that use shapes internally (#4555)

• Allow overloading __type__ with a computed in shapes (#4557)

2.6​

2.7​

• Improve error messages when compiling pointer default (#4624)

• Fix using WITH-bound DML from an UPDATE in an ELSE clause (#4641)

• Allow WITH MODULE in ddl in CREATE MIGRATION (#4668)

• Fix some broken casts from object types to JSON (#4663)

• Fix putting a statement as the body of an access policy (#4667)

• Loosen the rules on when we produce a “would change the interpretation” error. It is not only produced when a link is being used, not a property. (#4643)

• Fix certain errors involving default values in access policies (#4679)

• Avoid ISE when pickling DynamicRangeVar (#4681)

• Fix max_ex_value constraint. (#4671)

• Fix SET GLOBAL capabilities to no longer break in the CLI. (#4688)

• Fix links to schema::ObjectType breaking DROP TYPE. If you have a link in your schema to schema::ObjectType or one of its ancestors and you encounter internal server errors when trying to drop a type, it should be possible to repair your database by creating and then deleting a new link to schema::ObjectType. (#4670)

• Don’t insert unnecessary assert_exists calls on required links inside access policies bodies in some cases. (#4695)

2.8​

• Fix DML access policies that use shapes internally (#4589)

• Give a proper error message creating a migration with a USING that has DML (#4707)

• Don’t incorrectly evaluate DML access policies when elements are also DML. This fixes some cases in which policies would pass incorrectly. (#4745)

• Fix direct use of __subject__ from insert access policies (#4752)

• Produce an error message on casts to and literal references of enum types from indexes and constraints. Currently we generate an internal server error. A real fix unfortunately must wait for 3.0 for technical reasons. (#4754)

• Only apply filter cardinality inference to unique sets (#4763)

• Fix changing a link to non-computed and single at the same time (#4764)

• Fix error message for function calls on derived types (#4757)

• Fix deleting certain complex aliases (#4777)

• Fix link properties on inherited backlinks (#4788)

• Fix using array/string/bytes/json subscripting inside of indexes and constraints. (#4760)

• Fix apparent startup hangs due to a lock fd leaking into postgres (#4797)

• Fix some migrations with tricky constraint/computed interactions (#4794)

2.9​

• Fix broken DROPs of pointers in some multiple-inheritance situations (#4809)

• Properly execute function calls in UPDATE once per object (#4810)

• Fix accessing tuple elements on link properties (#4811)

• Fix assert_exists() not firing on some tuple values (#4812)

• Fix GROUP on the result of enumerate (#4813)

• Support more env vars in args.py, standardize docs (#4387)

• Fix computed properties that just copy id (#4807)

• Fix backlinks on derived union types (#4818)

• Fix references to the enclosing type in schema-defined computeds (#4826)

• UI: Fix regression introduced in 2.8 when editing empty string fields in data explorer

• UI: Improvements to handling of union link targets in schema and data explorer views

• UI: Fix loading indicators on tabs

2.10​

• Fix mismatch in session state after a ROLLBACK

• Fix ISE when doing set default on an abstract pointer (#4843)

• Fix accesses to __type__ from insert access policies (#4865)

• Properly forbid aggregation in index expressions (#4869)

• Fix grouping field when grouping by one key or nothing (#4906)

• Fix two issues with mutation in free objects (#4902)

• Only allow type names as the subject of an insert. (Previously dotted paths were allowed, with nonsensical behavior.) (#4922)

• Fix array arguments in HTTP interface (#4956)

• Support multi properties in UNLESS CONFLICT ON (#4955)

• Fix polymorphic type tests on result of update (#4954)

• Optimize trivial WITH -bound GROUP uses (#4978)

• Fix a category of confusing scoping related bugs in access policies (#4994)

• Get rid of the “unused alias definition” error. (#4819)

• Support mutation in USING expressions when changing a link to required or to single during a migration (#4873)

• Fix custom function calls on the HTTP interface (#4998)

• Avoid infinite recursion in some do-nothing intersection cases (#5007)

• Don’t mangle cast error messages when the cast value contains a type name (#5008)

• Allow JWT token auth in binary protocol (#4830)

• Use prepared statement cache in EdgeQL script execution (#4931)

• Fix non-transactional commands like DROP DATABASE when using Postgres 14.7 (#5026)

• Update packaged Postgres to 14.7

• Fix set single on required properties (#5031)

• Fix a ISE when using assert_exists and linkprops using query builder (#4961)

2.11​

• Fix adding a link property with a default value to an existing link (a regression in 2.10) (#5061)

2.12​

• Fix GROUP regression with some query-builder queries (a regression in 2.10) (#5073)

2.13​

• Implement a MIGRATION REWRITE system. This provides a mechanism for safely rewriting the migration history of a database while ensuring that the new history produces the same result as the old history. CLI tooling to take advantage of this feature is coming soon. (#4585)

• Fix DigitalOcean support: allow its custom error in bootstrap (#5139)

• Add a hint to the error message about link targets. (#5131)

• Infer cardinality of required multi pointers as AT_LEAST_ONE (#5180)

• Fix dump/restore of migrations with messages on them (#5171)

• Fix interaction of link properties and assert_exists and similar (#5182)

• Make assert_single and similar not lose track of values updated in an UPDATE in their argument. (#5088)

• Add a test for assert_exists+assert_single+UPDATE (#5242)

• Add support for new JWT layout (#5197)

• Fix uses of volatile expressions in update write access policies (#5256)

• Allow globals to be used in defaults (#5268)

• Fix errmessage interpolation to not produce an internal server error on braces in a message. Allow {{ and }} to be used to escape braces. (#5295)

2.14​

2.15​

• In multi-server instances, properly reload schema after a restore (#5463)

• Fix several bugs synchronizing configuration state

• Fix dropping a pointer’s constraint and making it computed at the same time (#5411)

• Don’t claim that making a pointer computed is data-safe (#5412)

• Prohibit NUL character in query source (#5414)

• Fix migration that delete an link alias computed in a parent and child (#5428)

• Fix GraphQL updates for multi links. (#4260)

• Fix altering enum that is used in a tuple (#5445)

• Fix changing cardinality of properties on types used in unions (#5457)

• Enable GraphQL support for type unions.

• Fix making pointer non-computed and giving it an abstract base at the same time (#5458)

• Make json casts of object arrays not include extra fields (#5484)

• Make coalesce infer a union type (#5472)

2.16​

• Fix ISEs involving single link with only computed link properties (#5499)

• Don’t ISE on free shape in insert (#5438)

• Always set cardinality of derived __tname__ properties (#5508)

• Work around mysterious postgres crashes on Digital Ocean (#5505)

• Make reestablishing system postgres connections more resilient (#5511)

• Fix graphql queries made against a freshly started server (#5456)

• Support dumping databases with std::duration config vals (#5528)

• Fix ISE for TypeExprs in function returns (#5540)

• Support comparisons on durations in static eval

• Fix create database conflicts with name in schema (#5515)

• Fix range and bytes output in json-lines/json-pretty mode (#5572)

• Include source locations in more scoping error messages (#5573)

• Fix an optional scoping bug with important access policy implications (#5575)