Light
Dark
System
v4latest
v4latest
v3
v2
v1

edgedb describe object

Describe a named schema object.

edgedb describe object [options] name

edgedb describe is a terminal command equivalent to describe object introspection command.

The describe command runs in the database it is connected to. For specifying the connection target see connection options.

--verbose

This is equivalent to running describe object ... as text verbose command, which enables displaying additional details, such as annotations and constraints, which are otherwise omitted.

name

Name of the schema object to describe.

Light
Dark
System

We use ChatGPT with additional context from our documentation to answer your questions. Not all answers will be accurate. Please join our Discord if you need more help.