Studio

To use the ArcadeDB Studio, point your web browser to the server and port that hosts the ArcadeDB server (in "development" or "test" mode). For instance, when running ArcadeDB locally with the default port this means: http://localhost:2480 .

Command

The first and most important panel in Studio is the Command panel. Below you can find a screenshot with the main components.

studio command panel explained

  • Main Menu is the vertical tab with the following options:

    • Query, the command panel to execute queries and commands against the database

    • Database, containing the information about the selected database and its schema. From this panel you can switch to a different database

    • Server, monitoring and administration of the server including metrics, events, settings, and backup configuration

    • Cluster, high availability cluster status and management (when HA is enabled)

    • API, with the description of the public HTTP API exposed on the current server

    • AI Assistant, an AI-powered assistant that helps you write queries, explore your data, and learn ArcadeDB features directly from Studio. An activation key is required and can be purchased from the Pricing page

    • Info, containing a quick reference to the online documentation

Execute a command/query

In order to execute a command (or query), select the language first. By default is SQL, but you can choose between:

  • SQL (for any models, including graphs and documents)

  • SQL Script (multiple commands/queries)

  • Apache Tinkerpop Gremlin (only for graphs)

  • Open Cypher (only for graphs)

  • MongoDB (only for documents)

  • GraphQL

studio command select language

Based on the selected language, the command text area will adjust the syntax highlighting to simplify the writing of the command.

The result of the command will appear in the Command Result area as a Graph a Table or tools/studio/json.adoc#studio-json.