cc57ac8c1c
The function cql3::util::maybe_quote() is used throughout Scylla to convert identifier names (column names, table names, etc.) into strings that can be embedded in CQL commands. maybe_quote() sometimes needs to quote these identifier names, but when the identifier name is lowercase, and not a CQL keyword, it is not quoted. Not quoting identifier names when not needed is nice and pretty, but has a forward-compatibility problem: If some CQL command with an unquoted identifier is saved somewhere, and new version of Scylla adss this identifier as a new reserved keyword - the CQL command will break. So this patch introduces a new function, cql3::util::quote(), which unconditionally quotes the given identifier. The new function is not yet used in Scylla, but we add a unit test (based on the test of maybe_quote()) to confirm it behaves correctly. Signed-off-by: Nadav Har'El <nyh@scylladb.com> Message-Id: <20220118161217.231811-2-nyh@scylladb.com>
104 lines
4.2 KiB
C++
104 lines
4.2 KiB
C++
/*
|
|
* Copyright (C) 2016-present ScyllaDB
|
|
*
|
|
* Modified by ScyllaDB
|
|
*/
|
|
|
|
/*
|
|
* SPDX-License-Identifier: AGPL-3.0-or-later
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <vector>
|
|
|
|
#include <boost/algorithm/string/join.hpp>
|
|
#include <boost/range/adaptor/transformed.hpp>
|
|
|
|
#include <seastar/core/sstring.hh>
|
|
|
|
#include "cql3/column_identifier.hh"
|
|
#include "cql3/CqlParser.hpp"
|
|
#include "cql3/error_collector.hh"
|
|
#include "cql3/relation.hh"
|
|
#include "cql3/statements/raw/select_statement.hh"
|
|
|
|
namespace cql3 {
|
|
|
|
namespace util {
|
|
|
|
|
|
void do_with_parser_impl(const sstring_view& cql, noncopyable_function<void (cql3_parser::CqlParser& p)> func);
|
|
|
|
template <typename Func, typename Result = std::result_of_t<Func(cql3_parser::CqlParser&)>>
|
|
Result do_with_parser(const sstring_view& cql, Func&& f) {
|
|
std::optional<Result> ret;
|
|
do_with_parser_impl(cql, [&] (cql3_parser::CqlParser& parser) {
|
|
ret.emplace(f(parser));
|
|
});
|
|
return std::move(*ret);
|
|
}
|
|
|
|
template<typename Range> // Range<cql3::relation_ptr>
|
|
sstring relations_to_where_clause(Range&& relations) {
|
|
auto expressions = relations | boost::adaptors::transformed(std::mem_fn(&relation::to_string));
|
|
return boost::algorithm::join(expressions, " AND ");
|
|
}
|
|
|
|
static std::vector<relation_ptr> where_clause_to_relations(const sstring_view& where_clause) {
|
|
return do_with_parser(where_clause, std::mem_fn(&cql3_parser::CqlParser::whereClause));
|
|
}
|
|
|
|
inline sstring rename_column_in_where_clause(const sstring_view& where_clause, column_identifier::raw from, column_identifier::raw to) {
|
|
auto relations = where_clause_to_relations(where_clause);
|
|
auto new_relations = relations | boost::adaptors::transformed([&] (auto&& rel) {
|
|
return rel->maybe_rename_identifier(from, to);
|
|
});
|
|
return relations_to_where_clause(std::move(new_relations));
|
|
}
|
|
|
|
/// build a CQL "select" statement with the desired parameters.
|
|
/// If select_all_columns==true, all columns are selected and the value of
|
|
/// selected_columns is ignored.
|
|
std::unique_ptr<cql3::statements::raw::select_statement> build_select_statement(
|
|
const sstring_view& cf_name,
|
|
const sstring_view& where_clause,
|
|
bool select_all_columns,
|
|
const std::vector<column_definition>& selected_columns);
|
|
|
|
/// maybe_quote() takes an identifier - the name of a column, table or
|
|
/// keyspace name - and transforms it to a string which can be used in CQL
|
|
/// commands. Namely, if the identifier is not entirely lower-case (including
|
|
/// digits and underscores), it needs to be quoted to be represented in CQL.
|
|
/// Without this quoting, CQL folds uppercase letters to lower case, and
|
|
/// forbids non-alpha-numeric characters in identifier names.
|
|
/// Quoting involves wrapping the string in double-quotes ("). A double-quote
|
|
/// character itself is quoted by doubling it.
|
|
/// maybe_quote() also quotes reserved CQL keywords (e.g., "to", "where")
|
|
/// but doesn't quote *unreserved* keywords (like ttl, int or as).
|
|
/// Note that this means that if new reserved keywords are added to the
|
|
/// parser, a saved output of maybe_quote() may no longer be parsable by
|
|
/// parser. To avoid this forward-compatibility issue, use quote() instead
|
|
/// of maybe_quote() - to unconditionally quote an identifier even if it is
|
|
/// lowercase and not (yet) a keyword.
|
|
sstring maybe_quote(const sstring& s);
|
|
|
|
/// quote() takes an identifier - the name of a column, table or keyspace -
|
|
/// and transforms it to a string which can be safely used in CQL commands.
|
|
/// Quoting involves wrapping the name in double-quotes ("). A double-quote
|
|
/// character itself is quoted by doubling it.
|
|
/// Quoting is necessary when the identifier contains non-alpha-numeric
|
|
/// characters, when it contains uppercase letters (which will be folded to
|
|
/// lowercase if not quoted), or when the identifier is one of many CQL
|
|
/// keywords. But it's allowed - and easier - to just unconditionally
|
|
/// quote the identifier name in CQL, so that is what this function does does.
|
|
sstring quote(const sstring& s);
|
|
|
|
// Check whether timestamp is not too far in the future as this probably
|
|
// indicates its incorrectness (for example using other units than microseconds).
|
|
void validate_timestamp(const query_options& options, const std::unique_ptr<attributes>& attrs);
|
|
|
|
} // namespace util
|
|
|
|
} // namespace cql3
|