TablePlus

    In this tutorial, we will show how to connect TablePlus with all the 3 YugabyteDB APIs on a local cluster. TablePlus works without any issues with YugabyteDB because the YugabyteDB APIs are compatible at the wire protocol level with databases already supported by TablePlus.

    TablePlus is available on both macOS and Windows. Follow the links below to download.

    Install TablePlus after the download completes.

    Start a Local Cluster

    Follow the instructions in the Quick Start to create a local YugabyteDB cluster. We will use the macOS install instructions for the rest of this tutorial.

    Optionally, run the following command to initialize the YEDIS API.

    Click on TablePlus and then choose from the list of database types.

    Now enter the connection details as shown in the screenshot below and then click to ensure that TablePlus is indeed able to establish connectivity with the YugabyteDB API. The color of the fields will change to green if the test succeeds.

    YSQL

    Connect with Cassandra-compatible YCQL

    Repeat the above steps for the Cassandra type as shown below.

    Repeat the above steps for the Redis type as shown below.

    Explore with TablePlus

    Now you have connected to all the YugabyteDB APIs and can start exploring them by simply double-clicking on the connection name.

    YB ALL

    Follow the instructions from on how to best use TablePlus.

    tableplus integration: redis metadata commands should gracefully error for redis compatible yedis