DBLX Setup and Installation


This part of the documentation covers the installation, setup, and administration of DBLX.

DBLX Supported platforms


Just about any computing environment should be able to run DBLX.

DBLX has been tested on the following operating systems and platforms:
- Windows XP, Vista, 7, 8, 8.1, and 10
- Mac OS/X, Any Intel-based version
- Linux (Ubunto, Mint. Will work with any Linux)
- Raspberry Pi
- Solaris
- Android

Installing DBLX


The installation of DBLX is comprised of creating a directory hold the application components. In some cases there are other steps related to permissions which need to be performed.
Based on the operating system, the steps to install DBLX are outlined below:

Windows XP, Vista, 7, 8, 8.1, 10


DBLX has an installer that will setup the Database Engine for you.
Run the installer to setup DBLX for most Windows environments.
If it is preferred not to run an installer, the following sections contains steps to manually install DBLX.

Windows configuration without installer.


Create a directory for DBLX on your local C: drive. For the least problems, it is strongly recommended to create a new directory for DBLX in the ROOT of the C: drive, such as c:\DBLX.
Do not create a directory in the 'Program Files' or the 'Program Files(x86)' folder, as the default Windows security settings will render the application unable to be executed.
While you can install DBLX to any Windows-compatible file system, it is recommended to only install to the C: drive for Windows. Do not install DBLX to a flash drive or cloud storage device.
Once the directory has been created, extract the contents of the DBLX zip file into the new directory.
Make sure that you select 'Run as Administrator' when you launch your ZIP program.
Make sure you have checked the ZIP option to 'use Folder Names'.

Windows Firewall settings:
Windows Firewall should be configured to allow Inbound and Outbound network traffic from port 7169.
It may also be necessary to disable the User Account Control (UAC) if you get 'Connection Refused' when trying to connect to the DBLX server from a DBLX client.

For C# .NET version of DBLX:
Once the files are unzipped, then a number of steps have to be taken to ensure that DBLX will execute without being affected by the Windows security settings.
Find the DBLX3.exe executable which you will use to run DBLX. In Windows Explorer select the DBLX3.exe file and right-click to select 'Properties'. In the 'Properties' window be sure that the option 'Run as Administrator' is selected. This option will cause DBLX3 to always be run as the Administrator so that it will not be affected by the Windows security settings.
Windows Firewall should be configured to allow DBLX3.exe to run.

For Java version of DBLX:
Once the files are unzipped, then a number of steps have to be taken to ensure that Java will execute without being affected by the Windows security settings.
Find the javaw.exe which you will use to run DBLX. DBLX requires Java 1.7 or later from any vendor (Oracle, OpenJDK, IBM).
In Windows Explorer select the javaw.exe file and right-click to select 'Properties'. In the 'Properties' window be sure that the option 'Run as Administrator' is selected. This option will cause javaw.exe to always be run as the Administrator so that it will not be affected by the Windows security settings.
Windows Firewall should be configured to allow javaw.exe to run.


Once the ZIP has been extracted and the related permissions have been configured, DBLX is ready to go!


Mac OS/X, Linux, UNIX


To install DBLX create a directory where the program will be run.
Copy in the TAR/ZIP file for your platform and extract all the files into the new directory. If using a ZIP file, be sure to enable the selection to 'use folder names' when extracting files from the ZIP.

Be sure that the user account which will run DBLX has full create, execute, and write permissions on the entire directory.
At first startup, DBLX will try to create a data directory to hold persisted database tables. If the permissions are not correct, the data directory will not be created and DBLX will not work as expected.


All operating systems

Once the files are installed, make sure that the user account which will run DBLX has full create, execute, and write permissions on the entire directory.
At first startup, DBLX will try to create a data directory to hold persisted database tables. If the permissions are not correct, the data directory will not be created and DBLX will not work as expected.
The last step to installing DBLX is to setup the server properties by editing the file server.properties.


Configuration options for DBLX


There are two values in server.properties which can be modified before starting the server:


    serverProperties/network/port:

    The TCP-IP port that DBLX will listen on.

    Set the port number to a value which is not already being used on your computer. Port 7169 is used as a default, and should not conflict with any existing applications.
    Be careful which port number is selected for DBLX as certain port numbers are reserved, such as 80 is reserved for HTTP and 21 is reserved for FTP.
    If a port is configured for DBLX which is already in use, the server will report an error at startup like "Cannot bind to XXXX. Port in use".


    serverProperties/data/tables/initialCache:

    The number of database tables which are cached in-memory.

    Set the initialCache value to the number of tables you would like loaded into memory. 10 tables are loaded by default.

    For performance reasons, DBLX keeps table data loaded in memory with the use of a table cache. As tables are created, modified, and queried DBLX will keep the most recent tables in its table cache.
    In most circumstances, this value should be changed to match the needs of any application which uses DBLX. For example, if you were using DBLX as a back-end for a web-based project you would want to determine how many tables are in use during normal operations. If you found that the project uses the same 12 tables over and over again, you would want to set the initialCache value to at least 12, and perhaps as high as 18 (which is either the real table count, or the real table count plus 50%).
    It is important to understand that this value is only for user-created tables. System tables are not included in the same table cache as user-created tables and are managed separately.


Running the DBLX Server


DBLX is comprised of the database server and one or more database clients. Communication between a client and server is accomplished through the use of a TCP-IP port.
To run the database server, install the files and then execute dbserver.bat or dbserver.sh based on your platform.

When the server starts up it will create a data directory and output a log file named dblx_log.log.
The log file will contain the following info when the server has been started successfully:

     Starting DBLX Server.
     DBLX Database server listening on port 7169


Backup or Moving the DBLX Server


To backup the DBLX Server, just backup all the files in the directory where DBLX was installed. It is not necessary to stop the database server to make a backup.

If you need to move the database server to a different location or computer, stop the database server and then copy all the files in the directory where DBLX was installed to the new location.


Using the DBLX database server

You need an DBLX client to use the database server. DBLX has two database clients, one is command-line based and the other is a Java class which can be used for programmatic access.

See the DBLX Client documentation for more details about the database clients.

 
 

DBLX Setup/Installation