Connection String and DSN
Connection String Format
The 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
In simple terms, an ODBC connection URL is a string with parameters of the choice separated by semicolon.
Supported Arguments
The ODBC driver supports and uses several connection string/DSN arguments. All parameter names are case-insensitive - ADDRESS
, Address
, and address
all are valid parameter names and refer to the same parameter. If an argument is not specified, the default value is used. The exception to this rule is the ADDRESS
attribute. If it is not specified, SERVER
and PORT
attributes are used instead.
Attribute keyword | Description | Default Value |
---|---|---|
|
Address of the remote node to connect to. The format is: |
None. |
|
Address of the node to connect to. This argument value is ignored if ADDRESS argument is specified. |
None. |
|
Port on which |
|
|
Username for SQL Connection. This parameter is required if authentication is enabled on the server. See Authentication and CREATE user docs for more details on how to enable authentication and create user, respectively. |
Empty string |
|
Password for SQL Connection. This parameter is required if authentication is enabled on the server. See Authentication and CREATE user docs for more details on how to enable authentication and create user, respectively. |
Empty string |
|
Schema name. |
|
|
DSN name to connect to. |
None. |
|
Number of rows returned in response to a fetching request to the data source. Default value should be fine in most cases. Setting a low value can result in slow data fetching while setting a high value can result in additional memory usage by the driver, and additional delay when the next page is being retrieved. |
|
|
Enables the non-colocated distributed joins feature for all queries that are executed over the ODBC connection. |
|
|
Enforces a join order of tables in SQL queries. If set to |
|
|
Used to specify ODBC protocol version to use. Currently, there are following versions: |
|
|
Set this property to |
|
|
Set this parameter to |
|
|
Lazy query execution.
By default, Ignite attempts to fetch the whole query result set to memory and send it to the client. For small and medium result sets, this provides optimal performance and minimize duration of internal database locks, thus increasing concurrency.
However, if the result set is too big to fit in the available memory, then it can lead to excessive GC pauses and even |
|
|
Enables server side update feature.
When Ignite executes a DML operation, first, it fetches all the affected intermediate rows for analysis to the query initiator (also known as reducer), and only then prepares batches of updated values that will be sent to remote nodes.
This approach might affect performance, and saturate the network if a DML operation has to move many entries over it.
Use this flag to tell Ignite to do all intermediate rows analysis and updates "in-place" on corresponding remote data nodes.
Defaults to |
|
|
Determines whether the SSL connection should be negotiated with the server. Use |
None. |
|
Specifies the name of the file containing the SSL server private key. |
None. |
|
Specifies the name of the file containing the SSL server certificate. |
None. |
|
Specifies the name of the file containing the SSL server certificate authority (CA). |
None. |
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 a node.
DRIVER={Apache Ignite};
ADDRESS=localhost,example.com:12345,127.0.0.1,192.168.3.80:5893;
SCHEMA=somecachename;
USER=yourusername;
PASSWORD=yourpassword;
SSL_MODE=[require|disable];
SSL_KEY_FILE=<path_to_private_key>;
SSL_CERT_FILE=<path_to_client_certificate>;
SSL_CA_FILE=<path_to_trusted_certificates>
DRIVER={Apache Ignite};ADDRESS=localhost:10800;CACHE=yourCacheName
DRIVER={Apache Ignite};ADDRESS=localhost:10800
DSN=MyIgniteDSN
DRIVER={Apache Ignite};ADDRESS=example.com:12901;CACHE=MyCache;PAGE_SIZE=4096
Configuring DSN
The same arguments apply 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
(for 32-bit [x86] systems) or odbc64
(for 64-bit systems) which is an ODBC Data Source Administrator.
When installing the DSN tool, if you use the pre-built msi file, make sure you’ve installed Microsoft Visual C++ 2010.
Launch this tool, via Control panel→Administrative Tools→Data Sources (ODBC)
. Once the ODBC Data Source Administrator is launched, select Add…→Apache Ignite
and configure your DSN.
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 the Linux distribution. As an example, if you are using unixODBC then you can run the following command which will print system wide ODBC related details:
odbcinst -j
Use the SYSTEM DATA SOURCES
and USER DATA SOURCES
properties to locate the odbc.ini
file.
Once you locate the odbc.ini
file, open it with the editor of your choice and add the DSN section to it, as shown below:
[DSN Name]
description=<Insert your description here>
driver=Apache Ignite
<Other arguments here...>
© 2024 GridGain Systems, Inc. All Rights Reserved. Privacy Policy | Legal Notices. GridGain® is a registered trademark of GridGain Systems, Inc.
Apache, Apache Ignite, the Apache feather and the Apache Ignite logo are either registered trademarks or trademarks of The Apache Software Foundation.