Connecting to a MySQL Database

This document demonstrates how to set up a connection to a MySQL database from the NetBeans IDE. Once connected, you can begin working with MySQL in the IDE's Database Explorer by creating new databases and tables, populating tables with data, and running SQL queries on database structures and content. This tutorial is designed for beginners with a basic understanding of database management, who want to apply their knowledge to working with MySQL in NetBeans IDE.

To follow this documentation, you need the following software and resources.

Software or Resources Version Required
NetBeans IDE 8.0,8.1,8.2,9 or latest
Java Development Kit (JDK) version 11 or latest
MySQL database server version 5.7 or latest

Configuring MySQL Server Properties

NetBeans IDE comes bundled with support for the MySQL RDBMS. Before you can access the MySQL Database Server in NetBeans IDE, you must configure the MySQL Server properties.

  1. Right-click the Databases node in the Services window and choose Register MySQL Server to open the MySQL Server Properties dialog box
  2. Confirm that the server hostname and port are correct.
  3. Enter the Administrator user name (if not displayed).
  4. Enter the Administrator password. The default is set to blank.
  5. Click the Admin Properties tab at the top of the dialog box.
    Click the Admin Properties tab at the top of the dialog box.
  6. In the Path/URL to admin tool field, type or browse to the location of your MySQL Administration application such as the MySQL Admin Tool, PhpMyAdmin, or other web-based administration tools.
  7. Type any arguments for the admin tool in the Arguments field.

  8. In the Path to start command, type or browse to the location of the MySQL start command. To find the start command, look for mysqld in the bin folder of the MySQL installation directory.
  9. Type any arguments for the start command in the Arguments field.

  10. In the Path to stop command field, type or browse to the location of the MySQL stop command. This is usually the path to mysqladmin in the bin folder of the MySQL installation directory. If the command is mysqladmin, in the Arguments field, type -u root stop to grant root permissions for stopping the server.
  11. When finished, the Admin Properties tab should resemble the following figure. If you are satisfied with your configuration, click OK.

Starting the MySQL Server

Before you can connect to a MySQL Database Server, you must first ensure that the MySQL Database Server is running on your machine. If the database server is not connected you will see (disconnected) next to the user name in the MySQL Server node in the Service window and you will not be able to expand the node.

To connect to the database server, confirm that the MySQL Database Server is running on your machine, right-click the Databases > MySQL Server node in the Services window and choose Connect. You might be prompted to supply a password to connect to the server.

When the server is connected you will be able to expand the MySQL Server node and view the all available MySQL databases.

Creating and Connecting to the Database Instance

