sqlglot.optimizer.qualify

  1from __future__ import annotations
  2
  3import typing as t
  4
  5from sqlglot import exp
  6from sqlglot.dialects.dialect import Dialect, DialectType
  7from sqlglot.optimizer.isolate_table_selects import isolate_table_selects
  8from sqlglot.optimizer.normalize_identifiers import normalize_identifiers
  9from sqlglot.optimizer.qualify_columns import (
 10    pushdown_cte_alias_columns as pushdown_cte_alias_columns_func,
 11    qualify_columns as qualify_columns_func,
 12    quote_identifiers as quote_identifiers_func,
 13    validate_qualify_columns as validate_qualify_columns_func,
 14)
 15from sqlglot.optimizer.qualify_tables import qualify_tables
 16from sqlglot.schema import Schema, ensure_schema
 17
 18
 19def qualify(
 20    expression: exp.Expression,
 21    dialect: DialectType = None,
 22    db: t.Optional[str] = None,
 23    catalog: t.Optional[str] = None,
 24    schema: t.Optional[dict | Schema] = None,
 25    expand_alias_refs: bool = True,
 26    expand_stars: bool = True,
 27    infer_schema: t.Optional[bool] = None,
 28    isolate_tables: bool = False,
 29    qualify_columns: bool = True,
 30    allow_partial_qualification: bool = False,
 31    validate_qualify_columns: bool = True,
 32    quote_identifiers: bool = True,
 33    identify: bool = True,
 34    infer_csv_schemas: bool = False,
 35) -> exp.Expression:
 36    """
 37    Rewrite sqlglot AST to have normalized and qualified tables and columns.
 38
 39    This step is necessary for all further SQLGlot optimizations.
 40
 41    Example:
 42        >>> import sqlglot
 43        >>> schema = {"tbl": {"col": "INT"}}
 44        >>> expression = sqlglot.parse_one("SELECT col FROM tbl")
 45        >>> qualify(expression, schema=schema).sql()
 46        'SELECT "tbl"."col" AS "col" FROM "tbl" AS "tbl"'
 47
 48    Args:
 49        expression: Expression to qualify.
 50        db: Default database name for tables.
 51        catalog: Default catalog name for tables.
 52        schema: Schema to infer column names and types.
 53        expand_alias_refs: Whether to expand references to aliases.
 54        expand_stars: Whether to expand star queries. This is a necessary step
 55            for most of the optimizer's rules to work; do not set to False unless you
 56            know what you're doing!
 57        infer_schema: Whether to infer the schema if missing.
 58        isolate_tables: Whether to isolate table selects.
 59        qualify_columns: Whether to qualify columns.
 60        allow_partial_qualification: Whether to allow partial qualification.
 61        validate_qualify_columns: Whether to validate columns.
 62        quote_identifiers: Whether to run the quote_identifiers step.
 63            This step is necessary to ensure correctness for case sensitive queries.
 64            But this flag is provided in case this step is performed at a later time.
 65        identify: If True, quote all identifiers, else only necessary ones.
 66        infer_csv_schemas: Whether to scan READ_CSV calls in order to infer the CSVs' schemas.
 67
 68    Returns:
 69        The qualified expression.
 70    """
 71    schema = ensure_schema(schema, dialect=dialect)
 72    expression = normalize_identifiers(expression, dialect=dialect)
 73    expression = qualify_tables(
 74        expression,
 75        db=db,
 76        catalog=catalog,
 77        schema=schema,
 78        dialect=dialect,
 79        infer_csv_schemas=infer_csv_schemas,
 80    )
 81
 82    if isolate_tables:
 83        expression = isolate_table_selects(expression, schema=schema)
 84
 85    if Dialect.get_or_raise(dialect).PREFER_CTE_ALIAS_COLUMN:
 86        expression = pushdown_cte_alias_columns_func(expression)
 87
 88    if qualify_columns:
 89        expression = qualify_columns_func(
 90            expression,
 91            schema,
 92            expand_alias_refs=expand_alias_refs,
 93            expand_stars=expand_stars,
 94            infer_schema=infer_schema,
 95            allow_partial_qualification=allow_partial_qualification,
 96        )
 97
 98    if quote_identifiers:
 99        expression = quote_identifiers_func(expression, dialect=dialect, identify=identify)
100
101    if validate_qualify_columns:
102        validate_qualify_columns_func(expression)
103
104    return expression