Clickhouse odbc driver mac os

Как собрать ClickHouse на Mac OS X

Сборка должна запускаться с x86_64 (Intel) на macOS версии 10.15 (Catalina) и выше в последней версии компилятора Xcode’s native AppleClang, Homebrew’s vanilla Clang или в GCC-компиляторах.

Установка Homebrew

Установка Xcode и инструментов командной строки

Установите из App Store последнюю версию Xcode.

Запустите ее, чтобы принять лицензионное соглашение. Необходимые компоненты установятся автоматически.

Затем убедитесь, что в системе выбрана последняя версия инструментов командной строки:

bash $ sudo rm -rf /Library/Developer/CommandLineTools $ sudo xcode-select —install

Установка компиляторов, инструментов и библиотек

bash $ brew update $ brew install cmake ninja libtool gettext llvm gcc

Просмотр исходников ClickHouse

bash $ git clone —recursive [email protected]:ClickHouse/ClickHouse.git # or https://github.com/ClickHouse/ClickHouse.git

Сборка ClickHouse

Чтобы запустить сборку в компиляторе Xcode’s native AppleClang:

bash $ cd ClickHouse $ rm -rf build $ mkdir build $ cd build $ cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -DENABLE_JEMALLOC=OFF .. $ cmake —build . —config RelWithDebInfo $ cd ..

Чтобы запустить сборку в компиляторе Homebrew’s vanilla Clang:

bash $ cd ClickHouse $ rm -rf build $ mkdir build $ cd build $ cmake -DCMAKE_C_COMPILER=$(brew —prefix llvm)/bin/clang -DCMAKE_CXX_COMPILER==$(brew —prefix llvm)/bin/clang++ -DCMAKE_BUILD_TYPE=RelWithDebInfo -DENABLE_JEMALLOC=OFF .. $ cmake -DCMAKE_C_COMPILER=$(brew —prefix llvm)/bin/clang -DCMAKE_CXX_COMPILER=$(brew —prefix llvm)/bin/clang++ -DCMAKE_BUILD_TYPE=RelWithDebInfo -DENABLE_JEMALLOC=OFF .. $ cmake —build . —config RelWithDebInfo $ cd ..

Чтобы собрать с помощью компилятора Homebrew’s vanilla GCC:

bash $ cd ClickHouse $ rm -rf build $ mkdir build $ cd build $ cmake -DCMAKE_C_COMPILER=$(brew —prefix gcc)/bin/gcc-11 -DCMAKE_CXX_COMPILER=$(brew —prefix gcc)/bin/g++-11 -DCMAKE_BUILD_TYPE=RelWithDebInfo -DENABLE_JEMALLOC=OFF .. $ cmake —build . —config RelWithDebInfo $ cd ..

Предупреждения

Если будете запускать clickhouse-server , убедитесь, что увеличили системную переменную maxfiles .

Вам понадобится команда sudo .

1. Создайте файл /Library/LaunchDaemons/limit.maxfiles.plist и поместите в него следующее:

bash $ sudo chown root:wheel /Library/LaunchDaemons/limit.maxfiles.plist

Чтобы проверить, как это работает, выполните команду ulimit -n .

Источник

Clickhouse odbc driver mac os

Tableau connector to ClickHouse using ODBC driver

This connector is a Tableau extension that improves compatibility between Tableau and ClickHouse. The connector gives users full access to Tableau data modeling and exploration features on ClickHouse data.

For official documentation on installing and use of the connector, please refer to the Altinity Tableau Documentation. Or you can follow the directions shown below, which assume you understand how ODBC and Tableau connectors work.

Before installing the ClickHouse connector with Tableau Desktop, the following pre-requisites must be installed:

• Tableau Desktop installed for Microsoft Windows or Apple OS X. Version 2020.2 or above is required.
• The clickhouse-odbc driver version 1.1.9 and above.
• A Tableau account to access the Extension gallery. (Required in future)

Instructions on how to install the clickhouse-odbc driver are available from the clickhouse-odbc Github repository. A Windows installer is available on the clickhouse-odbc Releases page.

In future this connector will be available in Tableau Extension Gallery. You will be able to install it directly from there.

For now, you must install the connector using Tableau developer mode ( procedure described here).

