Creating and Managing Database Connections with DBeaver

This topic explains how to work with the DBeaver plugin to create and manage databases in Zend Studio. DBeaver supports any database which has JDBC driver, and may handle any external data source which may or may not have a JDBC driver.

Prerequisistes

Connecting to a Database

This procedure explains how to establish a connection to a database using DBeaver.

 

 

Instructions on how to complete a procedure

To connect to a database :

  1. In the menu-bar, select Window | Show View | Database Navigator.
    The Database Navigator view is displayed.

  1. In the view's toolbar, click the Select active project icon to select a project you wish to create the database connection for.
  2. In the view's toolbar, click the New Connection Wizard icon .
    The Create new connection wizard is displayed.

  1. Select the database connection type, and click Next.
    If the driver for the connection type you selected has not been installed, you will be prompted to install it.

  1. Click Yes to download and install the driver files for the selected database.
    The driver is installed, and the Connection Settings dialog is displayed according to the database type you selected.

  1. Enter the general parameters for connecting to your database. These details may vary according to the database type, but they usually consist of the following parameters:
  • JDBC URL - Database URL. This field is editable only if the database driver doesn't have sample URL. Otherwise its value will be automatically changed whene you change other connection settings.
  • Host - Database host name.
  • Port - Database port number. Usually this field is optional. If left blank then the default database port will be used.
  • Database/Schema - Name of remote database/schema.
  • Server - Name of remote server.
  • User name/Password - User credentials. May be left blank for some drivers (e.g. for embedded databases).

Note:

Under the Advanced tab, you can configure advanced connections settings, e.g., Character Coding.

  1. Click Next.
    The Finish connection creation dialog is displayed.

 

  1. To test the connection before establishing the connection, click Test Connection.
  2. Configure the name and type of your connection (Development, Test, Connection), and click Finish.
    DBeaver establishes the new connection, which is displayed in the Database Navigator view.

  1. Expand the connection folders to view existing databases and tables. Generally, connections contain catalogs, catalog contains schemas, schemas contain tables, indexes, and procedures. Elements in the navigator view can be opened/edited/deleted/etc - possible additional actions are accessible through the context menu and/or toolbar.

 

Managing Connection Drivers

A database driver is a third-party library which provides the ability to work with specific database engines. The driver manager dialog allows you to create, delete and edit driver descriptions.

 

 

Instructions on how to complete a procedure

To manage your connection drivers:

  1. In the menu-bar, select Window | Show View | Database Navigator.
    The Database Navigator view is displayed.

  1. In the view's toolbar, click the Driver Manager icon .
    The Drive Manager dialog is displayed.

  1. To install a database driver, double-click a driver from the list.
    If the driver for the connection type you selected has not been installed, you will be prompted to install it.

  1. Click Yes to download and install the selected driver.
    The driver is installed, and the Edit Driver dialog is displayed.

  1. Edit the driver:
  • Driver name - Name of driver, shown in the driver manager. May be used by DBeaver to name scripts, show tips, etc.
  • Category (Optional) - Some databases have many different drivers, it is convenient to group these drivers. Category is just a name for this group. Most drivers do not have category.
  • Class name - Required field. It is a name of Java class which implements the driver. You may find the class name in the driver's documentation or click on the "Find Class" button in the "Driver Libraries" tab and choose the class name from the list.
  • Sample URL (Optional)- If this value is left blank, you will need to specify the full database URL. It is much more convenient when the sample URL is specified - in this case the connection wizard will require only valuable connection properties (host name, database name, etc).

Note:

For a full breakdown of the available driver editing options, in the Menu bar, go to Help | Help Contents | DBeaver Help | Manage Connections | Driver editor dialog.

  1. and click OK.
  2. To create a driver of your own, click New.
    The Create new driver dialog is displayed.

  1. Edit the driver according to the parameters specified in Step 5 above.
  2. To remove a driver, select the driver from the list, and click Remove.
  3. Click Yes, when prompted to approve the action.
    The driver is removed.

 

Working with your Database

Once you have established your connection, you can now begin to work with the data in your database using DBeaver.

Running SQL Queries and Scripts

This procedure will explain how to run SQL queries or scripts in your database using DBeaver.

 

 

Instructions on how to complete a procedure

To run SQL queries or scripts using DBeaver:

  1. In the menu-bar, select Window | Open Perspective | DBeaver.
    The DBeaver perspective is displayed.

  1. In the Toolbar, click the Open SQL Editor icon to edit and execute SQL queries and scripts.
    The SQL Editor is displayed.

  1. Enter SQL script, or right-click inside the editor, and select Load SQL Script to import an existing file.
  2. To execute, right-click inside the editor, and select Execute SQL Statement or Execute SQL Script.
    You can view a history of all the commands executed in the current SQL editor in the Execution Log tab.

Note:

For more information on working with data and metadata using DBeaver, select Help | Help Contents | DBeaver Help | Work with data from the menu-bar.

Setting Active Database

Instead of manually running a 'use database' query with a database prefix for each SQL script or query you wish to run, you can define a database as being 'active' to directly run SQL scripts and queries.

 

 

Instructions on how to complete a procedure

To set a database as active:

  1. In the menu-bar, select Window | Open Perspective | DBeaver.
    The DBeaver perspective is displayed.

  1. In the Database Navigator, right-click a database, and select Set Active.
    Any SQL query or script that you execute will be run on the active database.