# SequoiaDB

**Repository Path**: SequoiaDB/SequoiaDB

## Basic Information

- **Project Name**: SequoiaDB
- **Description**: SequoiaDB 巨杉数据库是一款分布式文档型数据库，自研的原生分布式存储引擎支持完整ACID，具备弹性扩展、高并发和高可用特性，并以文档型 JSON 的半结构化数据格式为基础，兼容S3对象数据引擎接口，进一步形成Multi-Model多模数据处理能力，可支持跨结构化、半结构化和非结构化的多模数据处理。适用于历史数据平台、全量数据平台、实时数据中台和内容数据管理平台等各类应用场景。
- **Primary Language**: C++
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: http://www.sequoiadb.com/cn/
- **GVP Project**: No

## Statistics

- **Stars**: 946
- **Forks**: 627
- **Created**: 2014-12-17
- **Last Updated**: 2025-08-12

## Categories & Tags

**Categories**: database-service

**Tags**: None

## README

SequoiaDB README
=================

Welcome to SequoiaDB!

SequoiaDB is a distributed document-oriented NoSQL Database.

Engine:
-----------------
	sequoiadb       -- SequoiaDB Engine
	sdbstart        -- SequoiaDB Engine start
	sdbstop         -- SequoiaDB Engine stop
	sdblist         -- SequoiaDB Engine list
	sdbfmp          -- SequoiaDB fenced mode process


Shell:
-----------------
	sdb             -- SequoiaDB client
	sdbbp           -- SequoiaDB client backend process


Cluster Manager:
-----------------
	sdbcm           -- SequoiaDB cluster manager
	sdbcmart        -- SequoiaDB cluster manager start
	sdbcmtop        -- SequoiaDB cluster manager stop
	sdbcmd          -- SequoiaDB cluster manager daemon


Tools:
-----------------
	sdbdpsdump      -- SequoiaDB log dump
	sdbexprt        -- SequoiaDB export
	sdbimprt        -- SequoiaDB import
	sdbinspt        -- SequoiaDB data inspection
	sdbrestore      -- SequoiaDB restore
	sdbtop          -- SequoiaDB TOP
	sdbperfcol      -- SequoiaDB performance collection
	sdbwsart        -- SequoiaDB web service start
	sdbwstop        -- SequoiaDB web service stop
	sequoiafs       -- SequoiaFS file system


Drivers:
-----------------
	C Driver:
		libstaticsdbc.a
		libsdbc.so
	C++ Driver:
		libstaticsdbcpp.a
		libsdbcpp.so
	PHP Driver:
		libsdbphp-x.x.x.so
	JAVA Driver:
		sequoiadb-driver-x.x.x.jar
	Python Driver:
		#if python2
		pysequoiadb-x.x.x-py2.tar.gz
		#if python3
		pysequoiadb-x.x.x-py3.tar.gz
	.NET Driver:
		sequoiadb.dll



Connectors:
-----------------
	Hadoop Connector:
		hadoop-connector.jar
	Hive Connector:
		hive-sequoiadb-apache.jar
	Storm Connector:
		storm-sequoiadb.jar


Building Prerequisites:
-----------------
	scons ( 2.3.0 )
	ant ( 1.8.2 )
	Python ( 2.7.3 )
	PostgreSQL ( 9.3.4 )
	Linux x86-64:
		g++ ( 4.3.4 )
		gcc ( 4.3.4 )
		make ( 3.81 )
		kernel ( 3.0.13-0.27-default )
	Linux PPC64:
		g++ ( 4.3.4 )
		gcc ( 4.3.4 )
		make ( 3.81 )
		kernel ( 3.0.13-0.27-ppc64 )
	Windows:
		Windows SDK 7.1 ( Installation path must be C:\Program Files\Microsoft SDKs\Windows\v7.1 or
		C:\Program Files (x86)\Microsoft SDKs\Windows\v7.1 )
	Note:
		The utility and kernel version are for recommendation only.
		Users may use different version but may need to deal with any incompatibility issues.


Building Engine:
-----------------
	Engine Only:
		scons --engine
	C/C++ Client:
		scons --client
	Shell:
		scons --shell
	Tools:
		scons --tool
	Testcase:
		scons --testcase
	FMP:
		scons --fmp
	All ( except drivers ):
		scons --all
	Note:
		adding option "--dd" for debug build


Building Drivers:
-----------------
	C/C++ Client:
	    	cd sequoiadb
		scons --client
	PHP Client:
		cd driver/php
		scons --phpversion=5.4.6
		Note:
			PHP source code is located in thirdparty/php directory
			The dir name must be "php-<version>"
	Python Client:
		cd driver/python
		<python-devel package is required>
		#if python2
		apt install python-dev
		scons
		#if python3
		apt install python3-dev
		scons --py3
	Java Client:
		cd driver/java
		mvn clean package -Dmaven.test.skip=true
	.Net Client:
		cd driver/C#.Net
		scons


Building Connectors:
-----------------
	Hadoop Connector:
		cd driver/java
		mvn clean package -Dmaven.test.skip=true
		cp -r target/sequoiadb-driver-x.x.x.jar sequoiadb.jar
		cd driver/hadoop/hadoop-connector
		ant -Dhadoop.version=2.2
	Hive Connector:
		cd driver/java
		mvn clean package -Dmaven.test.skip=true
		cp -r target/sequoiadb-driver-x.x.x.jar sequoiadb.jar
		cd driver/hadoop/hive
		ant
	Storm Connector:
		cd driver/storm
		ant
	PostgreSQL FDW:
		cd driver/postgresql
		make local
		# Make sure pg_config is in PATH
		make install


Package RPM Prerequisites:
-----------------
        rpmbuild ( 4.8.0 )
        scons ( 2.3.0 )
        ant ( 1.8.2 )
        Python ( 2.7.3 )
        PostgreSQL ( 9.3.4 )
        Linux x86-64:
                g++ ( 4.3.4 )
                gcc ( 4.3.4 )
                make ( 3.81 )
                kernel ( 3.0.13-0.27-default )


Package RPM:
-----------------
        # root permission is required
        # for RHEL and CentOS only
        python script/package.py
        # the RPM-package will output in package/output/RPMS/


Running:
-----------------
	For command line options to start SequoiaDB, invoke:
		$ ./sdbstart --help
	For command line options to stop SequoiaDB, invoke:
		$ ./sdbstop --help
	For command line options to start cluster manager, invoke:
		$ ./sdbcmart --help
	For command line options to stop cluster manager, invoke:
		$ ./sdbcmtop --help


	To run in standalone mode:
		$ mkdir /sequoiadb/data
		$ cd /sequoiadb/data
		$ /opt/sequoiadb/bin/sdbstart -p 11810 --force
		$ # sequoiadb start successful
		$ # start sequoiadb shell
		$ /opt/sequoiadb/bin/sdb
		> var db = new Sdb() ;
		> db.help() ;


	To run in cluster mode, please refer SequoiaDB Information Center.


Documentation:
-----------------
[SequoiaDB Home Page](http://www.sequoiadb.com/)


Restrictions:
-----------------
	- SequoiaDB officially supports x86_64 and ppc64 Linux build on CentOS, Redhat, SUSE and Ubuntu.
	- Windows build and 32 bit build are for testing purpose only.


License:
-----------------
	Most SequoiaDB source files are made available under the terms of the
	GNU Affero General Public License (AGPL). See individual files for details.
	All source files for clients, drivers and connectors are released
	under Apache License v2.0.