This is a prerequiste for a following commit. We want to move towards using non-contiguous memory chunks to avoid making large allocations. This commit does NOT change the behavior of Scylla at all. The rows corresponding to the result of a DESCRIBE statement are represented by an instance of `result_set`. Before these changes, we encoded descriptions using `bytes` and then passed them into a `result_set` using its method `add_row`. What it does is turn the instances of `bytes` into instances of `managed_bytes` and append them at the end of its internal vector. In these changes, we do it on our own and use another overload of the method.
144 lines
5.4 KiB
C++
144 lines
5.4 KiB
C++
/*
|
|
* Copyright (C) 2022-present ScyllaDB
|
|
*/
|
|
|
|
/*
|
|
* SPDX-License-Identifier: LicenseRef-ScyllaDB-Source-Available-1.0
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <seastar/core/sstring.hh>
|
|
#include "cql3/cql_statement.hh"
|
|
#include "cql3/statements/raw/describe_statement.hh"
|
|
|
|
/**
|
|
* SERVER-SIDE DESCRIBE STATEMENT
|
|
*
|
|
* Classes below are responsible for executing describe statement.
|
|
* - cluster_describe_statement - DESC CLUSTER
|
|
* - schema_describe_statement - DESC [FULL] SCHEMA / DESC [ONLY] KEYSPACE
|
|
* - listing_describe_statement - DESC KEYSPACES/TYPES/FUNCTIONS/AGGREGATES/TABLES
|
|
* - element_describe_statement - DESC TYPE/FUNCTION/AGGREGATE/MATERIALIZED VIEW/INDEX/TABLE
|
|
* - generic_describe_statements - DESC
|
|
*
|
|
* Keyspace element means: UDT, UDF, UDA, index, view or table
|
|
*/
|
|
|
|
namespace replica {
|
|
|
|
class database;
|
|
|
|
}
|
|
|
|
namespace cql3 {
|
|
|
|
class query_processor;
|
|
|
|
namespace statements {
|
|
|
|
using element_type = raw::describe_statement::element_type;
|
|
|
|
class describe_statement : public cql_statement {
|
|
protected:
|
|
describe_statement();
|
|
|
|
virtual std::vector<lw_shared_ptr<column_specification>> get_column_specifications() const = 0;
|
|
virtual std::vector<lw_shared_ptr<column_specification>> get_column_specifications(replica::database& db, const service::client_state& client_state) const {
|
|
return get_column_specifications();
|
|
}
|
|
virtual seastar::future<std::vector<std::vector<managed_bytes_opt>>> describe(cql3::query_processor& qp, const service::client_state& client_state) const = 0;
|
|
public:
|
|
virtual uint32_t get_bound_terms() const override;
|
|
virtual bool depends_on(std::string_view ks_name, std::optional<std::string_view> cf_name) const override;
|
|
virtual seastar::future<> check_access(query_processor& qp, const service::client_state& state) const override;
|
|
virtual seastar::shared_ptr<const metadata> get_result_metadata() const override;
|
|
|
|
virtual seastar::future<seastar::shared_ptr<cql_transport::messages::result_message>>
|
|
execute(cql3::query_processor& qp, service::query_state& state, const query_options& options, std::optional<service::group0_guard> guard) const override;
|
|
};
|
|
|
|
class cluster_describe_statement : public describe_statement {
|
|
private:
|
|
bool should_add_range_ownership(replica::database& db, const service::client_state& client_state) const;
|
|
future<managed_bytes_opt> range_ownership(const service::storage_proxy& proxy, const sstring& ks) const;
|
|
|
|
protected:
|
|
virtual std::vector<lw_shared_ptr<column_specification>> get_column_specifications() const override;
|
|
virtual std::vector<lw_shared_ptr<column_specification>> get_column_specifications(replica::database& db, const service::client_state& client_state) const override;
|
|
virtual seastar::future<std::vector<std::vector<managed_bytes_opt>>> describe(cql3::query_processor& qp, const service::client_state& client_state) const override;
|
|
|
|
public:
|
|
cluster_describe_statement();
|
|
};
|
|
|
|
class schema_describe_statement : public describe_statement {
|
|
struct schema_desc {
|
|
bool full_schema;
|
|
bool with_hashed_passwords;
|
|
};
|
|
struct keyspace_desc {
|
|
std::optional<sstring> keyspace;
|
|
bool only_keyspace;
|
|
};
|
|
|
|
private:
|
|
std::variant<schema_desc, keyspace_desc> _config;
|
|
[[maybe_unused]] bool _with_internals;
|
|
|
|
protected:
|
|
virtual std::vector<lw_shared_ptr<column_specification>> get_column_specifications() const override;
|
|
virtual seastar::future<std::vector<std::vector<managed_bytes_opt>>> describe(cql3::query_processor& qp, const service::client_state& client_state) const override;
|
|
|
|
public:
|
|
schema_describe_statement(bool full_schema, bool with_hashed_passwords, bool with_internals);
|
|
schema_describe_statement(std::optional<sstring> keyspace, bool only, bool with_internals);
|
|
};
|
|
|
|
class listing_describe_statement : public describe_statement {
|
|
private:
|
|
element_type _element;
|
|
[[maybe_unused]] bool _with_internals;
|
|
|
|
protected:
|
|
virtual std::vector<lw_shared_ptr<column_specification>> get_column_specifications() const override;
|
|
virtual seastar::future<std::vector<std::vector<managed_bytes_opt>>> describe(cql3::query_processor& qp, const service::client_state& client_state) const override;
|
|
|
|
public:
|
|
listing_describe_statement(element_type element, bool with_internals);
|
|
listing_describe_statement(const listing_describe_statement&) = default;
|
|
};
|
|
|
|
class element_describe_statement : public describe_statement {
|
|
private:
|
|
element_type _element;
|
|
std::optional<sstring> _keyspace;
|
|
sstring _name;
|
|
[[maybe_unused]] bool _with_internals;
|
|
|
|
protected:
|
|
virtual std::vector<lw_shared_ptr<column_specification>> get_column_specifications() const override;
|
|
virtual seastar::future<std::vector<std::vector<managed_bytes_opt>>> describe(cql3::query_processor& qp, const service::client_state& client_state) const override;
|
|
|
|
public:
|
|
element_describe_statement(element_type element, std::optional<sstring> keyspace, sstring name, bool with_internals);
|
|
};
|
|
|
|
class generic_describe_statement : public describe_statement {
|
|
private:
|
|
std::optional<sstring> _keyspace;
|
|
sstring _name;
|
|
[[maybe_unused]] bool _with_internals;
|
|
|
|
protected:
|
|
virtual std::vector<lw_shared_ptr<column_specification>> get_column_specifications() const override;
|
|
virtual seastar::future<std::vector<std::vector<managed_bytes_opt>>> describe(cql3::query_processor& qp, const service::client_state& client_state) const override;
|
|
|
|
public:
|
|
generic_describe_statement(std::optional<sstring> keyspace, sstring name, bool with_internals);
|
|
};
|
|
|
|
}
|
|
|
|
}
|