diff --git a/README.md b/README.md index 46c84e8d22156784a6860df303a8795ac4703ee3..e4fc6f3cf091c04be410943b1c3b54fd02af39fc 100755 --- a/README.md +++ b/README.md @@ -1,226 +1,79 @@ -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 - - -Drivers: ------------------ - C Driver: - libsdbc.a - libsdbc.so - C++ Driver: - libsdbcpp.a - libsdbcpp.so - PHP Driver: - libsdbphp-x.x.x.so - JAVA Driver: - sequoiadb.jar - PYTHON Driver: - lib.linux-x86_64-2.6 - .NET Driver: - sequoiadb.dll - Python Driver: - pysequoiadb.tar.gz - - -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: - scons --client - PHP Client: - cd driver/php5 - scons --phpversion=5.4.6 - Note: - PHP source code is located in thirdparty/php directory - The dir name must be "php-" - Python Client: - - cd driver/python - scons - Java Client: - cd driver/java - scons - .Net Client: - cd driver/C#.Net - scons - - -Building Connectors: ------------------ - Hadoop Connector: - cd driver/java - scons - cd driver/hadoop/hadoop-connector - ant -Dhadoop.version=2.2 - Hive Connector: - cd driver/java - scons - 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. +更新说明： + +大家好， 我们的开源项目“SequoiaDB”近期受到了此前GitHub被攻击的影响，代码库出现了混乱。之前我们和平台都努力尝试修复但是并没有解决问题，无奈最后只能将项目清除并重新上传项目代码，给您带来的不便和影响我们也深表歉意。 如有任何问题，请在issue向我们留言，或登录SequoiaDB官网（链接到联系我们）向我们的支持人员咨询 + +我们今后还会持续加大开源方面的投入，和大家共同构建开源社区，也希望大家今后多多支持！ + + +### SequoiaDB README + + +#### About Us + +SequoiaDB is a MySQL/PostgreSQL-compatible distributed relational database. + +It supports ACID, horizontal scaling, HA/DR and Multi-model data storage engine. + + + +#### **SequoiaDB Specific Characteristics** + +- **Standard SQL access, MySQL compatibility** + + SequoiaDB supports standard SQL access, and achieves MySQL/PostgreSQL/SparkSQL compatibility in protocol level. + +- **Financial-level distributed OLTP** + + As a financial-level multi-model distributed database, SequoiaDB is designed to support MySQL/PostgreSQL compatible OLTP. + +- **Distributed Architecture** + + SequoiaDB data storage engine applies native distributed architecture. The data are stored in different physical nodes, which could achieve the automated data distribution and management, as well as the flexible scalability. + +- **Multi-Model Data Engines** + + The flexible storage data types of SequoiaDB support structured, semi-structured and unstructured data, realizing the unified management of multi-model data. + +- **HTAP (Hybrid Transactional and Analytical Processing)** + + Through the support of SQL and the integration of Spark, SequoiaDB achieves the hybrid transactional and analytical processing, and agile and flexible business application implementation to handle more complicated business scenarios. + + + +#### **Documentation** + +- [English](http://www.sequoiadb.com/en/index.php?m=Files&a=index) + +- [Chinese](http://doc.sequoiadb.com/cn/SequoiaDB) + + + +#### **Architecture** + +#### ![Architecture](https://s2.ax1x.com/2019/04/12/AbTjrn.png) + + + +#### **Contact us** + +- [Contact SequoiaDB Team](http://www.sequoiadb.com/cn/About) + +- Twitter: [@_SequoiaDB](https://twitter.com/_SequoiaDB) +- [Medium](https://medium.com/@_SequoiaDB) + + + +#### **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. + + + +#### **Restriction** + +- 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.