Kyvos ODBC Driver for Windows

Kyvos ODBC Driver for Windows

This documentation is for Kyvos 2026.8.x. To view documentation for other Kyvos versions, click here.

This documentation is for Kyvos 2026.8.x. To view documentation for other Kyvos versions, click here.

1. Overview

The Kyvos ODBC Driver for Windows enables connectivity between the Kyvos Analytical Server and Windows-based BI tools, supporting both 32-bit and 64-bit configurations. Installation requires Windows (10 and 11) or Windows Server 2012/2016, Visual C++ Redistributable for Visual Studio 2022, and administrator privileges. Once installed, it supports Username/Password, OAuth, and Kerberos authentication, SSL-based security, and configurable logging for troubleshooting.


2. Prerequisites

Each computer on which you install the driver must meet the following minimum system requirements:

  • To install the driver, you must have Administrator privileges on the computer.

  • One of the following operating systems:

    • Windows 10 and Windows 11

    • Windows Server 2012 and 2016

  • Visual C++ Redistributable for Visual Studio 2022 installed (with the same bitness as the driver that you are installing)

Note

The installer for Visual C++ Redistributable for Visual Studio 2022 is available in the Kyvos ODBC Driver package

  • Available disk space: Maximum 150 MB


3. Installing Kyvos ODBC Driver on Windows

Note

When installing Kyvos ODBC driver on Windows operating systems, ensure that driver bitness matches with bitness of your BI tool.

To install the Kyvos ODBC Driver on Windows, perform the following steps.

  1. Double-click the Kyvos ODBC Installer executable file to start the installation.

  2. If prompted, enter Administrator credentials and click Ok.

  3. Click Next.

  4. Read License Agreement and click Yes if you agree to the terms; to continue with the installation. Else, click No to exit.

  5. Enter Username and Company Name in the corresponding fields and click Next.

  6. Choose the Setup Type. We recommend selecting the Complete

  7. If you have selected the Custom setup type, you can change the installation location, click Change to choose the folder on your computer, and then click OK. To accept the installation location, click Next.

  8. Click Install.

  9. When the installation completes, click Finish.

3.1 Verifying driver installation on Windows

You can find the details of the Kyvos ODBC Driver installed on your Windows computer in the ODBC Data Source Administrator.

  1. Open the ODBC Administrator:

  2. For Windows 10 and Windows 11, type ODBC Administrator in the Start menu and click on ODBC Data Source Administrator (64-bit) to open.

  3. Click the Drivers tab and verify that Kyvos ODBC Driver is available in the list of ODBC drivers installed on your system. The version number is displayed in the Version column corresponding to Kyvos ODBC Driver.


4. Creating a Data Source Name (DSN) on Windows

After installing Kyvos ODBC Driver, a default System DSN is created with the name Kyvos ODBC for Kyvos ODBC Driver. You can use this default System DSN to connect to Kyvos Analytical Server from your favorite BI Tool.

To create other DSN, you can do so using the following steps.

  1. Open the ODBC Administrator.

    1. Windows 10 and Windows 11, type ODBC Administrator in the Start menu and click on ODBC Data Source Administrator (64-bit) to open.

  2. Choose one:

    1. To create a DSN that only the user currently logged into Windows can use, click User DSN.

    2. Or, to create a DSN that all users who log in to Windows can use, click the System DSN However, you need Administrator credentials to Add/Modify System DSN.
      Note: It is recommended to create a System DSN instead of a User DSN. This is because, some applications load data using a different user account, and may not be able to detect User DSNs that are created under another user account.

  3. Click Add.

  4. In the Create New Data Source dialog box, select Kyvos ODBC Driver, and click Finish. This displays the Kyvos ODBC Driver DSN Setup dialog box. The Setup and Advance options tabs are displayed.

  5. To configure Data Source Name, complete the Setup tab details.

  6. On the Setup tab, enter the following details:

    1. Data Source Name: Enter a name for your data source.

    2. Host: Enter the IP address or hostname of the Kyvos Web App Server.

    3. Port: Enter the TCP port number that Kyvos Web App Server uses to listen for client connections.

    4. HTTP Path: Enter the web application path in the <webapp name>/sql format. For example, if the application name is kyvos, enter kyvos/sql.

    5. Authentication: Select one the following type:

      • Username and password,

        1. User Name: Enter your Kyvos Web App Server user name. 

        2. Password: Enter your Kyvos Web App Server password. Optionally, choose to save the password in an encrypted form using the corresponding checkbox.
          For Kerberos,

      • Kerberos: Specify Realm, Host FQDN, and Service Name.

      • Use SSL: Select the checkbox to configure the driver to connect to a Secure Sockets Layer (SSL) enabled Kyvos Analytical Server. When using SSL to connect to a server, the driver supports identity verification between the client and the server.

        • To access SSL options for a DSN, open the ODBC Data Source Administrator, where you created the DSN.

        • Select the DSN and click Configure.

  7. To test the connection, click the Test. If the connection fails, then recheck settings. Contact your Kyvos Analytical Server administrator if needed. Review results, if required, and then click OK.

  8. To save your settings and close the Kyvos ODBC Driver DSN Setup dialog box, click OK.

  9. To close the ODBC Data Source Administrator, click OK.