Just checkout( or download) connector code. Locate the tableau_odbc_connector and move it to a directory like TableauConnectors. Add a command line argument to direct Tableau Desktop to the folder that contains tableau_odbc_connector folder with connector sources. Here is an example.

After the connector is successfully installed, open Tableau Desktop.

1. You should see a new connection type — ClickHouse by Altinity Inc.
2. Just enter credentials in the dialog window.
3. Enter this query «SELECT version();» into Initial SQL tab to verify that connection was established successfully and click «Sign in».

You dont need to create an ODBC DSN. The connection credentials that you entered in dialog window will be used by connector directly.

About

Tableau connector to ClickHouse using ODBC driver

Источник

Clickhouse odbc driver mac os

Allows ClickHouse to connect to external databases via ODBC.

To safely implement ODBC connections, ClickHouse uses a separate program clickhouse-odbc-bridge . If the ODBC driver is loaded directly from clickhouse-server , driver problems can crash the ClickHouse server. ClickHouse automatically starts clickhouse-odbc-bridge when it is required. The ODBC bridge program is installed from the same package as the clickhouse-server .

This engine supports the Nullable data type.

Creating a Table

See a detailed description of the CREATE TABLE query.

The table structure can differ from the source table structure:

• Column names should be the same as in the source table, but you can use just some of these columns and in any order.
• Column types may differ from those in the source table. ClickHouse tries to cast values to the ClickHouse data types.
• The external_table_functions_use_nulls setting defines how to handle Nullable columns. Default value: 1. If 0, the table function does not make Nullable columns and inserts default values instead of nulls. This is also applicable for NULL values inside arrays.

Engine Parameters

• connection_settings — Name of the section with connection settings in the odbc.ini file.
• external_database — Name of a database in an external DBMS.
• external_table — Name of a table in the external_database .

Usage Example

Retrieving data from the local MySQL installation via ODBC

This example is checked for Ubuntu Linux 18.04 and MySQL server 5.7.

Ensure that unixODBC and MySQL Connector are installed.

By default (if installed from packages), ClickHouse starts as user clickhouse . Thus, you need to create and configure this user in the MySQL server.

Then configure the connection in /etc/odbc.ini .

You can check the connection using the isql utility from the unixODBC installation.

Table in ClickHouse, retrieving data from the MySQL table:

Источник

Как собрать ClickHouse на Mac OS X

Сборка должна запускаться с x86_64 (Intel) на macOS версии 10.15 (Catalina) и выше в последней версии компилятора Xcode’s native AppleClang, Homebrew’s vanilla Clang или в GCC-компиляторах.

Установка Homebrew

Установка Xcode и инструментов командной строки

Установите из App Store последнюю версию Xcode.

Запустите ее, чтобы принять лицензионное соглашение. Необходимые компоненты установятся автоматически.

Затем убедитесь, что в системе выбрана последняя версия инструментов командной строки:

bash $ sudo rm -rf /Library/Developer/CommandLineTools $ sudo xcode-select —install

Установка компиляторов, инструментов и библиотек

bash $ brew update $ brew install cmake ninja libtool gettext llvm gcc

Просмотр исходников ClickHouse

bash $ git clone —recursive [email protected]:ClickHouse/ClickHouse.git # or https://github.com/ClickHouse/ClickHouse.git

Сборка ClickHouse

Чтобы запустить сборку в компиляторе Xcode’s native AppleClang:

bash $ cd ClickHouse $ rm -rf build $ mkdir build $ cd build $ cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -DENABLE_JEMALLOC=OFF .. $ cmake —build . —config RelWithDebInfo $ cd ..

Чтобы запустить сборку в компиляторе Homebrew’s vanilla Clang:

bash $ cd ClickHouse $ rm -rf build $ mkdir build $ cd build $ cmake -DCMAKE_C_COMPILER=$(brew —prefix llvm)/bin/clang -DCMAKE_CXX_COMPILER==$(brew —prefix llvm)/bin/clang++ -DCMAKE_BUILD_TYPE=RelWithDebInfo -DENABLE_JEMALLOC=OFF .. $ cmake -DCMAKE_C_COMPILER=$(brew —prefix llvm)/bin/clang -DCMAKE_CXX_COMPILER=$(brew —prefix llvm)/bin/clang++ -DCMAKE_BUILD_TYPE=RelWithDebInfo -DENABLE_JEMALLOC=OFF .. $ cmake —build . —config RelWithDebInfo $ cd ..

