The Designer view allows you to graphically visualise, design, and modify your database schema in real time. This view can speed up the creation of tables, indexes, fields, and more. Additionally it will plot your current schema into a diagram representation to view the structure of your database and relationships between its tables.
The table graph renders an interactive diagram representation of your schema. You can use your mouse to move and zoom around the canvas and press any table to modify it. Surrealist will make a best effort to correctly and clearly visualise your tables automatically.
When rendering the diagram, Surrealist will attempt to detect whether a table is a regular table or an edge table. It does so by checking for the presence of an in
and out
field. Surrealist expects these two fields to be configured as record
types and correctly define the table(s) they point to. This works for both schemafull and schemaless tables.
On the top right of this panel you will find a + button which allows you to easily create new tables and edge tables, similar to the one found in the Explorer view.
The Settings icon ⚙ provides the option to alter the appearance of tables in the diagram. This can either be set to fields
when you want to display all defined fields, summary
for showing condensed stats for each table, or simple
when you only want to display only the name of each table.
Clicking any table in the table graph will open the table designer panel. This is where you can visually update the structure of a table, including permissions, fields, indexes, events, and more.
In addition, you can press the delete button in the top right to remove a table from your database.
The Designer view is built on top of the powerful INFO FOR DB and INFO FOR TABLE statements, which you can utilize yourself to programatically extract schema information from the database.