C / C++
macOS / Linux
To use TileDB C API in a program, just add
#include <tiledb/tiledb.h>and specify
-ltiledbwhen compiling, e.g.
$ gcc example.c -o example -ltiledb
To use the C++ API, add
#include <tiledb/tiledb>to your C++ project instead. The TileDB C++ API requires a compiler with C++11 support, thus your project must be compiled using the C++17 standard, e.g.
$ g++ -std=c++17 example.cpp -o example -ltiledb
If TileDB was installed in a non-default location on your system, use the
$ gcc example.c -o example -I<path/to/TileDB>/include -L<path/to/TileDB>/lib -ltiledb
At runtime, if TileDB is installed in a non-default location, you must make the linker aware of where the shared library resides by exporting an environment variable:
$ export DYLD_LIBRARY_PATH="<path/to/TileDB>/lib:$DYLD_LIBRARY_PATH"
$ export LD_LIBRARY_PATH="<path/to/TileDB>/lib:$LD_LIBRARY_PATH"
You can avoid the use of these environment variables by installing TileDB in a global (standard) location on your system, or hard-coding the path to the TileDB library at build time by configuring the
$ g++ -std=c++17 example.cpp -o example \
Building your program this way will result in a binary that will run without having to configure the
Alternatively, when installing to system-wide paths known to
sudo ldconfigafter installation to update the search cache.
To use TileDB from a Visual Studio C++ project, you need to add project properties telling the compiler and linker where to find the headers and libraries.
Open your project’s Property Pages. Under the General options for C/C++, edit the “Additional Include Directories” property. Add a new entry pointing to your TileDB installation (either built from source or extracted from the binary release .zip file), e.g.
Under the General options for the Linker, edit the “Additional Library Directories” property. Add a new entry pointing to your TileDB installation, e.g.
C:\path\to\TileDB\dist\lib. Under the Input options for Linker, edit “Additional Dependencies” and add
You should now be able to add
#include <tiledb/tiledb.h>(C API) or
#include <tiledb/tiledb>(C++ API) in your project.
When building your project in Visual Studio, ensure that the
x64build configuration is selected. Because TileDB is currently only available as a 64-bit library, applications that link with TileDB must also be 64-bit.
At runtime, the directory containing the DLLs must be in your
PATHenvironment variable, or you will see error messages at startup that the TileDB library or its dependencies could not be located. You can do this in Visual Studio by adding
PATH=C:\path\to\TileDB\dist\binto the “Environment” setting under “Debugging” in the Property Pages. You can also do this from the Windows Control Panel, or at the command prompt like so:
> $env:Path += ";C:\path\to\TileDB\dist\bin"
> set PATH=%PATH%;C:\path\to\TileDB\dist\bin
Should you experience any problem with the usage (e.g., getting errors about missing
.dllfiles when running a program), it is always a good idea to delete the
distdirectories in your TileDB repo path and restart the build from scratch, as
cmake’s cached state could present some unexpected problems.
TileDB includes support for CMake’s
find_package(). To use, TileDB must be installed globally or
CMAKE_PREFIX_PATHmust be set to the TileDB installation directory.
For example if TileDB was built with
../bootstrapand no prefix was given then the
</path/to/TileDB>/dist/lib/cmake/TileDBdirectory will contain the
TileDBConfig.cmakefile used for
find_package(TileDB). In your project, you would set
list(APPEND CMAKE_PREFIX_PATH "</path/to/TileDB>/dist")
You can also pass this like any other CMake variable on the command line when configuring your project, e.g.
$ cmake -DCMAKE_PREFIX_PATH=</path/to/TileDB>/dist ..
To link the executable
MyExein your project with the TileDB shared library, you would then use:
# Find TileDB
# Link to shared library, this will set header include directories also.
target_link_libraries(MyExe PRIVATE TileDB::tiledb_shared)
While disabled by default, TileDB can also be built as a static library. To do this, use the
-EnableStaticTileDB(Windows) bootstrap flag when configuring TileDB, or use the CMake equivalent flag
-DTILEDB_STATIC=ON. Then in your project simply link against the
# Find TileDB
# Link to static library, this will set header include directories also
target_link_libraries(MyExe PRIVATE TileDB::tiledb_static)