ClickHouse/src/Storages/StorageFile.h

183 lines
6.1 KiB
C++
Raw Normal View History

#pragma once
#include <Storages/Cache/SchemaCache.h>
#include <Storages/IStorage.h>
#include <Common/FileRenamer.h>
#include <IO/Archives/IArchiveReader.h>
2017-04-08 01:32:05 +00:00
#include <atomic>
#include <shared_mutex>
2017-04-08 01:32:05 +00:00
namespace DB
{
class StorageFile final : public IStorage
{
public:
struct CommonArguments : public WithContext
{
StorageID table_id;
std::string format_name;
std::optional<FormatSettings> format_settings;
std::string compression_method;
const ColumnsDescription & columns;
const ConstraintsDescription & constraints;
const String & comment;
const std::string rename_after_processing;
2023-07-31 12:04:27 +00:00
std::string path_to_archive;
};
/// From file descriptor
StorageFile(int table_fd_, CommonArguments args);
/// From user's file
StorageFile(const std::string & table_path_, const std::string & user_files_path, CommonArguments args);
/// From table in database
StorageFile(const std::string & relative_table_dir_path, CommonArguments args);
explicit StorageFile(CommonArguments args);
std::string getName() const override { return "File"; }
2020-08-03 13:54:14 +00:00
Pipe read(
const Names & column_names,
const StorageSnapshotPtr & storage_snapshot,
SelectQueryInfo & query_info,
ContextPtr context,
QueryProcessingStage::Enum processed_stage,
size_t max_block_size,
size_t num_streams) override;
2021-07-23 14:25:35 +00:00
SinkToStoragePtr write(
2017-05-21 22:25:25 +00:00
const ASTPtr & query,
const StorageMetadataPtr & /*metadata_snapshot*/,
ContextPtr context,
bool async_insert) override;
2020-06-18 10:29:13 +00:00
void truncate(
const ASTPtr & /*query*/,
const StorageMetadataPtr & /* metadata_snapshot */,
ContextPtr /* context */,
2020-06-18 16:10:47 +00:00
TableExclusiveLockHolder &) override;
2020-01-05 02:57:09 +00:00
2020-04-07 14:05:51 +00:00
void rename(const String & new_path_to_table_data, const StorageID & new_table_id) override;
2019-11-11 14:28:28 +00:00
2020-11-01 17:38:43 +00:00
bool storesDataOnDisk() const override;
2019-09-06 08:53:32 +00:00
Strings getDataPaths() const override;
NamesAndTypesList getVirtuals() const override { return virtual_columns; }
2020-04-27 13:55:30 +00:00
2021-04-26 13:34:44 +00:00
static Strings getPathsList(const String & table_path, const String & user_files_path, ContextPtr context, size_t & total_bytes_to_read);
2022-05-20 14:57:27 +00:00
/// Check if the format supports reading only some subset of columns.
/// Is is useful because such formats could effectively skip unknown columns
2021-03-31 14:21:19 +00:00
/// So we can create a header of only required columns in read method and ask
/// format to read only them. Note: this hack cannot be done with ordinary formats like TSV.
2022-05-13 18:39:19 +00:00
bool supportsSubsetOfColumns() const override;
bool supportsSubcolumns() const override { return true; }
bool prefersLargeBlocks() const override;
bool parallelizeOutputAfterReading(ContextPtr context) const override;
2021-10-25 16:23:44 +00:00
bool supportsPartitionBy() const override { return true; }
struct ArchiveInfo
{
2023-08-28 13:10:13 +00:00
std::vector<std::string> paths_to_archives;
std::string path_in_archive; // used when reading a single file from archive
2023-08-28 13:10:13 +00:00
IArchiveReader::NameFilter filter = {}; // used when files inside archive are defined with a glob
2023-08-30 08:40:55 +00:00
bool isSingleFileRead() const
{
2023-08-28 13:10:13 +00:00
return !filter;
}
};
ColumnsDescription getTableStructureFromFileDescriptor(ContextPtr context);
static ColumnsDescription getTableStructureFromFile(
const String & format,
const std::vector<String> & paths,
const String & compression_method,
const std::optional<FormatSettings> & format_settings,
2023-05-25 00:00:32 +00:00
ContextPtr context,
const std::optional<ArchiveInfo> & archive_info = std::nullopt);
static SchemaCache & getSchemaCache(const ContextPtr & context);
2023-07-31 12:04:27 +00:00
static void parseFileSource(String source, String & filename, String & path_to_archive);
static ArchiveInfo getArchiveInfo(
const std::string & path_to_archive,
const std::string & file_in_archive,
const std::string & user_files_path,
ContextPtr context,
size_t & total_bytes_to_read);
bool supportsTrivialCountOptimization() const override { return true; }
protected:
friend class StorageFileSource;
2021-07-23 14:25:35 +00:00
friend class StorageFileSink;
private:
void setStorageMetadata(CommonArguments args);
static std::optional<ColumnsDescription> tryGetColumnsFromCache(
const Strings & paths, const String & format_name, const std::optional<FormatSettings> & format_settings, ContextPtr context);
static void addColumnsToCache(
const Strings & paths,
const ColumnsDescription & columns,
const String & format_name,
const std::optional<FormatSettings> & format_settings,
const ContextPtr & context);
std::string format_name;
// We use format settings from global context + CREATE query for File table
// function -- in this case, format_settings is set.
// For `file` table function, we use format settings from current user context,
// in this case, format_settings is not set.
std::optional<FormatSettings> format_settings;
int table_fd = -1;
String compression_method;
std::string base_path;
2019-09-06 18:29:41 +00:00
std::vector<std::string> paths;
std::optional<ArchiveInfo> archive_info;
2019-07-21 13:15:04 +00:00
bool is_db_table = true; /// Table is stored in real database, not user's file
bool use_table_fd = false; /// Use table_fd instead of path
mutable std::shared_timed_mutex rwlock;
2020-05-30 21:57:37 +00:00
Poco::Logger * log = &Poco::Logger::get("StorageFile");
2021-04-26 13:34:44 +00:00
/// Total number of bytes to read (sums for multiple files in case of globs). Needed for progress bar.
2021-04-26 13:34:44 +00:00
size_t total_bytes_to_read = 0;
2021-10-28 13:56:45 +00:00
String path_for_partitioned_write;
bool is_path_with_globs = false;
/// These buffers are needed for schema inference when data source
/// is file descriptor. See getTableStructureFromFileDescriptor.
std::unique_ptr<ReadBuffer> read_buffer_from_fd;
std::unique_ptr<ReadBuffer> peekable_read_buffer_from_fd;
std::atomic<bool> has_peekable_read_buffer_from_fd = false;
// Counts the number of readers
std::atomic<int32_t> readers_counter = 0;
FileRenamer file_renamer;
bool was_renamed = false;
NamesAndTypesList virtual_columns;
};
}