Files
scylladb/cql3/statements/alter_table_statement.cc
Raphael S. Carvalho 989d8fe636 cql3/statements: verify that counter column cannot be added into non-counter table
A check, to validate that counter column cannot be added into non-counter table,
is missing for alter table statement. Validation is performed when building new
schema, but it's limited to checking that a schema will not contain both counter
and non-counter columns.

Due to lack of validation, the added counter column could be incorrectly
persisted to the schema, but this results in a crash when setting the new
schema to its table. On restart, it can be confirmed that the schema change
was indeed persisted when describing the table.
This problem is fixed by doing proper validation for the alter table statement,
which consists of making sure a new counter column cannot be added to a
non-counter table.

The test cdc_disallow_cdc_for_counters_test is adjusted because one of its tests
was built on the assumption that counter column can be added into a non-counter
table.

Fixes #7065.

Signed-off-by: Raphael S. Carvalho <raphaelsc@scylladb.com>
Message-Id: <20200824155709.34743-1-raphaelsc@scylladb.com>
(cherry picked from commit 1c29f0a43d)
2020-08-25 18:44:42 +03:00

422 lines
20 KiB
C++

/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Copyright 2015 ScyllaDB
*
* Modified by ScyllaDB
*/
/*
* This file is part of Scylla.
*
* Scylla is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Scylla is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Scylla. If not, see <http://www.gnu.org/licenses/>.
*/
#include "cql3/statements/alter_table_statement.hh"
#include "index/secondary_index_manager.hh"
#include "prepared_statement.hh"
#include "service/migration_manager.hh"
#include "validation.hh"
#include "db/extensions.hh"
#include <boost/range/adaptor/filtered.hpp>
#include <boost/range/adaptor/transformed.hpp>
#include "cql3/util.hh"
#include "view_info.hh"
#include "database.hh"
#include "db/view/view.hh"
namespace cql3 {
namespace statements {
alter_table_statement::alter_table_statement(shared_ptr<cf_name> name,
type t,
std::vector<column_change> column_changes,
shared_ptr<cf_prop_defs> properties,
renames_type renames)
: schema_altering_statement(std::move(name))
, _type(t)
, _column_changes(std::move(column_changes))
, _properties(std::move(properties))
, _renames(std::move(renames))
{
}
future<> alter_table_statement::check_access(service::storage_proxy& proxy, const service::client_state& state) const {
return state.has_column_family_access(keyspace(), column_family(), auth::permission::ALTER);
}
void alter_table_statement::validate(service::storage_proxy& proxy, const service::client_state& state) const
{
// validated in announce_migration()
}
static data_type validate_alter(const schema& schema, const column_definition& def, const cql3_type& validator)
{
auto type = def.type->is_reversed() && !validator.get_type()->is_reversed()
? reversed_type_impl::get_instance(validator.get_type())
: validator.get_type();
switch (def.kind) {
case column_kind::partition_key:
if (type->is_counter()) {
throw exceptions::invalid_request_exception(
format("counter type is not supported for PRIMARY KEY part {}", def.name_as_text()));
}
if (!type->is_value_compatible_with(*def.type)) {
throw exceptions::configuration_exception(
format("Cannot change {} from type {} to type {}: types are incompatible.",
def.name_as_text(),
def.type->as_cql3_type(),
validator));
}
break;
case column_kind::clustering_key:
if (!schema.is_cql3_table()) {
throw exceptions::invalid_request_exception(
format("Cannot alter clustering column {} in a non-CQL3 table", def.name_as_text()));
}
// Note that CFMetaData.validateCompatibility already validate the change we're about to do. However, the error message it
// sends is a bit cryptic for a CQL3 user, so validating here for a sake of returning a better error message
// Do note that we need isCompatibleWith here, not just isValueCompatibleWith.
if (!type->is_compatible_with(*def.type)) {
throw exceptions::configuration_exception(
format("Cannot change {} from type {} to type {}: types are not order-compatible.",
def.name_as_text(),
def.type->as_cql3_type(),
validator));
}
break;
case column_kind::regular_column:
case column_kind::static_column:
// Thrift allows to change a column validator so CFMetaData.validateCompatibility will let it slide
// if we change to an incompatible type (contrarily to the comparator case). But we don't want to
// allow it for CQL3 (see #5882) so validating it explicitly here. We only care about value compatibility
// though since we won't compare values (except when there is an index, but that is validated by
// ColumnDefinition already).
if (!type->is_value_compatible_with(*def.type)) {
throw exceptions::configuration_exception(
format("Cannot change {} from type {} to type {}: types are incompatible.",
def.name_as_text(),
def.type->as_cql3_type(),
validator));
}
break;
}
return type;
}
static void validate_column_rename(database& db, const schema& schema, const column_identifier& from, const column_identifier& to)
{
auto def = schema.get_column_definition(from.name());
if (!def) {
throw exceptions::invalid_request_exception(format("Cannot rename unknown column {} in table {}", from, schema.cf_name()));
}
if (schema.get_column_definition(to.name())) {
throw exceptions::invalid_request_exception(format("Cannot rename column {} to {} in table {}; another column of that name already exist", from, to, schema.cf_name()));
}
if (def->is_part_of_cell_name()) {
throw exceptions::invalid_request_exception(format("Cannot rename non PRIMARY KEY part {}", from));
}
if (!schema.indices().empty()) {
auto dependent_indices = db.find_column_family(schema.id()).get_index_manager().get_dependent_indices(*def);
if (!dependent_indices.empty()) {
auto index_names = ::join(", ", dependent_indices | boost::adaptors::transformed([](const index_metadata& im) {
return im.name();
}));
throw exceptions::invalid_request_exception(
format("Cannot rename column {} because it has dependent secondary indexes ({})", from, index_names));
}
}
}
void alter_table_statement::add_column(const schema& schema, const table& cf, schema_builder& cfm, std::vector<view_ptr>& view_updates, const column_identifier& column_name, const cql3_type validator, const column_definition* def, bool is_static) const {
if (is_static) {
if (!schema.is_compound()) {
throw exceptions::invalid_request_exception("Static columns are not allowed in COMPACT STORAGE tables");
}
if (!schema.clustering_key_size()) {
throw exceptions::invalid_request_exception("Static columns are only useful (and thus allowed) if the table has at least one clustering column");
}
}
if (def) {
if (def->is_partition_key()) {
throw exceptions::invalid_request_exception(format("Invalid column name {} because it conflicts with a PRIMARY KEY part", column_name));
} else {
throw exceptions::invalid_request_exception(format("Invalid column name {} because it conflicts with an existing column", column_name));
}
}
// Cannot re-add a dropped counter column. See #7831.
if (schema.is_counter() && schema.dropped_columns().count(column_name.text())) {
throw exceptions::invalid_request_exception(format("Cannot re-add previously dropped counter column {}", column_name));
}
auto type = validator.get_type();
if (type->is_collection() && type->is_multi_cell()) {
if (!schema.is_compound()) {
throw exceptions::invalid_request_exception("Cannot use non-frozen collections with a non-composite PRIMARY KEY");
}
if (schema.is_super()) {
throw exceptions::invalid_request_exception("Cannot use non-frozen collections with super column families");
}
// If there used to be a non-frozen collection column with the same name (that has been dropped),
// we could still have some data using the old type, and so we can't allow adding a collection
// with the same name unless the types are compatible (see #6276).
auto& dropped = schema.dropped_columns();
auto i = dropped.find(column_name.text());
if (i != dropped.end() && i->second.type->is_collection() && i->second.type->is_multi_cell()
&& !type->is_compatible_with(*i->second.type)) {
throw exceptions::invalid_request_exception(sprint("Cannot add a collection with the name %s "
"because a collection with the same name and a different type has already been used in the past", column_name));
}
}
if (type->is_counter() && !schema.is_counter()) {
throw exceptions::configuration_exception(format("Cannot add a counter column ({}) in a non counter column family", column_name));
}
cfm.with_column(column_name.name(), type, is_static ? column_kind::static_column : column_kind::regular_column);
// Adding a column to a base table always requires updating the view
// schemas: If the view includes all columns it should include the new
// column, but if it doesn't, it may need to include the new
// unselected column as a virtual column. The case when it we
// shouldn't add a virtual column is when the view has in its PK one
// of the base's regular columns - but even in this case we need to
// rebuild the view schema, to update the column ID.
if (!is_static) {
for (auto&& view : cf.views()) {
schema_builder builder(view);
if (view->view_info()->include_all_columns()) {
builder.with_column(column_name.name(), type);
} else if (view->view_info()->base_non_pk_columns_in_view_pk().empty()) {
db::view::create_virtual_column(builder, column_name.name(), type);
}
view_updates.push_back(view_ptr(builder.build()));
}
}
}
void alter_table_statement::alter_column(const schema& schema, const table& cf, schema_builder& cfm, std::vector<view_ptr>& view_updates, const column_identifier& column_name, const cql3_type validator, const column_definition* def, bool is_static) const {
if (!def) {
throw exceptions::invalid_request_exception(format("Column {} was not found in table {}", column_name, column_family()));
}
auto type = validate_alter(schema, *def, validator);
// In any case, we update the column definition
cfm.alter_column_type(column_name.name(), type);
// We also have to validate the view types here. If we have a view which includes a column as part of
// the clustering key, we need to make sure that it is indeed compatible.
for (auto&& view : cf.views()) {
auto* view_def = view->get_column_definition(column_name.name());
if (view_def) {
schema_builder builder(view);
auto view_type = validate_alter(*view, *view_def, validator);
builder.alter_column_type(column_name.name(), std::move(view_type));
view_updates.push_back(view_ptr(builder.build()));
}
}
}
void alter_table_statement::drop_column(const schema& schema, const table& cf, schema_builder& cfm, std::vector<view_ptr>& view_updates, const column_identifier& column_name, const cql3_type validator, const column_definition* def, bool is_static) const {
if (!def) {
throw exceptions::invalid_request_exception(format("Column {} was not found in table {}", column_name, column_family()));
}
if (def->is_primary_key()) {
throw exceptions::invalid_request_exception(format("Cannot drop PRIMARY KEY part {}", column_name));
} else {
// We refuse to drop a column from a base-table if one of its
// materialized views needs this column. This includes columns
// selected by one of the views, and in some cases even unselected
// columns needed to determine row liveness (in such case, the
// column exists in a view as a "virtual column").
for (const auto& view : cf.views()) {
for (const auto& column_def : view->all_columns()) {
if (column_def.name() == column_name.name()) {
throw exceptions::invalid_request_exception(format("Cannot drop column {} from base table {}.{}: materialized view {} needs this column",
column_name, keyspace(), column_family(), view->cf_name()));
}
}
}
for (auto&& column_def : boost::range::join(schema.static_columns(), schema.regular_columns())) { // find
if (column_def.name() == column_name.name()) {
cfm.remove_column(column_name.name());
break;
}
}
}
}
future<shared_ptr<cql_transport::event::schema_change>> alter_table_statement::announce_migration(service::storage_proxy& proxy, bool is_local_only) const
{
auto& db = proxy.get_db().local();
auto s = validation::validate_column_family(db, keyspace(), column_family());
if (s->is_view()) {
throw exceptions::invalid_request_exception("Cannot use ALTER TABLE on Materialized View");
}
const auto& ks = db.find_keyspace(keyspace());
auto replication_type = ks.get_replication_strategy().get_type();
if (is_local_only && replication_type != locator::replication_strategy_type::local) {
throw std::logic_error(format("Internal queries should not try to alter table schema for non-local tables, because it leads to inconsistencies: {}.{}",
s->ks_name(), s->cf_name()));
}
auto cfm = schema_builder(s);
if (_properties->get_id()) {
throw exceptions::configuration_exception("Cannot alter table id.");
}
auto& cf = db.find_column_family(s);
std::vector<view_ptr> view_updates;
using column_change_fn = std::function<void (const alter_table_statement*, const schema&, const table&, schema_builder&, std::vector<view_ptr>&, const column_identifier&, const data_type, const column_definition*, bool)>;
auto invoke_column_change_fn = [&] (column_change_fn fn) {
for (auto& [raw_name, raw_validator, is_static] : _column_changes) {
auto column_name = raw_name->prepare_column_identifier(*s);
auto validator = raw_validator ? raw_validator->prepare(db, keyspace()).get_type() : nullptr;
auto* def = get_column_definition(*s, *column_name);
fn(this, *s, cf, cfm, view_updates, *column_name, validator, def, is_static);
}
};
switch (_type) {
case alter_table_statement::type::add:
assert(_column_changes.size());
if (s->is_dense()) {
throw exceptions::invalid_request_exception("Cannot add new column to a COMPACT STORAGE table");
}
invoke_column_change_fn(std::mem_fn(&alter_table_statement::add_column));
break;
case alter_table_statement::type::alter:
assert(_column_changes.size() == 1);
invoke_column_change_fn(std::mem_fn(&alter_table_statement::alter_column));
break;
case alter_table_statement::type::drop:
assert(_column_changes.size());
if (!s->is_cql3_table()) {
throw exceptions::invalid_request_exception("Cannot drop columns from a non-CQL3 table");
}
invoke_column_change_fn(std::mem_fn(&alter_table_statement::drop_column));
break;
case alter_table_statement::type::opts:
if (!_properties) {
throw exceptions::invalid_request_exception("ALTER COLUMNFAMILY WITH invoked, but no parameters found");
}
{
auto schema_extensions = _properties->make_schema_extensions(db.extensions());
_properties->validate(db, schema_extensions);
if (!cf.views().empty() && _properties->get_gc_grace_seconds() == 0) {
throw exceptions::invalid_request_exception(
"Cannot alter gc_grace_seconds of the base table of a "
"materialized view to 0, since this value is used to TTL "
"undelivered updates. Setting gc_grace_seconds too low might "
"cause undelivered updates to expire "
"before being replayed.");
}
if (s->is_counter() && _properties->get_default_time_to_live() > 0) {
throw exceptions::invalid_request_exception("Cannot set default_time_to_live on a table with counters");
}
_properties->apply_to_builder(cfm, std::move(schema_extensions));
}
break;
case alter_table_statement::type::rename:
for (auto&& entry : _renames) {
auto from = entry.first->prepare_column_identifier(*s);
auto to = entry.second->prepare_column_identifier(*s);
validate_column_rename(db, *s, *from, *to);
cfm.rename_column(from->name(), to->name());
// If the view includes a renamed column, it must be renamed in
// the view table and the definition.
for (auto&& view : cf.views()) {
if (view->get_column_definition(from->name())) {
schema_builder builder(view);
auto view_from = entry.first->prepare_column_identifier(*view);
auto view_to = entry.second->prepare_column_identifier(*view);
validate_column_rename(db, *view, *view_from, *view_to);
builder.rename_column(view_from->name(), view_to->name());
auto new_where = util::rename_column_in_where_clause(
view->view_info()->where_clause(),
column_identifier::raw(view_from->text(), true),
column_identifier::raw(view_to->text(), true));
builder.with_view_info(view->view_info()->base_id(), view->view_info()->base_name(),
view->view_info()->include_all_columns(), std::move(new_where));
view_updates.push_back(view_ptr(builder.build()));
}
}
}
break;
}
return service::get_local_migration_manager().announce_column_family_update(cfm.build(), false, std::move(view_updates), is_local_only)
.then([this] {
using namespace cql_transport;
return ::make_shared<event::schema_change>(
event::schema_change::change_type::UPDATED,
event::schema_change::target_type::TABLE,
keyspace(),
column_family());
});
}
std::unique_ptr<cql3::statements::prepared_statement>
cql3::statements::alter_table_statement::prepare(database& db, cql_stats& stats) {
return std::make_unique<prepared_statement>(make_shared<alter_table_statement>(*this));
}
}
}