Installation and administration

System requirements

Software requirements

Operating systems

There are NitrosBase distributions for the following operating systems:

  • Windows Server 2016 and later, and Windows 10;
  • Ubuntu 16.0 and later.

Software libraries

There are the following ways to connect to NitrosBase:

  • via С API,
  • via С# API,
  • via ODBC,
  • using MS SQL Reporting Services.

Respective libraries and drivers are included in the distributions. Runtime environments needed for these librariers to function should be deployed on a machine where NitrosBase is installed.

Otherwise, one has to use the testsql utility (included in the distributions for both Windows and Linux).

Hardware requirements

  • CPU cores: 4 or more,
  • CPU frequency: 2.0 GHz or more,
  • RAM: 16 GB or more,
  • HDD free space (SSD is preferable) — 128 GB or more.

Installation

NitrosBase distributions are portable. It is sufficient to unpack the archive anywhere in the file system.

Linux and Windows distributions are almost equivalent structurally and functionally unlike otherwise stipulated explicitly.

Folder structure

Unpacked distribution contains the following folders:

  • bin — server and client executables, auxiliary libraries;
  • data — demo database data;
  • docs — documentation;
  • include — C/C++ headers;
  • lib — client libraries and drivers;
  • samples.c++ — code samples.

Demo database deployment

  1. Create the sntest1 demo database:
    nbase ../data/sntest1 -c create -p 3020

  2. Fill the database with demo data:
    nbase -p 3020 -q < ../data/sntest1/sntest_prepare.sql

  3. Execute simple demo query:
    nbase -p 3020 -q "select name, lastname, age from person limit 10"

Command-line interface

The nbase utility provides a command-line interface for basic tasks.

nbase [dbpath] [backuppath] [options] 

OPTIONS:

--help или -h        -- help  
    
--command=<command> 
 -c <command>  	     -- command:
                        create    - create new database and start server for it
                                    (dbpath and port are required)
                        open      - start server for database specified
                                    (dbpath and port are required)
                        close     - stop server of database specified
                                    (port is required)
                        backup    - backup database specified
                                    (port is required)
                        restore   - restore database specified
                                    (dbpath, port and backuppath are required)
--port=<port>
 -p <port>     	     -- TCP port listened by server

--query="sqlcommand"
 -q "sql command"    -- execute SQL query against database specified
                        (port is required);
                        if query is omitted, it will be red
                        from standard input

-b <path>            -- backup path

Examples

Create and start database

nbase c:/data/sntest1 -c create -p 3020

Start existing database

nbase c:/data/sntest1 -c open -p 3020

Stop database

nbase -c close -p 3020

Execute SQL query

nbase -p 3020 -q "select * from person limit 10"

Execute SQL query from file

nbase -p 3020 -q < query.sql