Apache Ignite SQL Documentation

The Apache Ignite SQL Developer Hub

Welcome to the Apache Ignite SQL developer hub. You'll find comprehensive guides and documentation to help you start working with Apache Ignite SQL as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

ODBC Driver

Overview

Ignite includes ODBC driver that allows you both select and modify data, stored in a distributed cache, using standard SQL queries and native ODBC API.

For detailed info on ODBC please refer to ODBC Programmer's Reference.

Apache Ignite ODBC driver implements version 3.0 of the ODBC API.

Cluster Configuration

ODBC driver is treated as a dynamic library on Windows and a shared object on Linux. An application does not load it directly. Instead, it uses a Driver Manager API that loads and unloads ODBC drivers whenever required.

Internally, Ignite ODBC driver uses TCP protocol to connect to an Ignite cluster. The connection works over an Ignite component called ClientListenerProcessor. Except for the ODBC connections, it also handles JDBC and thin client connections. By default, ClientListenerProcessor is enabled when an Ignite node is being launched​. Use the code below to change any parameters:

<bean id="ignite.cfg" class="org.apache.ignite.configuration.IgniteConfiguration">
  ...
  <property name="clientConnectorConfiguration">
    <bean class="org.apache.ignite.configuration.ClientConnectorConfiguration"/>
  </property>
  ...
</bean>
IgniteConfiguration cfg = new IgniteConfiguration();
...
ClientConnectorConfiguration clientConnectorCfg = new ClientConnectorConfiguration();
cfg.setClientConnectorConfiguration(clientConnectorCfg);
...

After ClientListenerProcessor is configured, it will be started with default settings; some of which are listed below:

Properties
Description
Default

host

Host name or IP address to bind to. When set to null, binding is done to localhost.

null

port

TCP port to bind to. If the specified port is already in use, Ignite will try to find another available port using portRange property.

10800

portRange

