Surrealist 2.0 is live! This is the official user interface that allows you to interact visually with your SurrealDB database. Seamlessly connect to any SurrealDB instance to query, explore, and design your ultimate database
This release marks is a near complete redesign of Surrealist, now officially integrated directly into the SurrealDB ecosystem. This release is packed with exciting new features, countless user experience improvements, and many highly requested changes.
Going forward Surrealist will be the official SurrealDB management interface and has joined the official SurrealDB suite. You can expect Surrealist to stay up to date with the latest SurrealDB versions, adopt new SurrealDB functionality at a faster pace, and offer even more control over your SurrealDB database.
Highlights
Redesigned user experience
Surrealist has received a complete makeover and redesign in order to improve and simplify the user experience. While Surrealist feels largely the same as the previous version, you’ll notice many improvements made to streamline the workflow. As part of this redesign certain functionality has been updated, such as making it easier to jump into the sandbox, simplify the management of connections, improve the organising of query tabs, and much more.
Functions, models, and docs
We have introduced new workflow views you can use to effortlessly manage schema-based functions (stored procedures), upload and list out your SurrealML models, and generate personalised API documentation.
Live query rework
The previous Live Query view has been replaced in favour of a new, easier to use live query inbox conveniently integrated directly into the Query View. Simply execute a live query in any request and switch to the Live results mode to view a stream of incoming messages. Active subscriptions will now be managed automatically for you, making it a breeze to test and iterate your live queries.
Connection overhaul
The connections list has also received a major overhaul to further aid with the management of multiple databases. You’ll now be able to jump into the sandbox at all times with a single click, as you will no longer have to define a connection before using it. Additionally, environments have been replaced with the more lightweight and easier to use connection templates, useful for people managing many related databases.
Powerful navigation
You can use the new Command Palette, accessible using ctrl + K/cmd + K, to quickly perform any action or navigate to any desired menu at light speed. The Command Palette supports full keyboard navigation, provides an intelligent search, and displays recent searches. You can also find the new Command Palette in the redesigned sidebar.
Changelog
- Complete interface redesign
- New overall appearance inline with the SurrealDB aesthetic
- Improved the general user experience of the app
- Simplified the use of the sandbox
- Replaced environments with connection templates
- Added tooltips to all non-descriptive interactive elements
- Improved view navigation with the new navigation sidebar
- New Functions view
- Allows you to list, create, and update schema-based functions
- Configure access permissions
- Define function arguments
- Full function body SurrealQL highlighting
- New ML Models view
- Upload and list your SurrealML models
- New API Docs view
- Personalised API documentation focused around your database
- Code snippets for most languages supported by SurrealDB
- Easy navigation using the table of contents
- Simplified sandbox
- You no longer have to create sandbox connections manually
- Built in support for loading official datasets
- Sandboxes support all regular connection functionality
- Quick sandbox reset button
- Introduced a command palette
- Navigate and trigger any action with just your keyboard
- Displays command keyboard shortcuts where available
- Lists out latest 3 searches
- Saved query labeling
- Organize your saved queries using one or more labels
- Queries can be filtered on labels in the saved queries drawer
- Reworked live queries
- Removed the Live view
- Live queries can be sent directly from the Query view
- Added a new “Live” result mode, which displays a live updating stream of messages
- Live queries are automatically restarted when you re-run the query
- You can mix live and non-live queries within the same request
- Improved query syntax highlighting
- Now available in most places queries are displayed
- Removed “Advanced editor” dialog from certain input fields, instead SurrealQL is now highlighted inline where applicable
- Help and support dialog
- Provides an easy way to access the docs and submit an issue
- Integrated newsfeed
- Accessible from the top right of the interface,
- Provides an integrated newsfeed with useful updates about Surrealist and SurrealDB
- Connection templates
- Replace the previous environment system
- Can be applied when creating or updating a connection
- Useful when working with multiple databases which share common connection details
- A special convenient “Local database” template is made available when locally serving a database on Surrealist desktop
- Variable inference
- Automatically analyses your query for variables and updates the variables panel
- Will never remove existing variable definitions
- Sandbox dataset loading
- Provides an easy way to experiment with SurrealQL by allowing you to load official datasets directly into your sandbox
- Query responses are now presented as SurrealQL values
- You can use a new setting to toggle between JSON and SurrealQL mode
- Records can now be edited by pressing a record id in any data table
- Designer view tables can now be manually moved and positioned
- Re-added the ability to scale the interface in Surrealist Desktop
- Query history is now tracked per connection
- Switching between views now works more predictably
Compatible with SurrealDB 1.4.2