starlanestudios / surrealist

Surrealist is the ultimate way to visually manage your SurrealDB database

       

             

Surrealist is the ultimate way to visually manage your SurrealDB database. Effortlessly connect to any SurrealDB database and execute queries, explore your tables and records, design your preferred schema, and much more. Surrealist is designed to suit a broad range of workflows, so whether you are pushing SurrealDB to its limits, or just getting started, Surrealist is the perfect tool to use.

Documentation

You can read our documentation for information on how to install and get started using Surrealist.

Using the Web App

The quickest way to jump into Surrealist is using the web app at https://surrealist.app/

The Surrealist web app provides a fully functional database management experience with support for multiple connections, an integrated sandbox environment,

While the web app provides a full database management experience, it is recommended to download and install the desktop app for the complete Surrealist experience and gain features such as one-click database serving.

Using the Desktop App

You can download the latest version of Surrealist Desktop from our Releases page. This version is the recommended way to interact with SurrealDB, as it supports additional features over the web app.

Features

Query view

Use the Query View to execute queries against your database. You can define variables in the Variables panel and use them in your queries, and browse the results in the Results panel.

Additionally, queries can be saved and organized in your Saved queries, while you can view a list of recent queries in the History drawer.

Explorer view

The Explorer View is used to browse your database and inspect individual records. When you select a table in the left panel, the table contents will be displayed in the Record Explorer. You can click on a record id to open the record inspector, in which you can edit the record contents and traverse graph relationships.

Designer view

The Designer View is a powerful tool you can use to define and manage your database schemas. You can create tables & edges, modify the database schema, and visualize the database tables in a graph view.

Authentication view

Use the Authentication View to manage access to the database by creating namespace logins, database logins, or scopes.

Functions view

Create and manage your schema level functions using the Functions view. Easily write your functions using the builtin SurrealQL editor, define their input parameters, and configure access permissions.

Models view

Use the Models View to upload SurML files to the database and list out available machine learning models.

API Docs view

The API Docs help you develop against your SurrealDB database faster by providing personalized API documentation in many available languages.

Local database serving

Using the desktop app you can effortlessly start a local SurrealDB database directly from the interface, while following logging output from the console drawer.

You can choose whether the local database is stored in memory or stored on disk on the Settings screen.

Sandbox

The Sandbox provides an easy to use playground to test, experiment, and learn SurrealDB. You can use the sandbox without having to start a database up, and data will be reset after you close Surrealist. Additionally, you can use the buttons in the toolbar to manually reset the sandbox or load an official dataset.

Command Palette

For advanced usage Surrealist provides a command palette accessible using cmd/ctrl + K which allows you to easily navigate to any part of the interface and trigger any action.

And much more

Explore the full list of features in the docs.

Contributing

We welcome any issues and PRs submitted to Surrealist. Before you open an issue or PR please read our Contributor Guide.

Disclaimer

• Surrealist aims to stay up-to-date with the latest stable release of SurrealDB. We cannot guarantee support for latest nightly builds.
• Connections to remote servers may require a HTTPS connection. You can easily configure SSL for your server using tools like Letsencrypt and nginx.

License

Source code for Surrealist is licensed under the MIT license.

Copyright © 2024 SurrealDB Ltd

surrealist's Issues

Permission inputs are not idempotent and they are unclear how to use

Describe the bug
A clear and concise description of what the bug is. If applicable, add screenshots to help explain your problem.

To Reproduce
Steps to reproduce the behavior:

1. Go to the Designer tab
2. Add a permission. I would suspect initially that I should write something like WHERE user = $auth.id, but after digging a bit, I found I have to write (user = $auth.id (notice the initial parentheses).
3. When i click "Apply schema" in the bottom, my field now updates to WHERE (user = $auth.id), but I was not able to write that initially, getting errors. So the permissions field is not idempotent

Expected behavior
I suspected that I had to write the whole permissions, but after digging in the code, i found that you add the WHERE ${value}) bit, so you have to remember that

