Onyx Database Browser

Onyx Database Browser License
View purchasing options
Onyx Database Browser can be purchased and downloaded using the following link: Purchase Here

To debug and inspect your database instance you can install Onyx Database Browser. This desktop application can connect to a local database or a remote database endpoint. Use it as a development companion and to inspect your data.

Getting Started with Onyx Database Browser

  1. Connecting to a Database

    When starting the application, use the dialog to connect to either a local or remote database. Connect to a remote database by specifying the location as a server:port value. For Example

    Screenshot of connecting to a database
    A local database can be selected by clicking on the Folder icon. The entire database directory must be selected.
    Specify the SSL properties by checking the SSL box and indicating the Keystore and Trust Store information.
  2. Viewing Schema

    Your schema is displayed using the left navigation panel. There are 2 tabs, Schema and Queries. Select the schema tab.

    Screenshot of database schema
    The schema is divided into System Entities and User Entities. System entities are required Onyx entities that determine system properties.

    Double click on an item within the tree to view entity properties such as relationships, indexes, attributes, and partitions

    Screenshot of database schema details
  3. Creating and Saving Queries

    Select the query tab in the left navigation panel. By default there is a Kotlin and a Java query for example.

    You can create a new Query by either right clicking on the tree or clicking the New Query link. After doing so, you will be prompted to define the type as either Kotlin or Java.

    Create a new Query
    The Queries are automatically saved and stored within the Database. They are publicly available for anyone to use within the Database.
    You can organize the queries by grouping them within directories.
  4. Executing Queries

    Execute the selected query by clicking the Execute button.

    Create a new Query
    You can also execute the query by right clicking and select the Run Query item within the query tree's context menu.
  5. Viewing Results

    The Query results is divided into 3 sections including Results, Tree, and Console

    To view the results within a table excluding relationship information select the Result tab

    Database browser result table

    To view the result object graph including relationships select the Tree tab

    Database browser result tree

    To view script output and potential compile or runtime errors select the Console tab

    Database browser result console
  6. Updating Records

    Update records by double clicking within the Result view table.

    Save the record by clicking the Save Record link.

    Database browser modify an entity

    You can also delete entities by using the right click context menu.

    Database browser delete or add an entity
    Rather than using the context menu or UI, alternatively you can use the script to run delete and update queries.
    Onyx does not have a concept of transactions so any updates made are final.