Extensions​

Built-in extensions​

There are a few built-in extensions available:

• edgeql_http: enables EdgeQL over HTTP,

• graphql: enables GraphQL,

• auth: enables EdgeDB Auth,

• ai: enables ext::ai module,

• pg_trgm: enables ext::pg_trgm, which re-exports pgtrgm,

• pg_unaccent: enables ext::pg_unaccent, which re-exports unaccent,

• pgcrypto: enables ext::pgcrypto, which re-exports pgcrypto,

• pgvector: enables ext::pgvector, which re-exports pgvector,

To enable these extensions, add a using statement at the top level of your schema:

using extension auth;

Standalone extensions​

Additionally, standalone extension packages can be installed via the CLI.

List installed extensions:

$ 

edgedb extension list -I my_instance

┌─────────┬─────────┐
│ Name    │ Version │
└─────────┴─────────┘

List available extensions:

$ 

edgedb extension list-available -I my_instance

┌─────────┬───────────────┐
│ Name    │ Version       │
│ postgis │ 3.4.3+6b82d77 │
└─────────┴───────────────┘

Install the postgis extension:

$ 

edgedb extension install -I my_instance -E postgis

Found extension package: postgis version 3.4.3+6b82d77
00:00:03 [====================] 22.49 MiB/22.49 MiB
Extension 'postgis' installed successfully.

Check that extension is installed:

$ 

edgedb extension list -I my_instance

┌─────────┬───────────────┐
│ Name    │ Version       │
│ postgis │ 3.4.3+6b82d77 │
└─────────┴───────────────┘

After installing extensions, make sure to restart your instance:

$ 

edgedb instance restart -I my_instance

Standalone extensions can now be declared in the schema, same as built-in extensions.

To restore a dump that uses a standalone extension, that extension must be installed before the restore process.