code reorganization phase - I
[csql.git] / README
blobea4a8101f4b17879ed7013bc3ab5e1d1d82223d9
1 Introduction 
2 ------------
3         CSQL is a fast, multi-threaded SQL main memory database engine. It works in both embedded mode (database client and server run in the same host) and client/server mode. It provides very high throughput of 100,000 selects/sec and 50,000 updates/sec from standard interface such as JDBC and ODBC. It aids in the development of high performance, fault-resilent applications requiring concurrent access to the shared data.
5         CSQL shall also be used as client side caching mechanism for any database system without compromising on transactional properties and indexed access. This is achieved by using CSQL-main memory database to cache the data from the target database (any traditional disk based database system). 
7         This solution has been designed with modern database requirements in mind, and particularly for use within high-volume environment that requires high performance, while still supporting the transactional properties. Applications shall use this caching solution with no or minimal application code changes. Application throughput may increase by a factor of 20 to 100 by incorporating data caching in its architecture.
9         It comes in dual license, GPL for open source community edition and commercial license for enterprise edition.
11 Platforms Supported
12 -------------------
13 Linux    - x86, x86_64
14 Solaris  - x86, sparc32, sparc64
15 FreeBSD  - x86, x86_64
17 Compilers Supported
18 -------------------
19 g++ in Linux
20 g++ in FreeBSD
21 CC in Solaris
23 Available Documentation
24 -----------------------
25 1.User Manual
26 2.Programmer's Guide 
27 3.Cache Guide
28 4.Replication Guide
30 All the manuals are available under the docs directory
32 Starting the Server
33 -------------------
34 setupenv.ksh script is available at the root directory which shall be used to
35 set the necessary environment variables for CSQL.
37 $. ./setupenv.ksh
39 Start the server using csqlserver executable
40 $csqlserver
42 This starts the server and creates the database file.
44 Interacting with Server using csql client
45 -----------------------------------------
46 Open another terminal and run setupenv.ksh script to set the necessary 
47 environment variables for CSQL.
49 $. ./setupenv.ksh
51 Run csql tool to get the CSQL prompt
53 $csql
54 CSQL>
56 You can execute DDL and DML statements on CSQL prompt.
58 Note:
59 Refer UserManual.pdf available in docs folder for details on working with CSQL
61 Shutting down the Server
62 ------------------------
63 Pressing Ctrl-C on the terminal where csqlserver is running, 
64 is safe and will stop the server gracefully.