8c257db283
Drop half-reversed (legacy) format of query::partition_slice. The select query builds a fully reversed (native) slice for reversed queries and use it together with a reversed schema to construct query::read_command that is further propagated to the database. A cluster feature is added to support nodes that still operate on half-reversed slices. When the feature is turned off: - query::read_command is transformed (to have table schema and half-reversed slices) before sending to other nodes - query::read_command is transformed (to have query schema (reversed) and reversed slices) after receiving it from other nodes - Similarly, mutations are transformed. They are reversed before being sent to other nodes or after receiving them from other nodes. Additional manual tests were performed to test a mixed-node cluster: 1. 3-node cluster with one node upgraded: reverse read queries performed on an old node 2. 3-node cluster with one node upgraded: reverse read queries performed on a new node 3. 3-node cluster with one node upgraded and all its sstable files deleted to trigger repair: reverse read queries performed on an old node 4. 3-node cluster with one node upgraded and all its sstable files deleted to trigger repair: reverse read queries performed on a new node All reverse read queries above consists of: - single-partition reverse reads with no clustering key restrictions, with single column restrictions and multi column restrictions both with and without paging turned on - multi-partition reverse reads with range restrictions with optional partition limit and partial ordering The exact same tests were also performed on a fully upgraded cluster. Fixes https://github.com/scylladb/scylladb/issues/12557 Closes scylladb/scylladb#18864 * github.com:scylladb/scylladb: mutation_partition: drop reverse parameter in compact_for_query clustering_key_filter: unify get_ranges and get_native_ranges streamed_mutation_freezer: drop the reverse parameter reverse-reads.md: Drop legacy reverse format information Fix comments refering to half-reversed (legacy) slices select_statement::do_execute: Add tracing informaction query::trim_clustering_row_ranges_to: require reversed schema for native reversed ranges query-request: Drop half_reverse_slice as it is no longer used anywhere readers: Use reversed schema and native reversed slices database: accept reversed schema for reversed queries storage_proxy: Support reverse queries in native format query_pagers: Replace _schema with _query_schema query_pagers: Support reverse queries in native format select_statement: Execute reversed query in native format storage_proxy::remote: Add support for mixed-node clusters mutation_query: Add reversed function to reverse reconcilable_result query-request: Add reversed function to reverse read_command features: add native_reverse_queries kl::reader::make_reader: Unify interface with mx::reader::make_reader config: drop reversed_reads_auto_bypass_cache config: drop enable_optimized_reversed_reads
ScyllaDB Documentation
This repository contains the source files for ScyllaDB Open Source documentation.
- The
devfolder contains developer-oriented documentation related to the ScyllaDB code base. It is not published and is only available via GitHub. - All other folders and files contain user-oriented documentation related to ScyllaDB Open Source and are sources for docs.scylladb.com.
To report a documentation bug or suggest an improvement, open an issue in GitHub issues for this project.
To contribute to the documentation, open a GitHub pull request.
Key Guidelines for Contributors
- Follow the ScyllaDB Style Guide.
- The user documentation is written in reStructuredText (RST) - a plaintext markup language similar to Markdown. If you're not familiar with RST, see ScyllaDB RST Examples.
- The developer documentation is written in Markdown. See Basic Markdown Syntax for reference.
Creating Knowledge Base Articles
The kb/ directory holds source files for knowledge base articles in the Knowledge Base section of the ScyllaDB documentation.
The kb/kb_common subdirectory contains a template for knowledge base articles to help you create new articles.
To create a new knowledge base article (KB):
- Copy the
kb-article-template.rstfile from/kb/kb_commonto/kband rename it with a unique name. - Open the new file and fill in the required information.
- Remove what is not needed.
- Run
make previewto build the docs and preview them locally. - Send a PR with "KB" in its title.
Building User Documentation
Prerequisites
- Python 3. Check your version with
$ python --version. - poetry 1.12 or later
- make
Mac OS X
You must have a working Homebrew in order to install the needed tools.
You also need the standard utility make.
Check if you have these two items with the following commands:
brew help
make -h
Linux Distributions
Building the user docs should work out of the box on most Linux distributions.
Windows
Use "Bash on Ubuntu on Windows" for the same tools and capabilities as on Linux distributions.
Building the Docs
- Run
make previewto build the documentation. - Preview the built documentation locally at http://127.0.0.1:5500/.
Cleanup
You can clean up all the build products and auto-installed Python stuff with:
make pristine
Information for Contributors
If you are interested in contributing to Scylla docs, please read the Scylla open source page at http://www.scylladb.com/opensource/ and complete a Scylla contributor agreement if needed. We can only accept documentation pull requests if we have a contributor agreement on file for you.
Third-party Documentation
-
Do any copying as a separate commit. Always commit an unmodified version first and then do any editing in a separate commit.
-
We already have a copy of the Apache license in our tree, so you do not need to commit a copy of the license.
-
Include the copyright header from the source file in the edited version. If you are copying an Apache Cassandra document with no copyright header, use:
This document includes material from Apache Cassandra.
Apache Cassandra is Copyright 2009-2014 The Apache Software Foundation.