14. Ovrimos Files and Configuration Parameters

14.1 Files that Ovrimos uses

This section provides brief information on the files and directories created by Ovrimos at installation time.

Directories created at installation time are listed and described below. The types of files included in each directory are also explained:

• bin: executables and configuration files.
• libsrc: source files for Ovrimos C client library. The readme file explains what is included in this directory and how to build a client library.  
• samples: sample C, Java and Perl source code which demonstrates the use of APIs for applications and stored procedures.
• shared: Ovrimos Web resources  shared by all databases and other files such as the JDBC driver and the Perl DBI driver. Additional Web resources, provided by the users, which should be accessed by all databases, can be put in this directory.
• shared $\backslash$help: on-line documentation. 
• testbase: files related to the demonstration database testbase created during installation.
• dbman: files used by Database Manager.

 

Table A.1: Contents of the <Ovrimos root dir>

File	Description
dbman.ini.create	Creates the initialization files for Database Manager and for testbase on Unix platforms. It also sets the setuid bit in the permissions of bin/dbman.
install	Additionally to the above, it installs Ovrimos in the boot sequence and runs it. Refer to Unix installation, Chapter 2.
ovrimos.init.create	Creates the Ovrimos startup script and inserts it in the boot sequence
uninstall	Uninstalls Ovrimos from the boot sequence.
start.htm	Is used as a shortcut to Database Manager.
license.txt	The License Agreement which indicates the terms of installing and using Ovrimos.

 

Table A.2: Contents of the bin directory

File	Description
dbman	Database Manager executable (see Chapter 4)
dbmcore	Ovrimos core executable
sqlcore	Ovrimos core executable
sqlapp4	SQL Query Tool executable (see Chapter 9)
playback	Used for database recovery (see Chapter 12)
mime.typ	Includes the MIME types corresponding to each file extension
init.scm	Scheme initialization file (see section 8.5.2)

 

   
14.2 Configuration Parameters

Two kinds of parameters hold configuration information about Ovrimos installed components. Global parameters refer to Ovrimos, while database parameters are associated with a specific database. The name and purpose of both kinds of parameters is independent of your operating system (i.e. Unix or Win32).

   
14.2.1 Global Parameters

Global parameters, which hold internal configuration data about Ovrimos, are specified in the file <Ovrimos root dir>/dbman.ini. Table A.3 lists these parameters only for the user's information, thus the former file shouldn't be modified.   

: Global parameters

Global Parameter	Purpose
DBMCORE	Full path of the dbmcore executable
SQLCORE	Full path of the sqlcore executable
SQLAPP4	Full path of the SQL Query Tool executable (refer to Chapter 9)
PLAYBACK	Full path of the playback executable used for the database recovery (refer to section 12.2)
HTTPSHAREDDIR	Full path of the directory including all the Ovrimos Web resources shared by Database Manager  and all databases created through Database Manager (refer to section 8.3).
MIMETYPES	Full path of the file which is used by the HTTP server of Database Manager and it includes the MIME types  corresponding to each file extension. This file is also used by the HTTP server of a database only if the corresponding Database parameter MIMETYPES hasn't been specified for this database.
VERSION	Ovrimos version.
SCHEMEINIT	Full path of the Scheme initialization file , used by the HTTP server of Database Manager (refer to section 8.5.2). This file is also used by the HTTP server of a database only if the corresponding Database parameter SCHEMEINIT hasn't been specified for this database.
DBMANHTTPPORT	HTTP port used for connecting to Database Manager (refer to Chapter 4). The default port is 9000. Users can change the value of this parameter if 9000 is already in use. However if you change this value, you won't be able to connect to databases using the database name.
DBMANHOSTNAME	Reserved for future use.
DBMANPASSWD	Specifies the encoded form of the initial password for dbman authentication. The initial password pass   corresponds to number 485539 .
DBMANEMAIL	The dbman e-mail. It is the mail address given when the application for the client certificate is made.
MAILSERVER	The mail server where the dbman receives e-mail.
SERIALNUMBER	Serial number  of the registered version which has been installed. A serial number identifies you as a registered Ovrimos user. In case of an unregistered version, this parameter doesn't have any value. Refer to section 4.12.
LICENSE	License  of the registered version which has been installed. It determines the number of purchased concurrent connections. Refer to section 4.12.
OPENSSL	Full path of the openssl executable
REPLICATOR	Full path of the replicator executable
DBMANTLSCIPHERSUITES	Type of Transport Layer Security set for Database Manager
DBMANTLSCREDENTIALS	The serial number of the Server Certificate
DBMANTLSAUTHENTICATION	Type of authentication required
DBMANTLSTRUSTEDCAS	CAs trusted by Database Manager

