Thank you for downloading InstantDB! STEP 1: PLEASE REVIEW THE EPL LICENSE -------------------------------------- Before using InstantDB, please review the EPL license agreement at: http://instantdb.enhydra.org/software/license/index.html STEP 2: PLEASE REVIEW THE NEW FEATURES AND CHANGES IN THIS RELEASE ------------------------------------------------------------------ This version of InstantDB contains significant new changes that are summarized below. STEP 3: PLEASE FOLLOW THE INSTALLATION INSTRUCTIONS PROVIDED BELOW -------------------------------------------------------------------- Please also make sure to carefully follow the installation instructions provided below. These installation instructions apply specifically to this release and they supercede the instructions currently available on the InstantDB web site. _____________________________________________________________________ For complete documentation on using InstantDB, see: http://instantdb.enhydra.org/software/documentation/index.html To join the InstantDB mailing lists, see: http://instantdb.enhydra.org/community/mailingLists/index.html _____________________________________________________________________ NEW PACKAGE NAMES ----------------- To conform with Java naming standards, all InstantDB classes have been put in the org.enhydra.instantdb package. Classes Old Package New Package ------- ----------- ----------- Core InstantDB and db org.enhydra.instantdb.db user-defined functions JDBC jdbc org.enhydra.instantdb.jdbc Examples (none) org.enhydra.instantdb. This has the following implications: 1. You must change code to load the JDBC driver to load org.enhydra.instantdb.jdbc.idbDriver instead of jdbc.idbDriver 2. In scripts for ScriptTool (formerly sample), replace the line: d jdbc.idbDriver; with d org.enhydra.instantdb.jdbc.idbDriver; 3. In batch and script files, add the new packages to references to InstantDB tools. For example, use java org.enhydra.instantdb.commsql. instead of java commsql NEW SAMPLE APPLICATION NAMES ---------------------------- The program "sample" has been renamed to ScriptTool and should now be invoked with the command: java org.enhydra.instantdb.ScriptTool. The program JDBCmain has been renamed to DBBrowser and should now be invoked using: java org.enhydra.instantdb.DBBrowser. * * * Send your comments or suggestions for InstantDB to instantdb@enhydra.org. INSTALLATION INSTRUCTIONS ------------------------- NOTE - These installation instructions supercede the instructions currently available on the InstantDB web site. - Create a new directory on your machine. - Download the zip archive: idbbeta.zip, and place it in the newly created directory. - Unzip the archive. Be careful to use a version of unzip that allows long filenames and that will re-create the full directory structure. You should now have the following sub-directories: - Classes holds the jar files containing the database classes - Examples holds various example files - Functions holds the source code for InstantDB's SQL functions - Doc contains release notes and updated properties and syntax documentation. Add the Classes/idb.jar, Classes/idbf.jar and Classes/idbexmpl.jar files to your CLASSPATH environment variable. Change to the Examples sub-directory and enter the command: java -ms16m -mx32m org.enhydra.instantdb.ScriptTool or, if you are running JDK 1.2 or above: java -Xms16m -Xmx32m org.enhydra.instantdb.ScriptTool ScriptTool will create further sub-directories and create database tables in those sub-directories. You will also see some output on the screen. This is due to the fact that the supplied properties file enables a certain amount of logging. This can be easily switched off by editing the sample.prp file and setting traceLevel to zero. The ScriptTool Scripting Program -------------------------------- The ScriptTool program takes its SQL from three files called sql1.txt, sql2.txt and sql3.txt in the sample sub-directory. This includes examples of some (but certainly not all) of the SQL syntax supported by InstantDB. Full details of the sample program are given in the examples section. The test program also includes a test import file: "import1.txt". The format of this file is found in import_schema.txt. More information on importing tables is described later. Viewing the Database -------------------- You can view the contents of the newly created database using the command: java -ms16m -mx32m org.enhydra.instantdb.DBBrowser This starts a small database browser. It initially displays the system properties such as the Java Virtual Machine being used. Click on Browse. This displays the contents of the current directory. Click on sample.prp and then click on Open. This constructs the URL for the database. Click on Connect and the program connects to the database. The left hand panel displays the tables held in the database, including system tables and indexes. Click on the import1 table - the program creates the SQL: SELECT * FROM import1 Click on Submit and this gets submitted to the database. The results are displayed in the right hand panel.