Surrealist Documentation

Surrealist provides several tools for database management and development:

• Visual Querying: Query View with syntax highlighting, saved queries, and graph visualization.
• Data Exploration: Explorer View for browsing tables, inspecting records, and following relationships.
• Schema Designing: Designer View for visual schema diagrams and creation.
• AI Assistance: 'Ask Sidekick' AI assistant for writing queries and designing schemas.
• Management: Integrated SurrealDB Cloud management panel, database access rules, user accounts, and resource permissions.
• Advanced Capabilities: GraphQL querying support, SurrealML model uploads, auto-generated API documentation, and stored procedure/function management.

Surrealist 3.0 introduces a dedicated GraphQL view. You can use this view to execute GraphQL queries against your database. It includes features such as:

• Live query validation and error checking.
• Full GraphQL syntax highlighting.
• Full support for query variables.

Surrealist includes an integrated management panel for SurrealDB Cloud. This allows you to:

• Provision and connect to Cloud instances.
• Manage billing.
• Monitor usage.

The Cloud management panel is accessible in both the Web and Desktop applications.

Surrealist 3.0 allows for more flexible connection management:

• Connect to an instance without immediately selecting a namespace or database.
• Switch namespaces and databases on-the-fly.
• Create and remove namespaces and databases directly from the toolbar.

The Web App is the quickest way to start using Surrealist directly in your browser. Visit the following URL to begin:

https://app.surrealdb.com/

The Authentication view has been overhauled to be compatible with SurrealDB 2.0. You can manage system users and access methods at three different levels:

• Root level
• Namespace level
• Database level

Authentication can be configured through redesigned editor dialogs.

The Desktop App is the recommended way to interact with SurrealDB as it supports additional features not available in the web version, such as:

• Local database serving
• Opening queries directly from your disk

You can download the latest version from the official download page or via the GitHub releases page.

You can customize the following settings for the database serving console:

• History size
• Log level

When using Surrealist, keep the following in mind:

• Version Compatibility: Surrealist aims to support the latest stable releases of SurrealDB. Support for nightly builds is not guaranteed.
• Remote Connections: Connecting to remote servers may require an HTTPS connection. You can configure SSL for your server using tools like letsencrypt and nginx.

Surrealist exports boolean constants that allow you to check which environment the current adapter belongs to. These are useful for conditional logic in your application (e.g., showing different UI components for Desktop vs. Browser).

• isDesktop: true if using DesktopAdapter.
• isBrowser: true if using BrowserAdapter.
• isDocker: true if using DockerAdapter.
• isMini: true if using MiniAdapter.