Environment (you can view the current version under Settings):

• OS: macOS monterey
• Version 1.6.3 (20230330.134541)

Surrealist 1.6.2 probable memory leak

Describe the bug
Surrealist 1.6.2 seems to have some kind of memory leak, as it peaked at 16 gigs memory usage.

To Reproduce
Unknown, was using the explorer at the time.

Expected behavior
No memory leak

Environment (you can view the current version under Settings):

• OS: Fedora Linux 37 (KDE 5.27.2, KDE Frameworks 5.103.0, Qt 5.15.0, Kernel 6.1.14-200.fc37)
• Version: 1.6.2

Darwin releases seems to be swapped (architecture–wise)

Describe the bug
I have downloaded Surrealist arm64 version, since I'm using Mac with M1 chip, but the application is not starting up, displaying the “Surrealist” is damaged and can’t be opened. You should move it to the Bin. error from the operating system. The interesting part is that the version labeled amd64 is working perfectly.

To Reproduce
Steps to reproduce the behavior:

1. Download release labeled arm64 to Mac computer with M-family chip: https://github.com/StarlaneStudios/Surrealist/releases/download/v1.5.2/surrealist-v1.5.2-darwin-arm64.tgz
2. Unpack, run the program, observe the error message
3. Repeat (1) for amd64 version: https://github.com/StarlaneStudios/Surrealist/releases/download/v1.5.2/surrealist-v1.5.2-darwin-amd64.tgz
4. Unpack, run the program - it works well

Environment (you can view the current version under Settings):

• OS: MacOS 13.0.1
• Version 1.5.2

Automatic update

Yeah, um, can you make the app only update itself, without downloading the new release every time? Thanks!

Graph view for relations

Describe your feature request
Firstly thank you for creating this amazing tool.

Given that SurrealDB is is capable of creating relations between records I think having visualization of these relations as a node graph would really help in being able to see the data.

Are you willing to contribute this feature?
Optionally, I am still getting used to SurrealDB and working on my own project in which I plan to have a sort of graph view for a users connections. If I am able to get that working I think it could be generalized to for surrealist as well.

Related pull request (if applicable)
e.g. PR #4

[Future] Pass `--no-banner` flag to integrated database in SurrealDB beta 9

Toggle comment on current line keyboard shortcut

Can't do scope authentication

This is probably not an issue with surrealist, but I have tried for a long time, and hope you can solve my issue.

I have defined a database scope called user_scope with a signup query: CREATE user SET email = $email, pass = crypto::argon2::generate($pass) and signin query SELECT * FROM user WHERE email = $email AND crypto::argon2::compare(pass, $pass) with 12h session duration.

However when trying to do scope authentication in the connection details like this

It still says I am offline, and the only thing logged in the terminal is 2023-04-04T20:21:19.537330Z INFO surrealdb::net: 127.0.0.1:65491 GET /rpc HTTP/1.1 101 "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko)" 136.791µs

What am I doing wrong?

Strange display

Describe the bug

To Reproduce
I don't know how this ended up but I noticed it in the database.

Environment (you can view the current version under Settings):

• OS: Windows
• Version 1.5.2

Array Record Links

Describe your feature request

Array Record Links

Are you willing to contribute this feature?

No.

Persistent configuration for projects

Describe your feature request
I believe that most developers are not working on many projects at once. So there is no point to fulfill the connecting config on every new tab. This will be best if there will be another select menu to choose the current project.

For example:
Select menu with the options somewhere in top of UI, near the Surrealist logo maybe:

1. Project 1
2. Project 2
3. Custom-named project
4. Add a new project

Selecting option 1 will load project 1, so every new tab will use preconfigured connection details for this project.

If you then select for example option 2 will load project 2. Every tab from project 1 will hide. Every new tab under project 2 will use preconfigured connection details for this project.

This has also expansion potential. For example: to enable the user to save queries to global or per project.

Display a notification when a new release is available