Чтобы собрать с помощью компилятора Homebrew’s vanilla GCC:

bash $ cd ClickHouse $ rm -rf build $ mkdir build $ cd build $ cmake -DCMAKE_C_COMPILER=$(brew —prefix gcc)/bin/gcc-11 -DCMAKE_CXX_COMPILER=$(brew —prefix gcc)/bin/g++-11 -DCMAKE_BUILD_TYPE=RelWithDebInfo -DENABLE_JEMALLOC=OFF .. $ cmake —build . —config RelWithDebInfo $ cd ..

Предупреждения

Если будете запускать clickhouse-server , убедитесь, что увеличили системную переменную maxfiles .

Вам понадобится команда sudo .

1. Создайте файл /Library/LaunchDaemons/limit.maxfiles.plist и поместите в него следующее:

bash $ sudo chown root:wheel /Library/LaunchDaemons/limit.maxfiles.plist

Чтобы проверить, как это работает, выполните команду ulimit -n .

Источник

Clickhouse odbc driver mac os

ODBC Driver for ClickHouse

This is the official ODBC driver implementation for accessing ClickHouse as a data source.

For more information on ClickHouse go to ClickHouse home page.

For more information on what ODBC is go to ODBC Overview.

The canonical repo for this driver is located at https://github.com/ClickHouse/clickhouse-odbc.

See LICENSE file for licensing information.

Table of contents

Pre-built binary packages of the release versions of the driver available for the most common platforms at:

The ODBC driver is mainly tested against ClickHouse server version 20.3 . Older versions of ClickHouse server as well as newer ones (with greater success) should work too. Possible complications with older version may include handling Null values and Nullable types, alternative wire protocol support, timezone handling during date/time conversions, etc.

Note, that since ODBC drivers are not used directly by a user, but rather accessed through applications, which in their turn access the driver through ODBC driver manager, user have to install the driver for the same architecture (32- or 64-bit) as the application that is going to access the driver. Moreover, both the driver and the application must be compiled for (and actually use during run-time) the same ODBC driver manager implementation (we call them «ODBC providers» here). There are three supported ODBC providers:

• ODBC driver manager associated with MDAC (Microsoft Data Access Components, sometimes referenced as WDAC, Windows Data Access Components) — the standard ODBC provider of Windows
• UnixODBC — the most common ODBC provider in Unix-like systems. Theoretically, could be used in Cygwin or MSYS/MinGW environments in Windows too.
• iODBC — less common ODBC provider, mainly used in Unix-like systems, however, it is the standard ODBC provider in macOS. Theoretically, could be used in Cygwin or MSYS/MinGW environments in Windows too.

If you have Homebrew installed (usually applicable to macOS only, but can also be available in Linux), just execute:

If you don’t see a package that matches your platforms under Releases, or the version of your system is significantly different than those of the available packages, or maybe you want to try a bleeding edge version of the code that hasn’t been released yet, you can always build the driver manually from sources:

Note, that it is always a good idea to install the driver from the corresponding native package (if one is supported for your platform, like .msi , etc., which you can also easily create if you are building from sources), than use the binaries that were manually copied to a destination folder.

Native packages will have all the dependency information so when you install the driver using a native package, all required run-time packages will be installed automatically. If you use manual packaging, i.e., just extract driver binaries to some folder, you also have to make sure that all the run-time dependencies are satisfied in your system manually:

The first step usually consists of registering the driver so that the corresponding ODBC provider is able to locate it.

The next step is defining one or more DSNs, associated with the newly registered driver, and setting driver-specific parameters in the body of those DSN definitions.

All this involves modifying a dedicated registry keys in case of MDAC, or editing odbcinst.ini (for driver registration) and odbc.ini (for DSN definition) files for UnixODBC or iODBC, directly or indirectly.

This will be performed automatically using some default values if you are installing the driver using native installers.

