ce6464b649
before this change, filesystem_storage::open() reuses `sstable::make_component_file_writer()` to create the temporary toc, it will rename the temporary toc to the real TOC when sealing the sstable. but this prevents us from reusing filesystem_storage in yet another storage backend. as the 1. create temporary 2. rename temporary to toc dance only applies to filesystem_storage. when filesystem_storage calls into sstable, it calls `sst.make_component_file_writer()`, which in turn calls the `_storage->make_component_sink()`. but at this moment, `_storage` is not necessarily `filesystem_storage` anymore. it could be a wrapper around `filesystem_storage`, which is not aware of the create-rename dance. and could do a lot more than create a temporary file when asked to "make_component_sink()". if we really want to go this way by reusing sstable's API in `filesystem_storage` to create a temporary toc, we will have to rename the whatever temporary toc component created by the wrapper backend to the toc with the seal() func. but again, this rename op is only implemented in the filesystem_storage backend. to mirror this operation in the wrapper backend does not make sense at all -- it does not have to be aware of the filesystem_storage's internals. so in this change, instead of reusing the `sstable::make_component_file_writer()`, we just inline its implementation in filesystem_storage to avoid this problem. this is also an improvement from the design perspective, as the storage should not call into its the higher abstraction -- sstable. Signed-off-by: Kefu Chai <kefu.chai@scylladb.com> Closes #14443
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 APIs - CQL and Thrift. 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.