Kyvos ODBC Driver for MAC
This documentation is for Kyvos 2026.8.x. To view documentation for other Kyvos versions, click here. |
|---|
1. Overview
The Kyvos ODBC Driver for Mac enables connectivity between the Kyvos Analytical Server and Mac-based BI tools using the ODBC standard, supporting OAuth and Username/Password authentication (Kerberos is not supported on Mac).
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.
Operating system: macOS Sequoia 15.5 or later, running on Apple Silicon (M-series chip)
Available disk space: Maximum 150 MB
3. Installing Kyvos ODBC Driver on Mac
To install the Kyvos ODBC Driver on Mac OS, perform the following steps.
Double-click the Kyvos ODBC Driver disk image (.dmg) file to mount it.
Double-click the Kyvos ODBC Driver installer package (kyvos.pkg) to launch the installer.
Click Continue on the Introduction screen.
Read the License Agreement and click Continue; then click Agree to accept the terms and proceed with the installation. Else, click Disagree to exit.
Click Install.
If prompted, enter Administrator credentials, then click Install Software.
When the installation completes, click Close.
Once the installation is complete, a folder named KyvosODBCDriver is created within the /Applications directory, containing the required folder structure (Acknowledgements, ErrorMessages, lib, and the associated configuration files).
3.1 Verifying the Driver Installation on Mac
To verify the driver installation on Mac, perform the following steps.
Navigate to /Applications/KyvosODBCDriver, and check the Date Modified column on the KyvosODBCDriver folder and its subfolders to confirm whether a new installation has replaced an existing one.
To confirm the exact driver version installed, check the log files generated when a query is executed through the Kyvos ODBC Driver — the installed version is recorded there.
After installing the Kyvos ODBC Driver, use the odbcinst.ini file to configure the Kyvos ODBC Driver.
4.1 Configuring the odbcinst.ini File
You need to configure the odbcinst.ini file at the following:
Kyvos ODBC Driver location: Applications/KyvosODBCDriver
System location: library/ODBC
To add the dylib path to the Kyvos ODBC Driver configuration file, perform the following steps.
Navigate to the Kyvos ODBC Driver location. The odbcinst.ini file is located at /Applications/KyvosODBCDriver
Open the odbcinst.ini file.
Add the dylib path, which must the same path of the dylib file in the Kyvos ODBC Driver. The file is located at Application/KyvosODBCDriver/lib/
[ODBC Drivers] Kyvos ODBC Driver = Installed [Kyvos ODBC Driver] Driver=Kyvos ODBC Driver .dylib path Setup=Kyvos ODBC Driver .dylib pathSave the file and navigate to the system location (library/ODBC/).
Verify that the
odbcinst.inifile is created. If it is not created, create it manually by copying the file from the Kyvos ODBC Driver location to the system location.If the file is created automatically, verify that it contains the same Kyvos ODBC Driver configurations as mentioned in Step-3. If the correct configuration is not present in the file, copy the driver’s configurations, using the correct .dylib file path and paste it into the odbcinst.ini file present at the system location.
Save the file.
5. Creating a Data Source Name (DSN)
Use the odbc.ini file to configure a DSN on your Mac machine.
Note
MAC does not support Kerberos authentication.
5.1 Configuring the odbc.ini File
In the same setup folder, edit the odbc.ini file to define the DSN and its connection properties:
[ODBC Data Sources]
KyvosDSN = Kyvos ODBC Driver
[KyvosODBC]
Driver = Kyvos ODBC Driver
Description = 64 bit Kyvos ODBC Driver
Host = start.trial.kyvosinsights.com
Locale = en-US
Port = 8081
AuthMech = 3
UserName = kyvos
HTTPPath = kyvos/sql
SSL = 0You can create the DSN from the odbc.ini file or using the iODBC Administrator.
Using iODBC Administrator
Enter details as mentioned above and create the DSN as shown in the following figure.
6. Configuring the 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. These settings are provided in the kyvos.odbcclient.ini file located in the /opt/KyvosODBCDriver/lib/
Open kyvos.odbcclient.ini file.
Configure the following logging parameters and save the file.
LogFileCount — the maximum number of log files to keep. After this number is reached, the driver deletes the oldest log file each time a new one is created.
LogFileSize — the maximum size of each log file, in Bytes. After this size is reached, the driver creates a new file and continues logging.
LogLevel — the logging level corresponding to the amount of information to include in log files.
Logging Level Number | Logging Level | Description |
1 | FATAL | Logs severe error events that lead the driver to stop processing. |
2 | ERROR | Logs error events that might allow the driver to continue running. |
3 | WARNING | Logs events that might result in an error if no action is taken. |
4 | INFO | Logs general information that describes the progress of the driver. |
5 | DEBUG | Logs detailed information that is useful for debugging the driver. |
6 | TRACE | Logs all driver activity, including result set. |
LogPath — the full path to the folder where log files are saved.
Rows 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.
EnableAsyncRead: Set it to 1 to enable or 0 to disable. By Default, this property is enabled and set to 1. 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.