Otherwise, if you are configuring manually, or need to modify the default configuration created by the installer, please see the exact locations of files (or registry keys) that need to be modified in the corresponding section below:

The list of DSN parameters recognized by the driver is as follows:

Parameter	Default value	Description
Url	empty	URL that points to a running ClickHouse instance, may include username, password, port, database, etc. Also, see URL query string
Proto	deduced from Url , or from Port and SSLMode : https if 443 or 8443 or SSLMode is not empty, http otherwise	Protocol, one of: http , https
Server or Host	deduced from Url	IP or hostname of a server with a running ClickHouse instance on it
Port	deduced from Url , or from Proto : 8443 if https , 8123 otherwise	Port on which the ClickHouse instance is listening
Path	/query	Path portion of the URL
UID or Username	default	User name
PWD or Password	empty	Password
Database	default	Database name to connect to
Timeout	30	Connection timeout
VerifyConnectionEarly	off	Verify the connection and credentials during SQLConnect and similar calls (adds a typical overhead of one trivial remote query execution), otherwise, possible connection-related failures will be detected later, during SQLExecute and similar calls
SSLMode	empty	Certificate verification method (used by TLS/SSL connections, ignored in Windows), one of: allow , prefer , require , use allow to enable SSL_VERIFY_PEER TLS/SSL certificate verification mode, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT is used otherwise
PrivateKeyFile	empty	Path to private key file (used by TLS/SSL connections), can be empty if no private key file is used
CertificateFile	empty	Path to certificate file (used by TLS/SSL connections, ignored in Windows), if the private key and the certificate are stored in the same file, this can be empty if PrivateKeyFile is specified
CALocation	empty	Path to the file or directory containing the CA/root certificates (used by TLS/SSL connections, ignored in Windows)
HugeIntAsString	off	Report integer column types that may underflow or overflow 64-bit signed integer ( SQL_BIGINT ) as a String / SQL_VARCHAR
DriverLog	on if CMAKE_BUILD_TYPE is Debug , off otherwise	Enable or disable the extended driver logging
DriverLogFile	\temp\clickhouse-odbc-driver.log on Windows, /tmp/clickhouse-odbc-driver.log otherwise	Path to the extended driver log file (used when DriverLog is on )

URL query string

Some of configuration parameters can be passed to the server as a part of the query string of the URL.

The list of parameters in the query string of the URL that are also recognized by the driver is as follows:

Parameter	Default value	Description
database	default	Database name to connect to
default_format	ODBCDriver2	Default wire format of the resulting data that the server will send to the driver. Formats supported by the driver are: ODBCDriver2 and RowBinaryWithNamesAndTypes

Note, that currently there is a difference in timezone handling between ODBCDriver2 and RowBinaryWithNamesAndTypes formats: in ODBCDriver2 date and time values are presented to the ODBC application in server’s timezone, wherease in RowBinaryWithNamesAndTypes they are converted to local timezone. This behavior will be changed/parametrized in future. If server and ODBC application timezones are the same, date and time values handling will effectively be identical between these two formats.

Troubleshooting: driver manager tracing and driver logging

To debug issues with the driver, first things that need to be done are:

• enabling driver manager tracing:
  • Enabling driver manager tracing: MDAC/WDAC (Microsoft/Windows Data Access Components)
  • Enabling driver manager tracing: UnixODBC
  • Enabling driver manager tracing: iODBC
• enabling driver logging, see DriverLog and DriverLogFile DSN parameters above
• making sure that the application is allowed to create and write these driver log and driver manager trace files

Building from sources

The general requirements for building the driver from sources are as follows:

• CMake 3.13.5 and later
• C++17 and C11 capable compiler toolchain:
  • Clang 4 and later
  • GCC 7 and later
  • Xcode 10 and later (on macOS 10.14 and later)
  • Microsoft Visual Studio 2017 and later

Additional requirements exist for each platform, which also depend on whether packaging and/or testing is performed.

See the exact steps for each platform in the corresponding section below:

The list of configuration options recognized during the CMake generation step is as follows:

