Skip to content

Database clients

Beekeeper Studio

Beekeeper Studio is a cross-platform desktop SQL editor and database manager. It has a SurrealDB connection type of its own, so a namespace and database can be browsed and queried without anything in between.

Note

Beekeeper Studio describes its SurrealDB support as alpha, and repeats that in the connection dialog with a link to the features it currently covers. Read that list before depending on it for more than browsing and querying.

  1. Open Beekeeper Studio and select New Connection.

  2. Set Connection Type to SurrealDB.

  3. Fill in the connection. The address is three separate fields rather than one URL:

    • Protocol, such as http

    • Host, such as localhost

    • Port, 8000 by default

  4. Choose an Authentication Method for the level the account belongs to, such as Root, then give the User and Password.

  5. Enter the Namespace and Database to open.

  6. Select Test to check the details, then Connect.

The Beekeeper Studio connection dialog with SurrealDB chosen as the connection type, showing separate protocol, host and port fields above the authentication method, user, password, namespace and database.

A connection can be saved into a folder and given a colour, which helps where several instances are open at once.

Connecting opens a query tab and lists the database's entities in the sidebar. Expanding a table shows its fields with the types SurrealDB holds them as, so a record<person> link or an array<string> reads as itself rather than as a foreign key.

Queries are written in SurrealQL and run with Run All, and results appear in a sortable grid below the editor:

SELECT product_name, quantity, price FROM cart LIMIT 10;

Beekeeper Studio connected to SurrealDB, with the entity sidebar showing a cart table and its field types, a SurrealQL query in the editor, and ten result rows in the grid below.

The screenshots here use the Surreal Deal Store sample dataset.

Was this page helpful?