Current section
Files
Jump to
Current section
Files
native/clickhouse-cpp/ut/utils.cpp
#include "utils.h"
#include <clickhouse/block.h>
#include <clickhouse/client.h>
#include <clickhouse/columns/column.h>
#include <clickhouse/columns/array.h>
#include <clickhouse/columns/date.h>
#include <clickhouse/columns/decimal.h>
#include <clickhouse/columns/enum.h>
#include <clickhouse/columns/geo.h>
#include <clickhouse/columns/ip4.h>
#include <clickhouse/columns/ip6.h>
#include <clickhouse/columns/numeric.h>
#include <clickhouse/columns/map.h>
#include <clickhouse/columns/string.h>
#include <clickhouse/columns/tuple.h>
#include <clickhouse/columns/uuid.h>
#include <clickhouse/base/socket.h> // for ipv4-ipv6 platform-specific stuff
#include <cinttypes>
#include <cstdint>
#include <ctime>
#include <iomanip>
#include <sstream>
#include <stdexcept>
#include <type_traits>
#include "clickhouse/types/types.h"
#include "absl/numeric/int128.h"
namespace {
using namespace clickhouse;
std::ostream & printColumnValue(const ColumnRef& c, const size_t row, std::ostream & ostr);
struct DateTimeValue {
explicit DateTimeValue(const time_t & v)
: value(v)
{}
template <typename T>
explicit DateTimeValue(const T & v)
: value(v)
{}
const time_t value;
};
std::ostream& operator<<(std::ostream & ostr, const DateTimeValue & time) {
const auto t = std::gmtime(&time.value);
char buffer[] = "2015-05-18 07:40:12\0\0";
std::strftime(buffer, sizeof(buffer), "%Y-%m-%d %H:%M:%S", t);
return ostr << buffer;
}
template <typename ColumnType, typename AsType = decltype(std::declval<ColumnType>().At(0)) >
bool doPrintValue(const ColumnRef & c, const size_t row, std::ostream & ostr) {
if (const auto & casted_c = c->As<ColumnType>()) {
if constexpr (is_container_v<std::decay_t<AsType>>
&& !std::is_same_v<ColumnType, ColumnString>
&& !std::is_same_v<ColumnType, ColumnFixedString>) {
ostr << PrintContainer{static_cast<AsType>(casted_c->At(row))};
} else {
ostr << static_cast<AsType>(casted_c->At(row));
}
return true;
}
return false;
}
template <typename ColumnEnumType>
bool doPrintEnumValue(const ColumnRef & c, const size_t row, std::ostream & ostr) {
if (const auto & casted_c = c->As<ColumnEnumType>()) {
// via temporary stream to preserve fill and alignment of the ostr
std::stringstream sstr;
sstr << casted_c->NameAt(row) << " (" << static_cast<int64_t>(casted_c->At(row)) << ")";
ostr << sstr.str();
return true;
}
return false;
}
template <>
bool doPrintValue<ColumnEnum8>(const ColumnRef & c, const size_t row, std::ostream & ostr) {
return doPrintEnumValue<ColumnEnum8>(c, row, ostr);
}
template <>
bool doPrintValue<ColumnEnum16>(const ColumnRef & c, const size_t row, std::ostream & ostr) {
return doPrintEnumValue<ColumnEnum16>(c, row, ostr);
}
template <>
bool doPrintValue<ColumnArray, void>(const ColumnRef & c, const size_t row, std::ostream & ostr) {
// via temporary stream to preserve fill and alignment of the ostr
std::stringstream sstr;
if (const auto & array_col = c->As<ColumnArray>()) {
const auto & row_values = array_col->GetAsColumn(row);
sstr << "[";
for (size_t i = 0; i < row_values->Size(); ++i) {
printColumnValue(row_values, i, sstr);
if (i < row_values->Size() - 1)
sstr << ", ";
}
sstr << "]";
ostr << sstr.str();
return true;
}
return false;
}
template <>
bool doPrintValue<ColumnTuple, void>(const ColumnRef & c, const size_t row, std::ostream & ostr) {
if (const auto & tupple_col = c->As<ColumnTuple>()) {
ostr << "(";
for (size_t i = 0; i < tupple_col->TupleSize(); ++i) {
const auto & nested_col = (*tupple_col)[i];
printColumnValue(nested_col, row, ostr);
if (i < tupple_col->TupleSize() - 1)
ostr << ", ";
}
ostr << ")";
return true;
}
return false;
}
template <>
bool doPrintValue<ColumnUUID, void>(const ColumnRef & c, const size_t row, std::ostream & ostr) {
if (const auto & uuid_col = c->As<ColumnUUID>()) {
ostr << ToString(uuid_col->At(row));
return true;
}
return false;
}
template <>
bool doPrintValue<ColumnMap, void>(const ColumnRef & c, const size_t row, std::ostream & ostr) {
// via temporary stream to preserve fill and alignment of the ostr
std::stringstream sstr;
if (const auto & map_col = c->As<ColumnMap>()) {
sstr << "{";
const auto tuples = map_col->GetAsColumn(row);
for (size_t i = 0; i < tuples->Size(); ++i) {
printColumnValue(tuples, i, sstr);
if (i < tuples->Size() - 1)
sstr << ", ";
}
sstr << "}";
ostr << sstr.str();
return true;
}
return false;
}
std::ostream & printColumnValue(const ColumnRef& c, const size_t row, std::ostream & ostr) {
const auto r = false
|| doPrintValue<ColumnString>(c, row, ostr)
|| doPrintValue<ColumnFixedString>(c, row, ostr)
|| doPrintValue<ColumnUInt8, unsigned int>(c, row, ostr)
|| doPrintValue<ColumnUInt32>(c, row, ostr)
|| doPrintValue<ColumnUInt16>(c, row, ostr)
|| doPrintValue<ColumnUInt64>(c, row, ostr)
|| doPrintValue<ColumnInt8, int>(c, row, ostr)
|| doPrintValue<ColumnInt32>(c, row, ostr)
|| doPrintValue<ColumnInt16>(c, row, ostr)
|| doPrintValue<ColumnInt64>(c, row, ostr)
|| doPrintValue<ColumnFloat32>(c, row, ostr)
|| doPrintValue<ColumnFloat64>(c, row, ostr)
|| doPrintValue<ColumnEnum8>(c, row, ostr)
|| doPrintValue<ColumnEnum16>(c, row, ostr)
|| doPrintValue<ColumnDate, DateTimeValue>(c, row, ostr)
|| doPrintValue<ColumnDate32, DateTimeValue>(c, row, ostr)
|| doPrintValue<ColumnDateTime, DateTimeValue>(c, row, ostr)
|| doPrintValue<ColumnDateTime64, DateTimeValue>(c, row, ostr)
|| doPrintValue<ColumnDecimal>(c, row, ostr)
|| doPrintValue<ColumnIPv4>(c, row, ostr)
|| doPrintValue<ColumnIPv6>(c, row, ostr)
|| doPrintValue<ColumnArray, void>(c, row, ostr)
|| doPrintValue<ColumnTuple, void>(c, row, ostr)
|| doPrintValue<ColumnUUID, void>(c, row, ostr)
|| doPrintValue<ColumnMap, void>(c, row, ostr)
|| doPrintValue<ColumnPoint>(c, row, ostr)
|| doPrintValue<ColumnRing>(c, row, ostr)
|| doPrintValue<ColumnPolygon>(c, row, ostr)
|| doPrintValue<ColumnMultiPolygon>(c, row, ostr);
if (!r)
ostr << "Unable to print value of type " << c->GetType().GetName();
return ostr;
}
struct ColumnValue {
const ColumnRef& c;
size_t row;
};
std::ostream & operator<<(std::ostream & ostr, const ColumnValue& v) {
return printColumnValue(v.c, v.row, ostr);
}
}
std::ostream& operator<<(std::ostream & ostr, const PrettyPrintBlock & pretty_print_block) {
// Pretty-print block:
// - names of each column
// - types of each column
// - values of column row-by-row
const auto & block = pretty_print_block.block;
if (block.GetRowCount() == 0 || block.GetColumnCount() == 0)
return ostr;
std::vector<int> column_width(block.GetColumnCount());
const auto horizontal_bar = '|';
const auto cross = '+';
const auto vertical_bar = '-';
std::stringstream sstr;
for (auto i = block.begin(); i != block.end(); ++i) {
auto width = column_width[i.ColumnIndex()] = std::max(i.Type()->GetName().size(), i.Name().size());
sstr << cross << std::setw(width + 2) << std::setfill(vertical_bar) << vertical_bar;
}
sstr << cross;
const std::string split_line(sstr.str());
ostr << split_line << std::endl;
// column name
for (auto i = block.begin(); i != block.end(); ++i) {
auto width = column_width[i.ColumnIndex()];
ostr << horizontal_bar << ' ' << std::setw(width) << i.Name() << ' ';
}
ostr << horizontal_bar << std::endl;;
ostr << split_line << std::endl;
// column type
for (auto i = block.begin(); i != block.end(); ++i) {
auto width = column_width[i.ColumnIndex()];
ostr << horizontal_bar << ' ' << std::setw(width) << i.Type()->GetName() << ' ';
}
ostr << horizontal_bar << std::endl;;
ostr << split_line << std::endl;
// values
for (size_t row_index = 0; row_index < block.GetRowCount(); ++row_index) {
for (auto i = block.begin(); i != block.end(); ++i) {
auto width = column_width[i.ColumnIndex()];
ostr << horizontal_bar << ' ' << std::setw(width) << ColumnValue{i.Column(), row_index} << ' ';
}
ostr << horizontal_bar << std::endl;
}
ostr << split_line << std::endl;
return ostr;
}
std::ostream& operator<<(std::ostream& ostr, const in_addr& addr) {
char buf[INET_ADDRSTRLEN];
const char* ip_str = inet_ntop(AF_INET, &addr, buf, sizeof(buf));
if (!ip_str)
return ostr << "<!INVALID IPv4 VALUE!>";
return ostr << ip_str;
}
std::ostream& operator<<(std::ostream& ostr, const in6_addr& addr) {
char buf[INET6_ADDRSTRLEN];
const char* ip_str = inet_ntop(AF_INET6, &addr, buf, sizeof(buf));
if (!ip_str)
return ostr << "<!INVALID IPv6 VALUE!>";
return ostr << ip_str;
}
namespace clickhouse {
std::ostream& operator<<(std::ostream & ostr, const Block & block) {
if (block.GetRowCount() == 0 || block.GetColumnCount() == 0)
return ostr;
for (size_t col = 0; col < block.GetColumnCount(); ++col) {
const auto & c = block[col];
ostr << c->GetType().GetName() << " [";
for (size_t row = 0; row < block.GetRowCount(); ++row) {
printColumnValue(c, row, ostr);
if (row != block.GetRowCount() - 1)
ostr << ", ";
}
ostr << "]";
if (col != block.GetColumnCount() - 1)
ostr << "\n";
}
return ostr;
}
std::ostream& operator<<(std::ostream & ostr, const Type & type) {
return ostr << type.GetName();
}
std::ostream & operator<<(std::ostream & ostr, const ServerInfo & server_info) {
return ostr << server_info.name << "/" << server_info.display_name
<< " ver "
<< server_info.version_major << "."
<< server_info.version_minor << "."
<< server_info.version_patch
<< " (" << server_info.revision << ")";
}
std::ostream & operator<<(std::ostream & ostr, const Profile & profile) {
return ostr
<< "rows : " << profile.rows
<< " blocks : " << profile.blocks
<< " bytes : " << profile.bytes
<< " rows_before_limit : " << profile.rows_before_limit
<< " applied_limit : " << profile.applied_limit
<< " calculated_rows_before_limit : " << profile.calculated_rows_before_limit;
}
std::ostream & operator<<(std::ostream & ostr, const Progress & progress) {
return ostr
<< "rows : " << progress.rows
<< " bytes : " << progress.bytes
<< " total_rows : " << progress.total_rows
<< " written_rows : " << progress.written_rows
<< " written_bytes : " << progress.written_bytes;
}
std::ostream& operator<<(std::ostream& ostr, const ItemView& item_view) {
ostr << "ItemView {" << clickhouse::Type::TypeName(item_view.type) << " : ";
switch (item_view.type) {
case Type::Void:
ostr << "--void--";
break;
case Type::Int8:
ostr << static_cast<int>(item_view.get<int8_t>());
break;
case Type::Int16:
ostr << static_cast<int>(item_view.get<int16_t>());
break;
case Type::Int32:
ostr << static_cast<int>(item_view.get<int32_t>());
break;
case Type::Int64:
ostr << item_view.get<int64_t>();
break;
case Type::UInt8:
ostr << static_cast<unsigned int>(item_view.get<uint8_t>());
break;
case Type::UInt16:
ostr << static_cast<unsigned int>(item_view.get<uint16_t>());
break;
case Type::UInt32:
ostr << static_cast<unsigned int>(item_view.get<uint32_t>());
break;
case Type::UInt64:
ostr << item_view.get<uint64_t>();
break;
case Type::Float32:
ostr << static_cast<float>(item_view.get<float>());
break;
case Type::Float64:
ostr << static_cast<double>(item_view.get<double>());
break;
case Type::String:
case Type::FixedString:
ostr << "\"" << item_view.data << "\" (" << item_view.data.size() << " bytes)";
break;
case Type::Date:
ostr << DateTimeValue(item_view.get<uint16_t>() * 86400);
break;
case Type::Date32:
ostr << DateTimeValue(item_view.get<int32_t>());
break;
case Type::DateTime:
ostr << DateTimeValue(item_view.get<uint32_t>());
break;
case Type::DateTime64: {
if (item_view.data.size() == sizeof(int32_t)) {
ostr << DateTimeValue(item_view.get<int32_t>());
}
else if (item_view.data.size() == sizeof(int64_t)) {
ostr << DateTimeValue(item_view.get<int64_t>());
}
else if (item_view.data.size() == sizeof(Int128)) {
ostr << DateTimeValue(item_view.get<Int128>());
}
else {
throw std::runtime_error("Invalid data size of ItemView of type DateTime64");
}
break;
}
case Type::Enum8:
ostr << static_cast<int>(item_view.get<int8_t>());
break;
case Type::Enum16:
ostr << static_cast<int>(item_view.get<int16_t>());
break;
case Type::UUID: {
const auto & uuid_vals = reinterpret_cast<const uint64_t*>(item_view.data.data());
ostr << ToString(clickhouse::UUID{uuid_vals[0], uuid_vals[1]});
break;
}
case Type::IPv4: {
in_addr addr;
addr.s_addr = ntohl(item_view.get<uint32_t>());
ostr << addr;
break;
}
case Type::IPv6:
ostr << *reinterpret_cast<const in6_addr*>(item_view.AsBinaryData().data());
break;
case Type::Int128:
ostr << item_view.get<Int128>();
break;
case Type::UInt128:
ostr << item_view.get<UInt128>();
break;
case Type::Decimal: {
if (item_view.data.size() == sizeof(int32_t)) {
ostr << item_view.get<int32_t>();
}
else if (item_view.data.size() == sizeof(int64_t)) {
ostr << item_view.get<int64_t>();
}
else if (item_view.data.size() == sizeof(Int128)) {
ostr << item_view.get<Int128>();
}
else {
throw std::runtime_error("Invalid data size of ItemView of type Decimal");
}
}
break;
case Type::Decimal32:
ostr << DateTimeValue(item_view.get<int32_t>());
break;
case Type::Decimal64:
ostr << DateTimeValue(item_view.get<int64_t>());
break;
case Type::Decimal128:
ostr << DateTimeValue(item_view.get<Int128>());
break;
// Unsupported types. i.e. there shouldn't be `ItemView`s of those types in practice.
// either because GetItem() is not implemented for corresponding column type
// OR this type code is never used, for `ItemView`s (but type code of wrapped column is).
case Type::LowCardinality:
case Type::Array:
case Type::Nullable:
case Type::Tuple:
case Type::Map:
case Type::Point:
case Type::Ring:
case Type::Polygon:
case Type::MultiPolygon: {
throw std::runtime_error("Invalid data size of ItemView of type " + std::string(Type::TypeName(item_view.type)));
}
};
return ostr << "}";
}
}
uint64_t versionNumber(const ServerInfo & server_info) {
return versionNumber(server_info.version_major, server_info.version_minor, server_info.version_patch, server_info.revision);
}
std::string ToString(const clickhouse::UUID& v) {
std::string result(36, 0);
// ffff ff ff ss ssssss
const int count = std::snprintf(result.data(), result.size() + 1, "%.8" PRIx64 "-%.4" PRIx64 "-%.4" PRIx64 "-%.4" PRIx64 "-%.12" PRIx64,
v.first >> 32, (v.first >> 16) & 0xffff, v.first & 0xffff, v.second >> 48, v.second & 0xffffffffffff);
if (count != 36) {
throw std::runtime_error("Error while converting UUID to string");
}
return result;
}