Partially move connection logic to Rust

Describe your feature request
Currently connections are always instantiated using the WebSocket implementation of the web view, which comes with unavoidable security constraints. The plan is to provide a new connection mechanism in the Rust backend which should allow for connections to non-HTTPS endpoints. The original approach must be kept in order to provide compatibility with the web app unless an alternative approach can be found.

This problem is currently solvable by wrapping your SurrealDB endpoint with an SSL certificate.

Related issues
#29

Creating floating point arrays converts values to string

Describe the bug
Not sure if this is a display bug in surrealist or some problem with type inference in surrealdb, but when I create a simple object with create test content {"test": [2.3,2.3,30] } it displays the record as

    {
        "id": "test:wg2egi4wf1057c1jpvzg",
        "test": [
            "2.3",
            "2.3",
            30
        ]
    }
]

Expected behavior
The returned record should display "test": [2.3,2.3,20]

latest version still causes surreal beta 9 to crash

using surreal beta 9 and surrealist 1.6.4 I am still gettings this error when attempting to connect.

thread 'tokio-runtime-worker' panicked at 'called `Result::unwrap()` on an `Err` value: Syntax("invalid type: sequence, expected a string")', lib/src/sql/statements/define.rs:1009:72
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
[1]    8996 abort      surreal start --user root --pass root --log debug -- file:Database/

I'm also still having to run a separate instance of surreal in the cli because of this error

MacOS 13.3.1
surreal 1.0.0-beta.9+20230402.5eafebd
surrealist 1.6.4

Zoom in for UI

Describe your feature request
It would be nice if I were able to zoom in to the UI, some elements feel too small. Standard buttons like ctrl +, ctrl - do not work. There is no related setting as well.

Are you willing to contribute this feature?
No, I do not have experience with the tech stack used.

Related pull request (if applicable)
N/A

Add Mac AMD64 binaries in release

Currently only ARM is supported for macs. Would it be possible to also include adm64?

Can't select empty record in explorer view

Describe the bug
It is not possible to select record in explorer view that has empty id.

To Reproduce
Steps to reproduce the behavior:

1. Go to explorer view
2. Create simple record with non empty id
3. Create record with empty id {"id": ""}
4. Try to select other record and try select this record
5. Can't open inspector on this record

Expected behavior
You can select a record with empty id and inspector opens.

Environment (you can view the current version under Settings):

• OS: EndeavourOS (Linux) and Windows
• Version: 1.7.1

Bad font rendering on Ubuntu 22.10

Describe the bug
I just installed v1.6.0 on my Ubuntu 22.10 and the rendering of text looks quite think, almost not visible. I attach a screenshot where it's hopefully visible. The text for the queries and results look just fine. It was fine in a previous release.

Expected behavior
A clear and concise description of what you expected to happen.

Environment (you can view the current version under Settings):

• OS: Ubuntu
• Version 22.10

Connection Closed Unexpected connection close (1006)

Describe the bug
I get an Connection Closed Unexpected connection close (1006) message if I connect to a remote instance that is secured via SSL and nginx and runs surrealdb in a docker container (nightly build). I do see the /rpc call in the remote console, but I do not see why the connection is closed. I can connect to the same endpoint e.g. via surrealdb-py. Is there a way to show additional debug information about the connection failure? I assume it's not a bug in surrealist, but some misconfiguration. It may help others to debug.

To Reproduce
See bug description.

Expected behavior
Connection works as expected.

Environment (you can view the current version under Settings):

• OS: Ubuntu 22.10

Easier navigation between different databases.

Describe your feature request
Currently to switch between databases you have to open the connection settings and manually type in the name of the database you would like to view. I propose an accordion style view to:

1. See the list of all databases for a namespace
2. Easily switch between them similar to how we have the tables on the left pane and can switch between them.

This makes working with multiple databases a lot easier especially when the names are not easy to remember (In my case each database is named based on the uuid of an entry in a central database so to get to a db I would first look up the id of the db in a table inside my admin db and then enter that id in the connection field)

