Getting started - Eloquence B.07.10 Database on Windows ======================================================= Revision: 2.0 - March 30, 2006 Introduction ------------ This document shows how to install and configure the Eloquence B.07.10 database in the Windows platform in a few simple steps. For a detailed description, please refer to the Eloquence B.07.00 Installation and Configuration Manual. Note: While Eloquence is at version B.07.10 we decided to keep the names for the services and configuration files from the previous version to avoid breaking existing customer installations when updating from a previous Eloquence 6.x release. 1. Installation ---------------- Download the Eloquence distribution from the Eloquence web site: http://eloquence.marxmeier.com/download/B0710/win32/ You need to download the Eloquence-B0710-10-win32.exe setup program. Please refer to the README and INSTALL.txt file in the download directory for additional information on installation. The Eloquence product is installed by default to (*) C:\Program Files\Eloquence (*) The default path depends on your Windows language. Localized versions of Windows default to a different location. For example, the German Windows version would default to C:\Programme\Eloquence The installation program will add the Eloquence bin directory (typically C:\Program Files\Eloquence\bin) to the default PATH. Unless the PATH is specifically defined otherwise for your account, Eloquence utilities can be executed on the command line without specifying the path. License keys ------------ Unless another license key is present, Eloquence defaults to the Eloquence Personal Edition license option, which provides a perpetual two user license and a database size limited to 50 MB. Eloquence has the option to install a temporary license key during installation that is valid for four weeks (when installed for the first time on a system). This temporary license option does not impose further restrictions. Evaluation license keys may also be requested from the Eloquence web site: http://eloquence.marxmeier.com/license/demo.html 2. Install Eloquence patches ---------------------------- For any serious use, the most recent patches should be installed. You can download the current B.07.10 patches: http://eloquence.marxmeier.com/support/B0710/patch/B0710.html To install an Eloquence patch please run the exe file and press OK. NOTE: Before installing the patch please make sure that Eloquence is not active. Otherwise a reboot may be required after installing the patch. The patch installation program installs a README file for each installed patch in the share\doc directory (typically C:\Program Files\Eloquence\share\doc) that describes the corrections or enhancements implemented by a patch. 3. Basic tuning of the database instance ---------------------------------------- The Eloquence B.07.10 default database server configuration should be acceptable for getting started. For any serious use, consider modifying the default database server configuration. This section explains some of the most useful configuration parameters... Open the database instance configuration file eloqdb6.cfg in a text editor, such as notepad. The configuration file uses a similar format as an .ini file (hash signs (#) are treated as comments). The eloqdb6.cfg file is located in the Eloquence etc directory (typically C:\Program Files\Eloquence\etc\eloqdb6.cfg). Consider changing the following configuration items: * SymcMode = 0 improves the performance (especially in desktop systems) but may result in a damaged database in case of a power failure while the database is written to. The default is SyncMode = 1. You should consider using SyncMode = 1 in production use but Syncmode = 0 for data migration and testing (this can also be changed dynamically with dbctl -u dba syncmode off). * BufferCache = 256 specifies to use a cache of 256 MB. This is a useful configuration value for serious use. The default cache size is 64 MB. * CheckPtSize = 50 specifies a checkpoint should be executed when the size of the transaction journal exceeds 50 MB. The default is 25 MB None of these recommended changes is strictly required and the change can be performed at any time and will be active the next time the database server is restarted. 4. Create the volume files -------------------------- Create a subdirectory at the desired location where the database volume files should be created. For example C:\db, open a command window (cmd.exe) and change to the directory. Then create the primary data volume and the transaction volume with the Eloquence dbvolcreate and dbvolextend utilities. For example: > cd \db > dbvolcreate db01.vol > dbvolextend -t log db02.vol This creates the primary data volume file db01.vol and the transaction volume db02.vol in the \db directory. The file names are also added to the server configuration file (eloqdb6.cfg) and must be changed accordingly if the files are later moved to a different location. 5. Configure the server automatic startup ----------------------------------------- Windows XP: * Open the Windows Control Panel * Select Performance and Maintenance * Select Administrative Tools * Open the Services applet Windows 2000: * Open the Windows Control Panel * Select Administrative Tools * Open the Services applet Select the eloqdb6 entry in the list. On Windows XP/2000, open the Properties dialog, either from the menu or using the context menu. On Windows NT, click the Startup... button to open the Startup Options dialog. Select "Startup: Automatic" and close the dialog with the OK button. This specifies that the eloqdb6 database server will be automatically started whenever the system is rebooted. Next, start the server for the first time. * Windows XP/2000: Select the eloqdb6 entry in the list, then choose Start either from the menu or using the context menu. By default, the eloqdb6 database server will write log messages to the Windows Event Log. In case the eloqdb6 does not start the Event Log will probably contain an error message pointing out the cause of the problem. 6. Creating a database ---------------------- To create a database, open a command window (cmd.exe) and change to the location where the schema file is located. Then run the Eloquence schema processor and create the database. For example: > dbschema sample.schema > dbcreate sample Please note: The dbschema command is a small batch file that calls the Eloquence schema utility with the -T option and implies the database schema follows HP3000 TurboIMAGE conventions. The equivalent schema command is: > schema -T sample.schema The Eloquence schema processor should be fully compatible with HP3000 schema files. If you encounter any problem, please contact the Eloquence support at support@marxmeier.com. If possible, attach the schema file. An error message -700 indicates the Eloquence data base server has not been started. After running schema, you need to create the database: > dbcreate database Finally you may want to use dbimport to import your data into the database. For data exported from a HP3000 the following options should be used: > dbimport -v -s database.exp -z roman8 database The option -v specifies the progress should be displayed, the option -s specifies the text file containing the data, the option -z specifies tha data is encoded in HP-ROMAN8 character set. For data migration options please review the document below: http://eloquence.marxmeier.com/support/B0710/doc/migration/index.html