ClickHouse/dbms/src/Interpreters/SyntaxAnalyzer.h

#pragma once

#include <Interpreters/AnalyzedJoin.h>

namespace DB
{

class IStorage;
using StoragePtr = std::shared_ptr<IStorage>;

struct SyntaxAnalyzerResult
{
    ASTPtr query;

    StoragePtr storage;

    NamesAndTypesList source_columns;

    /// Note: used only in tests.
    using Aliases = std::unordered_map<String, ASTPtr>;
    Aliases aliases;

    /// Which column is needed to be ARRAY-JOIN'ed to get the specified.
    /// For example, for `SELECT s.v ... ARRAY JOIN a AS s` will get "s.v" -> "a.v".
    NameToNameMap array_join_result_to_source;

    /// For the ARRAY JOIN section, mapping from the alias to the full column name.
    /// For example, for `ARRAY JOIN [1,2] AS b` "b" -> "array(1,2)" will enter here.
    NameToNameMap array_join_alias_to_name;

    /// The backward mapping for array_join_alias_to_name.
    NameToNameMap array_join_name_to_alias;

    AnalyzedJoin analyzed_join;

    /// Predicate optimizer overrides the sub queries
    bool rewrite_subqueries = false;
};

class SyntaxAnalyzer
{
public:
    SyntaxAnalyzerResult analyze(const ASTPtr & query,
                                 const Context & context,
                                 const StoragePtr & storage,
                                 NamesAndTypesList source_columns,
                                 const Names & required_result_columns = {},
                                 size_t subquery_depth = 0) const;
};

}