Starting ij provides batch and shell scripts for users in Windows and UNIX environments that can be used to start ij.

By calling the appropriate script, you can start ij and be able to connect with a simple command. The scripts are found in the bin directory of your installation. You can also customize the ij scripts to suit your environment.

If you are using as a client/server environment, start the Network Server before connecting to the database. (See "Starting the Network Server" in the for details.) You can start ij by running the ij scripts for your environment. Follow the instructions in "Setting up your environment" in to set the and JAVA_HOME environment variables and to add /bin to your path. Then use the following command:

ij [-p propertyFile] [inputFile]
Alternatively, set the environment variable, then use one of these commands: (UNIX) java [options] -jar $DERBY_HOME/lib/derbyrun.jar ij [-p propertyFile] [inputFile] (Windows) java [options] -jar %DERBY_HOME%\lib\derbyrun.jar ij [-p propertyFile] [inputFile]

Note that you cannot use the -cp argument or the CLASSPATH environment variable to set CLASSPATH variables when you are using the -jar argument to start the ij tool. That is, if you want to run the ij tool with a custom classpath, then you cannot use the -jar argument. Instead, you have to use the full class name to start the ij tool (java org.apache.derby.tools.ij).

You can also run the ij by setting the CLASSPATH or MODULEPATH variables via the setNetworkServerCP or setNetworkServerCP.bat scripts. Note that you first need to set variable. To run ij from the CLASSPATH, type

java [options] org.apache.derby.tools.ij [-p propertyFile] [inputFile]

To run ij from the MODULEPATH, type

(UNIX) java -p $MODULEPATH \ -m org.apache.derby.tools/org.apache.derby.tools.ij \ [options] (Windows) java -p %MODULEPATH% ^ -m org.apache.derby.tools/org.apache.derby.tools.ij ^ [options]

The command line items are:

  • java

    Start the JVM.

  • options

    The options that the JVM uses. You can use the -D option to set ij properties (see Starting ij using properties) or system properties, such as properties.

  • propertyFile

    A file you can use to set ij properties (instead of the -D option). The property file should be in the format created by the java.tools.Properties.save methods, which is the same format as the derby.properties file.

  • inputFile

    A file from which to read commands. The ij tool exits at the end of the file or an exit command. Using an input file causes ij to print out the commands as it runs them. If you reroute standard input, ij does not print out the commands. If you do not supply an input file, ij reads from the standard input.

For detailed information about ij commands, see ij commands and errors reference.