52693fc21c
* seastar 9ce62705...908ccd93 (42): > include/seastar: do not include unused headers > timer-set: Add missing sanity headers > tutorial.md: fix typos > Update tutorial.md to reflect update preemption methods > tutorial.md: remove trailing whitespace > json: Add a test for jsonable objects > json: Make formatter::write(vector/map/umap) copy their arguments > json: Make formatter call write for jsonable > test: futures: verify stream yields the consumed value > build: add pyyaml to install-dependencies.sh > stall-analyser: remove unused variable > stall-analyser: use itertools.dropwhile when appropriate > scripts: sort packages alphanumerically > docker: bind the file instead of copying during the build stage > docker: lint dockerfile > dns: use undeprecated c-ares APIs > stall-analyser: use argparse.FileType when appropriate > http/client: Retry request over fresh connection in case old one failed > http/client: Fix indentation after previous patch > http/client: Pass request and handle by reference > http/client: Introduce make_new_connection() > http/client: Fix parser result checking > http/client: Document max_connections > test/http: Generalize http connection factory > loopback_socket: Shutdown socket on EOF close > loopback_socket: Rename buffer's shutdown() to abort() > test: Add test for sharded<>::invoke_on_...() compilation > net/tls: Added additional error codes > io-tester.md: update available parameters for job description > io_tester: expose extent_allocation_size_hint via job param > file: Unfriend reactor class > memory.cc: fix cross-shard shrinking realloc > sharded: Mark invoke_on_others() helper lambda mutable > scheduling: Unfriend reactor from scheduling_group_key > reactor: Make allocate_scheduling_group_specific_data() accept key_id argument > reactor: Add local key_id variable to allocate_scheduling_group_specific_data() > timer: Unfriend reactor > reactor: Generalize timer removal > timer: Add type alias for timer_set > reactor: Move reactor::complete_timers() to timer_set > tests: test protobuf support in prometheus_test.py > tests: enable prometheus_test.py to test metrics without aggregation Closes scylladb/scylladb#19405
Scylla
What is Scylla?
Scylla is the real-time big data database that is API-compatible with Apache Cassandra and Amazon DynamoDB. Scylla embraces a shared-nothing approach that increases throughput and storage capacity to realize order-of-magnitude performance improvements and reduce hardware costs.
For more information, please see the ScyllaDB web site.
Build Prerequisites
Scylla is fairly fussy about its build environment, requiring very recent versions of the C++20 compiler and of many libraries to build. The document HACKING.md includes detailed information on building and developing Scylla, but to get Scylla building quickly on (almost) any build machine, Scylla offers a frozen toolchain, This is a pre-configured Docker image which includes recent versions of all the required compilers, libraries and build tools. Using the frozen toolchain allows you to avoid changing anything in your build machine to meet Scylla's requirements - you just need to meet the frozen toolchain's prerequisites (mostly, Docker or Podman being available).
Building Scylla
Building Scylla with the frozen toolchain dbuild is as easy as:
$ git submodule update --init --force --recursive
$ ./tools/toolchain/dbuild ./configure.py
$ ./tools/toolchain/dbuild ninja build/release/scylla
For further information, please see:
- Developer documentation for more information on building Scylla.
- Build documentation on how to build Scylla binaries, tests, and packages.
- Docker image build documentation for information on how to build Docker images.
Running Scylla
To start Scylla server, run:
$ ./tools/toolchain/dbuild ./build/release/scylla --workdir tmp --smp 1 --developer-mode 1
This will start a Scylla node with one CPU core allocated to it and data files stored in the tmp directory.
The --developer-mode is needed to disable the various checks Scylla performs at startup to ensure the machine is configured for maximum performance (not relevant on development workstations).
Please note that you need to run Scylla with dbuild if you built it with the frozen toolchain.
For more run options, run:
$ ./tools/toolchain/dbuild ./build/release/scylla --help
Testing
See test.py manual.
Scylla APIs and compatibility
By default, Scylla is compatible with Apache Cassandra and its API - CQL. There is also support for the API of Amazon DynamoDB™, which needs to be enabled and configured in order to be used. For more information on how to enable the DynamoDB™ API in Scylla, and the current compatibility of this feature as well as Scylla-specific extensions, see Alternator and Getting started with Alternator.
Documentation
Documentation can be found here. Seastar documentation can be found here. User documentation can be found here.
Training
Training material and online courses can be found at Scylla University. The courses are free, self-paced and include hands-on examples. They cover a variety of topics including Scylla data modeling, administration, architecture, basic NoSQL concepts, using drivers for application development, Scylla setup, failover, compactions, multi-datacenters and how Scylla integrates with third-party applications.
Contributing to Scylla
If you want to report a bug or submit a pull request or a patch, please read the contribution guidelines.
If you are a developer working on Scylla, please read the developer guidelines.
Contact
- The community forum and Slack channel are for users to discuss configuration, management, and operations of the ScyllaDB open source.
- The developers mailing list is for developers and people interested in following the development of ScyllaDB to discuss technical topics.