A common way of interacting with databases is through an SQL editor. NetBeans IDE has a built-in SQL Editor for this purpose. The SQL Editor is generally accessible via the Execute Command option from the right-click menu of the connection node (or of the connection node's child nodes). Now that you are connected to the MySQL server, you can create a new database instance using the SQL Editor. For purposes of this tutorial, create an instance called MyNewDatabase:

  1. In the IDE's Services window, right-click the MySQL Server node and choose Create Database. The Create MySQL Database dialog box opens.
  2. In the Create MySQL Database dialog box, type the name of the new database. We will use MyNewDatabase for this tutorial. Leave the checkbox unselected at this time.
  3. Click OK. The new database appears under the MySQL Server node in the Services window.
  4. Right-click the new database node and choose Connect in the popup menu to open the connection to the database. Database connections that are open are represented by a complete connection node (complete connection node icon) in the Services window.

Creating Database Tables

Now that you have connected to MyNewDatabase, you can begin exploring how to create tables, populate them with data, and modify data maintained in tables. This allows you to take a closer look at the functionality offered by the Database Explorer, as well as NetBeans IDE's support for SQL files.

MyNewDatabase is currently empty. In the IDE it is possible to add a database table by either using the Create Table dialog or by inputting an SQL query and running it directly from the SQL Editor. In the following exercises, you will use the SQL editor to create the Counselor table and the Create Table dialog box to create the Subject table. After you create the tables you will run an SQL script to populate the tables.

Using the SQL Editor

  1. In the Database Explorer, expand the MyNewDatabase connection node (connection node icon) and note that there are three subfolders: Tables, Views and Procedures.
  2. Right-click the Tables folder and choose Execute Command. A blank canvas opens in the SQL Editor in the main window.
  3. In the SQL Editor, type in the following query. This is a table definition for the Counselor table you are about to create.
                           CREATE TABLE Counselor (
                                id SMALLINT UNSIGNED NOT NULL AUTO_INCREMENT,
                                firstName VARCHAR (50),
                                nickName VARCHAR (50),
                                lastName VARCHAR (50),
                                telephone VARCHAR (25),
                                email VARCHAR (50),
                                memberSince DATE DEFAULT '0000-00-00',
                                PRIMARY KEY (id)
  5. To execute the query, either click the Run SQL (run SQL button) button in the taskbar at the top (Ctrl-Shift-E), or right-click within the SQL Editor and choose Run Statement. The IDE generates the Counselor table in the database, and you receive a message similar to the following in the Output window.
  6. .To verify changes, right-click the Tables node in the Database Explorer and choose Refresh. The Refresh option updates the Database Explorer's UI component to the current status of the specified database. Note that the new Counselor table node (table node icon) now displays under Tables in the Database Explorer. If you expand the table node you can see the columns (fields) you created, starting with the primary key (primary key node icon).
  7. Using the Create Table Dialog

    In this exercise, you will use the Create Table dialog box to create the Subject table.

    • In the Database Explorer, right-click the Tables node and choose Create Table. The Create Table dialog opens.
    • In the Table name text field, type Subject.
    • Click Add Column.
    • For the Name of the column, enter id. Choose SMALLINT for data type from the Type drop-down list. Click OK.
    • Select the Primary Key checkbox in the Add Column dialog box. You are specifying the primary key for your table. All tables found in relational databases must contain a primary key. Note that when you select the Key check box, the Index and Unique checkboxes are also automatically selected and the Null checkbox is deselected. This is because primary keys are used to identify a unique row in the database, and by default form the table index. Because all rows need to be identified, primary keys cannot contain a Null value.
    • Repeat this procedure by adding the remaining columns, as shown in the following table.
    Key Index Null Unique Column Name Data Type Size
    [checked] [checked] [checked] id SMALLINT 0
    [checked] name VARCHAR 50
    [checked] description VARCHAR 500
    [checked] FK_counselorID SMALLINT 0

You are creating a table named Subject that will hold data for each of the following records.

Name: name of the subject

Description:description of the subject

Counselor ID:counselor ID that corresponds to an ID from the Counselor table

Make sure that the fields in your Create Table dialog match those shown above, then click OK. The IDE generates the Subject table in the database, and you can see a new Subject table node (table node icon) immediately display under Tables in the Database Explorer.

Working with Table Data

In order to work with table data, you can make use of the SQL Editor in NetBeans IDE. By running SQL queries on a database, you can add, modify and delete data maintained in database structures.

To add a new record (row) to the Counselor table, do the following:

  1. Choose Execute Command from the Tables folder in the Database Explorer. A blank canvas opens in the SQL Editor in the main window.
  2. In the SQL Editor, type in the following query.
                        INSERT INTO Counselor
                        VALUES (1, 'Ricky', '"The Dragon"', 'Steamboat','334 612-5678', '', '1996-01-01')
  4. To execute the query, right-click within the SQL Editor and choose Run Statement. In the Output window, you can see a message indicating that the query was successfully executed.
  5. To verify that the new record has been added to the Counselor table, in the Database Explorer, right-click the Counselor table node and choose View Data. A new SQL Editor pane opens in the main window. When you choose View Data, a query to select all the data from the table is automatically generated in the upper region of the SQL Editor. The results of the statement are displayed in a table view in the lower region. In this example, the Counselor table displays. Note that a new row has been added with the data you just supplied from the SQL query.
Running an SQL Script

Another way to manage table data in NetBeans IDE is by running an external SQL script directly in the IDE. If you have created an SQL script elsewhere, you can simply open it in NetBeans IDE and run it in the SQL Editor.

For demonstrative purposes, download ifpwafcad.sql and save it to a location on your computer. This script creates two tables similar to what you just created above (Counselor and Subject), and immediately populates them with data.

Because the script overwrites these tables if they already exist, delete the Counselor and Subject tables now so it becomes obvious that new tables are being created when the script is run. To delete tables:

  • Right-click the Counselor and Subject table nodes in the Database Explorer and choose Delete.
  • Click Yes in the Confirm Object Deletion dialog box. Note that the dialog box lists the tables that will be deleted.

When you click Yes in the Confirm Object Deletion dialog box, the table nodes are automatically removed from the Database Explorer.

To run the SQL script on MyNewDatabase:

  1. Choose File > Open File from the IDE's main menu. In the file browser navigate to the location where you previously saved ifpwafcad.sql and click Open. The script automatically opens in the SQL Editor.
  2. Make sure your connection to MyNewDatabase is selected from the Connection drop-down box in the toolbar at the top of the Editor.
  3. Click the Run SQL (run SQL button) button in the SQL Editor's taskbar. The script is executed against the selected database, and any feedback is generated in the Output window.
  4. To verify changes, right-click the MyNewDatabase connection node in the Runtime window and choose Refresh. The Refresh option updates the Database Explorer's UI component to the current status of the specified database. Note that the two new tables from the SQL script now display as a table nodes under MyNewDatabase in the Database Explorer.
  5. Choose View Data from the right-click menu of a selected table node to see the data contained in the new tables. In this manner, you can compare the tabular data with the data contained in the SQL script to see that they match.

Configuration #

User can add one or more element according to the requirement before creating a new project. Here user can specify the nature of the document, refer a file, create new task, add new vendor etc.

Task Configurations #

Tasks needs to be configured before creating project. Tasks are important and can be customized based on your project workflow.

Steps to create tasks –
  1. Go to ‘Task(s)’ under ‘Configuration’
  2. Enter ‘Task Name’ and Select ‘Task Type’
  3. Click on ‘Submit’

Submitted task will be added to the list below and these tasks will be part of

project creation. Now you can create project with these created tasks.


User can also create category according to the nature of the document before creating a new project.
For example document might be related to Finance,Educational,Banking,Entertainment,Legal etc. In that way user first create the category based on the nature and then select that category during creating new project.

Category Name: User can mention any names that he wants in characters.

Category description: User can also write description regarding the category.

User can also search for the category if it's already existed or not in the list shown in the image. If it is already existed user do not need to create new category and can choose the same while creating a new project.

Add Vendors#

Agency Email: To add a vendor or agency user need to enter agency's mail id and click on the submit button as shown in the below image:

Once submit you can see the agency email id in the list as shown in the below image:

Agency Name: Till the time agency or vendor will not register and logged into the portal, the Agency name column will shows "Never logged in" status. Once vendor register and log in, it automatically show the name of the agency here.

This way user can add a new vendor and during creating a new project he can select vendor from the drop down list. Then it depends on the vendor whether he wants to accept the project or not.

Reference files#

Here user can also refer project or document to agency or translator for their better understanding. In some cases user can also refer one particular project for changes he wants to make in the project by uploading reference file.

As shown in the image above if user wants to refer a project "Neha 2" then he will click on the "+" button to expand it. User can send the file to agency or to translator or both of them by clicking on the check box and then click on the upload option shown next to the name of file.

User Management#

For privacy and security reasons main user(owner) of the software can grant authorities to agencies and translator according to their requirements. Here main user can define the role and can assign them to different users.

Assign role to user: To assign the role following steps required:

User email id: Enter user e-mail id whom you want to grant the authorities.

Select role(s):select a role from the drop down list.

Description: Add description of the role if required

Click on "Submit" button.

After clicking on submit button, you will see in the below list (as shown in the image above) that the role has been assigned to the particular user. You can also edit the role by clicking on " Edit" option, can take back the authorities by clicking on the "Delete" option and can also activate and deactivate the user by clicking on "active" or "Deactive" options.

Define a role: To define a new role following steps required:

Role Name:Enter any name you want to define the rale.

Permission(s): Select one or more permissions from the drop down list.

Description:Describe the role if required.

Click on the "Assign" button.

After clicking on the submit button, you can see the role name and the permissions assigned to the role name in the list below(as shown in the images above). If required you can also add or remove one or more permissions to the same role name by clicking on "Edit" button.