Extensions​

Built-in extensions​

There are a few built-in extensions available:

• edgeql_http: enables EdgeQL over HTTP,

• graphql: enables GraphQL,

• auth: enables Gel 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;
# or / and
using extension ai;

Standalone extensions​

Additionally, standalone extension packages can be installed via the CLI, with postgis being a notable example.

List installed extensions:

$ 

gel extension list

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

List available extensions:

$ 

gel extension list-available

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

Install the postgis extension:

$ 

gel extension install -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:

$ 

gel extension list

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

After installing extensions, make sure to restart your instance:

$ 

gel instance restart

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

using extension postgis;

Using extensions​

using extension ExtensionName ";"

DDL commands​

This section describes the low-level DDL commands for creating and dropping extensions. You typically don't need to use these commands directly, but knowing about them is useful for reviewing migrations.

create extension ExtensionName ";"

create extension graphql;

create extension edgeql_http;

drop extension ExtensionName ";"

drop extension graphql;

drop extension edgeql_http;