Apache Ignite Documentation

GridGain Developer Hub - Apache Ignitetm

Welcome to the Apache Ignite developer hub run by GridGain. Here you'll find comprehensive guides and documentation to help you start working with Apache Ignite as quickly as possible, as well as support if you get stuck.


GridGain also provides Community Edition which is a distribution of Apache Ignite made available by GridGain. It is the fastest and easiest way to get started with Apache Ignite. The Community Edition is generally more stable than the Apache Ignite release available from the Apache Ignite website and may contain extra bug fixes and features that have not made it yet into the release on the Apache website.


Let's jump right in!


Documentation     Ask a Question     Download


Javadoc     Scaladoc     Examples

Connection String and DSN

Connection string format and supported arguments.

Connection String Format

Apache Ignite ODBC Driver supports standard connection string format. Here is the formal syntax:

connection-string ::= empty-string[;] | attribute[;] | attribute; connection-string
empty-string ::=
attribute ::= attribute-keyword=attribute-value | DRIVER=[{]attribute-value[}]
attribute-keyword ::= identifier
attribute-value ::= character-string

To put it simple connection string is just list of the key=value entries separated by semicolon. You can find connection string samples below.

Supported Arguments

Apache Ignite ODBC driver supports and uses several connection string/DSN arguments. All parameter names are case-insensitive so ADDRESS, Address and address all are valid parameter names and refer to the same parameter. If argument is not specified, the default value is used. The exception of this rule is ADDRESS attribute. If it is not specified, SERVER and PORT attributes are used instead.

Attribute keyword


Default value


Address of the remote node to connect to. The format: [:]. For example: localhost, example.com:12345,,

If this attribute is specified then SERVER and PORT arguments are ignored.


Address of the node to connect to.

This argument value is ignored if ADDRESS argument is specified.


Port on which OdbcProcessor of the node is listening.

This argument value is ignored if ADDRESS argument is specified.



Cache name. If it is not defined than default cache will be used. Note that the cache name is case sensitive.


DSN name to connect to.


Number of rows returned in response to a fetching request to the data source. Default value should be fine in most cases. Setting low value can result in slow data fetching while setting high value can result in additional memory usage by the driver and additional delay when the next page is being retrieved.



Enables non-collocated distributed joins feature for all the queries that will be executed over an ODBC connection.



Enforces a join order of tables in SQL queries. If set to true the query optimizer will not reorder tables in the join.



Used to specify ODBC protocol version to use. Currently, there are only two versions: 1.6.0 and 1.8.0. You should use 1.6.0 protocol version to connect to nodes with Ignite version < 1.8.0.


Connection String Samples

You can find samples of the connection string below. These strings can be used with SQLDriverConnect ODBC call to establish connection with an Apache Ignite node.

DRIVER={Apache Ignite};ADDRESS=localhost:10800;CACHE=MyCache
DRIVER={Apache Ignite};ADDRESS=localhost:10800
DRIVER={Apache Ignite};ADDRESS=example.com:12901;CACHE=SomeCache;PROTOCOL_VERSION=1.6.0
DRIVER={Apache Ignite};ADDRESS=example.com:12901;CACHE=MyCache;PAGE_SIZE=4096

Configuring DSN

The same arguments can be used if you prefer to use DSN (Data Source Name) for connection purposes.

To configure DSN on Windows, you should use a system tool called odbcad32 which is an ODBC Data Source Administrator. To launch this tool, go to Control panel->Administrative Tools->Data Sources (ODBC). Once the ODBC Data Source Administrator is launched, select Add...->Apache Ignite and configure your DSN in the desired way.

To do the same on Linux, you have to locate the odbc.ini file. The file location varies among Linux distributions and depends on a specific Driver Manager used by a Linux distribution. As an example, if you are using unixODBC then you can run the following command that will print out system wide ODBC related details:

odbcinst -j

A path to the file of interest will be shown in between SYSTEM DATA SOURCES and

Once the odbc.ini file has been found, open it with any editor of your choice and add DSN section to it as shown below:

[DSN Name]
description=<Insert your description here>
driver=Apache Ignite
<Other arguments here...>

Updated less than a minute ago

Connection String and DSN

Connection string format and supported arguments.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.