Couchbase Query
note
You need to create and open a project from the Welcome Screen. Only after that you will see the DataGrip interface and will be able to create connections.
For full information about Couchbase Query, refer to the official documentation.
To download Couchbase Query database software, refer to the official software downloads.
This topic presents a general procedure on how you can create a data source for the connection to your Couchbase Query database in DataGrip, and run a test connection. It is assumed that you already have the necessary prerequisites 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.
note
DataGrip supports the Couchbase Query service, not the Couchbase Analytics service.
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.
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 Explorer ( View | Tool Windows | Database Explorer) , click the New icon () in the toolbar. Navigate to Data Source and select Couchbase Query.
In the General tab of Data Sources and Drivers dialog right pane, specify the driver and connection type.
In the Driver list, leave the default driver option, unless another driver is required for your connection.
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.
note
For the URL only connection type, the JDBC URL is stored in plain text as is, and is also available in IDE log file and data source information.
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.
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 DataGrip configuration directory.
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.
Specify the database connection details. Alternatively, paste the JDBC URL in the URL field.
defaultURL onlyIn the Host field, type your server address.
In the Port field, type the port of Couchbase Query. The default port is 11210.
note
Real port numbers might be different on your system. Verify that you use a correct port number with your database administrator, server settings, or hosting provider.
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.
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.
Paste the database default bucket name in the Default bucket field.
In the URL field, DataGrip 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.
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.
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.
In the URL field, DataGrip 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.
warning
For the URL only connection type, the URL field contents are stored in plain text, and are also available in the IDE log file.
Use the designated fields to provide your sensitive connection details instead of putting them into the URL field.
For the reference information about connection settings and properties on the General and other tabs of Data Sources and Drivers dialog () , see Connection settings and DBMS-specific properties.
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.
In case of any connection issues, refer to the Cannot connect to a database page.
(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.
Click OK to create the data source.
Find your new data source in Database Explorer () .
For more information about Database Explorer, see the corresponding reference topic.
tip
To see more namespaces under your new data source node, click the N of M button and select the ones you need. DataGrip will introspect and show them.
For more information about displaying namespaces in Database Explorer, refer to the Show all databases or schemas tutorial.
For more information about working with database objects in DataGrip, refer to Database objects.
To write and run queries, open the default query console by clicking the data source and pressing .
To view data of a database object, open Data editor and viewer by double-clicking the object.
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 () , see Data Sources.
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 |