ODBC Connector

ODBC

The LeanXcale ODBC driver is available for Windows and Unix-like systems like Linux.

1. Installation

1.1. ODBC Linux Installation

The next steps shows how to install the LeanXcale ODBC Driver for Linux. This procedure has been tested in Ubuntu 20.04 LTS, but it should work on other distributions too.

  1. Install prerequisite packages:

    sudo apt-get install unixodbc unixodbc-dev

    unixodbc-dev package is used by some extensions that needs to be compiled to be installed.

  2. Download the ODBC Connector from the Drivers page and unpack it.

  3. Copy the file libodbclx.so into /opt/leanxcale/odbc/client directory:

    mkdir -p /opt/leanxcale/odbc/client
    cp libodbclx.so /opt/leanxcale/odbc/client

    Make sure that the PHP user has read and execute permissions for libodbclx.so.

    For example:

    chmod +rx www-data /opt/leanxcale/odbc/client/libodbclx.so
  4. Create the file $HOME/.odbcinst.ini with this content:

    [LeanXcaleODBCDriver]
    Description = LeanXcale ODBC Driver for Linux
    Driver = /opt/leanxcale/odbc/client/libodbclx.so
    UsageCount = 1
  5. Create the file $HOME/.odbc.ini with this content:

    [LeanXcaleTests]
    Driver = LeanXcaleODBCDriver
    Description = Sample Database to be used for tests
    Trace = No
    Server = 123.45.67.89       # IP / hostname of your LeanXcale instance
    Port = 1529
    Database = dbtest
    UserName = user1
    Password = pass4user1
    Encoding = WCHAR_T

By default, ODBC driver managers are configured to use hidden versions of the odbc.ini and odbcinst.ini configuration files (named .odbc.ini and .odbcinst.ini) located in the home directory.

If you store these configuration files elsewhere, you must set these environment variables:

  • Set ODBCINI to the full path and file name of the odbc.ini file.

  • Set ODBCSYSINI to the full path of the directory that contains the odbcinst.ini file.

The driver manager will then be able to locate the files.

1.2. ODBC Windows Installation

1.2.1. Installing the ODBC Connector

  1. Download the ODBC Connector for Windows from the Drivers page

  2. Run the installer lx-odbc-setup-1.5.4.exe

  3. The default installation directory is C:\Program Files\Leanxcale\lx-odbc-driver

  4. If asked to install Visual C++ redistributable, follow the setup guide; just click Next as needed.

1.2.2. Registry Keys

The setup adds the relevant keys to the registry:

Registry Editor
[HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBCINST.INI]

[HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBCINST.INI\ODBC Drivers]
"LX DRIVER(x64)"="Installed"

[HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBCINST.INI\LX DRIVER(x64)]
"Driver"="[TARGETDIR]LXODBC.DLL"
"Setup"="[TARGETDIR]LXODBCSETUP.DLL"
"APILevel"="1"
"ConnectFunctions"="YYN"
"DriverODBCVer"="03.00"
"FileUsage"="0"
"SQLLevel"="3"

1.2.3. ODBC Data Source Administrator

When the driver has been installed, you can add the data source from the ODBC Data Source Administrator.

The datasource can be added from the User DSN tab:

  1. Click Add

    ODBC DSA
  2. Select LX DRIVER(x64) from the driver list

    ODBC DSA

With the driver selected, you can configure the Data Source Name properties:

ODBC DSA
Property Description Sample Values Comment

Data Source

Identifier for the datasource

ODBC logical name

Description

User friendly description of the database

Database name

Identifier for the database

SSL mode

SSL mode to use for connection

disable

Not yet supported

Host

LeanXcale server DNS or IP

Port

LeanXcale server access port

User

Login to database

Password

Database password

Trace

Error reporting level

no

TraceFile

Location of error log file

%temp%/lxodbc

Encoding

unicode

ANSI Encoding

auto-search

The Windows ODBC driver is an ANSI driver, but it supports unicode data.

2. Examples of use

Check the Quick Start guides of the following languages using the ODBC connector: