Apache Derby

Enable the Database Tools and SQL plugin

This functionality relies on the Database Tools and SQL plugin, which is bundled and enabled in JetBrains Rider 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.

Official documentation and software

• For full information about Apache Derby, refer to the official documentation.

• To download Apache Derby database software, refer to the official software downloads.

Connect to an Apache Derby database

1. In the Database tool window ( View | Tool Windows | Database) , click New and select Connect to Database.

2. If you have a connection string for the database defined in your solution or elsewhere, leave the Use connection string option selected and choose Apache Derby in the Database type selector.

   Use the String selector to choose the desired connection string from your solution or type it in manually, then click Connect.

3. You can also choose Add data source manually, click Next and select Apache Derby in the Database source selector. Follow the wizard steps to form the connection string by configuring individual options.

4. To access all available options for the new database connection, click in the Database window, then click New and select Apache Derby.

5. In the General tab of Data Sources and Drivers dialog right pane, specify the driver and connection type.

   1. From the Driver list, select the JDBC driver for your connection.

      For Apache Derby, the supported drivers are Apache Derby (Embedded) and Apache Derby (Remote). For more information about Apache Derby databases, refer to the official documentation: embedded databases, remote databases.

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

      Connection types for Apache Derby (Embedded)

      • Embedded: connect by using the path to the database folder.

      • In-Memory: connect to a temporary database stored entirely in the main memory.

      • URL only: connect by using only the URL.

      Connection types for Apache Derby (Remote)

      • default: connect by using Host, Port, Database, 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.

   

6. 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 JetBrains Rider 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.

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

   Connection types and settings for Apache Derby (Embedded)

   1. Enter the path to the database file or folder in Path. Alternatively, click the Open icon () and navigate to it.

   2. 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.

   3. 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.

      

   4. Tick the Create Database checkbox to create a new database and connect to it.

      For more information, refer to the DBMS-specific General tab reference.

   5. In the URL field, JetBrains Rider 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:derby:<path_to_the_file_or_folder>

      • Example: jdbc:derby:myDatabase

      For more information about the URL format, refer to the Apache Derby official documentation.

   

   1. Enter the path to the database file or folder in Path. Alternatively, click the Open icon () and navigate to it.

   2. 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.

   3. 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.

      

   4. Tick the Create Database checkbox to create a new database and connect to it.

      For more information, refer to the DBMS-specific General tab reference.

   5. In the URL field, JetBrains Rider 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:derby:memory:<path_to_the_file_or_folder>

      • Example: jdbc:derby:memory:myDatabase

      For more information about the URL format, refer to the Apache Derby official documentation.

   

   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.

      

   3. In the URL field, JetBrains Rider 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.

      For more information about the URL format, refer to the Apache Derby official documentation.

   

   Connection types and settings for Apache Derby (Remote)

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

   2. In the Port field, type the port of Apache Derby. The default port is 1527.

   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.

      

   5. In the Database field, type the database name to which you want to connect.

   6. In the URL field, JetBrains Rider 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:derby://<host_address>:<port_number>/<database_name>

      • Example: jdbc:derby://127.0.0.1:1527/myDatabase

   

   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.

      

   3. In the URL field, JetBrains Rider 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:derby://<host_address>:<port_number>/<database_name>

      • Example: jdbc:derby://127.0.0.1:1527/myDatabase

   

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

8. 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.

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

   

10. Click OK to create the data source.

11. 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 JetBrains Rider, refer to Database objects.

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

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