To use TileDB C API in a program, just add #include <tiledb/tiledb.h>
and specify -ltiledb
when compiling, e.g.
To use the C++ API, add #include <tiledb/tiledb>
to your C++ project instead. The TileDB C++ API requires a compiler with C++17 support, thus your project must be compiled using the C++17 standard, e.g.
If TileDB was installed in a non-default location on your system, use the -I
and -L
options:
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:
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 rpath
, e.g.
Building your program this way will result in a binary that will run without having to configure the LD_LIBRARY_PATH
or DYLD_LIBRARY_PATH
environment variables.
Alternatively, when installing to system-wide paths known to ldconfig
(typically in /etc/ld.so.conf.d/*
or /etc/ld.so.conf
), run sudo ldconfig
after 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. C:\path\to\TileDB\dist\include
.
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 tiledb.lib
.
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 x64
build 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 PATH
environment 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\bin
to 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:
Should you experience any problem with the usage (e.g., getting errors about missing .dll
files when running a program), it is always a good idea to delete the build
and dist
directories 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_PATH
must be set to the TileDB installation directory.
For example if TileDB was built with ../bootstrap
and no prefix was given then the </path/to/TileDB>/dist/lib/cmake/TileDB
directory will contain the TileDBConfig.cmake
file used for find_package(TileDB)
. In your project, you would set CMAKE_PREFIX_PATH
like so:
You can also pass this like any other CMake variable on the command line when configuring your project, e.g.
To link the executable MyExe
in your project with the TileDB shared library, you would then use:
While disabled by default, TileDB can also be built as a static library. To do this, use the --enable-static-tiledb
(macOS/Linux) or -EnableStaticTileDB
(Windows) bootstrap flag when configuring TileDB, or use the CMake equivalent flag -DTILEDB_STATIC=ON
. Then in your project simply link against the tiledb_static
target instead:
You can see the example CMake project in the TileDB source repository to see an example project structure that links against TileDB.
After installing TileDB and the Python bindings, from a Python shell:
After building TileDB-Java, you can run the examples located in path/to/TileDB-Java/src/main/java/examples
using you IDE or from a terminal.
To run an example from the terminal, use:
You may need to explicitly define the java library path if not using the bundled jar:
After installing the Go bindings, download any of the TileDB-Go examples, and then run with:
After installing TileDB, from an R shell: