| Note |
|---|
| Work in progress, can be obsolete |
| Note |
|---|
|
Detailed requirements are displayed on configure stage, KDb won't try to build if they are not met. You can also look for the "find_package" lines in the top level CMakeLists.txt file.
All database drivers are optional, what gives you a full choice.
| Note |
|---|
| PostgreSQL Server installation is not needed for building KDb or software that uses it. The server is needed only for running the actual database service. Any installation on separate (e.g. remote) machine can be reused. |
| Note |
|---|
| MySQL Server installation is not needed for building KDb or software that uses KDb. The server is needed for running actual database service. Any installation on separate (e.g. remote) machine can be reused. |
| Note |
|---|
| Sybase/MSSQL and xBase support is disabled for now --Jstaniek (talk) 14:14, 9 October 2014 (UTC) |
Download KDb source code as explained on the Download page. The root directory of the source code is referred as {kdb-source-dir}, and the root build directory is referred as {kdb-build-dir}.
Not recommended for developers, instead see Variant 2 below. You can install KDb in the global PREFIX ({kdb-install-prefix} = /usr by default), but this is not recommended as can be in conflict with existing or future installations, e.g. binaries installed from packages. Type:
KDE Community Wiki mkdir {kdb-build-dir}
cd {kdb-build-dir}
cmake {options} {kdb-source-dir}
This will configure installation of KDb libraries into /usr/local/lib, its binaries into /usr/local/bin, etc.
To change that to /usr/lib (really really not recommended for developers), etc., change the cmake command to:
cmake -DCMAKE_INSTALL_PREFIX=/usr {options} {kdb-source-dir}
Here is recommended directory structure:
mkdir {kdb-build-dir}
cd {kdb-build-dir}
cmake -DCMAKE_INSTALL_PREFIX={kdb-install-prefix} {options} {kdb-source-dir}
This will configure build dir as {kdb-build-dir} and installation of KDb libraries into {kdb-install-prefix}/lib(64), its binaries into {kdb-build-dir}/bin, etc.
{options} mean some extra cmake options that let you to control how KDb is built and what is included:
Instead of using command line, you can also alter these options once you configure the build by invoking an interactive tool:
ccmake .
in {kdb-build-dir}, then to reconfigure press c key when you're done and then press q key.
Read about more CMake options here.
At any time in the {kdb-build-dir} you can type
cmake .
and the configuration step will display you the current selection of options. Following sections are available:
TODO: To avoid installing to global a location such as /usr, for whatever reason, for your convenience, config-for-local.sh script has been prepared with default configuration settings. You can find it in tools/ subdirectory of the source code. Use it as follows:
1. Make sure $PREDICATE_INSTALL_PREFIX environment variable is set to directory that is indended PREFIX for the local Predicate installation, e.g. $HOME/predicate/inst.
2. To have the Predicate installation work environment variables PATH, LD_LIBRARY_PATH, PKG_CONFIG_PATH, QT_PLUGIN_PATH should be set properly. Double check this:
_libdir=lib # or lib64 for 64-bit platforms export PATH=$PREDICATE_INSTALL_PREFIX/bin:$PATH export LD_LIBRARY_PATH=$PREDICATE_INSTALL_PREFIX/$_libdir:$LD_LIBRARY_PATH export PKG_CONFIG_PATH=$PREDICATE_INSTALL_PREFIX/$_libdir/pkgconfig:$PKG_CONFIG_PATH export QT_PLUGIN_PATH=$PREDICATE_INSTALL_PREFIX/$_libdir/plugins/predicate:$QT_PLUGIN_PATH
3. Then:
mkdir -p {predicate-build-dir}
cd {predicate-build-dir}
(better pick your {predicate-build-dir} outside of the source code)
{predicate-source-dir}/tools/config-for-local.sh {cmake-options}
For explanation of {cmake_options}, see the cmake options section.
===Variant 3: Configuration for re-using local KDE 4 installation===
Here is recommendation of a directory structure:
If you use local KDE 4 installation, e.g. for developed applications, for your convenience, config-for-kde.sh script has been prepared with default configuration settings. You can find it in tools/ subdirectory of the source code. Use it as follows:
1. Make sure $KDEDIRS environment variable is set to directory that is intended PREFIX for the local KDE 4 installation, e.g. $HOME/kde4/inst.
2. To make the Predicate installation work, environment variables PATH, LD_LIBRARY_PATH, PKG_CONFIG_PATH, QT_PLUGIN_PATH should be set properly. Several of these are probably already set for the local KDE 4 installation but better double check this:
_libdir=lib # or lib64 for 64-bit platforms export PATH=$KDEDIRS/bin:$PATH export LD_LIBRARY_PATH=$KDEDIRS/$_libdir:$LD_LIBRARY_PATH export PKG_CONFIG_PATH=$KDEDIRS/$_libdir/pkgconfig:$PKG_CONFIG_PATH export QT_PLUGIN_PATH=$KDEDIRS/$_libdir/kde4/plugins:$QT_PLUGIN_PATH
3. Then:
mkdir -p {predicate-build-dir}
cd {predicate-build-dir}
(better pick your {predicate-build-dir} outside of the source code)
{predicate-source-dir}/tools/config-for-kde.sh {cmake-options}
For explanation of {cmake_options}, see the cmake options section.
Recommended for accurate debugging: The default debug setting is RelWithDebInfo which is suitable only for obtaining backtraces. If you are developing code that uses KDb or developing KDb itself you may want to precisely set breakpoints, watch points, use step by step command accurately in your debugger, rely on assertions, debug and warning messages. If this is the case, you can replace -DCMAKE_BUILD_TYPE=RelWithDebInfo cmake option with:
-DCMAKE_BUILD_TYPE=Debug
Using Debug results in a slower code. That can be acceptable in most cases during testing and development given the machine is fast enough. It is not intended for production releases of the software unless you know what you're doing.
To build with tests enabled (both unit tests and functional tests), add -DBUILD_TESTING=ON to the cmake command before building.
For any configuration option: Type the above configuration command only once, to configure the cmake-based buildsystem. Then just type:
make make install
To completely reconfigure, remove the {kdb-build-dir} directory completely and repeat the configuration process.
Recommended: Taking advantage of multi-core processors. On dual-core machines compilation can be greatly speed up with the -j parameter of the make program. For example whenever you are invoking make, for dual-core processor try to invoke:
make -j3
Similarly, for quad-core processor:
make -j5
Generaly for N-core processor use the -jN+1 parameter.
Recommended: Faster linking on Linux. Linking can take noticeable time in large software such as Calligra. On Linux Gold linker can be used to speed up this task. If you're building for Linux, install the Gold linker package and add the following to your cmake command:
-DCMAKE_C_FLAGS=-fuse-linker-plugin -DCMAKE_CXX_FLAGS=-fuse-linker-plugin
(you can set the CMAKE_C_FLAGS adn CMAKE_CXX_FLAGS variables in your {build dir}/CMakeCache.txt file either using text editor or the ccmake tool)
To enable debugging inside of bison (.y) file, put this in your $HOME/.gdbinit config file:
set directories {kdb-source-dir}/src/parser
(change {kdb-source-dir} to appropriate absolute path)
