EdgeDB 1.0 is launching on Feb 10th! Watch the live event.
Claim your ticket
EdgeQL Tutorial

Introspection

Subtopics

EdgeDB schema is fully introspectable. There are two approaches to introspection corresponding to two different use-cases: human-oriented and query-oriented.

For human-oriented introspection the goal is to quickly see some useful information about the database structure expressed as either DDL, SDL or a human-readable text summary. The DESCRIBE command does exactly that. By default it produces the DDL command needed to create the schema object in question:

Input
Run
Output
Press the 'Run' button to evaluate the input

It is also possible to get an SDL snippet or even see an entire module as SDL:

Input
Run
Output
Press the 'Run' button to evaluate the input
Input
Run
Output
Press the 'Run' button to evaluate the input

To see more detailed information, such as all the inherited links and properties, etc. use the TEXT mode:

Input
Run
Output
Press the 'Run' button to evaluate the input