ClickHouse/src/Storages/StorageKeeperMap.cpp

459 lines
15 KiB
C++
Raw Normal View History

2022-07-27 13:20:45 +00:00
#include <Storages/StorageKeeperMap.h>
2022-07-26 09:08:55 +00:00
#include <Columns/ColumnString.h>
2022-07-27 13:20:45 +00:00
#include <Core/NamesAndTypes.h>
2022-07-26 09:08:55 +00:00
#include <DataTypes/DataTypeString.h>
2022-07-27 13:20:45 +00:00
#include <Interpreters/evaluateConstantExpression.h>
#include <Parsers/ASTCreateQuery.h>
#include <Parsers/ASTExpressionList.h>
#include <Parsers/ASTFunction.h>
#include <Parsers/ASTIdentifier.h>
#include <Parsers/ASTSelectQuery.h>
2022-07-26 09:08:55 +00:00
#include <Processors/ISource.h>
#include <Processors/Sinks/SinkToStorage.h>
2022-07-27 13:20:45 +00:00
#include <Storages/ColumnsDescription.h>
#include <Storages/IKVStorage.h>
#include <Storages/KVStorageUtils.h>
2022-07-26 09:08:55 +00:00
#include <Storages/StorageFactory.h>
2022-07-27 13:20:45 +00:00
#include <Storages/StorageInMemoryMetadata.h>
#include <Storages/checkAndGetLiteralArgument.h>
2022-07-26 09:08:55 +00:00
#include <Common/ZooKeeper/KeeperException.h>
#include <Common/ZooKeeper/Types.h>
2022-07-27 13:20:45 +00:00
#include <Common/ZooKeeper/ZooKeeperConstants.h>
#include <boost/algorithm/string/classification.hpp>
#include <Poco/Base64Decoder.h>
#include <Poco/Base64Encoder.h>
#include <Poco/MemoryStream.h>
#include <Poco/StreamCopier.h>
2022-07-26 09:08:55 +00:00
namespace DB
{
namespace ErrorCodes
{
2022-08-03 13:34:14 +00:00
extern const int NUMBER_OF_ARGUMENTS_DOESNT_MATCH;
extern const int BAD_ARGUMENTS;
extern const int KEEPER_EXCEPTION;
2022-08-03 14:02:14 +00:00
extern const int LOGICAL_ERROR;
2022-07-26 09:08:55 +00:00
}
2022-07-27 13:20:45 +00:00
namespace
2022-07-26 09:08:55 +00:00
{
2022-07-27 13:20:45 +00:00
std::string base64Encode(const std::string & decoded)
{
std::ostringstream ostr; // STYLE_CHECK_ALLOW_STD_STRING_STREAM
ostr.exceptions(std::ios::failbit);
Poco::Base64Encoder encoder(ostr, Poco::BASE64_URL_ENCODING);
encoder.rdbuf()->setLineLength(0);
encoder << decoded;
encoder.close();
return ostr.str();
2022-07-26 09:08:55 +00:00
}
2022-07-27 13:20:45 +00:00
std::string base64Decode(const std::string & encoded)
2022-07-26 09:08:55 +00:00
{
2022-07-27 13:20:45 +00:00
std::string decoded;
Poco::MemoryInputStream istr(encoded.data(), encoded.size());
Poco::Base64Decoder decoder(istr, Poco::BASE64_URL_ENCODING);
Poco::StreamCopier::copyToString(decoder, decoded);
return decoded;
}
2022-08-03 13:34:14 +00:00
constexpr std::string_view default_host = "default";
2022-07-26 09:08:55 +00:00
}
class StorageKeeperMapSink : public SinkToStorage
{
StorageKeeperMap & storage;
std::unordered_map<std::string, std::string> new_values;
2022-07-27 13:20:45 +00:00
size_t primary_key_pos;
2022-07-26 09:08:55 +00:00
public:
2022-07-27 13:20:45 +00:00
StorageKeeperMapSink(StorageKeeperMap & storage_, const StorageMetadataPtr & metadata_snapshot)
: SinkToStorage(metadata_snapshot->getSampleBlock()), storage(storage_)
{
auto primary_key = storage.getPrimaryKey();
assert(primary_key.size() == 1);
primary_key_pos = getHeader().getPositionByName(storage.getPrimaryKey()[0]);
}
2022-07-26 09:08:55 +00:00
std::string getName() const override { return "StorageKeeperMapSink"; }
void consume(Chunk chunk) override
{
2022-07-27 13:20:45 +00:00
auto rows = chunk.getNumRows();
auto block = getHeader().cloneWithColumns(chunk.detachColumns());
WriteBufferFromOwnString wb_key;
WriteBufferFromOwnString wb_value;
2022-07-26 09:08:55 +00:00
for (size_t i = 0; i < rows; ++i)
{
2022-07-27 13:20:45 +00:00
wb_key.restart();
wb_value.restart();
2022-07-26 09:08:55 +00:00
2022-07-27 13:20:45 +00:00
size_t idx = 0;
for (const auto & elem : block)
{
elem.type->getDefaultSerialization()->serializeBinary(*elem.column, i, idx == primary_key_pos ? wb_key : wb_value);
++idx;
}
2022-07-26 09:08:55 +00:00
2022-07-27 13:20:45 +00:00
auto key = base64Encode(wb_key.str());
new_values[std::move(key)] = std::move(wb_value.str());
2022-07-26 09:08:55 +00:00
}
}
void onFinish() override
{
auto & zookeeper = storage.getClient();
Coordination::Requests requests;
for (const auto & [key, value] : new_values)
{
2022-07-27 13:20:45 +00:00
auto path = storage.fullPathForKey(key);
2022-07-26 09:08:55 +00:00
if (zookeeper->exists(path))
requests.push_back(zkutil::makeSetRequest(path, value, -1));
else
requests.push_back(zkutil::makeCreateRequest(path, value, zkutil::CreateMode::Persistent));
}
zookeeper->multi(requests);
}
};
2022-07-27 13:20:45 +00:00
template <typename KeyContainer>
2022-07-26 09:08:55 +00:00
class StorageKeeperMapSource : public ISource
{
2022-07-27 13:20:45 +00:00
const StorageKeeperMap & storage;
2022-07-26 09:08:55 +00:00
size_t max_block_size;
2022-07-27 13:20:45 +00:00
using KeyContainerPtr = std::shared_ptr<KeyContainer>;
KeyContainerPtr container;
using KeyContainerIter = typename KeyContainer::const_iterator;
KeyContainerIter it;
KeyContainerIter end;
2022-07-26 09:08:55 +00:00
2022-07-27 13:20:45 +00:00
public:
StorageKeeperMapSource(
const StorageKeeperMap & storage_,
const Block & header,
size_t max_block_size_,
KeyContainerPtr container_,
KeyContainerIter begin_,
KeyContainerIter end_)
: ISource(header), storage(storage_), max_block_size(max_block_size_), container(std::move(container_)), it(begin_), end(end_)
{
2022-07-26 09:08:55 +00:00
}
2022-07-27 13:20:45 +00:00
std::string getName() const override { return "StorageKeeperMapSource"; }
2022-07-26 09:08:55 +00:00
2022-07-27 13:20:45 +00:00
Chunk generate() override
{
if (it >= end)
2022-07-26 09:08:55 +00:00
{
2022-07-27 13:20:45 +00:00
it = {};
return {};
2022-07-26 09:08:55 +00:00
}
2022-07-27 13:20:45 +00:00
using KeyType = typename KeyContainer::value_type;
if constexpr (std::same_as<KeyType, Field>)
{
const auto & sample_block = getPort().getHeader();
const auto & key_column_type = sample_block.getByName(storage.getPrimaryKey().at(0)).type;
auto raw_keys = serializeKeysToRawString(it, end, key_column_type, max_block_size);
for (auto & raw_key : raw_keys)
raw_key = base64Encode(raw_key);
2022-07-26 09:08:55 +00:00
2022-07-27 13:20:45 +00:00
return storage.getBySerializedKeys(raw_keys, nullptr);
}
else
2022-07-26 09:08:55 +00:00
{
2022-07-27 13:20:45 +00:00
size_t elem_num = std::min(max_block_size, static_cast<size_t>(end - it));
auto chunk = storage.getBySerializedKeys(std::span{it, it + elem_num}, nullptr);
it += elem_num;
return chunk;
2022-07-26 09:08:55 +00:00
}
}
2022-07-27 13:20:45 +00:00
};
2022-07-26 09:08:55 +00:00
2022-08-03 13:34:14 +00:00
namespace
{
zkutil::ZooKeeperPtr getZooKeeperClient(const std::string & hosts, const ContextPtr & context)
{
if (hosts == default_host)
return context->getZooKeeper()->startNewSession();
return std::make_shared<zkutil::ZooKeeper>(hosts);
}
}
2022-07-27 13:20:45 +00:00
StorageKeeperMap::StorageKeeperMap(
ContextPtr context,
const StorageID & table_id,
const StorageInMemoryMetadata & metadata,
std::string_view primary_key_,
2022-08-03 13:34:14 +00:00
std::string_view keeper_path_,
const std::string & hosts,
bool create_missing_root_path)
: IKeyValueStorage(table_id), keeper_path(keeper_path_), primary_key(primary_key_), zookeeper_client(getZooKeeperClient(hosts, context))
2022-07-27 13:20:45 +00:00
{
setInMemoryMetadata(metadata);
2022-07-26 09:08:55 +00:00
2022-07-27 13:20:45 +00:00
if (keeper_path.empty())
throw Exception("keeper_path should not be empty", ErrorCodes::BAD_ARGUMENTS);
if (!keeper_path.starts_with('/'))
throw Exception("keeper_path should start with '/'", ErrorCodes::BAD_ARGUMENTS);
2022-07-26 09:08:55 +00:00
2022-08-03 13:34:14 +00:00
auto client = getClient();
if (keeper_path != "/" && !client->exists(keeper_path))
2022-07-27 13:20:45 +00:00
{
2022-08-03 13:34:14 +00:00
if (!create_missing_root_path)
2022-07-26 09:08:55 +00:00
{
2022-08-03 13:34:14 +00:00
throw Exception(
ErrorCodes::BAD_ARGUMENTS,
"Path '{}' doesn't exist. Please create it or set 'create_missing_root_path' to true'",
keeper_path_);
}
else
{
LOG_TRACE(&Poco::Logger::get("StorageKeeperMap"), "Creating root path {}", keeper_path);
size_t cur_pos = 0;
do
{
size_t search_start = cur_pos + 1;
cur_pos = keeper_path.find('/', search_start);
if (search_start == cur_pos)
throw Exception("keeper_path is invalid, contains subsequent '/'", ErrorCodes::BAD_ARGUMENTS);
auto path = keeper_path.substr(0, cur_pos);
auto status = client->tryCreate(path, "", zkutil::CreateMode::Persistent);
if (status != Coordination::Error::ZOK && status != Coordination::Error::ZNODEEXISTS)
throw zkutil::KeeperException(status, path);
} while (cur_pos != std::string_view::npos);
}
2022-07-26 09:08:55 +00:00
}
}
2022-07-27 13:20:45 +00:00
2022-07-26 09:08:55 +00:00
Pipe StorageKeeperMap::read(
const Names & column_names,
2022-07-27 13:20:45 +00:00
const StorageSnapshotPtr & storage_snapshot,
2022-07-26 09:08:55 +00:00
SelectQueryInfo & query_info,
2022-07-27 13:20:45 +00:00
ContextPtr /*context*/,
2022-07-26 09:08:55 +00:00
QueryProcessingStage::Enum /*processed_stage*/,
size_t max_block_size,
2022-07-27 13:20:45 +00:00
unsigned num_streams)
2022-07-26 09:08:55 +00:00
{
2022-07-27 13:20:45 +00:00
storage_snapshot->check(column_names);
FieldVectorPtr filtered_keys;
bool all_scan;
Block sample_block = storage_snapshot->metadata->getSampleBlock();
auto primary_key_type = sample_block.getByName(primary_key).type;
std::tie(filtered_keys, all_scan) = getFilterKeys(primary_key, primary_key_type, query_info);
const auto process_keys = [&]<typename KeyContainerPtr>(KeyContainerPtr keys) -> Pipe
2022-07-26 09:08:55 +00:00
{
2022-07-27 13:20:45 +00:00
if (keys->empty())
return {};
::sort(keys->begin(), keys->end());
keys->erase(std::unique(keys->begin(), keys->end()), keys->end());
2022-07-26 09:08:55 +00:00
2022-07-27 13:20:45 +00:00
Pipes pipes;
2022-07-26 09:08:55 +00:00
2022-07-27 13:20:45 +00:00
size_t num_keys = keys->size();
size_t num_threads = std::min<size_t>(num_streams, keys->size());
assert(num_keys <= std::numeric_limits<uint32_t>::max());
assert(num_threads <= std::numeric_limits<uint32_t>::max());
for (size_t thread_idx = 0; thread_idx < num_threads; ++thread_idx)
{
size_t begin = num_keys * thread_idx / num_threads;
size_t end = num_keys * (thread_idx + 1) / num_threads;
using KeyContainer = typename KeyContainerPtr::element_type;
pipes.emplace_back(std::make_shared<StorageKeeperMapSource<KeyContainer>>(
*this, sample_block, max_block_size, keys, keys->begin() + begin, keys->begin() + end));
}
return Pipe::unitePipes(std::move(pipes));
};
auto & client = getClient();
if (all_scan)
return process_keys(std::make_shared<std::vector<std::string>>(client->getChildren(keeper_path)));
return process_keys(std::move(filtered_keys));
2022-07-26 09:08:55 +00:00
}
2022-07-27 13:20:45 +00:00
SinkToStoragePtr StorageKeeperMap::write(const ASTPtr & /*query*/, const StorageMetadataPtr & metadata_snapshot, ContextPtr /*context*/)
2022-07-26 09:08:55 +00:00
{
2022-07-27 13:20:45 +00:00
return std::make_shared<StorageKeeperMapSink>(*this, metadata_snapshot);
2022-07-26 09:08:55 +00:00
}
2022-07-27 13:20:45 +00:00
zkutil::ZooKeeperPtr & StorageKeeperMap::getClient() const
2022-07-26 09:08:55 +00:00
{
if (zookeeper_client->expired())
2022-08-03 13:34:14 +00:00
{
2022-07-26 09:08:55 +00:00
zookeeper_client = zookeeper_client->startNewSession();
2022-08-03 13:34:14 +00:00
zookeeper_client->sync("/");
}
2022-07-26 09:08:55 +00:00
return zookeeper_client;
}
const std::string & StorageKeeperMap::rootKeeperPath() const
{
return keeper_path;
}
2022-07-27 13:20:45 +00:00
std::string StorageKeeperMap::fullPathForKey(const std::string_view key) const
{
return fmt::format("{}/{}", keeper_path, key);
}
Chunk StorageKeeperMap::getByKeys(const ColumnsWithTypeAndName & keys, PaddedPODArray<UInt8> & null_map) const
{
if (keys.size() != 1)
throw Exception(ErrorCodes::LOGICAL_ERROR, "StorageKeeperMap supports only one key, got: {}", keys.size());
auto raw_keys = serializeKeysToRawString(keys[0]);
if (raw_keys.size() != keys[0].column->size())
throw DB::Exception(ErrorCodes::LOGICAL_ERROR, "Assertion failed: {} != {}", raw_keys.size(), keys[0].column->size());
return getBySerializedKeys(raw_keys, &null_map);
}
Chunk StorageKeeperMap::getBySerializedKeys(const std::span<const std::string> keys, PaddedPODArray<UInt8> * null_map) const
{
Block sample_block = getInMemoryMetadataPtr()->getSampleBlock();
MutableColumns columns = sample_block.cloneEmptyColumns();
size_t primary_key_pos = getPrimaryKeyPos(sample_block, getPrimaryKey());
if (null_map)
{
null_map->clear();
null_map->resize_fill(keys.size(), 1);
}
auto client = getClient();
std::vector<std::future<Coordination::GetResponse>> values;
values.reserve(keys.size());
for (const auto & key : keys)
{
values.emplace_back(client->asyncTryGet(fullPathForKey(key)));
}
auto wait_until = std::chrono::system_clock::now() + std::chrono::milliseconds(Coordination::DEFAULT_OPERATION_TIMEOUT_MS);
for (size_t i = 0; i < keys.size(); ++i)
{
auto & value = values[i];
if (value.wait_until(wait_until) != std::future_status::ready)
throw DB::Exception(ErrorCodes::LOGICAL_ERROR, "Failed to fetch values: timeout");
auto response = value.get();
Coordination::Error code = response.error;
if (code == Coordination::Error::ZOK)
{
fillColumns(base64Decode(keys[i]), response.data, primary_key_pos, sample_block, columns);
}
else if (code == Coordination::Error::ZNONODE)
{
if (null_map)
{
(*null_map)[i] = 0;
for (size_t col_idx = 0; col_idx < sample_block.columns(); ++col_idx)
columns[col_idx]->insert(sample_block.getByPosition(col_idx).type->getDefault());
}
}
else
{
throw DB::Exception(ErrorCodes::KEEPER_EXCEPTION, "Failed to fetch value: {}", code);
}
}
size_t num_rows = columns.at(0)->size();
return Chunk(std::move(columns), num_rows);
}
namespace
{
StoragePtr create(const StorageFactory::Arguments & args)
{
ASTs & engine_args = args.engine_args;
2022-08-03 13:34:14 +00:00
if (engine_args.empty() || engine_args.size() > 3)
2022-07-27 13:20:45 +00:00
throw Exception(
ErrorCodes::NUMBER_OF_ARGUMENTS_DOESNT_MATCH,
2022-08-03 13:34:14 +00:00
"Storage KeeperMap requires 1-4 arguments:\n"
"keeper_path: path in the Keeper where the values will be stored (required)\n"
"keys_limit: number of keys allowed, set to 0 for no limit (default: 0)\n"
"hosts: comma separated Keeper hosts, set to '{0}' to use the same Keeper as ClickHouse (default: '{0}')\n"
"create_missing_root_path: true if the root path should be created if it's missing (default: 1)",
default_host);
auto keeper_path = checkAndGetLiteralArgument<std::string>(engine_args[0], "keeper_path");
std::string hosts = "default";
if (engine_args.size() > 1)
hosts = checkAndGetLiteralArgument<std::string>(engine_args[1], "hosts");
[[maybe_unused]] size_t keys_limit = 0;
if (engine_args.size() > 2)
keys_limit = checkAndGetLiteralArgument<UInt64>(engine_args[2], "keys_limit");
2022-07-27 13:20:45 +00:00
2022-08-03 13:34:14 +00:00
bool create_missing_root_path = true;
if (engine_args.size() > 3)
create_missing_root_path = checkAndGetLiteralArgument<UInt64>(engine_args[3], "create_missing_root_path");
2022-07-27 13:20:45 +00:00
StorageInMemoryMetadata metadata;
metadata.setColumns(args.columns);
metadata.setConstraints(args.constraints);
if (!args.storage_def->primary_key)
throw Exception("StorageKeeperMap requires one column in primary key", ErrorCodes::BAD_ARGUMENTS);
metadata.primary_key = KeyDescription::getKeyFromAST(args.storage_def->primary_key->ptr(), metadata.columns, args.getContext());
auto primary_key_names = metadata.getColumnsRequiredForPrimaryKey();
if (primary_key_names.size() != 1)
throw Exception("StorageKeeperMap requires one column in primary key", ErrorCodes::BAD_ARGUMENTS);
2022-08-03 13:34:14 +00:00
return std::make_shared<StorageKeeperMap>(
args.getContext(), args.table_id, metadata, primary_key_names[0], keeper_path, hosts, create_missing_root_path);
2022-07-27 13:20:45 +00:00
}
}
2022-07-26 09:08:55 +00:00
void registerStorageKeeperMap(StorageFactory & factory)
{
factory.registerStorage(
"KeeperMap",
2022-07-27 13:20:45 +00:00
create,
2022-07-26 09:08:55 +00:00
{
2022-07-27 13:20:45 +00:00
.supports_sort_order = true,
.supports_parallel_insert = true,
});
2022-07-26 09:08:55 +00:00
}
}