Username and Password

Kerberos

Username and Password

Kerberos

image-20260904-125415.png
image-20260904-125328.png

Note

It is recommended to create a System DSN instead of a User DSN. This is because, some applications load data using a different user account, and may not be able to detect User DSNs that are created under another user account.


5. Configuring Kyvos ODBC Advanced Settings

The Kyvos ODBC settings controls driver-level settings such as encoding, certificate paths, locale, logging, fetching rows per block, and enabling asynchronous reading.

To help troubleshoot issues, you can configure logging settings for the driver. In addition to the functionality provided in the Kyvos ODBC Driver, the ODBC Data Source Administrator provides tracing functionality.

Important

Logging or tracing decreases performance and can consume a large quantity of disk space, so make sure to keep log level as FATAL which will have a negligible impact on performance and disk space.

image-20260827-071438.png

To configure driver logging on Windows, perform the following steps.

  1. To access logging options, open the ODBC Data Source Administrator where you created the DSN, then select the DSN, click Configure.

  2. On the Kyvos ODBC Driver DSN Setup dialog box, click the Advance Options tab.

    • Log Level: Select the required log level from the list. Select the logging level corresponding to the amount of information that you want to include in log files. This following table enlists the information corresponding to each log level.

Logging level

Description

Logging level

Description

FATAL 

Logs severe error events that lead the driver to stop processing.

ERROR

Logs error events that might allow the driver to continue running.

WARNING

Logs events that might result in an error if no action is taken.

INFO

Logs general information that describes the progress of the driver.

DEBUG

Logs detailed information that is useful for debugging the driver.

TRACE

Logs all driver activity, including result set.

    • Log Path: Specify the full path to the folder where you want to save log files.

    • Max Number of Files:Type the maximum number of log files to keep. After the maximum number of log files is reached, each time an additional file is created, the driver deletes the oldest log file.

    • Max File Size (MB): Type the maximum size of each log file in megabytes (MB). After the maximum file size is reached, the driver creates a new file and continues logging.

    • SSL Options: specify the CA certificates that you want to use to verify the server, do one of the following:

      1. Trusted Certificate Path: To configure the driver to load certificates from a specific PEM file, specify the full path to the file.

      2. System Trust Store: Select this option to use the Windows Trust Store. If using Windows Trust Store, you MUST import the trusted CA certificates to the Trust Store.

    • Row Fetched Per Block: Specify the number of rows fetched in each chunk. The default value of the Rows Fetched Per Block property is 50000.

      • To increase the limit for the chunk size at Kyvos Analytical Server,

        • Add the sql.hive.server2.thrift.resultset.max.fetch.size property at the connection level.

        • Add a required limit in the Value field.

    • Enable Async Read: Select the check box to enable asynchronous reading. Similarly, clear the check box to disable asynchronous reading.

      • This feature can be enabled in scenarios where a query is expected to return a large number of records to the BI tool. With asynchronous reading enabled, the Kyvos ODBC Driver streams and displays results as they arrive instead of waiting for the complete result set, improving overall query performance and responsiveness.

      • By Default, this property is enabled.

  1. Click OK.

  2. Restart your BI application for new settings to come in effect. The Kyvos ODBC Driver creates a log file named log at the location specified in the Log Path field.

Important

After Connecting using Kyvos ODBC Driver to the server, a folder named SQLLog is created at the logging path location. Under this folder, new folders are created for the current date(s), which contains the Kyvos_odbc_client_SQLLog.log file. This file captures records for all the queries sent to the Kyvos Analytical Server.

The default log level is set as FATAL, and the default location for log files is C:\ProgramData\Kyvos\Kyvos ODBC Driver\Logs. You cannot disable logging for Kyvos ODBC Driver.

Copyright Kyvos, Inc. 2026. All rights reserved.