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