I also think this feature could be extended to namespaces as well.

Are you willing to contribute this feature?
Yes

The command INFO FOR NAMESPACE returns the names of each database inside a namespace so it would be very simple to display this as a list or a dropdown

For namespaces INFO FOR KV returns the list of namespaces so a similar thing could be applied there as well.

Abnormal text cursor position in query section

Surrealist.-.Cursor.Bug.mp4

Describe the bug
The text cursor doesn't follow the normal flow of text in the query section.

To Reproduce
Steps to reproduce the behavior:

1. Open Surrealist
2. Start Session
3. Type queries in the query section and there's your issue

Expected behavior
Text cursor position follows normal text flow.

Environment:

• OS: Windows
• Version 1.7.1

GLIBC issue on Debian Bullseye

Describe the bug
Running surrealist on Debian Bullseye gives the following error: ./surrealist: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.34` not found (required by ./surrealist)

I am able to build from source just fine though.

Just thought i would mention the error in case building on debian is a possibility for you instead of Ubuntu (which i assume you are building on for the linux release) as a debian build should also work fine for Ubuntu.

Thanks for the app!

Add mention of surrealist.app site and downloads page to docs

There is currently no mention of the https://surrealist.app site, or a link to the GitHub releases (for the desktop app downloads) on the documentation page at https://surrealist.starlane.studio.

Accessing array elements using index variable, shows parse error on index variable

Describe the bug
Accessing array elements using index variable, shows parse error on index variable.

To Reproduce
Steps to reproduce the behavior:

1. create variables and record them as below image, I gave hardcoded values for id and array index, it's working
   

2.create record, and assign value for id using variable, and hardcoded value for index - its also working.

3.list all records are good.

4.create record, and assign value for id using variable, and access array element using index variable shows parse error.

Expected behavior
record should created.

Environment (you can view the current version under Settings):

• OS: Windows
• OS Version 10
• Surreal Version: beta9
• Surrealist Version: 1.7.0

Editable records returned from queries

Describe your feature request
I suppose this one is tricky, but I often find myself wanting to query data, and then edit that data in place. I understand why the results in the query editor are read-only, but I thought of two possible ways around this:

1. Highlight the 'id' field (if returned in the query) in such a way that it is clickable and will open an 'editable' record window.
2. Make the 'Explorer' View queryable with 'WHERE' statements somehow.

Are you willing to contribute this feature?
I can't...

General UI bugs

Describe the bug
I know its very nit-picky but being a UI designer i just thought I'd point out a few UI inconsistencies. I can help fix some of these if needed.

1. the connect button does not fill the url bar on windows:

windows:

Mac:

you can see there is some wierd padding on windows. looks fine on mac

2. Connect button has wrong highlight border radius:

if you highlight the connect button on mac the highlight as a lower border radius than the button which makes it look wierd.

3. when resizing panes on mac things seem to get highlight:

the main query mode seems fine it's all the new ones.

4. The surrealist icon is too big compared to other icons on macos:

Environment (you can view the current version under Settings):

• OS: Windows & MacOS
• Version 1.6.1

Grab and drop - user custom layout of sections

Describe your feature request
I think is a good idea to allow users to change positions in specific sections.
Currently is possible to change size only.

How can I build this from source on Linux?

Updating does not actually update.

Describe the bug
Whenever I download the newest .deb file in order to update the application, the installation proceeds as usual and the version number in apt is changed but Surrealist itself does not get updated and I have been stuck with v1.5.2 since. Not even uninstalling and reinstalling works.

Environment (you can view the current version under Settings):

• OS: Linux (Kali)
• Version 1.5.2

Allow to specify path

Describe your feature request
I use rocksdb as surrealdb backend so would be good if we can specify optional path when starting the surrealdb server.

surreal start -u root -p root -s file:///home/prabir/app/path_to.db

Are you willing to contribute this feature?
No

Record link has no destination

Describe the bug
After creating a record with the surrealdb library for python as follows: surrealdb_client.create_one("table", "123", {"data": 123})
On trying to open it a popup came out and say "Record link has no destination"
When I try to read data with surreal sql cli it gives me the correct data.

To Reproduce
Steps to reproduce the behavior:

1. Create a script in python with as https://github.com/surrealdb/surrealdb.py/blob/main/examples/http_client_example.py
2. use method create_one with a numeric id

Environment (you can view the current version under Settings):

• OS: Ubuntu

Red error line shows in multiline (with enter) SQL commands, long line (without enter) wont show an error.

Describe the bug
red error line shows in multiline SQL commands.
Long-line SQL commands won't show an error.

To Reproduce
Steps to reproduce the behavior:

if I move to another tab, and reopen this tab, then it won't show the error line,

after that, if I type anything in the current tab (which have multiline command), then immediately it shows an error line

Expected behavior
Don't show an error line.

Environment (you can view the current version under Settings):

• OS: Windows
• Version 10
• surrealist: 1.7.1

Flash of white background

Describe the bug
When I change from table to json view in the result options. Every time I see a flash of the white background of the query and variable sections (only on this two sections).

To Reproduce
Steps to reproduce the behavior:

1. Install Surrealist 1.4.1 on macOS (amd) with dark mode active
2. Click on table view and then change to json view again
3. See the flash of white background

Expected behavior
Don't flash my eyes 👀

Environment (you can view the current version under Settings):

• OS: macOS Ventura 13.0.1 (amd)
• Surrealist Version: 1.4.1

Static column headers

Describe your feature request
It would be nice if the column headers were static so that when I scroll down a long list of items the field names will still be visible on top.

Are you willing to contribute this feature?
Unfortunately no... I'm not familiar with the frontend you're using.

Connection Closed Unexpected connection close (1006) when trying to open table with 100k records

Describe the bug
I have a table with aproximatly 100k events. When I'm trying to navigate to the table view in explorer I get Connection Closed
Unexpected connection close (1006). Changings Results per page didn't help.

To Reproduce
Steps to reproduce the behavior:

1. Select Explorer
2. Click on some large table
3. Get Connection Closed Unexpected connection close (1006)

Expected behavior
Table records are shown.

Environment (you can view the current version under Settings):

• OS: Windows
• Version 1.5.2

Saved queries run only in the first tab (not the current open one)

Describe the bug
Saved queries run only in the first tab and not the currently open one.

To Reproduce
Steps to reproduce the behavior:

1. Open a few tabs
2. Go to tab 2 or 3 or 4 etc (not the first one)
3. Try to edit or run the saved query
4. See that you do not see anything expect to see
5. Go to the first tab - if you tried to edit the saved query, then this query will be in the query section (on the first tab instead of X tab)

Expected behavior
I would expect to see ( #12 ), or at least to work edit / run query in the currently open tab.

Environment (you can view the current version under Settings):

• OS: macOS Ventrua 13.0.1 (amd)
• Version 1.4.1

Record Selection

Describe your feature request
Currently, in the "Record Explorer" view, I have to click on the record id in order to display the record in the "Inspector". It would be nice if I were able to select the record by clicking anywhere in the row. This would especially be helpful if there are many fields: If I am scrolled far to the right (horizontally), then I have to scroll all the way back to the beginning in order to select a record for editing.

Are you willing to contribute this feature?
Not capable!

Add aur package for archlinux

Need to add webkit2gtk as deps then create surrealist-bin package in aur.

Can use https://github.com/marketplace/actions/publish-aur-package

Query: execute only selected text

Describe your feature request
Query window should execute only selected code, to make it easier to work with many different statements in one window.
Maybe you could also add a little run icon for statments in the gutter?
Are you willing to contribute this feature?
I hope I can help but I don't know Go and TS is not my strongest lang.

can no longer connect after update from 1.6.1 > 1.6.2

click connect and get this error connection closed: unexpected connection close 1006

The only way I could get it to work was to manually start a surreal instance in the CLI with args surreal start --user root --pass root

have these default credentials been removed?

macos ventura
version 1.6.2

Pressing `<ctrl> enter` in the `variables` tab does not execute the query

Just the title. Thank you for the awesome tool!

Add configurable global query timeout

Improve UX in `saved queries` functionality

Describe your feature request

I think there is a field for improving user experience in saved queries functionality.
I currently use PostmanCanary and would like to fully switch to Surrealist, but there are a few things that make my life easier with Postman than Surrealist that stop me from swapping it.

1. Moving parts of UI
   There is currently a little menu in saved queries with remove, copy, edit, and run query buttons. This menu is hidden by default and shows on hover which unfortunately comes to be very annoying as it is 'moving' all other queries in that section. Especially when are a lot of saved queries.

2. Transition
   The same menu (see 1.) has a transition on hover. It's invisible if your cursor is away. So if you want to run the saved query, you need to move the cursor on the query itself, wait a few ms, and move it to the run query button. It's one unnecessary step. Like the previous issue, it's going worst as you more often use this functionality. Especially when you have a lot of similar and long queries saved.

3. Conciseness
   I think only query names should be visible in the list of saved queries. Of course, the best solution will be to leave this to the end user and just allow them to define it in the settings. I have a 30' display and in Surrealist I can see only 6 queries at once vs 40 queries in Postman.

4. Opening of cards
   I believe the best way to handle saved queries will be to open the card with a specific query after clicking on it. Currently, we can only: copy, remove or run the query, but if the query is a long one we can't see what we actually copying, removing, or running. The edit functionality is bugged ( #13 ) making it unusable in some cases or at least not a nice experience. This will be a nice if opened tab will be named based on the saved query.

Wrong display of uint64 values

Describe the bug
unsigned integer 64 fields are not displayed correctly: create test:obj content {'test': 648518346479846132}; displays as

[
    {
        "id": "test:obj",
        "test": 648518346479846100
    }
]

Expected behavior
Should display as

[
    {
        "id": "test:obj",
        "test": 648518346479846132
    }
]

creating a record with a variable shows result as null

Describe the bug
While creating a record with a variable, it doesn't show the result, instead, it shows null, but the record created,
and record explorer is not automatically refreshed, it requires manual refresh

To Reproduce
Steps to reproduce the behavior:

1. use surrealist 1.7
2. simply create the record like in the image below

Expected behavior
Show Record

Environment (you can view the current version under Settings):

• OS: Windows
• Version 10

Incorrectly rendered values

Describe the bug
Certain values are rendered differently in the "Record explorer" view compared to the "Inspector" view

To Reproduce
Run the following query:

CREATE signup SET arrivalDate = '2023-10-01', arrivalFlight = 'DL 1234', arrivalTime = '6:30 PM'

Then open the record in the Explorer view.
This is what I see for example:

Expected behavior
I expect the fields in the "Record Explorer" to be rendered as they are shown in the "Inspector" view.

Environment (you can view the current version under Settings):

• OS: Windows
• Version 1.5.2

Thank you!

1.16.1 Filed to open connection

Describe the bug
Failed to construct 'WebSocket': An insecure WebSocket connection may not be initiated from a page loaded over HTTPS.

Scoop or Chocolatey support

Describe your feature request

I want to scoop install surrealist or cinst surrealist so I can keep my software manifest clean and reproducible

Are you willing to contribute this feature?
I don't know how to make the package manifests, but I am willing to learn to do so.

Failed to connect to insecure websocket

Describe the bug
When trying to connect to an external DB over http instead of the https the client fails and throws:

This behaviour appeares to be windows specific. Works fine on MacOS

To Reproduce

• Install surrealist using msi from github
• attempt to connect to external db over http

Expected behavior
Surrealist connects to db.

Environment (you can view the current version under Settings):

• OS: Windows
• Version 1.6.1