README.INSTALL

   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 Untar the distribution
  17 ----------------------
  18 Go to the root directory and enter the following commands.
  19 $gunzip csql-linux-i686-1.0Beta.tar.gz
  20 $tar xvf csql-linux-i686-1.0Beta.tar
  21
  22 This will create the following directories,
  23   1. include
  24   2. lib
  25   3. bin
  26   4. docs
  27   5. examples
  28 and following files,
  29   1. Doxyfile
  30   2. COPYING
  31   3. AUTHORS
  32   4. ChangeLog
  33   5. README
  34
  35 under csql-linux-i686-1.0Beta directory.
  36
  37 Available Documentation
  38 -----------------------
  39 1.User Manual is available under the docs directory
  40 2.HTML API Reference for DB API under the docs/html directory (Refer next section)
  41 3.DB API example programs under the examples directory
  42
  43 Generating API Reference
  44 ------------------------
  45 Go to the root directory and enter
  46 $doxygen
  47
  48 This will create "docs/html" directory under which API Reference html files are stored. Refer index.html in that directory.
  49
  50 Starting the Server
  51 -------------------
  52 Note: kernel.shmmax should be set to more than 500 MB before starting the server
  53
  54 In linux for setting 1GB enter
  55 $sysctl -w kernel.shmmax=1000000000
  56
  57 Change csql.conf file under the installation root directory if necessary.
  58 Set the CSQL_CONFIG_FILE environment variable to absolute path of csql.conf file.
  59
  60 $export CSQL_CONFIG_FILE=/tmp/csql.conf
  61
  62
  63 You should find csqlserver executable under the bin directory of the installation.
  64
  65 $./csqlserver
  66
  67 This starts the server and creates the database file.
  68
  69 Shutting down the Server
  70 ------------------------
  71 Pressing Ctrl-C on the terminal where csqlserver is running, is safe and will stop the server gracefully by removing the database file.
  72