sqlglot.optimizer.eliminate_subqueries

  1import itertools
  2
  3from sqlglot import expressions as exp
  4from sqlglot.helper import find_new_name
  5from sqlglot.optimizer.scope import build_scope
  6
  7
  8def eliminate_subqueries(expression):
  9    """
 10    Rewrite derived tables as CTES, deduplicating if possible.
 11
 12    Example:
 13        >>> import sqlglot
 14        >>> expression = sqlglot.parse_one("SELECT a FROM (SELECT * FROM x) AS y")
 15        >>> eliminate_subqueries(expression).sql()
 16        'WITH y AS (SELECT * FROM x) SELECT a FROM y AS y'
 17
 18    This also deduplicates common subqueries:
 19        >>> expression = sqlglot.parse_one("SELECT a FROM (SELECT * FROM x) AS y CROSS JOIN (SELECT * FROM x) AS z")
 20        >>> eliminate_subqueries(expression).sql()
 21        'WITH y AS (SELECT * FROM x) SELECT a FROM y AS y CROSS JOIN y AS z'
 22
 23    Args:
 24        expression (sqlglot.Expression): expression
 25    Returns:
 26        sqlglot.Expression: expression
 27    """
 28    if isinstance(expression, exp.Subquery):
 29        # It's possible to have subqueries at the root, e.g. (SELECT * FROM x) LIMIT 1
 30        eliminate_subqueries(expression.this)
 31        return expression
 32
 33    root = build_scope(expression)
 34
 35    if not root:
 36        return expression
 37
 38    # Map of alias->Scope|Table
 39    # These are all aliases that are already used in the expression.
 40    # We don't want to create new CTEs that conflict with these names.
 41    taken = {}
 42
 43    # All CTE aliases in the root scope are taken
 44    for scope in root.cte_scopes:
 45        taken[scope.expression.parent.alias] = scope
 46
 47    # All table names are taken
 48    for scope in root.traverse():
 49        taken.update(
 50            {
 51                source.name: source
 52                for _, source in scope.sources.items()
 53                if isinstance(source, exp.Table)
 54            }
 55        )
 56
 57    # Map of Expression->alias
 58    # Existing CTES in the root expression. We'll use this for deduplication.
 59    existing_ctes = {}
 60
 61    with_ = root.expression.args.get("with")
 62    recursive = False
 63    if with_:
 64        recursive = with_.args.get("recursive")
 65        for cte in with_.expressions:
 66            existing_ctes[cte.this] = cte.alias
 67    new_ctes = []
 68
 69    # We're adding more CTEs, but we want to maintain the DAG order.
 70    # Derived tables within an existing CTE need to come before the existing CTE.
 71    for cte_scope in root.cte_scopes:
 72        # Append all the new CTEs from this existing CTE
 73        for scope in cte_scope.traverse():
 74            if scope is cte_scope:
 75                # Don't try to eliminate this CTE itself
 76                continue
 77            new_cte = _eliminate(scope, existing_ctes, taken)
 78            if new_cte:
 79                new_ctes.append(new_cte)
 80
 81        # Append the existing CTE itself
 82        new_ctes.append(cte_scope.expression.parent)
 83
 84    # Now append the rest
 85    for scope in itertools.chain(root.union_scopes, root.subquery_scopes, root.table_scopes):
 86        for child_scope in scope.traverse():
 87            new_cte = _eliminate(child_scope, existing_ctes, taken)
 88            if new_cte:
 89                new_ctes.append(new_cte)
 90
 91    if new_ctes:
 92        expression.set("with", exp.With(expressions=new_ctes, recursive=recursive))
 93
 94    return expression
 95
 96
 97def _eliminate(scope, existing_ctes, taken):
 98    if scope.is_derived_table:
 99        return _eliminate_derived_table(scope, existing_ctes, taken)
100
101    if scope.is_cte:
102        return _eliminate_cte(scope, existing_ctes, taken)
103
104
105def _eliminate_derived_table(scope, existing_ctes, taken):
106    # This makes sure that we don't:
107    # - drop the "pivot" arg from a pivoted subquery
108    # - eliminate a lateral correlated subquery
109    if scope.parent.pivots or isinstance(scope.parent.expression, exp.Lateral):
110        return None
111
112    # Get rid of redundant exp.Subquery expressions, i.e. those that are just used as wrappers
113    to_replace = scope.expression.parent.unwrap()
114    name, cte = _new_cte(scope, existing_ctes, taken)
115    table = exp.alias_(exp.table_(name), alias=to_replace.alias or name)
116    table.set("joins", to_replace.args.get("joins"))
117
118    to_replace.replace(table)
119
120    return cte
121
122
123def _eliminate_cte(scope, existing_ctes, taken):
124    parent = scope.expression.parent
125    name, cte = _new_cte(scope, existing_ctes, taken)
126
127    with_ = parent.parent
128    parent.pop()
129    if not with_.expressions:
130        with_.pop()
131
132    # Rename references to this CTE
133    for child_scope in scope.parent.traverse():
134        for table, source in child_scope.selected_sources.values():
135            if source is scope:
136                new_table = exp.alias_(exp.table_(name), alias=table.alias_or_name, copy=False)
137                table.replace(new_table)
138
139    return cte
140
141
142def _new_cte(scope, existing_ctes, taken):
143    """
144    Returns:
145        tuple of (name, cte)
146        where `name` is a new name for this CTE in the root scope and `cte` is a new CTE instance.
147        If this CTE duplicates an existing CTE, `cte` will be None.
148    """
149    duplicate_cte_alias = existing_ctes.get(scope.expression)
150    parent = scope.expression.parent
151    name = parent.alias
152
153    if not name:
154        name = find_new_name(taken=taken, base="cte")
155
156    if duplicate_cte_alias:
157        name = duplicate_cte_alias
158    elif taken.get(name):
159        name = find_new_name(taken=taken, base=name)
160
161    taken[name] = scope
162
163    if not duplicate_cte_alias:
164        existing_ctes[scope.expression] = name
165        cte = exp.CTE(
166            this=scope.expression,
167            alias=exp.TableAlias(this=exp.to_identifier(name)),
168        )
169    else:
170        cte = None
171    return name, cte