Building the project

This is the top-level description of the build process.

Building has been tested on Microsoft Windows and in several Linux distributions. On the Widnows platform use Visual Studio 2005 or Visual C++ Express 2005. On Linux, only the standard tools are used.

External dependency projects

The project is dependent on several third-party open-source projects. Building these projects is described in separate documents: Building the PCRE library, Building the Crypto++ library, Building the Intl library, Building the WX libraries, Building ODBC support and Installing the relaytool. Build these before building the project. The following table shows the dependencies:

Project Windows Unix
PCRE Build Build
Crypto++ Build Build
Intl Build or use GNU binaries for Windows Use from the distribution
wxWidgets Build if you need the GUI client Build if you need the GUI client
ODBC Built-in Build or use from the distribution
relaytool Not used Download and install

The project may be built in "debug" or "release" configuration. Both configurations may coexist. In the description of the build process, the selected configuration will be denoted as $(CONF_NAME).

The build process starts with unpacking the project into a directory. The directory is later referenced as $(SQL_ROOT). Then prepare all dependency projects listed above.

The directory structure below $(SQL_ROOT) is described here.
Description of subprojects

The project consists of a number of subprojects:

Name Description Depends on
zip Compression library for files larger than 4 GB -
sec Cryptograpy and authentication utilities Crypto++
krnl Main client library that communicates with the 602SQL server (dynamic) sec, odbc, relaytool (on Unix)
krnllib Main client library taht communicates with the 602SQL server (static) sec
odbcw ODBC driver (on Windows also contains the setup functions) krnllib
odbccfg ODBC configuration utility for unixODBC (Unix only) unixODBC
gcli GUI client krnl, zip, wxWidgets
srv SQL server sec, zip, PCRE, intl
svc SQL server as a Windows service sec, zip, PCRE, intl
mng Server manager with GUI krnl, wxWidgets

The following subprojects are described in separate documents:

Name Description
PHP module Module for accessing the database from PHP scripts
JDBC driver Driver for accessing the database from Java programs
SDBC driver Driver for accessing the database from OpenOffice programs

Building on the Windows platform

The build process is described by multiple property sheets and by several property pages in individual projects. The projects inherit many parameter values from the property sheets. A brief description of paramters can be found here. Usually it is not necessary to modify anything other than some user macros in the "common" property sheet.

C runtime library type

All parts of an executable or a dynamic library must use the same type of C runtime libraries (CRT). Because static libraries from the project and from the dependency projects are used in multiple dynamic libraries and executables, it is wise to extent this rule to all compiled objects and to use the same type of CRT in all modules.

The type of CRT is specified by the value of "Runtime Library" option in the "C/C++ Code Generation" property page.

For all subprojects of the project the type of CRT is defined in "common debug" and "common release" property sheets. The default setting is "static". For external projects modify the corresponding property pages or makefiles.

When deciding which type of C runtime library to use, take into consideration the following:

  • Using the static CRT makes the resulting binaries some tens of kilobytes bigger.
  • Using the dynamic CRT means that you have to deploy the CRT dll. Check if you are eligible to do this.
  • It is not clear if using the dynamic CRT for libintl violates the LGPL.
  • With the static CRT, the language of the SQL server depends on the LANGUAGE environment variable or locales, and cannot by defined by the option in the GUI client.

In order to build the project:

  1. Open the solution (.sln) file located in the build subdirectory.
  2. In the Property Manager, open the "common" property sheet and edit the page User Macros. Define the paths to the dependency project root directories. Update values of other variables, if necessary.
  3. Select the $(CONF_NAME) configuration and build the solution.

Output files are in the output\$(CONF_NAME) subdirectory. The full binary tree is the $(InstRoot) directory, where InstRoot is a macro defined in the "common" property sheet.
Building on the Unix platforms

The build process is driven by the autoconf system.

  1. In $(SQL_ROOT)/build, prepare the configuration directory (debug or release): mkdir $(CONF_NAME) cd $(CONF_NAME)
  2. ../configure configure-params

    The configure parameters are described here.

  3. make

    This produces project binaries in the output/$(CONF_NAME) subdirectory.

  4. make prefix=<path>/ install

    This creates the installation tree in the directory defined by the specified prefix. All binaries are relocable: the directory structure may be copied to /usr, /usr/local, /opt or any other place, and will run there.