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