Installation & Getting Started

This documentation serves as a guide for installing the necessary files. After the proper installation, the database is ready to work.

Hardware Limitations

You will need an NVIDIA graphic card with Compute Capability 6.0 or higher. You can find a list of NVIDIA graphic cards and their compute capabilities here.

Software Dependencies

In both Linux and Windows enviroments, you need to have GPU driver installed. We recommend to download the newest NVIDIA GPU driver. If you install whole NVIDIA CUDA package, this will install also suitable drivers.

Windows Only

You need to have installed .NET Core Runtime 2.2 before running the installation wizard. You can download it from here. It is needed for Console Client, which is included.

Linux: Installation Script

Make sure you can execute the installation script (if not, use command chmod +x qikkDB_Linux_Installer.sh) and that you are running the script as root.

After reading Terms of Use, write :q to continue.

Hit ENTER on keyboard if you accept Term of Use.

Choose destination folder and hit enter on keyboard to continue. It cannot be the current folder, you have to create a new folder. A relative path is supported.

Choose a user name (user will own the installed files and the service will be run under this user) and hit enter on keyboard to continue.

Chose a user group (user will own the installed files and the service will be run under this user) and hit enter on keyboard to continue.

Now the service is running and if the database crashes, it will be restarted automatically.

Linux: Deployment via Docker

The docker image is available at Docker Hub as qikkdb/qikkdb-community:latest. Requirements for using this image are drivers at your Linux host machine as well as Docker.io and NVIDIA Docker tools.

Detailed reference for running qikkDB in Docker is at our Docker hub repository.

Windows: Installation Wizard

First step is to read general information and warning about copyright and penalties resulting from its violation. For the next step press “Next” button.

Now you have to read and accept the Terms of Use to continue the installation process.

Console client is located in .\console\QikkDB.ConsoleClient.exe. Just double click on it or run it using powershell or cmd (.\QikkDB.ConsoleClient.exe). Console have to be started after the successful start of database core. We recommend you to run command 'help' to see all the options that console supports. You can see the list of supported console commands here as well.

The next step is to choose the folder where the installer will install qikkDB. Bear in mind, that you need to have read & write access to the selected folder. For the next step press “Next” button.

In this step you need to confirm the installation. For the next step press “Next” button.

After that, you may need to allow changes in your computer and after this confirmation a loading bar will inform you about the state of installation process.

Last screen is just to inform you about the success of the installation. After pressing “Close” button, qikkDB is ready to use.

Starting Database

Go to the directory where you have installed the program.

Configuration

The configuration files are in directory 'configuration'. There is a configuration file for logging ('log_config.default') and main configuration file for starting database core ('main_config.default'). If you want to change default settings, you have to create a copy from configuration file and remove '.default' extension. Now you can edit this new file and the changes will be reflected after starting / restarting the database core.

Databases

Databases will be saved (if not changed in main_config file) in directory 'databases'. After starting / restarting database, all databases which have extension '.db' will be loaded. If there is a database which you do not want to load, just change the extension '.db' to something else, e.g. '.dbx'.

Logs

Logs will be saved in directory 'logs' if not changed in configuration file ('log_config').

Linux

If not deployed via Docker, you can start database core as follows:

After the sucessful installation, database server is running as service. If the database server crashes when running as service, it will be automatically restarted. If you want to run the database server using executable file, it can be found in directory ./bin/qikkdb, just run it using command ./qikkdb (preferably run it as background process - e.g. using tmux). If you want to import a single csv file locally, run it with arguments (more information here).

The docker image is available at Docker Hub as qikkdb/qikkdb-community:latest. Requirements for using this image are drivers at your Linux host machine as well as Docker.io and NVIDIA Docker tools.

Requirements for using this image are drivers at your Linux host machine as well as Docker.io and NVIDIA Docker tools. Detailed reference for running qikkDB in Docker is at our Docker hub repository.

Console client is located in ./console/QikkDB.ConsoleClient. Run it using command ./QikkDB.ConsoleClient if you are located in directory ./console. Console have to be started after the successful start of database server. We recommend you to run command 'help' to see all the options that console supports. You can see the list of supported console commands here as well.

Windows

First step is to start database server. After the database server (database core) has successfully started, you can connect console or web client to this running database server. After successful installation, the executable file is in .\bin\dropdbase_instarea.exe. To execute properly, run as administrator. If you want to import a single csv file locally, run it using powershell or cmd (also in administrator mode) and add needed arguments (more information here). Do not start the database server more than once concurrently.

Console client is located in ./console/QikkDB.ConsoleClient. Double click on it or run it using powershell or cmd (./QikkDB.ConsoleClient). Console have to be started after the successful start of database server. We recommend you to run command 'help' to see all the options that console supports. You can see the list of supported console commands here as well.

First Query

Importing file using console

Let's import some data to start querying. But first, a new database has to be created:

CREATE DATABASE first_database

Locate a CSV file with your data on harddrive and import using console:

IMPORT first_database "C:\temp\sample.csv"

The console will be showing progress of importing process and will print message once done. A new table sample will be created in the database first_database.

Getting number of records in table

Before you run a SQL query, you need to select previously created database:

USE first_database

And now you can query the table for number of records:

SELECT COUNT(*) FROM sample

Naming Rules for Database / Table / Column Names

Windows filesystem is case insensitive, so naming your first database as 'MyDatabase' and the second one as 'mydatabase' will result in rewritting one of the database files. Bear this in mind and do not differ your database names just in lower/upper case, if you are running database core on Windows. Linux filesystem is case sensitive, so you can name your database as you want and if a database core is running on Linux, it will work just fine.

Names cannot contain characters '/' (slash), '\' (backslash) or '@' (at).

What's next

To learn more about: