ClickHouse/dbms/src/TableFunctions/TableFunctionRemote.h

#pragma once

#include <TableFunctions/ITableFunction.h>


namespace DB
{

/* remote ('address', db, table) - creates a temporary StorageDistributed.
 * To get the table structure, a DESC TABLE request is made to the remote server.
 * For example
 * SELECT count() FROM remote('example01-01-1', merge, hits) - go to `example01-01-1`, in the merge database, the hits table.
 * An expression that generates a set of shards and replicas can also be specified as the host name - see below.
 * Also, there is a cluster version of the function: cluster('existing_cluster_name', 'db', 'table')
 */
class TableFunctionRemote : public ITableFunction
{
public:

    explicit TableFunctionRemote(const std::string & name_ = "remote");

    std::string getName() const override { return name; }

    StoragePtr execute(const ASTPtr & ast_function, const Context & context) const override;

private:

    std::string name;
    bool is_cluster_function;
    std::string help_message;
};

}