Releases: surrealdb/surrealist
Surrealist v2.1.2
This patch release introduces experimental support for the SurrealDB 2.0 alpha release, a new updating experience, and additional improvements.
Changelog
- Experimental support for SurrealDB 2.0 Alpha
- Enabled by setting the
surreal_compatfeature flag tov2 - Disables the Authentication view for now
- Supports database serving
- Enabled by setting the
- Overhauled the updating experience
- Now displayed in a custom popup within the interface
- Surrealist will now check for updates more frequently
- Added a
Check for updatescommand to manually check for updates
- Improved access to feature flags
- Now accessible via the
Manage Feature Flagscommand
- Now accessible via the
- Allow manual triggering of auto completions within the query editor
- Will list out all tables, functions, and params
- Added support for creating relations in the record creator
- Limit the record table renderer to 100 records to prevent performance degradation
- Changed the default exporter file name
- Improved function editing experience
- Improved the GeoJSON explorer drawer (#333)
- Fixed the titlebar not displaying on the start screen on MacOS
- Fixed the explorer not resetting to page 1 when switching tables
- Fixed the explorer incorrectly showing nested columns
- Minor UI improvements
Click here to view the previous changelog for Surrealist 2.1
Compatible with SurrealDB 1.4.2+
Surrealist v2.1.1
This release focuses on bringing an array of user experience improvements to the entire interface, including enhanced support for GeoJSON, globally inspectable record ids, and a new keyboard shortcut guide.
Changelog
- Redesigned the data exporter
- Added a new option to omit comments from the resulting file
- You can now choose which tables are included in the export
- Added globally inspectable record ids
- Hold cmd/ctrl and click any record id to open the record inspector
- Supported in most SurrealQL editors, including query results
- Added a keyboard shortcut guide
- Accessible from the Help & Support menu
- Added a geometry explorer for GeoJSON values (#314)
- Improved designer drawer error handling on save
- Added a new setting to change the appearance of the table graph lines
- Added a schema mode dropdown to the table creator
- Improved field kind inputs
- Improved designer drawer table type editing
- Added a button to quickly open live messages when executing a live query
- Lowered the editor debounce delay
- Improved logging output format
- Added multiline support to permission inputs
- Changed the Models view icon
- Improved designer record link detection
- Improved connection template details inputs
- Redesigned the editor autocompletion popup
- Added the new Surreal Deal Store dataset
- Fixed
CREATEstatements not highlighting record ids - Fixed authentication errors not printing the cause
- Fixed incorrect snippets in the API Docs view (#321)
- Fixed data import button not displaying spinner
- Fixed the editor folding placeholder color
- Fixed backslashes causing the command palette to crash
- Fixed empty objects breaking highlighting
- Fixed starting database serving always triggering a reconnect
- Fixed issues during connection switching
- Fixed record id highlighting issues
- Fixed creating relation tables not configuring the type
- Fixed various Safari input issues
- Fixed non-json values not persisting in the record inspector
- Fixed the explorer pagination resetting to 1 when fetching new pages
- Fixed
WHEREbeing required when entering custom permission logic - Fixed
type::table()always returning NONE - Fixed some table graph edges not clearing after rerender
Click here to view the previous changelog for Surrealist 2.1
Compatible with SurrealDB 1.4.2+
Surrealist v2.1.0
Introducing Surrealist 2.1, the first significant release since the launch of Surrealist 2.0 back in April. This update is packed with exciting new features and improvements to the user experience. Let's explore some of the most notable additions in this release.
Highlights
Desktop file association
Users of the Surrealist Desktop app will notice .surql and .surrealql files can now be opened directly with Surrealist. Doing so will automatically start Surrealist, navigate to the Query view, and open the query in a new tab. This makes it even easier to store queries in external files, and further improves the workflow when working with many queries.
Designer record link visualization
In addition to visualizing relations between tables, the Surrealist Designer view can now also draw relations based on simple record link fields. This highly suggested feature allows you to visualize your schema in even further detail. While disabled by default, this functionality can be easily enabled from the Table Graph options.
CSV Table importing
Migrating from other databases and data sources can be a pain, which is why Surrealist now offers a convenient CSV table importer. Simply select a .csv file from the data importer (Explorer view > Import data), enter a desired table name, and Surrealist will automatically convert your rows to records. Additionally, the importer will automatically parse SurrealQL compatible data such as objects, arrays, and dates.
Changelog
- Added designer view record link visualization
- Draws lines for all
record<>fields defined on tables - Can be enabled in the designer view options
- Multiple links are collapsed into a single line for readability
- Draws lines for all
- Added support for .surql file opening with Surrealist Desktop
- Queries are opened as a new tab in the query view
- Currently limited to files of at most 5 MB in size
- Added custom connection groups
- Redesigned the connection list to support creating groups
- Connections can be assigned to a group from the connection editor
- Group names can be customized
- Added support for importing tables from CSV files
- Accessible by selecting a .csv file from the "Import data" button in the Explorer view
- Automatically parses SurrealQL values such as objects, arrays, and dates
- Added support for deeplinking to the desktop app
- Allows integrating Surrealist deeper into custom tooling and workflows
- Added a loading indicator for long running queries
- Added schema function autocompletions in queries
- Added an appearance setting to permanently expand the sidebar
- Added
cmd+L/ctrl+Lshortcut to open the connections list - Added Surrealist Mini window messaging protocol
- Added PHP examples to the API Docs view
- Added new convenient query context menu items
- Added the ability to resize the record creator, inspector, and designer drawers
- Added a log file for debugging purposes
- Added a confirmation when removing a connection
- Improved .NET examples in the API Docs view
- Improved Surrealist Mini startup performance for datasets
- Improved explorer logic and performance
- Improved the explorer record creation drawer
- Improved serving console performance
- Improved database version detection logic
- Improved SurrealQL syntax highlighting across the app
- Improved desktop config file readability
- Fixed authentication view incorrectly clearing passwords
- Fixed newsfeed indicator not always dissapearing
- Fixed certain endpoints getting blocked on MacOS
- Fixed explorer filter parsing and error checking
- Fixed unintended overscroll behavior on MacOS
- Fixed certain hover cards not having the correct background
- Fixed large numbers causing the explorer to crash
- Fixed command palette not saving history correctly
Compatible with SurrealDB 1.4.2+
Surrealist v2.0.6
User interface improvements, bug fixes and SurrealDB 1.5.0
- Updated SurrealDB to 1.5.0
- Disable spellcheck on fields
- Add devtools command for Desktop
- Make version check required
- Pass preview mode through vite
- Fix environment check
Click here to view the previous changelog for Surrealist 2.0
Compatible with SurrealDB 1.4.2
Surrealist v2.0.5
- Added new user registration functionality to scopes in the Authentication view
- Also accessible using "Register user in scope" commands
- Automatically extracts required params from the
SIGNUPquery
- Added the ability to restore the embed generator from an embed URL
- Only available in the online generator
- Added new commands to sync database schema and disconnect from the database
- Added back the ability to resize the query list, table list, and functions list panels
- Added a confirmation when resetting the sandbox environment
- Added additional context menu items throughout the interface
- Changed scope fields to hide sensitive fields by default
- Applies to fields named
password,pass, orsecret
- Applies to fields named
- Changed
Cmd + Spaceto only execute the selection if one is active - Changed Models view to be always displayed in the sidebar
- Changed some icons throughout the interface
- Changed the explorer to directly open a table after creation
- Improved placeholder UI when views are empty
- Improved version checking logic for reverse proxy connections
- Improved the UI when the connection isn't active
- Fixed incorrect embed generator URL in desktop app
- Fixed the table mode in Surrealist Mini
Click here to view the previous changelog for Surrealist 2.0
Compatible with SurrealDB 1.4.2
Surrealist v2.0.4
- Added a setting to display the query view horizontally
- Added highlighting for REMOVE statement and UNSET keyword
- Added query selection formatting
- Redesigned Surrealist mini generator
- Improved some input placeholders for clarity
- Improved version check logic
- Allow tab navigation in single-line code inputs
- Error screen will now navigate you to the sandbox
- Fixed libssl 1.1 error on linux platforms
- Fixed large comment icon in authentication view
- Fixed explorer record creator not working
- Fixed designer graph not updating when removing a table
- Fixed designer graph not updating when changing table appearance
- Fixed ML view not always rendering in the sidebar
- Fixed query errors not displaying in results panel
- Fixed missing support for JWKS tokens
- Minor UI/UX improvements
Click here to view the previous changelog for Surrealist 2.0
Compatible with SurrealDB 1.4.2
Surrealist v2.0.3
- Added support for 64-bit number handling
- Clear query responses when resetting the sandbox
- Minor improvements to the API docs
- Improved accessibility for icon buttons
- Fixed relation tables unable to save
- Fixed unintended error checking in query results
- Fixed moving designer tables resulting in a crash
- Fixed scope signup query issues
- Fixed database exports not working when including records
- Fixed backticks in table names breaking certain views
- Fixed Surrealist not reconnecting after changing connection details
- Fixed namespace users unable to list out tables
- Fixed serving settings storage path breaking when edited
- Fixed warning when installing .deb package
- Fixed tables and variables not autocompleting
- Fixed missing
Cmd/Ctrl + /hotkey for toggling comments - Fixed explorer copy record id context menu action
- Fixed variables pane, Record creator and editor being limited to JSON
Click here to view the previous changelog for Surrealist 2.0
Compatible with SurrealDB 1.4.2
Surrealist v2.0.2
- Updated and improved the error screen
- Updated .NET API docs
- Added a placeholder overlay for mobile devices
- Fixed further sidebar issues
- Fixed ordering of releases in the changelog dialog
- Fixed returning to start screen when removing a connection
- Fixed syntax highlighting breaking on empty strings
- Fixed authentication view sometimes not opening the user creator
Click here to view the previous changelog for Surrealist 2.0
Compatible with SurrealDB 1.4.2
Surrealist v2.0.1
- Fixed sidebar not aligning with content
- Fixed query list cutting off half way
- Fixed functions view arguments crash
Click here to view the previous changelog for Surrealist 2.0
Compatible with SurrealDB 1.4.2
Surrealist v2.0.0
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