Figure A.1 shows the contents of dbman.ini on a Unix system where only the demonstration database  testbase  exists. The last line of the former file specifies the full path of testbase initialization file.

Parameter REPLICATOR have a value in Replicator (R) version. Parameters DBMANTLSCIPHERSUITES, DBMTLSCREDENTIALS, DBMANTLSAUTHENTICATION and DBMANTLSUSEDCAS have values in SSL (S) version.

Reference: the contents of testbase are described in section B.3

  

Figure A.1: Example of dbman.ini on a Unix system

Notice in the figure A.1 that there are two databases. One is testbase, created during installation, which is placed under the <Ovrimos root dir> and the other is planets, created in a different path.

   
14.2.2 Database Parameters

The database parameters contain configuration data for each database created through Database Manager. They are stored in the file $DIR/<database name>.ini. Many of these parameters are set automatically by Database Manager. Table A.4 lists these parameters only for the user's information. They shouldn't be modified by editing the database initialization file. To modify them, you should follow the instructions given in section 4.9 about Database Configuration.

 

: Database parameters

SQL Server Parameters	Description
SQLPORT	Port used for SQL connections. It must be unique for each database. The port must not be used by another application. Database Manager sets the port automatically and ensures there will never be a conflict between Ovrimos databases' ports. In case of conflict with another application, you may edit this number from Database Manager. (See section 4.9). SQL Port accepts values in the range 1024-65535.
REPLICATORPORT	Port used for connections by remote replicators. It must be unique for each database. The port must not be used by another application. Database Manager sets the port automatically and ensures there will never be a conflict between Ovrimos databases' ports. In case of conflict with another application, you may edit this number from Database Manager. (See section 4.9). REPLICATOR Port accepts values in the range 1024-65535.
REPLICATORDIR	The directory where the replicated data will be kept.
REPLICATORTHERADS	The number of Ovrimos fibers dedicated to data replication.
SHMEMKEY	Shared Memory Key. Shared Memory allows two or more processes share a memory segment. However, multiple processes sharing a piece of memory have to coordinate its use among themselves. Maximum value permitted for SHMEMKEY is 65535.
SEMKEY	Semaphore Key. Semaphores are mainly used to synchronize the access to shared memory segments. Maximum value permitted for SEMKEY is 65535.
BACKCOMPAT	specifies if the database will be used only with pre-Ovrimos 2.6 clients. It is provided for backward compatibility. It takes the value 'Y' or 'N'. . Backward Compatibility affects communication, not data storage. Therefore, it may be modified as necessary at any time.
DIR	Database Directory   where the database files are stored.
BACKUPDIR	Backup Directory . After shutting down the database, the database files are backed up automatically in this directory. To safe keep the backup, it is recommended that the directory is placed on a different volume.
LOGFILE	Log File . It is the transactions' log which is run in case of an abnormal termination (refer to Chapter 12). It is also recommended that this log is kept on a different volume.
CIPHER	Cipher  used for data encryption. Refer to section 4.8.1 about setting the cipher and section 13.3 about Data Encryption.
CRYPTOKEY	Encryption Key . Refer to section 4.8.1 about setting the CRYPTOKEY, if necessary, and section 13.3 about Data Encryption.
TEMPDIR	Temporary Directory . For example, this directory includes the database lock files, temporary tables, the .logerr
AGIDIR	AGI Directory . It includes the stored procedures (refer to section 10.5).
HTTP Server Parameters	Description
HTTPPORT	Port where the database listens to HTTP requests. It must be unique for each database. The port must not be used by another application. Database Manager sets the port automatically and ensures there will never be a conflict between Ovrimos databases' ports. In case of conflict with another application, you may edit this number from Database Manager. (See section 4.9). HTTP Port accepts values in the range 1024-65535.
HTTPSESSIONTIMEOUT	Maximum period of time, in minutes, that an HTTP session (for example, a session with SQL Terminal) is allowed to remain idle before the server terminates the session. Its default value is 15 minutes.
CHARSET	Character Set  of text transmitted by the HTTP server so that browsers are able to interpret them correctly. Default Character Set is ISO-8859-1 (Latin)
HTTPROOTDIR	HTTP Root Directory . Ovrimos, database-specific, Web resources are stored in this directory (e.g. HTML or Scheme files). Refer to section 8.3.
HTTPLOGFILE	HTTP Log File . Refer to chapter 8.
SCHEMEHANDLERS	Scheme Handlers File . The URL prefixes served by persistent Scheme scripts are stored in this file (refer to section 8.5.2).
SCHEMEINIT	Scheme Library File . If not specified, the value becomes, by default, the one specified by the corresponding global parameter (refer to section 8.5.2).
EXECEXT	Executable Extensions . Refer to section 8.5.4.
MIMETYPES	MIME Types File . If not specified, the values becomes, by default, the one specified by the corresponding global parameter (refer to section A.2.1).
Password Parameters	Description
USERPOLICY	It specifies all the password parameters concerning database users other than admin. (Refer to Password Parameters, section 4.9 and Password Policy, section 13.4.2).
Fine Tuning Parameters	Description
SQLTHREADS	Number of SQL Fibers, used by Ovrimos to serve SQL requests.
HTTPTHREADS	Number of HTTP Fibers, used by Ovrimos to serve HTTP requests (through SQL Terminal or Scheme scripts), refer to section 7.2.4.
LOCKWAITTIME	Lock Wait Time. It specifies the number of times a connection is allowed to be put to sleep and awakened before it quits trying to acquire a lock.
BTREENUM	Total B-Trees . It specifies the total number of simultaneously opened B-trees corresponding to the database's indices.
BTREENODECACHE	Cached B-Tree Nodes . It specifies the maximum number of B-tree nodes that the cache can hold.
MAPFILENUM	Cached Tables . It specifies the maximum number of permanent and temporary database tables that the cache can hold.
MAPPAGEFACTOR	Mapped Region Size . By taking advantage of the operating system's memory-mapped file I/O mechanism, users can map file regions to memory and define their number (in pages). The physical size of each file region equals to the size of the operating system's page.
MAPPAGENUM	Mapped Regions Per Table. It specifies the maximum number of mapped regions corresponding to each database table (permanent or temporary).
Miscellaneous Parameters	Description
HOSTNAME	Refer to section 4.9.5.
MAILSERVER	Refer to section 4.9.5.
Transport Layer Security Parameters	Description
TLSCIPHERSUITES	Type of TLS level set. If no SSL exists (level None), this parameter has no value.
TLSCREDENTIALS	Serial number of the Server.
TLSAUTHENTICATION	Authentication required.
TLSTRUSTEDCAS	Certificate Authorities trusted by the database.

Figure A.2 shows the parameters associated with the demonstration database testbase, which are stored in the file /home/ovrimos/testbase/testbase.ini. The last line of this file specifies the full path of the global parameters file.

Note: Since testbase is created during installation, some parameters are set by default at this time. Some others may be absent, because they were not set then. In the example of figure A.2 we assume that the user has configured testbase at some later time. Parameters REPLICATORPORT, REPLICATORDIR and REPLICATORTHREADS have values in Replicator (R) version. Parameters TLSCREDENTIALS, TLSAUTHENTICATIONS and TLSUSEDCAS have values in SSL (S) version.

  

Figure A.2: Example of a database initialization file