Working with the Java DB (Derby) Database
This document demonstrates how to set up a connection to Java DB database in NetBeans IDE. Once a connection is made, you can begin working with the database in the IDE, allowing you to create tables, populate them with data, run SQL statements and queries, and more.
The Java DB database is Sun’s supported distribution of Apache Derby. Java DB is a fully transactional, secure, standards-based database server, written entirely in Java, and fully supports SQL, JDBC API, and Java EE technology. The Java DB database is packaged with the GlassFish application server, and is included in JDK 6 as well. For more information on Java DB database, consult the official documentation.
To follow this tutorial, you need the following software and resources.
|Software or Resource||Version Required|
version 10.4.x, 10.5.x
|Java DB is installed when you install JDK 7 or JDK 8 (except on Mac OS X). If you are using Mac OS X you can download and install Java DB manually or use the Java DB that is installed by Java EE version of the NetBeans IDE installer.|
Configuring the Database
If you have the GlassFish Server registered in your NetBeans IDE installation, Java DB will already be registered for you. Therefore, you can skip ahead to Starting the Server and Creating a Database.
If you downloaded the GlassFish server separately and need help registering it in NetBeans IDE, see Registering a GlassFish Server Instance in the IDE’s Help Contents (F1).
If you just downloaded Java DB on its own, perform the following steps.
Run the self-extracting file. A folder named 'javadb' will be created in the same location as the file. If you just downloaded Java DB and want to have the database server reside in a different location than where it was extracted to, you should relocate it now.
On your system, create a new directory to be used as a home directory for the individual instances of the database server. For example, you can create this folder in the Java DB root directory (javadb) or in any other location.
Before continuing further, it is important to understand the components found in Java DB’s root directory:
demosubdirectory contains the demonstration programs.
binsubdirectory contains the scripts for executing utilities and setting up the environment.
javadocsubdirectory contains the API documentation that was generated from source code comments.
docssubdirectory contains the Java DB documentation.
libsubdirectory contains the Java DB jar files.
Registering the Database in NetBeans IDE
Now that the database is configured, perform the following steps to register Java DB in the IDE.
In the Services window, right-click the Java DB Database node and choose Properties to open the Java DB Settings dialog box.
For the Java DB Installation text field, enter the path to the Java DB root directory (javadb) that you specified in the previous step.
For Database Location, use the default location if a location is already provided. Click OK
For example, the default location might look like
C:\Documents and Settings\username\.netbeans-derby on a Windows machine.
Note. If the Database Location field is empty you will need to set the path to the directory that contains your databases. You will need to create a directory for the databases if no directory exists.
Starting the Server and Creating a Database
The Java DB Database menu options are displayed when you right-click the Java DB node in the Services window. This contextual menu items allow you to start and stop the database server, create a new database instance, as well as register database servers in the IDE (as demonstrated in the previous step). To start the database server:
In the Services window, right-click the Java DB node and choose Start Server. Note the following output in the Output window, indicating that the server has started: image::images/output-start-db.png
Right-click the Java DB node and choose Create Database to open the Create Java DB Database dialog.
contactfor the Database Name.
nbuserfor the User Name and Password. Click OK. image::images/javadb-createdb.png
Note. The Database Location is the default location set during installation of Java DB from GlassFish. If you installed Java DB separately, this location might be different.
After you create the database, if you expand the Databases node in the Services window you can see that the IDE created a database connection and that the database was added to the list under the Java DB node.
Connecting to the Database
So far, you have successfully started the the database server and created a database instance named
contact in the IDE. In the Services window of the IDE you can perform the following common tasks on database structures.
creating, deleting, modifying tables
populating tables with data
viewing tabular data
executing SQL statements and queries
In order to begin working with the
contact database, you need to create a connection to it. To connect to the
contact database perform the following steps.
Expand the Databases node in the Services window and locate the new database and the database connection nodes.
The database connection node( image::images/connection-node-icon.png) is displayed under the Databases node. The name of the database is displayed under the Java DB node.
Note. You will also see the
sample [app on APP] database connection that is the default database schema.
Right-click the contact database connection node (
jdbc:derby://localhost:1527/contact [nbuser on NBUSER]) and choose Connect.
The connection node icon appears whole ( image::images/connection-node-icon.png), signifying that the connection was successful.
3. Create a convenient display name for the database by right-clicking the database connection node (
jdbc:derby://localhost:1527/contact [nbuser on NBUSER] ) and choosing Rename. Type
Contact DB in the text field and click OK.
contact database that you just created is currently empty. It does not yet contain any tables or data. In NetBeans IDE you can add a database table by either using the Create Table dialog, or by inputting an SQL statement and running it directly from the SQL Editor. You can explore both methods:
Using the Create Table Dialog
Contact DBconnection node and note that there are several schema subnodes. The app schema is the only schema that applies to this tutorial. Right-click the APP node and choose Set as Default Schema.
Expand the APP node and note that there are three subfolders: Tables, Views and Procedures. Right-click the Tables node and choose Create Table to open the Create Table dialog box.
In the Table Name text field, type
Click Add Column. The Add Column dialog box appears.
For Column Name, enter
id. For Data Type, select
INTEGERfrom the drop-down list.
Under Constraints, select the Primary Key checkbox to specify that this column is the primary key for your table. All tables found in relational databases must contain a primary key. Note that when you select the Primary Key check box, the Index and Unique check boxes are also automatically selected and the Null check box is deselected. This is because primary keys are used to identify a unique row in the database, and by default are used as the table index. Because all rows must be identified, primary keys cannot contain a
Repeat this procedure now by specifying fields as shown in the table below:
|Key |Index |Null |Unique |Column name |Data type |Size
|[checked] |[checked] |[checked] |id |INTEGER |0
|[checked] |firstName |VARCHAR |20
|[checked] |lastName |VARCHAR |20
|[checked] |nickName |VARCHAR |30
|[checked] |friendSince |DATE |0
|[checked] |email |VARCHAR |60
You are creating a table named
* First Name
* Last Name
* Nick Name
* Friend Since Date
* Email Address
When you are sure that your Create Table dialog contains the same specifications as those shown above, click OK. The IDE generates the
=== Using the SQL Editor:
1. In the Service window, either right-click the
CREATE TABLE "COLLEAGUES" ( "ID" INTEGER not null primary key, "FIRSTNAME" VARCHAR(30), "LASTNAME" VARCHAR(30), "TITLE" VARCHAR(10), "DEPARTMENT" VARCHAR(20), "EMAIL" VARCHAR(60) ); ----
*Note: *Statements and queries formed in the SQL Editor are parsed in Structured Query Language. SQL adheres to strict syntax rules which you should be familiar with when working in the IDE’s editor. SQL syntax can also differ depending on the database management system. See the JavaDB Reference Manual for specific guidelines.
3. Click the Run SQL (image::images/run-sql-button.png) button in the task bar at the top of the editor (Ctrl-Shift-E) to execute the query. In the Output window (Ctrl-4), a message displays indicating that the statement was successfully executed.
4. To verify changes, right-click the
== Adding Table Data
Now that you have created one or more tables in the
* Write an SQL statement in the SQL Editor that supplies a value for every field present in the table schema. * Use the SQL Editor to add records to the table. * Use an external SQL script to import records to the table.
Read the sections below to learn how to use all these methods of populating the
=== Running an SQL Statement
1. Expand the Tables under the
INSERT INTO APP.FRIENDS VALUES (1,'Theodore','Bagwell','T-Bag','2004-12-25','firstname.lastname@example.org') ----
While you are typing, you can use the SQL Editor code completion.
3. Right-click inside the SQL Editor and choose Run Statement. The Output window displays a message indicating that the statement was successfully executed.
4. To verify that the new record has been added to the
When you choose View Data, a query to select all the data from the table is automatically generated in the upper pane of the SQL Editor. The results of the statement are displayed in the lower pane of the SQL Editor. In this case, the
=== Using the SQL Editor
1. Right-click the
== Deleting Tables
In the following step, you use an external SQL script to create a new
1. Expand the Tables node under the database connection node in the Services window. 2. Right-click the table that you want to delete and choose Delete.
== Using an External SQL Script
Issuing commands from an external SQL script is a popular way to manage your database. You may have already created an SQL script elsewhere, and want to import it into NetBeans IDE to run it on a specified database.
In this exercise the script will create a new table named
1. Download colleagues.sql to your local system
2. Choose File > Open File from the IDE’s main menu. In the file browser navigate to the location of the saved
Alternatively, you can copy the contents of colleagues.sql and then open the SQL editor and paste the contents of the file into the SQL editor.
3. Make sure your connection to
== Recreating Tables from a Different Database
If you have a table from another database which you would like to recreate in the database you are working in from NetBeans IDE, the IDE offers a handy tool for this. You first need to have the second database registered in the IDE, similar to what was described at the beginning of this tutorial. For the purposes of this tutorial, use the
1. Connect to the
image::images/grab-structure.png 3. In the Grab Table dialog that opens, specify a location on your computer to save the grab file that will be created. Click Save.
The grab file records the table definition of the selected table.
4. Expand the APP schema node under the
At this point you can change the table name or edit the table definition. Otherwise, click OK to immediately create the table in the
If you view the data in the new
This concludes the Working with the Java DB (Derby) Database tutorial. This tutorial demonstrated how to set up a connection to the Java DB database in NetBeans IDE. It then demonstrated how to create, view, modify and delete tables in the IDE’s Services window. It also showed how work with the SQL Editor to add data to tables, and use the IDE’s functionality allowing you to recreate tables using definitions from other databases.