ClickHouse/src/Storages/MergeTree/IMergeTreeDataPart.h

450 lines
18 KiB
C++
Raw Normal View History

2016-02-14 04:58:47 +00:00
#pragma once
2019-10-10 16:30:30 +00:00
#include <DataStreams/IBlockInputStream.h>
#include <Core/Row.h>
#include <Core/Block.h>
2020-09-15 09:55:57 +00:00
#include <common/types.h>
#include <Core/NamesAndTypes.h>
2019-10-10 16:30:30 +00:00
#include <Storages/IStorage.h>
#include <Storages/MergeTree/MergeTreeIndexGranularity.h>
2019-06-19 10:07:56 +00:00
#include <Storages/MergeTree/MergeTreeIndexGranularityInfo.h>
Data Skipping Indices (#4143) * made index parser * added index parsing * some fixes * added index interface and factory * fixed compilation * ptrs * added indexParts * indextypes * index condition * IndexCondition * added indexes in selectexecutor * fix * changed comment * fix * added granularity * comments * fix * fix * added writing indexes * removed indexpart class * fix * added setSkipIndexes * add rw for MergeTreeIndexes * fixes * upd error * fix * fix * reading * test index * fixed nullptr error * fixed * fix * unique names * asts -> exprlist * minmax index * fix * fixed select * fixed merging * fixed mutation * working minmax * removed test index * fixed style * added indexes to checkDataPart * added tests for minmax index * fixed constructor * fix style * fixed includes * fixed setSkipIndexes * added indexes meta to zookeeper * added parsing * removed throw * alter cmds parse * fix * added alter * fix * alters fix * fix alters * fix "after" * fixed alter * alter fix + test * fixes * upd setSkipIndexes * fixed alter bug with drop all indices * fix metadata editing * new test and repl fix * rm test files * fixed repl alter * fix * fix * indices * MTReadStream * upd test for bug * fix * added useful parsers and ast classes * fix * fix comments * replaced columns * fix * fixed parsing * fixed printing * fix err * basic IndicesDescription * go to IndicesDescr * moved indices * go to indicesDescr * fix test minmax_index* * fixed MT alter * fixed bug with replMT indices storing in zk * rename * refactoring * docs ru * docs ru * docs en * refactor * rename tests * fix docs * refactoring * fix * fix * fix * fixed style * unique idx * unique * fix * better minmax calculation * upd * added getBlock * unique_condition * added termForAST * unique * fixed not * uniqueCondition::mayBeTrueOnGranule * fix * fixed bug with double column * is always true * fix * key set * spaces * test * tests * fix * unique * fix * fix * fixed bug with duplicate column * removed unused data * fix * fixes * __bitSwapLastTwo * fix
2019-02-05 14:50:25 +00:00
#include <Storages/MergeTree/MergeTreeIndices.h>
#include <Storages/MergeTree/MergeTreePartInfo.h>
#include <Storages/MergeTree/MergeTreePartition.h>
#include <Storages/MergeTree/MergeTreeDataPartChecksum.h>
#include <Storages/MergeTree/MergeTreeDataPartTTLInfo.h>
#include <Storages/MergeTree/MergeTreeIOSettings.h>
#include <Storages/MergeTree/KeyCondition.h>
#include <Columns/IColumn.h>
#include <Poco/Path.h>
#include <shared_mutex>
2016-02-14 04:58:47 +00:00
namespace zkutil
{
class ZooKeeper;
using ZooKeeperPtr = std::shared_ptr<ZooKeeper>;
}
2016-02-14 04:58:47 +00:00
namespace DB
{
2019-10-21 15:33:59 +00:00
struct ColumnSize;
class MergeTreeData;
2019-12-07 19:30:37 +00:00
struct FutureMergedMutatedPart;
class IReservation;
using ReservationPtr = std::unique_ptr<IReservation>;
2019-10-21 15:33:59 +00:00
class IVolume;
using VolumePtr = std::shared_ptr<IVolume>;
2019-10-21 15:33:59 +00:00
class IMergeTreeReader;
2019-10-21 17:23:06 +00:00
class IMergeTreeDataPartWriter;
class MarkCache;
2020-07-09 01:00:16 +00:00
class UncompressedCache;
2019-10-10 16:30:30 +00:00
namespace ErrorCodes
{
}
2020-02-19 14:07:36 +00:00
/// Description of the data part.
2019-10-10 16:30:30 +00:00
class IMergeTreeDataPart : public std::enable_shared_from_this<IMergeTreeDataPart>
2016-02-14 04:58:47 +00:00
{
2019-10-10 16:30:30 +00:00
public:
using Checksums = MergeTreeDataPartChecksums;
using Checksum = MergeTreeDataPartChecksums::Checksum;
2019-10-10 16:30:30 +00:00
using ValueSizeMap = std::map<std::string, double>;
2016-02-14 04:58:47 +00:00
2019-10-21 15:33:59 +00:00
using MergeTreeReaderPtr = std::unique_ptr<IMergeTreeReader>;
2019-10-21 17:23:06 +00:00
using MergeTreeWriterPtr = std::unique_ptr<IMergeTreeDataPartWriter>;
2019-10-21 15:33:59 +00:00
using ColumnSizeByName = std::unordered_map<std::string, ColumnSize>;
using NameToPosition = std::unordered_map<std::string, size_t>;
using Type = MergeTreeDataPartType;
IMergeTreeDataPart(
const MergeTreeData & storage_,
const String & name_,
const MergeTreePartInfo & info_,
const VolumePtr & volume,
const std::optional<String> & relative_path,
Type part_type_);
IMergeTreeDataPart(
MergeTreeData & storage_,
const String & name_,
const VolumePtr & volume,
const std::optional<String> & relative_path,
Type part_type_);
2019-10-10 16:30:30 +00:00
virtual MergeTreeReaderPtr getReader(
const NamesAndTypesList & columns_,
const StorageMetadataPtr & metadata_snapshot,
2019-10-10 16:30:30 +00:00
const MarkRanges & mark_ranges,
UncompressedCache * uncompressed_cache,
MarkCache * mark_cache,
const MergeTreeReaderSettings & reader_settings_,
2019-10-10 16:30:30 +00:00
const ValueSizeMap & avg_value_size_hints_ = ValueSizeMap{},
const ReadBufferFromFileBase::ProfileCallback & profile_callback_ = ReadBufferFromFileBase::ProfileCallback{}) const = 0;
2019-10-20 23:36:27 +00:00
virtual MergeTreeWriterPtr getWriter(
const NamesAndTypesList & columns_list,
2020-06-17 12:39:20 +00:00
const StorageMetadataPtr & metadata_snapshot,
2019-11-05 11:53:22 +00:00
const std::vector<MergeTreeIndexPtr> & indices_to_recalc,
2019-10-20 23:36:27 +00:00
const CompressionCodecPtr & default_codec_,
const MergeTreeWriterSettings & writer_settings,
2019-11-05 11:53:22 +00:00
const MergeTreeIndexGranularity & computed_index_granularity = {}) const = 0;
2019-10-10 16:30:30 +00:00
virtual bool isStoredOnDisk() const = 0;
virtual bool supportsVerticalMerge() const { return false; }
2016-02-14 04:58:47 +00:00
/// NOTE: Returns zeros if column files are not found in checksums.
2020-03-23 13:40:14 +00:00
/// Otherwise return information about column size on disk.
2020-03-23 12:19:43 +00:00
ColumnSize getColumnSize(const String & column_name, const IDataType & /* type */) const;
2020-03-23 13:40:14 +00:00
/// Return information about column size on disk for all columns in part
2020-03-23 12:19:43 +00:00
ColumnSize getTotalColumnsSize() const { return total_columns_size; }
2019-12-19 13:10:57 +00:00
virtual String getFileNameForColumn(const NameAndTypePair & column) const = 0;
virtual ~IMergeTreeDataPart();
2019-10-10 16:30:30 +00:00
using ColumnToSize = std::map<std::string, UInt64>;
2020-06-03 21:30:10 +00:00
/// Populates columns_to_size map (compressed size).
2020-03-23 12:19:43 +00:00
void accumulateColumnSizes(ColumnToSize & /* column_to_size */) const;
2019-10-10 16:30:30 +00:00
2020-01-14 13:23:51 +00:00
Type getType() const { return part_type; }
2019-10-10 16:30:30 +00:00
String getTypeName() const { return getType().toString(); }
2019-10-10 16:30:30 +00:00
2020-01-16 16:15:01 +00:00
void setColumns(const NamesAndTypesList & new_columns);
const NamesAndTypesList & getColumns() const { return columns; }
2020-06-03 21:30:10 +00:00
/// Throws an exception if part is not stored in on-disk format.
2019-10-10 16:30:30 +00:00
void assertOnDisk() const;
void remove(bool keep_s3 = false) const;
2019-10-16 18:27:53 +00:00
/// Initialize columns (from columns.txt if exists, or create from column files if not).
/// Load checksums from checksums.txt if exists. Load index if required.
void loadColumnsChecksumsIndexes(bool require_columns_checksums, bool check_consistency);
2019-10-28 11:00:29 +00:00
String getMarksFileExtension() const { return index_granularity_info.marks_file_extension; }
2018-06-04 11:43:09 +00:00
/// Generate the new name for this part according to `new_part_info` and min/max dates from the old name.
/// This is useful when you want to change e.g. block numbers or the mutation version of the part.
2018-05-23 19:34:37 +00:00
String getNewName(const MergeTreePartInfo & new_part_info) const;
/// Returns column position in part structure or std::nullopt if it's missing in part.
2020-05-15 10:26:44 +00:00
///
/// NOTE: Doesn't take column renames into account, if some column renames
/// take place, you must take original name of column for this part from
/// storage and pass it to this method.
std::optional<size_t> getColumnPosition(const String & column_name) const;
2019-10-31 14:44:17 +00:00
2020-01-16 16:15:01 +00:00
/// Returns the name of a column with minimum compressed size (as returned by getColumnSize()).
/// If no checksums are present returns the name of the first physically existing column.
2020-10-27 11:04:03 +00:00
String getColumnNameWithMinimumCompressedSize(const StorageMetadataPtr & metadata_snapshot) const;
2020-01-16 16:15:01 +00:00
2019-10-10 16:30:30 +00:00
bool contains(const IMergeTreeDataPart & other) const { return info.contains(other.info); }
/// If the partition key includes date column (a common case), these functions will return min and max values for this column.
DayNum getMinDate() const;
DayNum getMaxDate() const;
/// otherwise, if the partition key includes dateTime column (also a common case), these functions will return min and max values for this column.
time_t getMinTime() const;
time_t getMaxTime() const;
2018-05-23 19:34:37 +00:00
bool isEmpty() const { return rows_count == 0; }
2018-10-17 03:13:00 +00:00
const MergeTreeData & storage;
2016-02-14 04:58:47 +00:00
String name;
MergeTreePartInfo info;
/// Part unique identifier.
/// The intention is to use it for identifying cases where the same part is
/// processed by multiple shards.
UUID uuid = UUIDHelpers::Nil;
VolumePtr volume;
2019-10-10 16:30:30 +00:00
2020-06-03 21:30:10 +00:00
/// A directory path (relative to storage's path) where part data is actually stored
/// Examples: 'detached/tmp_fetch_<name>', 'tmp_<name>', '<name>'
mutable String relative_path;
2020-01-14 13:23:51 +00:00
MergeTreeIndexGranularityInfo index_granularity_info;
size_t rows_count = 0;
2019-10-10 16:30:30 +00:00
time_t modification_time = 0;
/// When the part is removed from the working set. Changes once.
mutable std::atomic<time_t> remove_time { std::numeric_limits<time_t>::max() };
2016-02-14 04:58:47 +00:00
2017-04-16 15:00:33 +00:00
/// If true, the destructor will delete the directory with the part.
bool is_temp = false;
2016-02-14 04:58:47 +00:00
/// If true it means that there are no ZooKeeper node for this part, so it should be deleted only from filesystem
bool is_duplicate = false;
/// Frozen by ALTER TABLE ... FREEZE ... It is used for information purposes in system.parts table.
mutable std::atomic<bool> is_frozen {false};
/**
* Part state is a stage of its lifetime. States are ordered and state of a part could be increased only.
* Part state should be modified under data_parts mutex.
*
* Possible state transitions:
2019-09-04 18:26:18 +00:00
* Temporary -> Precommitted: we are trying to commit a fetched, inserted or merged part to active set
* Precommitted -> Outdated: we could not to add a part to active set and doing a rollback (for example it is duplicated part)
2020-08-08 00:47:03 +00:00
* Precommitted -> Committed: we successfully committed a part to active dataset
2019-09-04 18:26:18 +00:00
* Precommitted -> Outdated: a part was replaced by a covering part or DROP PARTITION
* Outdated -> Deleting: a cleaner selected this part for deletion
* Deleting -> Outdated: if an ZooKeeper error occurred during the deletion, we will retry deletion
* Committed -> DeleteOnDestroy if part was moved to another disk
*/
enum class State
{
2019-09-04 18:26:18 +00:00
Temporary, /// the part is generating now, it is not in data_parts list
PreCommitted, /// the part is in data_parts, but not used for SELECTs
Committed, /// active data part, used by current and upcoming SELECTs
Outdated, /// not active data part, but could be used by only current SELECTs, could be deleted after SELECTs finishes
Deleting, /// not active data part with identity refcounter, it is deleting right now by a cleaner
DeleteOnDestroy, /// part was moved to another disk and should be deleted in own destructor
};
using TTLInfo = MergeTreeDataPartTTLInfo;
using TTLInfos = MergeTreeDataPartTTLInfos;
TTLInfos ttl_infos;
/// Current state of the part. If the part is in working set already, it should be accessed via data_parts mutex
void setState(State new_state) const;
State getState() const;
/// Returns name of state
static String stateToString(State state);
String stateString() const;
String getNameWithState() const
{
return name + " (state " + stateString() + ")";
}
/// Returns true if state of part is one of affordable_states
bool checkState(const std::initializer_list<State> & affordable_states) const
{
for (auto affordable_state : affordable_states)
{
if (state == affordable_state)
return true;
}
return false;
}
/// Throws an exception if state of the part is not in affordable_states
void assertState(const std::initializer_list<State> & affordable_states) const;
/// Primary key (correspond to primary.idx file).
/// Always loaded in RAM. Contains each index_granularity-th value of primary key tuple.
/// Note that marks (also correspond to primary key) is not always in RAM, but cached. See MarkCache.h.
using Index = Columns;
Index index;
2016-02-14 04:58:47 +00:00
MergeTreePartition partition;
2018-11-15 14:06:54 +00:00
/// Amount of rows between marks
/// As index always loaded into memory
MergeTreeIndexGranularity index_granularity;
2018-11-15 14:06:54 +00:00
/// Index that for each part stores min and max values of a set of columns. This allows quickly excluding
/// parts based on conditions on these columns imposed by a query.
/// Currently this index is built using only columns required by partition expression, but in principle it
/// can be built using any set of columns.
struct MinMaxIndex
{
/// A direct product of ranges for each key column. See Storages/MergeTree/KeyCondition.cpp for details.
2020-03-10 14:56:55 +00:00
std::vector<Range> hyperrectangle;
bool initialized = false;
public:
MinMaxIndex() = default;
/// For month-based partitioning.
MinMaxIndex(DayNum min_date, DayNum max_date)
2020-03-10 14:56:55 +00:00
: hyperrectangle(1, Range(min_date, true, max_date, true))
, initialized(true)
{
}
2020-03-10 14:39:30 +00:00
void load(const MergeTreeData & data, const DiskPtr & disk_, const String & part_path);
void store(const MergeTreeData & data, const DiskPtr & disk_, const String & part_path, Checksums & checksums) const;
void store(const Names & column_names, const DataTypes & data_types, const DiskPtr & disk_, const String & part_path, Checksums & checksums) const;
void update(const Block & block, const Names & column_names);
void merge(const MinMaxIndex & other);
};
MinMaxIndex minmax_idx;
Checksums checksums;
2016-02-14 04:58:47 +00:00
/// Columns with values, that all have been zeroed by expired ttl
2019-10-10 16:30:30 +00:00
NameSet expired_columns;
2016-02-14 04:58:47 +00:00
CompressionCodecPtr default_codec;
2019-10-10 16:30:30 +00:00
/// For data in RAM ('index')
UInt64 getIndexSizeInBytes() const;
UInt64 getIndexSizeInAllocatedBytes() const;
UInt64 getMarksCount() const;
2020-03-23 13:32:02 +00:00
UInt64 getBytesOnDisk() const { return bytes_on_disk; }
void setBytesOnDisk(UInt64 bytes_on_disk_) { bytes_on_disk = bytes_on_disk_; }
2019-10-10 16:30:30 +00:00
size_t getFileSizeOrZero(const String & file_name) const;
2020-06-03 21:30:10 +00:00
/// Returns path to part dir relatively to disk mount point
String getFullRelativePath() const;
2020-06-03 21:30:10 +00:00
/// Returns full path to part dir
2019-10-10 16:30:30 +00:00
String getFullPath() const;
2020-05-29 15:02:12 +00:00
2020-06-03 21:30:10 +00:00
/// Moves a part to detached/ directory and adds prefix to its name
void renameToDetached(const String & prefix) const;
2020-06-03 21:30:10 +00:00
/// Makes checks and move part to new directory
/// Changes only relative_dir_name, you need to update other metadata (name, is_temp) explicitly
2020-06-03 22:00:02 +00:00
virtual void renameTo(const String & new_relative_path, bool remove_new_dir_if_exists) const;
2020-06-03 21:30:10 +00:00
/// Makes clone of a part in detached/ directory via hard links
2020-06-26 11:30:23 +00:00
virtual void makeCloneInDetached(const String & prefix, const StorageMetadataPtr & metadata_snapshot) const;
2016-02-14 04:58:47 +00:00
2020-10-20 01:24:30 +00:00
/// Makes full clone of part in specified subdirectory (relative to storage data directory, e.g. "detached") on another disk
void makeCloneOnDisk(const DiskPtr & disk, const String & directory_name) const;
2019-06-07 19:16:42 +00:00
2020-05-15 10:26:44 +00:00
/// Checks that .bin and .mrk files exist.
///
/// NOTE: Doesn't take column renames into account, if some column renames
/// take place, you must take original name of column for this part from
/// storage and pass it to this method.
virtual bool hasColumnFiles(const NameAndTypePair & /* column */) const { return false; }
/// Returns true if this part shall participate in merges according to
/// settings of given storage policy.
bool shallParticipateInMerges(const StoragePolicyPtr & storage_policy) const;
2020-06-03 21:30:10 +00:00
/// Calculate the total size of the entire directory with all the files
2020-02-28 17:14:55 +00:00
static UInt64 calculateTotalSizeOnDisk(const DiskPtr & disk_, const String & from);
2020-03-23 12:19:43 +00:00
void calculateColumnsSizesOnDisk();
2017-08-16 19:22:49 +00:00
2020-06-03 09:51:23 +00:00
String getRelativePathForPrefix(const String & prefix) const;
/// Return set of metadat file names without checksums. For example,
/// columns.txt or checksums.txt itself.
NameSet getFileNamesWithoutChecksums() const;
/// File with compression codec name which was used to compress part columns
/// by default. Some columns may have their own compression codecs, but
/// default will be stored in this file.
static inline constexpr auto DEFAULT_COMPRESSION_CODEC_FILE_NAME = "default_compression_codec.txt";
static inline constexpr auto DELETE_ON_DESTROY_MARKER_FILE_NAME = "delete-on-destroy.txt";
static inline constexpr auto UUID_FILE_NAME = "uuid.txt";
/// Checks that all TTLs (table min/max, column ttls, so on) for part
/// calculated. Part without calculated TTL may exist if TTL was added after
/// part creation (using alter query with materialize_ttl setting).
bool checkAllTTLCalculated(const StorageMetadataPtr & metadata_snapshot) const;
/// Return some uniq string for file
/// Required for distinguish different copies of the same part on S3
String getUniqueId() const;
2019-11-18 12:22:27 +00:00
protected:
2020-03-23 12:19:43 +00:00
/// Total size of all columns, calculated once in calcuateColumnSizesOnDisk
ColumnSize total_columns_size;
/// Size for each column, calculated once in calcuateColumnSizesOnDisk
ColumnSizeByName columns_sizes;
2020-03-23 13:32:02 +00:00
/// Total size on disk, not only columns. May not contain size of
/// checksums.txt and columns.txt. 0 - if not counted;
UInt64 bytes_on_disk{0};
2020-05-21 09:00:44 +00:00
/// Columns description. Cannot be changed, after part initialization.
2020-01-16 16:15:01 +00:00
NamesAndTypesList columns;
2020-01-17 12:24:27 +00:00
const Type part_type;
2020-01-16 16:15:01 +00:00
2019-11-18 12:22:27 +00:00
void removeIfNeeded();
2020-01-16 16:15:01 +00:00
2020-06-03 18:59:18 +00:00
virtual void checkConsistency(bool require_part_metadata) const;
void checkConsistencyBase() const;
2019-11-18 12:22:27 +00:00
2020-03-23 12:19:43 +00:00
/// Fill each_columns_size and total_size with sizes from columns files on
/// disk using columns and checksums.
2020-06-29 20:36:18 +00:00
virtual void calculateEachColumnSizes(ColumnSizeByName & each_columns_size, ColumnSize & total_size) const = 0;
2020-03-23 12:19:43 +00:00
2020-05-29 15:02:12 +00:00
String getRelativePathForDetachedPart(const String & prefix) const;
2017-08-16 19:22:49 +00:00
private:
/// In compact parts order of columns is necessary
NameToPosition column_name_to_position;
2019-11-18 12:22:27 +00:00
/// Reads part unique identifier (if exists) from uuid.txt
void loadUUID();
2019-10-31 14:44:17 +00:00
/// Reads columns names and types from columns.txt
void loadColumns(bool require);
2020-08-08 00:47:03 +00:00
/// If checksums.txt exists, reads file's checksums (and sizes) from it
2019-10-31 14:44:17 +00:00
void loadChecksums(bool require);
/// Loads marks index granularity into memory
virtual void loadIndexGranularity();
/// Loads index file.
void loadIndex();
/// Load rows count for this part from disk (for the newer storage format version).
/// For the older format version calculates rows count from the size of a column with a fixed size.
void loadRowsCount();
2020-05-21 09:00:44 +00:00
/// Loads ttl infos in json format from file ttl.txt. If file doesn't exists assigns ttl infos with all zeros
2019-10-31 14:44:17 +00:00
void loadTTLInfos();
void loadPartitionAndMinMaxIndex();
2020-08-28 09:07:20 +00:00
/// Load default compression codec from file default_compression_codec.txt
/// if it not exists tries to deduce codec from compressed column without
/// any specifial compression.
void loadDefaultCompressionCodec();
/// Found column without specific compression and return codec
/// for this column with default parameters.
CompressionCodecPtr detectDefaultCompressionCodec() const;
mutable State state{State::Temporary};
2016-02-14 04:58:47 +00:00
};
2019-10-10 16:30:30 +00:00
using MergeTreeDataPartState = IMergeTreeDataPart::State;
2019-10-21 15:33:59 +00:00
using MergeTreeDataPartPtr = std::shared_ptr<const IMergeTreeDataPart>;
using MergeTreeMutableDataPartPtr = std::shared_ptr<IMergeTreeDataPart>;
bool isCompactPart(const MergeTreeDataPartPtr & data_part);
bool isWidePart(const MergeTreeDataPartPtr & data_part);
bool isInMemoryPart(const MergeTreeDataPartPtr & data_part);
2016-02-14 04:58:47 +00:00
}