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 $ export JDK_HOME=<path of jdk home>
  21 $ export PATH=$PATH:$JDK_HOME/bin
  22 $ ./configure --prefix=`pwd`/install CXXFLAGS="-I$JDK_HOME/include -I$JDK_HOME/include/linux"
  23 $ make
  24 $ make install
  25 $ ./csqlinstall.ksh
  26
  27 Note:
  28 setupenv.ksh script is available at the root directory which shall be used to
  29 set the necessary environment variables.
  30
  31 This will create "install" directory under the current directory and places all the executables created in bin directory and libraries in lib directory.
  32
  33 Available Documentation
  34 -----------------------
  35 1.User Manual is available under the docs directory
  36 2.HTML API Reference for DB API under the docs/html directory (Refer next section)
  37 3.DB API, SQL API, JDBC, ISQL  example programs under the examples directory
  38
  39 Generating API Reference
  40 ------------------------
  41 Go to the root directory and enter
  42 $doxygen
  43
  44 This will create "docs/html" directory under which API Reference html files are stored. Refer index.html in that directory.
  45
  46 Starting the Server
  47 -------------------
  48 Note: kernel.shmmax should be set to more than 500 MB before starting the server
  49
  50 In linux for setting 1GB enter
  51 $sysctl -w kernel.shmmax=1000000000
  52
  53 You should find csqlserver executable under the bin directory of the installation.
  54 Change csql.conf file under the installation root directory if necessary.
  55 Set the CSQL_CONFIG_FILE environment variable to absolute path of csql.conf file.
  56
  57 For example, if csql.conf is available at /tmp directory, then
  58 $export CSQL_CONFIG_FILE=/tmp/csql.conf
  59
  60 Start the server using csqlserver executable
  61 $./csqlserver
  62
  63 This starts the server and creates the database file.
  64
  65 Note:
  66 Refer UserManual.pdf available in docs folder to know how to work with csql
  67
  68 Shutting down the Server
  69 ------------------------
  70 Pressing Ctrl-C on the terminal where csqlserver is running,
  71 is safe and will stop the server gracefully by removing the database file.