2014-01-28 16:45:10 +00:00
|
|
|
#pragma once
|
|
|
|
|
2019-03-11 14:01:45 +00:00
|
|
|
#include <Parsers/IAST_fwd.h>
|
2019-05-17 14:34:25 +00:00
|
|
|
#include <Storages/IStorage_fwd.h>
|
2020-10-14 12:19:29 +00:00
|
|
|
#include <Storages/ColumnsDescription.h>
|
2022-03-17 13:14:57 +00:00
|
|
|
#include <Access/Common/AccessType.h>
|
2019-03-11 14:01:45 +00:00
|
|
|
|
2017-01-21 04:24:28 +00:00
|
|
|
#include <memory>
|
2019-05-17 14:34:25 +00:00
|
|
|
#include <string>
|
2014-01-28 16:45:10 +00:00
|
|
|
|
2019-03-11 14:01:45 +00:00
|
|
|
|
2014-01-28 16:45:10 +00:00
|
|
|
namespace DB
|
|
|
|
{
|
|
|
|
|
2017-01-21 04:24:28 +00:00
|
|
|
class Context;
|
|
|
|
|
2017-04-16 15:00:33 +00:00
|
|
|
/** Interface for table functions.
|
2014-01-28 16:45:10 +00:00
|
|
|
*
|
2017-04-16 15:00:33 +00:00
|
|
|
* Table functions are not relevant to other functions.
|
|
|
|
* The table function can be specified in the FROM section instead of the [db.]Table
|
|
|
|
* The table function returns a temporary StoragePtr object that is used to execute the query.
|
2014-01-28 16:45:10 +00:00
|
|
|
*
|
2017-04-16 15:00:33 +00:00
|
|
|
* Example:
|
2014-01-28 16:45:10 +00:00
|
|
|
* SELECT count() FROM remote('example01-01-1', merge, hits)
|
2017-04-16 15:00:33 +00:00
|
|
|
* - go to `example01-01-1`, in `merge` database, `hits` table.
|
2020-10-14 12:19:29 +00:00
|
|
|
*
|
|
|
|
*
|
|
|
|
* When creating table AS table_function(...) we probably don't know structure of the table
|
|
|
|
* and have to request if from remote server, because structure is required to create a Storage.
|
|
|
|
* To avoid failures on server startup, we write obtained structure to metadata file.
|
|
|
|
* So, table function may have two different columns lists:
|
|
|
|
* - cached_columns written to metadata
|
|
|
|
* - the list returned from getActualTableStructure(...)
|
|
|
|
* See StorageTableFunctionProxy.
|
2014-01-28 16:45:10 +00:00
|
|
|
*/
|
|
|
|
|
2020-10-14 12:19:29 +00:00
|
|
|
class ITableFunction : public std::enable_shared_from_this<ITableFunction>
|
2014-01-28 16:45:10 +00:00
|
|
|
{
|
|
|
|
public:
|
2019-07-09 15:40:21 +00:00
|
|
|
static inline std::string getDatabaseName() { return "_table_function"; }
|
|
|
|
|
2017-04-16 15:00:33 +00:00
|
|
|
/// Get the main function name.
|
2017-04-01 07:20:54 +00:00
|
|
|
virtual std::string getName() const = 0;
|
2014-01-28 16:45:10 +00:00
|
|
|
|
2020-10-14 12:19:29 +00:00
|
|
|
/// Returns true if we always know table structure when executing table function
|
|
|
|
/// (e.g. structure is specified in table function arguments)
|
|
|
|
virtual bool hasStaticStructure() const { return false; }
|
|
|
|
/// Returns false if storage returned by table function supports type conversion (e.g. StorageDistributed)
|
|
|
|
virtual bool needStructureConversion() const { return true; }
|
|
|
|
|
2021-04-10 23:33:54 +00:00
|
|
|
virtual void parseArguments(const ASTPtr & /*ast_function*/, ContextPtr /*context*/) {}
|
2020-10-14 12:19:29 +00:00
|
|
|
|
|
|
|
/// Returns actual table structure probably requested from remote server, may fail
|
2021-04-10 23:33:54 +00:00
|
|
|
virtual ColumnsDescription getActualTableStructure(ContextPtr /*context*/) const = 0;
|
2020-10-14 12:19:29 +00:00
|
|
|
|
2022-02-18 16:19:42 +00:00
|
|
|
/// Check if table function needs a structure hint from SELECT query in case of
|
|
|
|
/// INSERT INTO FUNCTION ... SELECT ...
|
|
|
|
/// It's used for schema inference.
|
|
|
|
virtual bool needStructureHint() const { return false; }
|
|
|
|
|
|
|
|
/// Set a structure hint from SELECT query in case of
|
|
|
|
/// INSERT INTO FUNCTION ... SELECT ...
|
|
|
|
/// This hint could be used not to repeat schema in function arguments.
|
|
|
|
virtual void setStructureHint(const ColumnsDescription &) {}
|
|
|
|
|
2018-03-02 05:03:28 +00:00
|
|
|
/// Create storage according to the query.
|
2021-04-10 23:33:54 +00:00
|
|
|
StoragePtr
|
2021-12-15 11:30:57 +00:00
|
|
|
execute(const ASTPtr & ast_function, ContextPtr context, const std::string & table_name, ColumnsDescription cached_columns_ = {}, bool use_global_context = false) const;
|
2014-02-23 00:37:25 +00:00
|
|
|
|
2021-03-19 12:47:27 +00:00
|
|
|
virtual ~ITableFunction() = default;
|
2018-03-02 05:03:28 +00:00
|
|
|
|
|
|
|
private:
|
2021-04-10 23:33:54 +00:00
|
|
|
virtual StoragePtr executeImpl(
|
|
|
|
const ASTPtr & ast_function, ContextPtr context, const std::string & table_name, ColumnsDescription cached_columns) const = 0;
|
2022-03-17 13:14:57 +00:00
|
|
|
|
2020-04-06 05:19:40 +00:00
|
|
|
virtual const char * getStorageTypeName() const = 0;
|
2022-03-24 03:32:35 +00:00
|
|
|
|
2022-03-17 13:14:57 +00:00
|
|
|
virtual AccessType getSourceAccessType() const;
|
2014-01-28 16:45:10 +00:00
|
|
|
};
|
|
|
|
|
2016-05-28 10:15:36 +00:00
|
|
|
using TableFunctionPtr = std::shared_ptr<ITableFunction>;
|
2014-01-28 16:45:10 +00:00
|
|
|
|
|
|
|
|
|
|
|
}
|