RubyMine 2024.3 Help

Couchbase Query

Enable the Database Tools and SQL plugin

This functionality relies on the Database Tools and SQL plugin, which is bundled and enabled in RubyMine by default. If the relevant features are not available, make sure that you did not disable the plugin.

  1. Press Ctrl+Alt+S to open settings and then select Plugins.

  2. Open the Installed tab, find the Database Tools and SQL plugin, and select the checkbox next to the plugin name.

Before you begin

This topic presents a general procedure on how you can create a data source for the connection to your Couchbase Query database in RubyMine, and run a test connection. It is assumed that you already have the necessary connection details and the database is up and running.

For example, if you want to run a database on your machine and connect to that database, the corresponding DBMS software must be installed on the machine first.

To learn about your DBMS software, refer to its official documentation.

You can skip the port field or set the port number to 11210 that is the default port for the Couchbase Query Service.

For Couchbase Query, data editing is currently not supported.

Connect to a Couchbase Query database

  1. To connect to the database, create a data source that will store your connection details. You can do this using one of the following ways:

    • In the main menu, go to File | New | Data Source and select Couchbase Query.

    • In the Database tool window (View | Tool Windows | Database) , click the New icon (the New icon) in the toolbar. Navigate to Data Source and select Couchbase Query.

    Create a new data source
  2. In the General tab of Data Sources and Drivers dialog right pane, specify the driver and connection type.

    1. In the Driver list, leave the default driver option, unless another driver is required for your connection.

    2. From the Connection type list, select the connection type depending on the connection details that you have:

      • default: connect by using Host, Port, Default bucket, and URL.

      • URL only: connect by using only the URL.

      For the URL only connection type, the JDBC URL that you enter is used and as is, including the database credentials.

      For the other connection types, the JDBC URL is broken down into connection details. You can either specify them separately and use the automatically generated URL, or you can enter the URL directly in the corresponding field.

    General tab of the Data Sources and Drivers dialog
  3. Check if there is a Download missing driver files link at the bottom of the connection settings area. Click this link to download drivers that are required to interact with a database. For a direct download link, refer to the JetBrains JDBC drivers page.

    Location for the downloaded JDBC drivers is the RubyMine configuration directory.

    The Download missing driver files link

    You can also use your drivers for the database instead of the provided ones. For more information about connecting to a database with your driver, refer to Add a user driver to an existing connection.

    If there is no Download missing driver files link, then you already have the required drivers.

  4. Specify the database connection details. Alternatively, paste the JDBC URL in the URL field.

    1. In the Host field, type your server address.

    2. In the Port field, type the port of Couchbase Query. The default port is 11210.

    3. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:

      • User & Password: by using your login and password.

      • No auth: authentication is not required.

    4. In the User and Password fields, type your user credentials.

      To use no password, leave the Password field empty.

      To delete a once entered password, right-click the Password field and select Set Empty.

      the Set Empty context menu action
    5. Paste the database default bucket name in the Default bucket field.

    6. In the URL field, RubyMine generates the JDBC URL automatically using the values of other connection settings.

      If you need to use a JDBC URL with certain additional settings, paste it in the URL field. The general URL to use is as follows:

      • Format: jdbc:couchbase:<host_address>:<port_number>/<database_name>

      • Example: jdbc:couchbase:127.0.0.1:11210/myDatabase

      For more information about the URL format, refer to the driver documentation.

    Database connection details
    1. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:

      • User & Password: by using your login and password.

      • No auth: authentication is not required.

    2. In the User and Password fields, type your user credentials.

      To use no password, leave the Password field empty.

      To delete a once entered password, right-click the Password field and select Set Empty.

      the Set Empty context menu action
    3. In the URL field, RubyMine generates the JDBC URL automatically using the values of other connection settings.

      If you need to use a JDBC URL with certain additional settings, paste it in the URL field. The general URL to use is as follows:

      • Format: jdbc:couchbase:<host_address>:<port_number>/<database_name>

      • Example: jdbc:couchbase:127.0.0.1:11210/myDatabase

      For more information about the URL format, refer to the driver documentation.

    Database connection details

    For the reference information about connection settings and properties on the General and other tabs of Data Sources and Drivers dialog (Ctrl+Alt+Shift+S) , see Connection settings and DBMS-specific properties.

  5. Ensure that the connection to the database can be established using the provided details. To do that, click the Test Connection link at the bottom of the connection details area.

    Test Connection link

    In case of any connection issues, refer to the Cannot connect to a database page.

  6. (Optional) By default, only the default namespace is introspected and available to work with. If you also want to work with other namespaces, in the Schemas tab, select them for the introspection.

    Schemas tab of the Data Sources and Drivers dialog
  7. Click OK to create the data source.

  8. Find your new data source in the Database tool window (⌘ 1) .

    • For more information about the Database tool window, see the corresponding reference topic.

    • For more information about working with database objects in RubyMine, refer to Database objects.

    • To write and run queries, open the default query console by clicking the data source and pressing F4.

    • To view data of a database object, open Data editor and viewer by double-clicking the object.

Connection settings and DBMS-specific properties

Connection settings

For the reference information about connection settings (for example, Host, Port, and so on) on the General and other tabs of Data Sources and Drivers dialog (Ctrl+Alt+Shift+S) , see Data Sources.

DBMS-specific properties

General tab

Item

Description

Connection type

Default bucket

In Couchbase Query, a bucket is the fundamental space for storing data in Couchbase Server. Default bucket is the one configured the first time you access the administration console. For more information about Couchbase Query buckets, refer to the official documentation.

default

Last modified: 15 November 2024