README

   1 Introduction
   2 ------------
   3 CSQL is a fast, multi-threaded SQL main memory database engine. It is a free software, licensed with the GNU GENERAL PUBLIC LICENSE http://www.gnu.org/
   4 It aids in the development of high performance, fault-resilent applications requiring concurrent access to the shared data.
   5
   6 Check www.databasecache.com for more details about its usage.
   7
   8 Platforms Supported
   9 -------------------
  10 Linux
  11
  12 Compilers Supported
  13 -------------------
  14 g++ in linux
  15
  16 Compiling the source
  17 --------------------
  18 Go to the root directory and enter the following commands.
  19
  20 $./configure --prefix=`pwd`/install
  21 $make
  22 $./csqlinstall.ksh
  23
  24 This will create "install" directory under the current directory and places all the executables created in bin directory and libraries in lib directory.
  25
  26 Available Documentation
  27 -----------------------
  28 1.User Manual is available under the docs directory
  29 2.HTML API Reference for DB API under the docs/html directory (Refer next section)
  30 3.DB API example programs under the examples directory
  31
  32 Generating API Reference
  33 ------------------------
  34 Go to the root directory and enter
  35 $doxygen
  36
  37 This will create "docs/html" directory under which API Reference html files are stored. Refer index.html in that directory.
  38
  39 Starting the Server
  40 -------------------
  41 Note: kernel.shmmax should be set to more than 500 MB before starting the server
  42
  43 In linux for setting 1GB enter
  44 $sysctl -w kernel.shmmax=1000000000
  45
  46 You should find csqlserver executable under the bin directory of the installation.
  47 Change csql.conf file under the installation root directory if necessary.
  48 Set the CSQL_CONFIG_FILE environment variable to absolute path of csql.conf file.
  49
  50 For example, if csql.conf is available at /tmp directory, then
  51 $export CSQL_CONFIG_FILE=/tmp/csql.conf
  52
  53 Start the server using csqlserver executable
  54 $./csqlserver
  55
  56 This starts the server and creates the database file.
  57
  58 Shutting down the Server
  59 ------------------------
  60 Pressing Ctrl-C on the terminal where csqlserver is running,
  61 is safe and will stop the server gracefully by removing the database file.