First check in of README file
[csql.git] / README
blob5f7a74f081383f4134c5c66371ebe348eee3667b
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.
6 Platforms Supported
7 -------------------
8 Linux and Solaris
10 Compilers Supported
11 -------------------
12 g++ in linux,
13 CC in solaris
15 Compiling the source
16 --------------------
17 Go to the root directory and enter the following commands.
19 $./configure --prefix=`pwd`/install
20 $make
21 $make install
23 This will create "install" directory under the current directory and places all the executables created in bin directory and libraries in lib directory.
25 Available Documentation
26 -----------------------
27 1.User Manual is available under the docs directory
28 2.HTML API Reference for DB API under the docs/html directory
29 3.DB API example programs under the examples directory
31 Generating API Reference
32 ------------------------
33 Go to the root directory and enter
34 $doxygen
36 This will create "docs/html" directory under which API Reference html files are stored. Refer index.html in that directory.
38 Starting the Server
39 -------------------
40 You should find csqlserver executable under the bin directory of the installation.
42 $./csqlserver
44 This starts the server and creates the database file.
46 Shutting down the Server
47 ------------------------
48 Pressing Ctrl-C on the terminal where csqlserver is running, is safe and will stop the server gracefully by removing the database file.