ClickHouse/src/Storages/ExternalDataSourceConfiguration.h

#pragma once

#include <Parsers/ASTIdentifier.h>
#include <Interpreters/Context.h>
#include <Poco/Util/AbstractConfiguration.h>


namespace ExternalDataSource
{
}

namespace DB
{

struct ExternalDataSourceConfiguration
{
    String host;
    UInt16 port;
    String username;
    String password;
    String database;
    String table;
    String schema;

    ExternalDataSourceConfiguration() = default;
    ExternalDataSourceConfiguration(const ExternalDataSourceConfiguration & configuration) = default;

    String toString() const;
};

using ExternalDataSourceConfigurationPtr = std::shared_ptr<ExternalDataSourceConfiguration>;

/// Highest priority is 0, the bigger the number in map, the less the priority.
using ExternalDataSourcesConfigurationByPriority = std::map<size_t, std::vector<ExternalDataSourceConfiguration>>;


struct StoragePostgreSQLConfiguration : ExternalDataSourceConfiguration
{
    explicit StoragePostgreSQLConfiguration(
            const ExternalDataSourceConfiguration & common_configuration,
            const String & on_conflict_ = "")
        : ExternalDataSourceConfiguration(common_configuration)
        , on_conflict(on_conflict_) {}

    String on_conflict;
    std::vector<std::pair<String, UInt16>> addresses; /// Failover replicas.
};


using EngineArgs = std::vector<std::pair<String, DB::Field>>;

/* If storage engine's configuration was define via named_collections,
 * return all options in ExternalDataSource::Configuration struct.
 *
 * Also check if engine arguemnts have key-value defined configuration options:
 * ENGINE = PostgreSQL(postgresql_configuration, database = 'postgres_database');
 * In this case they will override values defined in config.
 *
 * If there are key-value arguments apart from common: `host`, `port`, `username`, `password`, `database`,
 * i.e. storage-specific arguments, then return them back in a set: ExternalDataSource::EngineArgs.
 */
std::tuple<ExternalDataSourceConfiguration, EngineArgs, bool>
tryGetConfigurationAsNamedCollection(ASTs args, ContextPtr context, bool is_database_engine = false);

ExternalDataSourcesConfigurationByPriority
tryGetConfigurationsByPriorityAsNamedCollection(const Poco::Util::AbstractConfiguration & dict_config, const String & dict_config_prefix, ContextPtr context);

}