## Derby Network Server sample program

The Network Server sample demo program (NsSample) is a simple JDBC application that interacts with the Derby Network Server. The program:

- starts the Derby Network Server
- checks if the Derby Network Server is running
- loads the DB2 JDBC Universal Driver or the Derby Client Network JDBC Driver
- creates the database '`NsSampledb`' if not already created
- checks to see if the schema is already created, and if not, creates the schema which includes the `SAMPLETBL` table and corresponding indexes.
- connects to the database
- loads the schema by inserting data
- starts client threads to perform database related operations
- has each of the clients perform DML operations (select, insert, delete, update) using JDBC calls, in particular one client opens an embedded connection to perform database operations while the other client opens a client connection to the Derby Network Server to perform database operations.
- waits for the client threads to finish the tasks
- shuts down the Derby Network Server at the end of the demo

The following files should be installed in the %DERBY_INSTALL%`\demo\programs\nserverdemo\` directory in order to run the sample program:

- `NsSample.java`
  This is the entry point into the demo application. The program starts up two clients. One client opens an embedded connection to perform database operations while the other client opens a client connection to the Derby Network Server to perform database operations. This program provides the following constants that can be changed to modify the sample demo:
  - `NUM_ROWS` - The number of rows that must be initially loaded into the schema.
  - `ITERATIONS` - The number of iterations for which each client thread does database related work.
  - `NUM_CLIENT_THREADS` - The number of clients that you want to run the program against.
  - `NETWORKSERVER_PORT` - The port on which the network server is running.
  You can also modify the program to exclude starting the Network Server as part of the sample program. Make sure to recompile the java files before running the program if you make any changes to the source code.
- `NsSampleClientThread.java` This file contains two Java classes:
  - The `NsSampleClientThread` class extends Thread and does all the necessary work by instantiating a `NsSampleWork` instance.
  - The `NsSampleWork` class contains everything required to perform DML operations using JDBC calls. The `doWork` method in the `NsSampleWork` class represents all the work done as part of this sample program.
- `NetworkServerUtil.java`
  This file contains helper methods to start the Derby Network Server and to shutdown the server.
- Compiled class files:
  - `NsSample.class`
  - `NsSampleClientThread.class`
  - `NsSampleWork.class`
  - `NetworkServerUtil.class`

## Running the Network Server demo program

To run the Derby Network Server demonstration program:

1. Open a command prompt and change directories to the %DERBY_INSTALL%`\demo\programs\` directory, where %DERBY_INSTALL% is the directory where you installed Derby.
2. Set the CLASSPATH to the current directory (".") and also include the following jar files in order to use the Derby Network Server and the DB2 JDBC Universal Driver or the Derby Client Network JDBC Driver.
   - `derbynet.jar`
     The Network Server jar file. It must be in your CLASSPATH to use any of the Derby Network Server functions.
   - `derbyclient.jar`
     This jar file must be in your CLASSPATH to use the Derby Client Network JDBC Driver.
   - `db2jcc.jar`
     This jar file must be in your CLASSPATH to use the DB2 JDBC Universal Driver.
   - `db2jcc_license_c.jar`
     This jar file is the license file for the Universal Driver.
   - `derby.jar`
     The Derby database engine jar file.
3. Test the CLASSPATH settings by running the following java command:

       java org.apache.derby.tools.sysinfo

   This command will show the Derby jar files that are in the CLASSPATH as well as the DB2 JDBC Universal Driver along with their respective versions.
4. Once you have set up your environment correctly, execute the application from the
   %DERBY_INSTALL%`\demo\programs\` directory:

       java nserverdemo.NsSample [driverType]

   - Where the possible values for driverType are:
     - derbyClient (default)
     - jccjdbcclient

You should receive output similar to the following if the program runs successfully:
`Using JDBC driver: org.apache.derby.jdbc.ClientDriver
Derby Network Server created
Server is ready to accept connections on port 1621.
Connection number: 1.
[NsSample] Derby Network Server started.
[NsSample] Sample Derby Network Server program demo starting.
Please wait .....................
Connection number: 2.
[NsSampleWork] Begin creating table - SAMPLETBL and necessary indexes.
[NsSampleClientThread] Thread id - 1; started.
[NsSampleWork] Thread id - 1; requests database connection, dbUrl =jdbc:derby:NSSampledb;
[NsSampleClientThread] Thread id - 2; started.
[NsSampleWork] Thread id - 2; requests database connection, dbUrl =jdbc:derby://localhost:1621/NSSampledb;create=true;
Connection number: 3.
[NsSampleWork] Thread id - 1 selected 1 row [998,Derby41 ,2.92903314E14,9572]
[NsSampleWork] Thread id - 2 selected 1 row [998,Derby41 ,2.92903314E14,9572]
[NsSampleWork] Thread id - 1 selected 1 row [998,Derby41 ,2.92903314E14,9572]
[NsSampleWork] Thread id - 1 selected 1 row [998,Derby41 ,2.92903314E14,9572]
[NsSampleWork] Thread id - 1 selected 1 row [998,Derby41 ,2.92903314E14,9572]
[NsSampleWork] Thread id - 1; inserted 1 row.
[NsSampleWork] Thread id - 1 selected 1 row [998,Derby41 ,2.92903314E14,9572]
[NsSampleWork] Thread id - 1 selected 1 row [52,Derby41 ,2.92903314E14,9572]
[NsSampleWork] Thread id - 1 selected 1 row [52,Derby41 ,2.92903314E14,9572]
[NsSampleWork] Thread id - 2; updated 1 row with t_key = 9572
[NsSampleWork] Thread id - 1; updated 1 row with t_key = 9572
[NsSampleWork] Thread id - 2 selected 1 row [53,Derby41 ,2.92903314E14,9572]
[NsSampleWork] Thread id - 1; inserted 1 row.
[NsSampleWork] Thread id - 1; closed connection to the database.
[NsSampleClientThread] Thread id - 1; finished all tasks.
[NsSampleWork] Thread id - 2; deleted 1 row with t_key = 9572
[NsSampleWork] Thread id - 2 selected 1 row [923,Derby14 ,4122.9033,9180]
[NsSampleWork] Thread id - 2; inserted 1 row.
[NsSampleWork] Thread id - 2 selected 1 row [923,Derby14 ,4122.9033,9180]
[NsSampleWork] Thread id - 2; inserted 1 row.
[NsSampleWork] Thread id - 2 selected 1 row [923,Derby14 ,4122.9033,9180]
[NsSampleWork] Thread id - 2 selected 1 row [923,Derby14 ,4122.9033,9180]
[NsSampleWork] Thread id - 2; closed connection to the database.
[NsSampleClientThread] Thread id - 2; finished all tasks.
[NsSample] Shutting down network server.
Connection number: 4.
Shutdown successful.
[NsSample] End of Network server demo.
`

Running the demo program will also create new directories and files:

- `NSSampledb`
  This directory makes up the NSSampledb database.
- `derby.log`
  This log file contains Derby progress and error messages.