Defines number of ports to try to bind to. E.g. if the port is set to 10800 and portRange is 100, then server will consequentially try to bind to any port from [10800, 10900] range until it finds free port`.

100

maxOpenCursorsPerConnection

Maximum number of cursors that can be opened simultaneously for a single connection.

128

threadPoolSize

Number of request-handling threads in the thread pool.

MAX(8, CPU cores)

socketSendBufferSize

Size of the TCP socket send buffer. When set to 0, system default value is used.

0

socketReceiveBufferSize

Size of the TCP socket receive buffer. When set to 0, system default value is used.

0

tcpNoDelay

Whether to use TCP_NODELAY option or not.

true

idleTimeout

Idle timeout for client connections.
Clients will automatically be disconnected from the server after being idle for the configured timeout.
When this parameter is set to zero or a negative value, idle timeout will be disabled.

0

isOdbcEnabled

Whether access through ODBC is enabled.

true

isThinClientEnabled

Whether access through thin client is enabled.

true

It's always possible to change these parameters as shown in the example below:

<bean id="ignite.cfg" class="org.apache.ignite.configuration.IgniteConfiguration">
  ...
  <!-- Enabling ODBC. -->
  <property name="clientConnectorConfiguration">
    <bean class="org.apache.ignite.configuration.ClientConnectorConfiguration">
      <property name="host" value="127.0.0.1"/>
      <property name="port" value="10800"/>
      <property name="portRange" value="5"/>
      <property name="maxOpenCursorsPerConnection" value="512"/>
      <property name="socketSendBufferSize" value="65536"/>
      <property name="socketReceiveBufferSize" value="131072"/>
      <property name="threadPoolSize" value="4"/>
    </bean>
  </property>
  ...
</bean>
IgniteConfiguration cfg = new IgniteConfiguration();
...
ClientConnectorConfiguration clientConnectorCfg = new ClientConnectorConfiguration();

clientConnectorCfg.setHost("127.0.0.1");
clientConnectorCfg.setPort(12345);
clientConnectorCfg.setPortRange(2);
clientConnectorCfg.setMaxOpenCursorsPerConnection(512);
clientConnectorCfg.setSocketSendBufferSize(65536);
clientConnectorCfg.setSocketReceiveBufferSize(131072);
clientConnectorCfg.setThreadPoolSize(4);

cfg.setClientConnectorConfiguration(clientConnectorCfg);
...

A connection that is established from the ODBC driver side to the cluster via ClientListenerProcessor is also configurable. Here you can find more details on how to alter connection settings from the driver side.

Thread-Safety

The current implementation of Ignite ODBC driver only provides thread-safety at the connections level. It means that you should not access the same connection from multiple threads without additional synchronization, though you can create separate connections for every thread and use them simultaneously.

Prerequisites

Apache Ignite ODBC Driver was officially tested on:

OS

Windows (XP and up, both 32-bit and 64-bit versions),
Windows Server (2008 and up, both 32-bit and 64-bit versions)
Ubuntu (14.x and 15.x 64-bit)

C++ compiler

MS Visual C++ (10.0 and up), g++ (4.4.0 and up)

Visual Studio

2010 and above

Building ODBC Driver

Apache Ignite is now shipped with pre-built installers for both 32- and 64-bit versions of the driver for Windows. So if you just want to install ODBC driver on Windows you may go straight to the Installing ODBC Driver section for installation instructions.

If you use Linux you will still need to build ODBC driver before you can install it. So if you are using Linux or if you still want to build the driver by yourself for Windows, then keep reading.

Ignite ODBC Driver source code is shipped as part of the Apache Ignite package and it should be built before the usage. For instructions on how to download and set up Apache Ignite, please refer to Getting Started page.

Since the ODBC Driver is written in C++, it is shipped as part of the Apache Ignite C++ and depends on some of the C++ libraries. More specifically, it depends on utils and binary Ignite libraries. It means that you will need to build them prior to building the ODBC driver itself.

We assume here that you are using binary Ignite release. If you are using source release instead, than instead of %IGNITE_HOME%\platforms\cpp path you should use %IGNITE_HOME%\modules\platforms\cpp in all places.

Building on Windows

You will need MS Visual Studio 2010 or later to be able to build the ODBC driver on Windows. Once you have it, open Ignite solution %IGNITE_HOME%\platforms\cpp\project\vs\ignite.sln (or ignite_86.sln if you are running 32-bit platform), left-click on odbc project in the "Solution Explorer" and choose "Build". Visual Studio will automatically detect and build all the necessary dependencies.

If you are using VS 2015 or later (MSVC 14.0 or later), you need to add legacy_stdio_definitions.lib as an additional library to odbc project linker's settings in order to be able to build the project. To add this library to the linker input in the IDE, open the context menu for the project node, choose Properties, then in the Project Properties dialog box, choose Linker, and edit the Linker Input to add legacy_stdio_definitions.lib to the semi-colon-separated list.

Once the build process is over, you can find ignite.odbc.dll in %IGNITE_HOME%\platforms\cpp\project\vs\x64\Release for the 64-bit version and in %IGNITE_HOME%\platforms\cpp\project\vs\Win32\Release for the 32-bit version.

Building installers on Windows

Once you have built driver binaries you may want to build installers for easier installation. Ignite uses WiX Toolset to generate ODBC installers, so to build them you'll need to download and install WiX. Make sure you have added bin directory of the WiX Toolset to your PATH variable.

Once everything is ready, open terminal and navigate to the directory %IGNITE_HOME%\platforms\cpp\odbc\install. Execute the following commands one by one to build drivers:

candle.exe ignite-odbc-amd64.wxs
light.exe -ext WixUIExtension ignite-odbc-amd64.wixobj
candle.exe ignite-odbc-x86.wxs
light.exe -ext WixUIExtension ignite-odbc-x86.wixobj

As a result, ignite-odbc-amd64.msi and ignite-odbc-x86.msi files should appear in the directory. You can use them to install your freshly built drivers.

Building on Linux

On a Linux-based operating system, you will need to install an ODBC Driver Manager of your choice to be able to build and use the Ignite ODBC Driver. The Apache Ignite ODBC Driver has been tested with UnixODBC.

Additionally, you will need GCC, G++, and Make to build the driver and its dependencies.

Once all the above mentioned are installed, you can build the Ignite ODBC driver:

cd $IGNITE_HOME/platforms/cpp
libtoolize && aclocal && autoheader && automake --add-missing && autoreconf
./configure --enable-odbc --disable-node --disable-core
make

#The following step will most probably require root privileges:
make install

After the build process is over, you can find out where your ODBC driver has been placed by running the following command:

whereis libignite-odbc

The path should look like - /usr/local/lib/libignite-odbc.so

Installing ODBC driver

In order to use ODBC driver, you need to register it in your system so that your ODBC Driver Manager will be able to locate it.

Installing on Windows

For 32-bit Windows, you should use 32-bit version of the driver. For the
64-bit Windows, you can use 64-bit driver as well as 32-bit. You may want to install both 32-bit and 64-bit drivers on 64-bit Windows to be able to use your driver from both 32-bit and 64-bit applications.

Installing using installers

Microsoft Visual C++ 2010 Redistributable Package for 32-bit or 64-bit should be installed first.

This is the easiest way and one should use it by default. Just launch installer for the version of the driver that you need and follow instructions:

  • 32-bit installer: %IGNITE_HOME%\platforms\cpp\bin\odbc\ignite-odbc-x86.msi
  • 64-bit installer: %IGNITE_HOME%\platforms\cpp\bin\odbc\ignite-odbc-amd64.msi

Installing manually

To install driver on Windows manually, you should first choose a directory on your
file system where your driver or drivers will be located. Once you have
chosen the location, you have to put your driver there and ensure that all driver
dependencies can be resolved as well, i.e., they can be found either in the %PATH% or
in the same directory where the driver DLL resides.

After that, you have to use one of the install scripts from the following directory
%IGNITE_HOME%/platforms/cpp/odbc/install. Note, that you may need OS administrator privileges to execute these scripts.

install_x86 <absolute_path_to_32_bit_driver>
install_amd64 <absolute_path_to_64_bit_driver> [<absolute_path_to_32_bit_driver>]

Installing on Linux

To be able to build and install ODBC driver on Linux, you need to first install
ODBC Driver Manager. Apache Ignite ODBC driver has been tested with [UnixODBC]
(http://www.unixodbc.org).

Once you have built and performed "make install" command, the Ignite ODBC Driver i.e. libignite-odbc.so will be placed in the /usr/local/lib folder. To install it as an ODBC driver in your Driver Manager and be able to use it, you should perform the following steps:

  • Ensure linker is able to locate all dependencies of the ODBC driver. You can check this by using ldd command like so (assuming ODBC driver is located under /usr/local/lib):
    ldd /usr/local/lib/libignite-odbc.so
    If there are unresolved links to other libraries, you may want to add directories with these libraries to the LD_LIBRARY_PATH.

  • Edit file $IGNITE_HOME/platforms/cpp/odbc/install/ignite-odbc-install.ini and ensure that Driver parameter of the Apache Ignite section points to the right location where libignite-odbc.so is located.

  • To install Apache Ignite ODBC driver, use the following command:
    odbcinst -i -d -f $IGNITE_HOME/platforms/cpp/odbc/install/ignite-odbc-install.ini
    To perform this command, you may need root privileges.

Now the Apache Ignite ODBC driver is installed and ready for use. You can connect to it and use it just like any other ODBC driver.