CHANGELOG.md

Change Log

2.0.0 - The ultimate interface

• Surrealist has joined SurrealDB as the official interface
  • New docs available at https://surrealdb.com/docs/surrealist
• 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

1.11.7 - SurrealDB 1.4.0

• Support for SurrealDB 1.3.0
• Fixed rendering of incorrect columns in explorer view

1.11.6 - SurrealDB 1.3.0

• Support for SurrealDB 1.3.0

1.11.5 - SurrealDB 1.2.1

• Support for SurrealDB 1.2.1
  • Fixes some reported errors and crashes

1.11.4 - SurrealDB 1.2

• Support for SurrealDB 1.2.0

1.11.3 - Designer improvements

• Support for SurrealDB 1.1.1
• Designer view improvements
  • Design panel is now collapsed by default
  • You will be prompted when switching tables if you have unsaved changes
  • Snapshots now include the entire graph (#167)
  • Fixed incorrect editing behavior (#166)

1.11.2 - SurrealDB 1.1

• Support for SurrealDB 1.1.0
• Added a new import database button to the toolbar
  • Allows for executing any .surql file without having to use the query view
  • Useful for loading in backups, pre-defined query files, etc.
• Fixed search index issues (#154)

1.11.1 - General improvements

• Added designer view SVG snapshots (#150)
• Improved record link detection to support complex ids
• Improved support for escaped table names (#155)
• Display query time correctly in combined mode (#157)
• Fixed error caused by failing to find an available port (#137)
• Fixed explorer view pagination issues (#133)
• Fixed user selection on Linux (#148)
• Fixed overflow issues in the authentication view
• Fixed editor zooming not working

1.11.0 - Sandbox connections

• Added sandbox connections
  • Connect to an internally embedded SurrealDB instance
  • Useful for rapid testing without requiring a local or remote SurrealDB instance
  • Currently only in-memory and non-persistent
• Query results are now more accurate (#115)
  • No longer always displayed as an array
• Query time value is displayed again (#113)
• Fixed incorrect explorer pagination (#133)
• Fixed situations in which connections incorrectly appeared closed
• Slightly adjust minimum window size and splitter sizes

1.10.3 - Critical fixes

• Fixed the web app breaking when accessing non-/ paths
• Fixed schema fetching failing when authenticated as a root user

1.10.2 - Technical update

• Implement internal view routing
  • The current view is now displayed in the URL
  • This means you can bookmark and share specific views on the web app
• Improved explorer inspector
  • Can now be opened manually by pressing the wrench button
• Changed explorer table pinning
  • You can now toggle a table pin by double clicking a table
• Improved overal performance
• Improved JSON syntax highlighting
• Re-enable JSON syntax validation
• Replaced most "refresh" buttons with a single universal refresh in the address bar
• Store active view globally instead of per session
• Fixed record ids passed as variable not working as expected
• Fixed strange query editor behavior when holding shift
• Fixed incorrect panel sizes in the authentication view
• Fixed incorrect wrapping behavior in explorer view (#129)
• Refactored the code base to be more future proof
• Minor UI improvements

1.10.1 - Minor improvements

• Added auto closing bracket support in SurrealQL editors
• Added the ability to rename query tabs on double click
• Updated surrealql grammar to the latest version
• Updated live query editor UI
• Updated console toggle button layout
• Updated editor focus and tab removal handling
• Fixed desktop app not being able to connect to http endpoints (#117)
• Fixed combined query result mode incorrectly handling empty and error results (#118)
• Fixed authentication view not updating on session change
• Fixed some surrealql editors not taking up any height (#119)

1.10.0 - Major feature update

• Improved feature parity between the desktop and web app
  • Designer view is now available in the web app
  • Authentication view is now available in the web app
  • Connections are now handled the same way
• Added new Live Query view
  • Can be used to listen to one or more live queries
  • Combines all incoming live query messages into a single feed
  • Live query messages can be expanded to view their contents
• Added support for Query View tabs (#70)
  • Query tabs are stored per session
  • Tabs are saved and persisted
• Designer View improvements
  • Field names and types are now truncated when they are too long
  • Limit tables to displaying 7 fields, with a button to view more
• Overhaul exporting functionality
  • Now supports exporting table records
  • Select which elements to export in the new exporter dialog
  • Add support for analyzers, scopes, params, and functions
• Overhaul syntax highlighting
  • Highlighting is now based on the official SurrealQL grammar
  • JavaScript is now correctly highlighted
  • Modified color scheme
• Added a new "Combined" query result mode
  • Combines the results of multiple queries into a single list
  • Useful for when you want to copy or view all results without switching tabs
• The config file is now stored in a new location
  • Linux: $XDG_CONFIG_HOME or $HOME/.config/surrealist.json
  • macOS: $HOME/Library/Application Support/surrealist.json
  • Windows: %AppData%\surrealist.json
• Added a convenience button to load a query from disk
• Surrealist now warns you when you connect to an outdated version of SurrealDB
• The web app now more reliably connects to localhost endpoints
• Replaced the window pinning toolbar button with a settings entry and hotkey (F11)
• Expand all designer view sections by default
• Fixed web app always starting in light theme for a split second
• Fixed query error highlighting not working since beta 12
• Fixed certain errors not displaying in the result panel

1.9.2 - SurrealDB 1.0 support

• Update to SurrealDB 1.0

1.9.1 - Beta 11 support

• Update to SurrealDB beta 11
• Fixed the web app not displaying query errors
• Highlight the new ONLY keyword
• Respect the query timeout setting on desktop
• Endpoints with "ws://" will no longer break
• Correctly validate connection details
• Support improved SurrealDB error messages (#103)

1.9.0 - Beta 10 support

• Full support for SurrealDB beta 10
• Local database now launches with --allow-all and --auth
• Updated syntax highlighting with new keywords
• Designer view updates
  • Added designer related options
    • Table Layout controls how tables are positioned within the graph. Currently supports "Diagram" and "Grid"
    • Node Appearance controls how nodes are rendered. Currently supports "Fields", "Summary", and "Simple"
    • Configurable per session, however default values can be set in the settings dialog
  • Added support for default field values
  • Added support for changefeeds
  • Improved handling of table views
  • Field kind can now be set to any value, however a table can still be quickly selected
  • Fixed schema export not working
  • Fixed certain index and event properties not being required
• Authentication view updates
  • Added support for manging root logins
  • Added support for user comments
• Fixed font zoom shortcuts not always working
• Fixed multiple editor related issues
• Minor UI improvements

1.8.0 - Designer Redesign

• Overhauled the designer view
  • Displays tables in a visual graph
  • Select a table to view and modify its schema
  • Save the graph as a PNG image
• Added editor font zooming
  • Ctrl + Alt + + to zoom in
  • Ctrl + Alt + - to zoom out
  • Ctrl + Alt + 0 to reset
  • To use these shortcuts you must not have any editor focused, this is a limitation at the moment
• Added explorer view table pinning
  • Pinned tables will appear first in the list
• Removed visualizer view in favor of the new designer view
• Fixed instances of cursor misplacement within editors
• Fixed various schema parsing issues
• Fixed light theme issues (#82)
• Fixed UI freezing when writing large queries (#87)
• Fixed variables pane rarely resetting it's size
• Fixed console panel rendering in the web app
• Fixed light theme not always using the right editor color scheme
• Fixed explorer contents persisting after disconnect

1.7.5 - Bug fixes

• Remove UI zooming due to editor issues (#78)
  • We intend to re-add this feature in the future once upstream issues are resolved
• More accurately report on local database launch failures (#76)
  • The console panel can now be toggled at any time allowing you to see potential errors
• Add refresh button to inspector panel
• Respect XDG_CONFIG_HOME for locating the settings file (#67)
• Fix some panel sizing issues

1.7.4 - Inspector history

• Added back and forward buttons to the inspector panel
  • More easily navigate when editing multiple records
• Fixed inspector pane opening too small
• Inspector pane now remembers its size
• Fixed comment shortcut using the wrong keys (#58)
• Various UI improvements

1.7.3 - UI Improvements

• Added the ability to drag sessions to customize their order
• Add support for latest SurrealDB nightly builds (#64)
• Correctly handle databases with no tables (#66)
• Fixed panels sometimes breaking when resizing the window
• Redesigned settings dialog
  • Session search box is now a setting

1.7.2 - Improved error highlighting

• Improved the error highlighter
  • Results in significantly less false positives
  • Now accurately highlights the position of the syntax error
  • Correctly handles comments
• Fixed visualizer no longer displaying edges in newer versions of SurrealDB
• Dismissed update notifications will be hidden until a new version is available
• Added manual update check button in settings

1.7.1 - Live error checking

• Added live error checking to the query view
  • Underlines invalid queries with an underline
  • Displays the error message on hover
  • Can be disabled in the settings dialog
• Fixed some connection UI issues
• Updated internal version of surrealdb

1.7.0 - Environments

• Replaced the tab system with a new session system
  • Sessions are organized into environments
  • Environments can define default connection details which all sessions within fallback to
  • Provides a significantly better user experience when defining many sessions
  • Sessions can be pinned directly to the toolbar for quick access
  • Existing tabs are automatically migrated to sessions
• Added filtering functionality to the explorer view
  • Filter input can be toggled by pressing the filter icon on the top right of the explorer panel
  • Validates the where clause and indicates when it is invalid
• Local database starting is now decoupled from the active sessions
  • Root username, root password, and port are now configured in settings
• Overhauled the settings UI to be more scalable
• Improve table retrieval performance for explorer and designer view
• The surreal executable path can now also be manually specified in settings
• Changed the way multiple responses are displayed in query view
  • Tabs have been replaced by pagination
• Surrealist windows can be resized to a slightly smaller size than before
• Fixed database start button getting stuck in loading state

1.6.4 - Minor improvements

• Updated internal version of surrealdb
• Fixed surrealdb process sometimes staying alive after exit
• Fixed unexpected behavior with permission inputs in designer view (#46)

1.6.3 - UI/UX Improvements

• Records are now opened in the explorer when the entire row is clicked
• Passwords are no longer displayed in plaintext by default
• Fixed wrapping issues with record links
• Close explorer when table is deleted
• Improved performance of total record count calculation
• Fixed inconsistent row heights in explorer
• Alphabetically sort headers
• Impose a visual limit on the length of record links
• Fixed update notification not opening the releases page
• Fixed incorrect colors in query view table renderer
• Scope name is now displayed in the connection bar
• Further attempts to fix spaces behaving weirdly when selected

1.6.2 - Visualization export

• Improvements to the visualizer view
  • Graphs can be saved as png and jpg
  • Improved node layout algorithm
  • Fixed labels dissapearing close to the edge
• Add new "Export schema" toolbar button in designer view
  • Exports the database schema to a .surql file
  • Unlike surreal export this file only contains schema definitions, not data
  • Useful when you want to save an existing schema and apply it to another database
• Added new "Advanced editor" buttons to some Designer view inputs
  • Opens a dedicated dialog with a multiline syntax highted editor
  • The regular input boxes can still be used and now accept multilines
• Scope authentication fields can now be fully customized
• Remember the active tab between application restarts
• Allow selecting multiple from and to tables when creating edges
• Improved table sorting in explorer and designer view
• Fixed an issue in the table view renderer causing a crash
• Improve preview of array items within table views
• Table headers are now sticky and always visible
• Fixed various visual issues and inconsistencies
• Updated to latest SurrealDB nightly

1.6.1 - Schema management

• Added designer view
  • Allows graphically creating and modifying schemas
  • Supports permissions, fields, indexes, and events
  • Create new tables and edge tables
• Added visualizer view
  • Plots your tables and relationships into a graph
  • Provides a useful overview of your database design
  • Early stages, will gain more functionality in the future
• Added authentication view
  • Manage namespace & database logins
  • Manage database scopes
• Rewritten backend in Rust
  • Will allow for more intelligent features in the future
  • Dev tools are now available in release builds (Ctrl + Shift + I)
• Added the ability to search table lists
• Allow executing queries from variables pane
• Highlighting for single quotes and <future>
• Added "Execute selection" option to query editor context menu
• Improved matching of certain types in explorer view
• The current view is now scoped to the tab instead of global
• Edge tables now display a different icon from normal tables
• Use left and right arrow keys to cycle between the available modes
• Fixed incorrect UI state due to lack of access (anonymous & scope auth)
• Fixed crash on connecting to insecure endpoint

1.5.2 - Bug fixes

• Add new anonymous connection authentication mode
• Improve record link detection
• Fixed database and scope authentication not working
• Add more syntax highlighting keywords
• Fixed certain functions not being matched correctly
• Fixed crash when editing a saved query
• Fixed horizontal scrollbar in history and favorites panel

1.5.1 - New shortcuts

• Added new keyboard shortcuts
  • Ctrl + number to switch to another tab
  • Ctrl + Q to switch to the Query View
  • Ctrl + E to switch to the Explorer View
  • Ctrl + S to start / stop the local server
  • Ctrl + - to zoom out
  • Ctrl + + to zoom in
• Added editor zooming
  • Experimental, may not work on all systems (This cannot be fixed at the moment)
  • Can cause issues with draggable elements
• Added the ability to create new records in explorer view
• Added the ability to delete records in explorer view
• Add button to disconnect from the database when connected
• Improve automatic theme and prevent potential flashing of the wrong theme
• Fixed history not saving when all entries are cleared
• Added syntax highlighting for SurrealDB functions
• Improve WebSocket handling to result in more consistent behavior
• Fixed table view incorrectly marking certain strings as records
• Tweak some default values
• Various UI/UX improvements

1.5.0 - Explorer view

• Added an explorer view to view and edit tables and their data
  • You can switch between Query and Explorer view using the button in the top left
  • Edit records directly as JSON
  • View and traverse record relations
  • Columns can be sorted by clicking on the header
• Redesigned the table view
  • Improved cell rendering based on data type
  • Objects and arrays can be hovered for a preview
  • Null and undefined values are now styled differently
• Added namespace, database, and scope authentication
  • Redesigned the connection details dialog to include new fields
• Added additional keywords for highlighting
• Table completion will now be triggered in more situations
• Tabs can be dragged to reorder them
• Improved favorites dragging behavior

1.4.2 - Improved favorites

• Redesigned the favorites UI/UX
  • Queries are now be opened by clicking rather than hovering
  • You can now edit and rename queries in a dialog
  • Favorites can be manually sorted by dragging
  • Added the option to open a query in a new tab
• New tabs now use the connection details of the previous tab
• Hide the Surreal banner in the console
• Improved the pane dragging behavior
• Fixed text moving within the editor when selected

1.4.1 - Saved queries (Fixed)

• Highlight regex correctly in the query editor
• Fixed updater not working
• Fixed issues with the table viewer
• Improve database start/stop button behavior
• Changed default tab names

1.4.0 - Saved queries

• Added query saving functionality
• Added a button to render query results as table
• Redesigned the query history UI
• Added F9 as shortcut for "Execute query"
• F9 and Ctrl + Space now work outside the editor
• Improved the panel resizing behavior

1.3.0 - Console panel

• Added a console panel to view logs for the integrated database (#1)
  • Can be hidden and revealed on the fly or from the setting screen
• Disabled uneccecary auto completion for input fields (#3)
• Added configurable global query timeout setting
• Added update checker to prompt about new releases
  • Can be disabled from the settings screen
• Added comment toggle shortcut to the query editor (Ctrl + /)
• Updated the setting screen UI

1.2.0 - Local database

• Added the ability to start and stop a local database directly from Surrealist
  • Will use the username, password, and port entered for the current tab
  • The tab hosting the database will display an indication icon
• Added an "Automatic" theme option that uses your operating system theme
  • This is now the default
• Added auto completion support for variables

1.1.2 - Query history

• Query history drawer
• Result wrapping setting
• Ctrl+Space to suggest table names at any time
• Various UI fixes

1.1.1 - UX Improvements

• Fixed indentation issues
• Improved query result consistency
• Added auto completion for table names

1.1.0 - Feature complete

• Auto connect when switching tabs
• Dark theme support
• Variables pane
• Improved error handling
• Various UI fixes

1.0.0 - Initial release

• Multi-tab query editing
• Support for multiple queries in one request
• Provides a clean and foldable view of your query result
• SurrealQL syntax highlighting