efed973dd3
LWT `IF` (column_condition) duplicates the expression prepare and evaluation code. Annoyingly, LWT IF semantics are a little different than the rest of CQL: a NULL equals NULL, whereas usually NULL = NULL evaluates to NULL. This series converts `IF` prepare and evaluate to use the standard expression code. We employ expression rewriting to adjust for the slightly different semantics. In a few places, we adjust LWT semantics to harmonize them with the rest of CQL. These are pointed out in their own separate patches so the changes don't get lost in the flood. Closes #12356 * github.com:scylladb/scylladb: cql3: lwt: move IF clause expression construction to grammar cql3: column_condition: evaluate column_condition as a single expression cql3: lwt: allow negative list indexes in IF clause cql3: lwt: do not short-circuit col[NULL] in IF clause cql3: column_condition: convert _column to an expression cql3: expr: generalize evaluation of subscript expressions cql3: expr: introduce adjust_for_collection_as_maps() cql3: update_parameters: use evaluation_inputs compatible row prefetch cql3: expr: protect extract_column_value() from partial clustering keys cql3: expr: extract extract_column_value() from evaluation machinery cql3: selection: introduce selection_from_partition_slice cql3: expr: move check for ordering on duration types from restrictions to prepare cql3: expr: remove restrictions oper_is_slice() in favor of expr::is_slice() cql3: column_condition: optimize LIKE with constant pattern after preparing cql3: expr: add optimizer for LIKE with constant pattern test: lib: add helper to evaluate an expression with bind variables but no table cql3: column_condition: make the left-hand-side part of column_condition::raw cql3: lwt: relax constraints on map subscripts and LIKE patterns cql3: expr: fix search_and_replace() for subscripts cql3: expr: fix function evaluation with NULL inputs cql3: expr: add LWT IF clause variants of binary operators cql3: expr: change evaluate_binop_sides to return more NULL information
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.