Option	Default value	Description
CMAKE_BUILD_TYPE	RelWithDebInfo	Build type, one of: Debug , Release , RelWithDebInfo
CH_ODBC_ALLOW_UNSAFE_DISPATCH	ON	Allow unchecked handle dispatching (may slightly increase performance in some scenarios)
CH_ODBC_ENABLE_SSL	ON	Enable TLS/SSL (required for utilizing https:// interface, etc.)
CH_ODBC_ENABLE_INSTALL	ON	Enable install targets (required for packaging)
CH_ODBC_ENABLE_TESTING	inherits value of BUILD_TESTING	Enable test targets
CH_ODBC_PREFER_BUNDLED_THIRD_PARTIES	ON	Prefer bundled over system variants of third party libraries
CH_ODBC_PREFER_BUNDLED_POCO	inherits value of CH_ODBC_PREFER_BUNDLED_THIRD_PARTIES	Prefer bundled over system variants of Poco library
CH_ODBC_PREFER_BUNDLED_SSL	inherits value of CH_ODBC_PREFER_BUNDLED_POCO	Prefer bundled over system variants of TLS/SSL library
CH_ODBC_PREFER_BUNDLED_GOOGLETEST	inherits value of CH_ODBC_PREFER_BUNDLED_THIRD_PARTIES	Prefer bundled over system variants of Google Test library
CH_ODBC_PREFER_BUNDLED_NANODBC	inherits value of CH_ODBC_PREFER_BUNDLED_THIRD_PARTIES	Prefer bundled over system variants of nanodbc library
CH_ODBC_RUNTIME_LINK_STATIC	OFF	Link with compiler and language runtime statically
CH_ODBC_THIRD_PARTY_LINK_STATIC	ON	Link with third party libraries statically
CH_ODBC_DEFAULT_DSN_ANSI	ClickHouse DSN (ANSI)	Default ANSI DSN name
CH_ODBC_DEFAULT_DSN_UNICODE	ClickHouse DSN (Unicode)	Default Unicode DSN name
TEST_DSN_LIST	$;$	; -separated list of DSNs, each test will be executed with each of these DSNs

Configuration options above can be specified in the first cmake command (generation step) in a form of -Dopt=val .

Run-time dependencies: Windows

All modern Windows systems come with preinstalled MDAC driver manager.

Another run-time dependecies are C++ Redistributable for Visual Studio 2017 or same for 2019 , etc., depending on the package being installed, however the required DLL’s are redistributed with the .msi installer, and you can choose to install them from there, if you don’t have them installed in your system already.

Run-time dependencies: macOS

Execute the following in the terminal (assuming you have Homebrew installed):

Execute the following in the terminal (assuming you have Homebrew installed):

Run-time dependencies: Red Hat/CentOS

Execute the following in the terminal:

Execute the following in the terminal:

Run-time dependencies: Debian/Ubuntu

Execute the following in the terminal:

Execute the following in the terminal:

Configuration: MDAC/WDAC (Microsoft/Windows Data Access Components)

To configure already installed drivers and DSNs, or create new DSNs, use Microsoft ODBC Data Source Administrator tool:

• for 32-bit applications (and drivers) execute %systemdrive%\Windows\SysWoW64\Odbcad32.exe
• for 64-bit applications (and drivers) execute %systemdrive%\Windows\System32\Odbcad32.exe

For full description of ODBC configuration mechanism in Windows, as well as for the case when you want to learn how to manually register a driver and have a full control on configuration in general, see:

Note, that the keys are subject to «Registry Redirection» mechanism, with caveats.

You can find sample configuration for this driver here (just map the keys to corresponding sections in registry):

In short, usually you will end up editing /etc/odbcinst.ini and /etc/odbc.ini for system-wide driver and DSN entries, and

/.odbc.ini for user-wide driver and DSN entries.

There can be exceptions to this, as these paths are configurable during the compilation of UnixODBC itself, or during the run-time via ODBCINI , ODBCINSTINI , and ODBCSYSINI .

For more info, see:

You can find sample configuration for this driver here:

These samples can be added to the corresponding configuration files using the odbcinst tool (assuming the package is installed under /usr/local ):

In short, usually you will end up editing /etc/odbcinst.ini and /etc/odbc.ini for system-wide driver and DSN entries, and

/.odbc.ini for user-wide driver and DSN entries.

In macOS, if those INI files exist, they usually are symbolic or hard links to /Library/ODBC/odbcinst.ini and /Library/ODBC/odbc.ini for system-wide, and

/Library/ODBC/odbc.ini for user-wide configs respectively.

There can be exceptions to this, as these paths are configurable during the compilation of iODBC itself, or during the run-time via ODBCINI and ODBCINSTINI . Note, that ODBCINSTINI in iODBC contains the full path to the file, while for UnixODBC it is a file name, and the file itself is expected to be under ODBCSYSINI dir.

For more info, see:

You can find sample configuration for this driver here:

Enabling driver manager tracing: MDAC/WDAC (Microsoft/Windows Data Access Components)

Comprehensive explanations (possibly, with some irrelevant vendor-specific details though) on how to enable ODBC driver manager tracing could be found at the following links:

Enabling driver manager tracing: UnixODBC

Comprehensive explanations (possibly, with some irrelevant vendor-specific details though) on how to enable ODBC driver manager tracing could be found at the following links:

Enabling driver manager tracing: iODBC

Comprehensive explanations (possibly, with some irrelevant vendor-specific details though) on how to enable ODBC driver manager tracing could be found at the following links:

Building from sources: Windows

CMake bundled with the recent versions of Visual Studio can be used.

An SDK required for building the ODBC driver is included in Windows SDK, which in its turn is also bundled with Visual Studio.

You will need to install WiX toolset to be able to generate .msi packages. You can download and install it from WiX toolset home page.

All of the following commands have to be issued in Visual Studio Command Prompt:

• use x86 Native Tools Command Prompt for VS 2019 or equivalent for 32-bit builds
• use x64 Native Tools Command Prompt for VS 2019 or equivalent for 64-bit builds

Clone the repo with submodules:

Enter the cloned source tree, create a temporary build folder, and generate the solution and project files in it:

Build the generated solution in-place:

. and, optionally, run tests (note, that for non-unit tests, preconfigured driver and DSN entries must exist, that point to the binaries generated in this build folder):

. or open the IDE and build all , package , and test targets manually from there:

Building from sources: macOS

You will need macOS 10.14 or later, Xcode 10 or later with Command Line Tools installed, as well as up-to-date Homebrew available in the system.

Install Homebrew using the following command, and follow the printed instructions on any additional steps required to complete the installation:

Then, install the latest Xcode from App Store. Open it at least once to accept the end-user license agreement and automatically install the required components.

Then, make sure that the latest Command Line Tools are installed and selected in the system:

Build-time dependencies: iODBC

Execute the following in the terminal:

Build-time dependencies: UnixODBC

Execute the following in the terminal:

Clone the repo recursively with submodules:

Enter the cloned source tree, create a temporary build folder, and generate a Makefile for the project in it:

Build the generated solution in-place:

. and, optionally, run tests (note, that for non-unit tests, preconfigured driver and DSN entries must exist, that point to the binaries generated in this build folder):

. or, if you configured the project with ‘-G Xcode’ initially, open the IDE and build all , package , and run_tests targets manually from there:

Building from sources: Red Hat/CentOS

Build-time dependencies: UnixODBC

Execute the following in the terminal:

Build-time dependencies: iODBC

Execute the following in the terminal:

All of the following commands have to be issued right after this one command issued in the same terminal session:

Clone the repo with submodules:

Enter the cloned source tree, create a temporary build folder, and generate a Makefile for the project in it:

Build the generated solution in-place:

. and, optionally, run tests (note, that for non-unit tests, preconfigured driver and DSN entries must exist, that point to the binaries generated in this build folder):

Building from sources: Debian/Ubuntu

Build-time dependencies: UnixODBC

Execute the following in the terminal:

Build-time dependencies: iODBC

Execute the following in the terminal:

Assuming, that the system cc and c++ are pointing to the compilers that satisfy the minimum requirements from Building from sources.

If the version of cmake is not recent enough, you can install a newer version by folowing instructions from one of these pages:

Clone the repo with submodules:

Enter the cloned source tree, create a temporary build folder, and generate a Makefile for the project in it:

Build the generated solution in-place:

. and, optionally, run tests (note, that for non-unit tests, preconfigured driver and DSN entries must exist, that point to the binaries generated in this build folder):

Источник