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 and Solaris
  11
  12 Compilers Supported
  13 -------------------
  14 g++ in linux,
  15 CC in solaris
  16
  17 Compiling the source
  18 --------------------
  19 Go to the root directory and enter the following commands.
  20
  21 $./configure --prefix=`pwd`/install
  22 $make
  23 $make install
  24
  25 This will create "install" directory under the current directory and places all the executables created in bin directory and libraries in lib directory.
  26
  27 Available Documentation
  28 -----------------------
  29 1.User Manual is available under the docs directory
  30 2.HTML API Reference for DB API under the docs/html directory (Refer next section)
  31 3.DB API example programs under the examples directory
  32
  33 Generating API Reference
  34 ------------------------
  35 Go to the root directory and enter
  36 $doxygen
  37
  38 This will create "docs/html" directory under which API Reference html files are stored. Refer index.html in that directory.
  39
  40 Starting the Server
  41 -------------------
  42 Note: kernel.shmmax should be set to more than 500 MB before starting the server
  43
  44 In linux for setting 1GB enter
  45 $sysctl -w kernel.shmmax=1000000000
  46
  47 You should find csqlserver executable under the bin directory of the installation.
  48 Change csql.conf file under the installation root directory if necessary.
  49 Set the CSQL_CONFIG_FILE environment variable to absolute path of csql.conf file.
  50
  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, is safe and will stop the server gracefully by removing the database file.