mz_sql_parser/ast/defs/

statement.rs

// Copyright 2018 sqlparser-rs contributors. All rights reserved.
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// This file is derived from the sqlparser-rs project, available at
// https://github.com/andygrove/sqlparser-rs. It was incorporated
// directly into Materialize on December 21, 2019.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License in the LICENSE file at the
// root of this repository, or online at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::collections::BTreeMap;
use std::fmt;

use enum_kinds::EnumKind;
use serde::{Deserialize, Serialize};
use smallvec::{SmallVec, smallvec};

use crate::ast::display::{self, AstDisplay, AstFormatter, WithOptionName};
use crate::ast::{
    AstInfo, ColumnDef, ConnectionOption, ConnectionOptionName, CreateConnectionOption,
    CreateConnectionType, CreateSinkConnection, CreateSourceConnection, CreateSourceOption,
    CreateSourceOptionName, DeferredItemName, Expr, Format, FormatSpecifier, IcebergSinkMode,
    Ident, IntervalValue, KeyConstraint, MaterializedViewOption, Query, SelectItem, SinkEnvelope,
    SourceEnvelope, SourceIncludeMetadata, SubscribeOutput, TableAlias, TableConstraint,
    TableWithJoins, UnresolvedDatabaseName, UnresolvedItemName, UnresolvedObjectName,
    UnresolvedSchemaName, Value,
};

/// A top-level statement (SELECT, INSERT, CREATE, etc.)
#[allow(clippy::large_enum_variant)]
#[derive(Debug, Clone, PartialEq, Eq, Hash, EnumKind)]
#[enum_kind(StatementKind, derive(Serialize, Deserialize))]
pub enum Statement<T: AstInfo> {
    Select(SelectStatement<T>),
    Insert(InsertStatement<T>),
    Copy(CopyStatement<T>),
    Update(UpdateStatement<T>),
    Delete(DeleteStatement<T>),
    CreateConnection(CreateConnectionStatement<T>),
    CreateDatabase(CreateDatabaseStatement),
    CreateSchema(CreateSchemaStatement),
    CreateWebhookSource(CreateWebhookSourceStatement<T>),
    CreateSource(CreateSourceStatement<T>),
    CreateSubsource(CreateSubsourceStatement<T>),
    CreateSink(CreateSinkStatement<T>),
    CreateMetricSink(CreateMetricSinkStatement<T>),
    CreateView(CreateViewStatement<T>),
    CreateMaterializedView(CreateMaterializedViewStatement<T>),
    CreateTable(CreateTableStatement<T>),
    CreateTableFromSource(CreateTableFromSourceStatement<T>),
    CreateIndex(CreateIndexStatement<T>),
    CreateType(CreateTypeStatement<T>),
    CreateRole(CreateRoleStatement),
    CreateCluster(CreateClusterStatement<T>),
    CreateClusterReplica(CreateClusterReplicaStatement<T>),
    CreateSecret(CreateSecretStatement<T>),
    CreateNetworkPolicy(CreateNetworkPolicyStatement<T>),
    AlterCluster(AlterClusterStatement<T>),
    AlterOwner(AlterOwnerStatement<T>),
    AlterObjectRename(AlterObjectRenameStatement),
    AlterObjectSwap(AlterObjectSwapStatement),
    AlterRetainHistory(AlterRetainHistoryStatement<T>),
    AlterIndex(AlterIndexStatement<T>),
    AlterSecret(AlterSecretStatement<T>),
    AlterSetCluster(AlterSetClusterStatement<T>),
    AlterSink(AlterSinkStatement<T>),
    AlterSource(AlterSourceStatement<T>),
    AlterSystemSet(AlterSystemSetStatement),
    AlterSystemReset(AlterSystemResetStatement),
    AlterSystemResetAll(AlterSystemResetAllStatement),
    AlterConnection(AlterConnectionStatement<T>),
    AlterNetworkPolicy(AlterNetworkPolicyStatement<T>),
    AlterRole(AlterRoleStatement<T>),
    AlterTableAddColumn(AlterTableAddColumnStatement<T>),
    AlterMaterializedViewApplyReplacement(AlterMaterializedViewApplyReplacementStatement),
    Discard(DiscardStatement),
    DropObjects(DropObjectsStatement),
    DropOwned(DropOwnedStatement<T>),
    SetVariable(SetVariableStatement),
    ResetVariable(ResetVariableStatement),
    Show(ShowStatement<T>),
    StartTransaction(StartTransactionStatement),
    SetTransaction(SetTransactionStatement),
    Commit(CommitStatement),
    Rollback(RollbackStatement),
    Subscribe(SubscribeStatement<T>),
    ExplainPlan(ExplainPlanStatement<T>),
    ExplainPushdown(ExplainPushdownStatement<T>),
    ExplainTimestamp(ExplainTimestampStatement<T>),
    ExplainSinkSchema(ExplainSinkSchemaStatement<T>),
    ExplainAnalyzeObject(ExplainAnalyzeObjectStatement<T>),
    ExplainAnalyzeCluster(ExplainAnalyzeClusterStatement),
    Declare(DeclareStatement<T>),
    Fetch(FetchStatement<T>),
    Close(CloseStatement),
    Prepare(PrepareStatement<T>),
    Execute(ExecuteStatement<T>),
    ExecuteUnitTest(ExecuteUnitTestStatement<T>),
    Deallocate(DeallocateStatement),
    Raise(RaiseStatement),
    GrantRole(GrantRoleStatement<T>),
    RevokeRole(RevokeRoleStatement<T>),
    GrantPrivileges(GrantPrivilegesStatement<T>),
    RevokePrivileges(RevokePrivilegesStatement<T>),
    AlterDefaultPrivileges(AlterDefaultPrivilegesStatement<T>),
    ReassignOwned(ReassignOwnedStatement<T>),
    ValidateConnection(ValidateConnectionStatement<T>),
    Comment(CommentStatement<T>),
}

impl<T: AstInfo> AstDisplay for Statement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            Statement::Select(stmt) => f.write_node(stmt),
            Statement::Insert(stmt) => f.write_node(stmt),
            Statement::Copy(stmt) => f.write_node(stmt),
            Statement::Update(stmt) => f.write_node(stmt),
            Statement::Delete(stmt) => f.write_node(stmt),
            Statement::CreateConnection(stmt) => f.write_node(stmt),
            Statement::CreateDatabase(stmt) => f.write_node(stmt),
            Statement::CreateSchema(stmt) => f.write_node(stmt),
            Statement::CreateWebhookSource(stmt) => f.write_node(stmt),
            Statement::CreateSource(stmt) => f.write_node(stmt),
            Statement::CreateSubsource(stmt) => f.write_node(stmt),
            Statement::CreateSink(stmt) => f.write_node(stmt),
            Statement::CreateMetricSink(stmt) => f.write_node(stmt),
            Statement::CreateView(stmt) => f.write_node(stmt),
            Statement::CreateMaterializedView(stmt) => f.write_node(stmt),
            Statement::CreateTable(stmt) => f.write_node(stmt),
            Statement::CreateTableFromSource(stmt) => f.write_node(stmt),
            Statement::CreateIndex(stmt) => f.write_node(stmt),
            Statement::CreateRole(stmt) => f.write_node(stmt),
            Statement::CreateSecret(stmt) => f.write_node(stmt),
            Statement::CreateType(stmt) => f.write_node(stmt),
            Statement::CreateCluster(stmt) => f.write_node(stmt),
            Statement::CreateClusterReplica(stmt) => f.write_node(stmt),
            Statement::CreateNetworkPolicy(stmt) => f.write_node(stmt),
            Statement::AlterCluster(stmt) => f.write_node(stmt),
            Statement::AlterNetworkPolicy(stmt) => f.write_node(stmt),
            Statement::AlterOwner(stmt) => f.write_node(stmt),
            Statement::AlterObjectRename(stmt) => f.write_node(stmt),
            Statement::AlterRetainHistory(stmt) => f.write_node(stmt),
            Statement::AlterObjectSwap(stmt) => f.write_node(stmt),
            Statement::AlterIndex(stmt) => f.write_node(stmt),
            Statement::AlterSetCluster(stmt) => f.write_node(stmt),
            Statement::AlterSecret(stmt) => f.write_node(stmt),
            Statement::AlterSink(stmt) => f.write_node(stmt),
            Statement::AlterSource(stmt) => f.write_node(stmt),
            Statement::AlterSystemSet(stmt) => f.write_node(stmt),
            Statement::AlterSystemReset(stmt) => f.write_node(stmt),
            Statement::AlterSystemResetAll(stmt) => f.write_node(stmt),
            Statement::AlterConnection(stmt) => f.write_node(stmt),
            Statement::AlterRole(stmt) => f.write_node(stmt),
            Statement::AlterTableAddColumn(stmt) => f.write_node(stmt),
            Statement::AlterMaterializedViewApplyReplacement(stmt) => f.write_node(stmt),
            Statement::Discard(stmt) => f.write_node(stmt),
            Statement::DropObjects(stmt) => f.write_node(stmt),
            Statement::DropOwned(stmt) => f.write_node(stmt),
            Statement::SetVariable(stmt) => f.write_node(stmt),
            Statement::ResetVariable(stmt) => f.write_node(stmt),
            Statement::Show(stmt) => f.write_node(stmt),
            Statement::StartTransaction(stmt) => f.write_node(stmt),
            Statement::SetTransaction(stmt) => f.write_node(stmt),
            Statement::Commit(stmt) => f.write_node(stmt),
            Statement::Rollback(stmt) => f.write_node(stmt),
            Statement::Subscribe(stmt) => f.write_node(stmt),
            Statement::ExplainPlan(stmt) => f.write_node(stmt),
            Statement::ExplainPushdown(stmt) => f.write_node(stmt),
            Statement::ExplainAnalyzeObject(stmt) => f.write_node(stmt),
            Statement::ExplainAnalyzeCluster(stmt) => f.write_node(stmt),
            Statement::ExplainTimestamp(stmt) => f.write_node(stmt),
            Statement::ExplainSinkSchema(stmt) => f.write_node(stmt),
            Statement::Declare(stmt) => f.write_node(stmt),
            Statement::Close(stmt) => f.write_node(stmt),
            Statement::Fetch(stmt) => f.write_node(stmt),
            Statement::Prepare(stmt) => f.write_node(stmt),
            Statement::Execute(stmt) => f.write_node(stmt),
            Statement::ExecuteUnitTest(stmt) => f.write_node(stmt),
            Statement::Deallocate(stmt) => f.write_node(stmt),
            Statement::Raise(stmt) => f.write_node(stmt),
            Statement::GrantRole(stmt) => f.write_node(stmt),
            Statement::RevokeRole(stmt) => f.write_node(stmt),
            Statement::GrantPrivileges(stmt) => f.write_node(stmt),
            Statement::RevokePrivileges(stmt) => f.write_node(stmt),
            Statement::AlterDefaultPrivileges(stmt) => f.write_node(stmt),
            Statement::ReassignOwned(stmt) => f.write_node(stmt),
            Statement::ValidateConnection(stmt) => f.write_node(stmt),
            Statement::Comment(stmt) => f.write_node(stmt),
        }
    }
}
impl_display_t!(Statement);

impl StatementKind {
    /// Whether this statement explains a query or catalog object.
    pub fn is_explain(&self) -> bool {
        match self {
            Self::ExplainPlan
            | Self::ExplainPushdown
            | Self::ExplainTimestamp
            | Self::ExplainSinkSchema
            | Self::ExplainAnalyzeObject
            | Self::ExplainAnalyzeCluster => true,
            Self::Select
            | Self::Insert
            | Self::Copy
            | Self::Update
            | Self::Delete
            | Self::CreateConnection
            | Self::CreateDatabase
            | Self::CreateSchema
            | Self::CreateWebhookSource
            | Self::CreateSource
            | Self::CreateSubsource
            | Self::CreateSink
            | Self::CreateMetricSink
            | Self::CreateView
            | Self::CreateMaterializedView
            | Self::CreateTable
            | Self::CreateTableFromSource
            | Self::CreateIndex
            | Self::CreateType
            | Self::CreateRole
            | Self::CreateCluster
            | Self::CreateClusterReplica
            | Self::CreateSecret
            | Self::CreateNetworkPolicy
            | Self::AlterCluster
            | Self::AlterOwner
            | Self::AlterObjectRename
            | Self::AlterObjectSwap
            | Self::AlterRetainHistory
            | Self::AlterIndex
            | Self::AlterSecret
            | Self::AlterSetCluster
            | Self::AlterSink
            | Self::AlterSource
            | Self::AlterSystemSet
            | Self::AlterSystemReset
            | Self::AlterSystemResetAll
            | Self::AlterConnection
            | Self::AlterNetworkPolicy
            | Self::AlterRole
            | Self::AlterTableAddColumn
            | Self::AlterMaterializedViewApplyReplacement
            | Self::Discard
            | Self::DropObjects
            | Self::DropOwned
            | Self::SetVariable
            | Self::ResetVariable
            | Self::Show
            | Self::StartTransaction
            | Self::SetTransaction
            | Self::Commit
            | Self::Rollback
            | Self::Subscribe
            | Self::Declare
            | Self::Fetch
            | Self::Close
            | Self::Prepare
            | Self::Execute
            | Self::ExecuteUnitTest
            | Self::Deallocate
            | Self::Raise
            | Self::GrantRole
            | Self::RevokeRole
            | Self::GrantPrivileges
            | Self::RevokePrivileges
            | Self::AlterDefaultPrivileges
            | Self::ReassignOwned
            | Self::ValidateConnection
            | Self::Comment => false,
        }
    }

    /// Whether this kind of statement can carry secret values, i.e. `CREATE
    /// SECRET` or `ALTER SECRET`. Such secret material must never be persisted
    /// verbatim (e.g. in `mz_statement_execution_history`), not even in error
    /// messages.
    pub fn is_secret(&self) -> bool {
        matches!(
            self,
            StatementKind::CreateSecret | StatementKind::AlterSecret
        )
    }

    /// Whether this kind of statement can carry sensitive material that we
    /// redact from logged SQL text (and error messages): secret values, or
    /// bulk/PII user data in `INSERT`/`UPDATE`/`EXECUTE`. A superset of
    /// [`Self::is_secret`].
    pub fn is_sensitive(&self) -> bool {
        self.is_secret()
            || matches!(
                self,
                StatementKind::Insert | StatementKind::Update | StatementKind::Execute
            )
    }
}

/// A static str for each statement kind
pub fn statement_kind_label_value(kind: StatementKind) -> &'static str {
    match kind {
        StatementKind::Select => "select",
        StatementKind::Insert => "insert",
        StatementKind::Copy => "copy",
        StatementKind::Update => "update",
        StatementKind::Delete => "delete",
        StatementKind::CreateConnection => "create_connection",
        StatementKind::CreateDatabase => "create_database",
        StatementKind::CreateSchema => "create_schema",
        StatementKind::CreateWebhookSource => "create_webhook",
        StatementKind::CreateSource => "create_source",
        StatementKind::CreateSubsource => "create_subsource",
        StatementKind::CreateSink => "create_sink",
        StatementKind::CreateMetricSink => "create_metric_sink",
        StatementKind::CreateView => "create_view",
        StatementKind::CreateMaterializedView => "create_materialized_view",
        StatementKind::CreateTable => "create_table",
        StatementKind::CreateTableFromSource => "create_table_from_source",
        StatementKind::CreateIndex => "create_index",
        StatementKind::CreateType => "create_type",
        StatementKind::CreateRole => "create_role",
        StatementKind::CreateCluster => "create_cluster",
        StatementKind::CreateClusterReplica => "create_cluster_replica",
        StatementKind::CreateSecret => "create_secret",
        StatementKind::CreateNetworkPolicy => "create_network_policy",
        StatementKind::AlterCluster => "alter_cluster",
        StatementKind::AlterObjectRename => "alter_object_rename",
        StatementKind::AlterRetainHistory => "alter_retain_history",
        StatementKind::AlterObjectSwap => "alter_object_swap",
        StatementKind::AlterIndex => "alter_index",
        StatementKind::AlterNetworkPolicy => "alter_network_policy",
        StatementKind::AlterRole => "alter_role",
        StatementKind::AlterSecret => "alter_secret",
        StatementKind::AlterSetCluster => "alter_set_cluster",
        StatementKind::AlterSink => "alter_sink",
        StatementKind::AlterSource => "alter_source",
        StatementKind::AlterSystemSet => "alter_system_set",
        StatementKind::AlterSystemReset => "alter_system_reset",
        StatementKind::AlterSystemResetAll => "alter_system_reset_all",
        StatementKind::AlterOwner => "alter_owner",
        StatementKind::AlterConnection => "alter_connection",
        StatementKind::AlterTableAddColumn => "alter_table",
        StatementKind::AlterMaterializedViewApplyReplacement => {
            "alter_materialized_view_apply_replacement"
        }
        StatementKind::Discard => "discard",
        StatementKind::DropObjects => "drop_objects",
        StatementKind::DropOwned => "drop_owned",
        StatementKind::SetVariable => "set_variable",
        StatementKind::ResetVariable => "reset_variable",
        StatementKind::Show => "show",
        StatementKind::StartTransaction => "start_transaction",
        StatementKind::SetTransaction => "set_transaction",
        StatementKind::Commit => "commit",
        StatementKind::Rollback => "rollback",
        StatementKind::Subscribe => "subscribe",
        StatementKind::ExplainPlan => "explain_plan",
        StatementKind::ExplainPushdown => "explain_pushdown",
        StatementKind::ExplainAnalyzeObject => "explain_analyze_object",
        StatementKind::ExplainAnalyzeCluster => "explain_analyze_cluster",
        StatementKind::ExplainTimestamp => "explain_timestamp",
        StatementKind::ExplainSinkSchema => "explain_sink_schema",
        StatementKind::Declare => "declare",
        StatementKind::Fetch => "fetch",
        StatementKind::Close => "close",
        StatementKind::Prepare => "prepare",
        StatementKind::Execute => "execute",
        StatementKind::ExecuteUnitTest => "execute_unit_test",
        StatementKind::Deallocate => "deallocate",
        StatementKind::Raise => "raise",
        StatementKind::GrantRole => "grant_role",
        StatementKind::RevokeRole => "revoke_role",
        StatementKind::GrantPrivileges => "grant_privileges",
        StatementKind::RevokePrivileges => "revoke_privileges",
        StatementKind::AlterDefaultPrivileges => "alter_default_privileges",
        StatementKind::ReassignOwned => "reassign_owned",
        StatementKind::ValidateConnection => "validate_connection",
        StatementKind::Comment => "comment",
    }
}

/// `SELECT`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct SelectStatement<T: AstInfo> {
    pub query: Query<T>,
    pub as_of: Option<AsOf<T>>,
}

impl<T: AstInfo> AstDisplay for SelectStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        // A query whose rendering begins with `SHOW` (a bare `SHOW` body, or a
        // set operation whose leftmost operand is one) only reparses as a query
        // when parenthesized: a top-level leading `SHOW` is dispatched as a
        // `Statement::Show`, which terminates and would reject a following set
        // operator or ORDER BY/LIMIT/OFFSET. The parser unwraps the redundant
        // outer parens (see `parse_query_tail`), so wrapping round-trips.
        let parenthesize_show = self.query.body.starts_with_show();
        if parenthesize_show {
            f.write_str("(");
        }
        f.write_node(&self.query);
        if parenthesize_show {
            f.write_str(")");
        }
        if let Some(as_of) = &self.as_of {
            f.write_str(" ");
            f.write_node(as_of);
        }
    }
}
impl_display_t!(SelectStatement);

/// `INSERT`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct InsertStatement<T: AstInfo> {
    /// TABLE
    pub table_name: T::ItemName,
    /// COLUMNS
    pub columns: Vec<Ident>,
    /// A SQL query that specifies what to insert.
    pub source: InsertSource<T>,
    /// RETURNING
    pub returning: Vec<SelectItem<T>>,
}

impl<T: AstInfo> AstDisplay for InsertStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("INSERT INTO ");
        f.write_node(&self.table_name);
        if !self.columns.is_empty() {
            f.write_str(" (");
            f.write_node(&display::comma_separated(&self.columns));
            f.write_str(")");
        }
        f.write_str(" ");
        f.write_node(&self.source);
        if !self.returning.is_empty() {
            f.write_str(" RETURNING ");
            f.write_node(&display::comma_separated(&self.returning));
        }
    }
}
impl_display_t!(InsertStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum CopyRelation<T: AstInfo> {
    Named {
        name: T::ItemName,
        columns: Vec<Ident>,
    },
    Select(SelectStatement<T>),
    Subscribe(SubscribeStatement<T>),
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum CopyDirection {
    To,
    From,
}

impl AstDisplay for CopyDirection {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str(match self {
            CopyDirection::To => "TO",
            CopyDirection::From => "FROM",
        })
    }
}
impl_display!(CopyDirection);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum CopyTarget<T: AstInfo> {
    Stdin,
    Stdout,
    Expr(Expr<T>),
}

impl<T: AstInfo> AstDisplay for CopyTarget<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            CopyTarget::Stdin => f.write_str("STDIN"),
            CopyTarget::Stdout => f.write_str("STDOUT"),
            CopyTarget::Expr(expr) => f.write_node(expr),
        }
    }
}
impl_display_t!(CopyTarget);

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum CopyOptionName {
    Format,
    Delimiter,
    Null,
    Escape,
    Quote,
    Header,
    AwsConnection,
    MaxFileSize,
    Files,
    Pattern,
}

impl AstDisplay for CopyOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str(match self {
            CopyOptionName::Format => "FORMAT",
            CopyOptionName::Delimiter => "DELIMITER",
            CopyOptionName::Null => "NULL",
            CopyOptionName::Escape => "ESCAPE",
            CopyOptionName::Quote => "QUOTE",
            CopyOptionName::Header => "HEADER",
            CopyOptionName::AwsConnection => "AWS CONNECTION",
            CopyOptionName::MaxFileSize => "MAX FILE SIZE",
            CopyOptionName::Files => "FILES",
            CopyOptionName::Pattern => "PATTERN",
        })
    }
}

impl WithOptionName for CopyOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            CopyOptionName::Format
            | CopyOptionName::Delimiter
            | CopyOptionName::Null
            | CopyOptionName::Escape
            | CopyOptionName::Quote
            | CopyOptionName::Header
            | CopyOptionName::AwsConnection
            | CopyOptionName::MaxFileSize => false,
            CopyOptionName::Files | CopyOptionName::Pattern => true,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct CopyOption<T: AstInfo> {
    pub name: CopyOptionName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(CopyOption);

/// `COPY`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CopyStatement<T: AstInfo> {
    /// RELATION
    pub relation: CopyRelation<T>,
    /// DIRECTION
    pub direction: CopyDirection,
    // TARGET
    pub target: CopyTarget<T>,
    // OPTIONS
    pub options: Vec<CopyOption<T>>,
}

impl<T: AstInfo> AstDisplay for CopyStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("COPY ");
        match &self.relation {
            CopyRelation::Named { name, columns } => {
                f.write_node(name);
                if !columns.is_empty() {
                    f.write_str("(");
                    f.write_node(&display::comma_separated(columns));
                    f.write_str(")");
                }
            }
            CopyRelation::Select(query) => {
                f.write_str("(");
                f.write_node(query);
                f.write_str(")");
            }
            CopyRelation::Subscribe(query) => {
                f.write_str("(");
                f.write_node(query);
                f.write_str(")");
            }
        };
        f.write_str(" ");
        f.write_node(&self.direction);
        f.write_str(" ");
        f.write_node(&self.target);
        if !self.options.is_empty() {
            f.write_str(" WITH (");
            f.write_node(&display::comma_separated(&self.options));
            f.write_str(")");
        }
    }
}
impl_display_t!(CopyStatement);

/// `UPDATE`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct UpdateStatement<T: AstInfo> {
    /// `FROM`
    pub table_name: T::ItemName,
    pub alias: Option<TableAlias>,
    /// Column assignments
    pub assignments: Vec<Assignment<T>>,
    /// WHERE
    pub selection: Option<Expr<T>>,
}

impl<T: AstInfo> AstDisplay for UpdateStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("UPDATE ");
        f.write_node(&self.table_name);
        if let Some(alias) = &self.alias {
            f.write_str(" AS ");
            f.write_node(alias);
        }
        if !self.assignments.is_empty() {
            f.write_str(" SET ");
            f.write_node(&display::comma_separated(&self.assignments));
        }
        if let Some(selection) = &self.selection {
            f.write_str(" WHERE ");
            f.write_node(selection);
        }
    }
}
impl_display_t!(UpdateStatement);

/// `DELETE`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct DeleteStatement<T: AstInfo> {
    /// `FROM`
    pub table_name: T::ItemName,
    /// `AS`
    pub alias: Option<TableAlias>,
    /// `USING`
    pub using: Vec<TableWithJoins<T>>,
    /// `WHERE`
    pub selection: Option<Expr<T>>,
}

impl<T: AstInfo> AstDisplay for DeleteStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("DELETE FROM ");
        f.write_node(&self.table_name);
        if let Some(alias) = &self.alias {
            f.write_str(" AS ");
            f.write_node(alias);
        }
        if !self.using.is_empty() {
            f.write_str(" USING ");
            f.write_node(&display::comma_separated(&self.using));
        }
        if let Some(selection) = &self.selection {
            f.write_str(" WHERE ");
            f.write_node(selection);
        }
    }
}
impl_display_t!(DeleteStatement);

/// `CREATE DATABASE`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateDatabaseStatement {
    pub name: UnresolvedDatabaseName,
    pub if_not_exists: bool,
}

impl AstDisplay for CreateDatabaseStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CREATE DATABASE ");
        if self.if_not_exists {
            f.write_str("IF NOT EXISTS ");
        }
        f.write_node(&self.name);
    }
}
impl_display!(CreateDatabaseStatement);

/// `CREATE SCHEMA`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateSchemaStatement {
    pub name: UnresolvedSchemaName,
    pub if_not_exists: bool,
}

impl AstDisplay for CreateSchemaStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CREATE SCHEMA ");
        if self.if_not_exists {
            f.write_str("IF NOT EXISTS ");
        }
        f.write_node(&self.name);
    }
}
impl_display!(CreateSchemaStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ConnectionDefaultAwsPrivatelink<T: AstInfo> {
    pub connection: T::ItemName,
    // TODO port should be switched to a vec of options similar to KafkaBrokerAwsPrivatelink if ever support more than port
    pub port: Option<u16>,
}

impl<T: AstInfo> AstDisplay for ConnectionDefaultAwsPrivatelink<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_node(&self.connection);
        if let Some(port) = self.port {
            f.write_str(" (PORT ");
            f.write_node(&display::escape_single_quote_string(&port.to_string()));
            f.write_str(")");
        }
    }
}
impl_display_t!(ConnectionDefaultAwsPrivatelink);

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
/// A MATCHING rule inside BROKERS (...) that routes brokers matching a pattern
/// through an AWS PrivateLink tunnel.
pub struct KafkaMatchingBrokerRule<T: AstInfo> {
    /// Given a broker's host:port, should we use this route?
    pub pattern: ConnectionRulePattern,
    /// Route to the broker through this PrivateLink connection.
    pub tunnel: KafkaBrokerAwsPrivatelink<T>,
}

#[derive(
    Debug,
    Clone,
    PartialEq,
    Eq,
    Hash,
    PartialOrd,
    Ord,
    Serialize,
    Deserialize
)]
/// Parsed from a string, with optional leading and trailing '*' wildcards.
pub struct ConnectionRulePattern {
    /// If true, allow any combination of characters before the literal match.
    pub prefix_wildcard: bool,
    /// We expect the broker's host:port to match these characters in their entirety.
    pub literal_match: String,
    /// If true, allow any combination of characters after the literal match.
    pub suffix_wildcard: bool,
}

impl<T: AstInfo> AstDisplay for KafkaMatchingBrokerRule<T> {
    fn fmt<W>(&self, f: &mut AstFormatter<W>)
    where
        W: fmt::Write,
    {
        f.write_str("MATCHING ");
        f.write_node(&self.pattern);
        f.write_str(" ");
        f.write_node(&self.tunnel);
    }
}
impl_display_t!(KafkaMatchingBrokerRule);

impl AstDisplay for ConnectionRulePattern {
    fn fmt<W>(&self, f: &mut AstFormatter<W>)
    where
        W: fmt::Write,
    {
        f.write_str("'");
        if self.prefix_wildcard {
            f.write_str("*");
        }
        f.write_node(&display::escape_single_quote_string(&self.literal_match));
        if self.suffix_wildcard {
            f.write_str("*");
        }
        f.write_str("'");
    }
}
impl_display!(ConnectionRulePattern);

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct KafkaBroker<T: AstInfo> {
    pub address: String,
    pub tunnel: KafkaBrokerTunnel<T>,
}

impl<T: AstInfo> AstDisplay for KafkaBroker<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("'");
        f.write_node(&display::escape_single_quote_string(&self.address));
        f.write_str("'");
        f.write_node(&self.tunnel);
    }
}

impl_display_t!(KafkaBroker);

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum KafkaBrokerTunnel<T: AstInfo> {
    Direct,
    AwsPrivatelink(KafkaBrokerAwsPrivatelink<T>),
    SshTunnel(T::ItemName),
}

impl<T: AstInfo> AstDisplay for KafkaBrokerTunnel<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        use KafkaBrokerTunnel::*;
        match self {
            Direct => {}
            AwsPrivatelink(aws) => {
                f.write_str(" ");
                f.write_node(aws);
            }
            Self::SshTunnel(connection) => {
                f.write_str("USING SSH TUNNEL ");
                f.write_node(connection);
            }
        }
    }
}

impl_display_t!(KafkaBrokerTunnel);

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum KafkaBrokerAwsPrivatelinkOptionName {
    AvailabilityZone,
    Port,
}

impl AstDisplay for KafkaBrokerAwsPrivatelinkOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            Self::AvailabilityZone => f.write_str("AVAILABILITY ZONE"),
            Self::Port => f.write_str("PORT"),
        }
    }
}
impl_display!(KafkaBrokerAwsPrivatelinkOptionName);

impl WithOptionName for KafkaBrokerAwsPrivatelinkOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            Self::AvailabilityZone | Self::Port => false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct KafkaBrokerAwsPrivatelinkOption<T: AstInfo> {
    pub name: KafkaBrokerAwsPrivatelinkOptionName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(KafkaBrokerAwsPrivatelinkOption);
impl_display_t!(KafkaBrokerAwsPrivatelinkOption);

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct KafkaBrokerAwsPrivatelink<T: AstInfo> {
    pub connection: T::ItemName,
    pub options: Vec<KafkaBrokerAwsPrivatelinkOption<T>>,
}

impl<T: AstInfo> AstDisplay for KafkaBrokerAwsPrivatelink<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("USING AWS PRIVATELINK ");
        f.write_node(&self.connection);
        if !self.options.is_empty() {
            f.write_str(" (");
            f.write_node(&display::comma_separated(&self.options));
            f.write_str(")");
        }
    }
}
impl_display_t!(KafkaBrokerAwsPrivatelink);

/// `CREATE CONNECTION` refactor WIP
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateConnectionStatement<T: AstInfo> {
    pub name: UnresolvedItemName,
    pub connection_type: CreateConnectionType,
    pub if_not_exists: bool,
    pub values: Vec<ConnectionOption<T>>,
    pub with_options: Vec<CreateConnectionOption<T>>,
}

impl<T: AstInfo> AstDisplay for CreateConnectionStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CREATE CONNECTION ");
        if self.if_not_exists {
            f.write_str("IF NOT EXISTS ");
        }
        f.write_node(&self.name);
        f.write_str(" TO ");
        self.connection_type.fmt(f);
        f.write_str(" (");
        f.write_node(&display::comma_separated(&self.values));
        f.write_str(")");

        if !self.with_options.is_empty() {
            f.write_str(" WITH (");
            f.write_node(&display::comma_separated(&self.with_options));
            f.write_str(")");
        }
    }
}
impl_display_t!(CreateConnectionStatement);

/// `VALIDATE CONNECTION`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ValidateConnectionStatement<T: AstInfo> {
    /// The connection to validate
    pub name: T::ItemName,
}

impl<T: AstInfo> AstDisplay for ValidateConnectionStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("VALIDATE CONNECTION ");
        f.write_node(&self.name);
    }
}
impl_display_t!(ValidateConnectionStatement);

/// `CREATE (SOURCE | TABLE) <name> FROM WEBHOOK`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateWebhookSourceStatement<T: AstInfo> {
    pub name: UnresolvedItemName,
    pub is_table: bool,
    pub if_not_exists: bool,
    pub body_format: Format<T>,
    pub include_headers: CreateWebhookSourceIncludeHeaders,
    pub validate_using: Option<CreateWebhookSourceCheck<T>>,
    pub in_cluster: Option<T::ClusterName>,
}

impl<T: AstInfo> AstDisplay for CreateWebhookSourceStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CREATE ");

        if self.is_table {
            f.write_str("TABLE ");
        } else {
            f.write_str("SOURCE ");
        }

        if self.if_not_exists {
            f.write_str("IF NOT EXISTS ");
        }
        f.write_node(&self.name);

        // CREATE TABLE ... FROM WEBHOOK does not support specifying a cluster.
        if !self.is_table {
            if let Some(cluster_name) = &self.in_cluster {
                f.write_str(" IN CLUSTER ");
                f.write_node(cluster_name);
            }
        }

        f.write_str(" FROM WEBHOOK ");

        f.write_str("BODY FORMAT ");
        f.write_node(&self.body_format);

        f.write_node(&self.include_headers);

        if let Some(validate) = &self.validate_using {
            f.write_str(" ");
            f.write_node(validate);
        }
    }
}

impl_display_t!(CreateWebhookSourceStatement);

/// `CHECK ( ... )`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateWebhookSourceCheck<T: AstInfo> {
    pub options: Option<CreateWebhookSourceCheckOptions<T>>,
    pub using: Expr<T>,
}

impl<T: AstInfo> AstDisplay for CreateWebhookSourceCheck<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CHECK (");

        if let Some(options) = &self.options {
            f.write_node(options);
            f.write_str(" ");
        }

        f.write_node(&self.using);
        f.write_str(")");
    }
}

impl_display_t!(CreateWebhookSourceCheck);

/// `CHECK ( WITH ( ... ) )`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateWebhookSourceCheckOptions<T: AstInfo> {
    pub secrets: Vec<CreateWebhookSourceSecret<T>>,
    pub headers: Vec<CreateWebhookSourceHeader>,
    pub bodies: Vec<CreateWebhookSourceBody>,
}

impl<T: AstInfo> AstDisplay for CreateWebhookSourceCheckOptions<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("WITH (");

        let mut delim = "";
        if !self.headers.is_empty() {
            f.write_node(&display::comma_separated(&self.headers[..]));
            delim = ", ";
        }
        if !self.bodies.is_empty() {
            f.write_str(delim);
            f.write_node(&display::comma_separated(&self.bodies[..]));
            delim = ", ";
        }
        if !self.secrets.is_empty() {
            f.write_str(delim);
            f.write_node(&display::comma_separated(&self.secrets[..]));
        }

        f.write_str(")");
    }
}

impl_display_t!(CreateWebhookSourceCheckOptions);

/// `SECRET ... [AS ...] [BYTES]`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateWebhookSourceSecret<T: AstInfo> {
    pub secret: T::ItemName,
    pub alias: Option<Ident>,
    pub use_bytes: bool,
}

impl<T: AstInfo> AstDisplay for CreateWebhookSourceSecret<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("SECRET ");
        f.write_node(&self.secret);

        if let Some(alias) = &self.alias {
            f.write_str(" AS ");
            f.write_node(alias);
        }

        if self.use_bytes {
            f.write_str(" BYTES");
        }
    }
}

impl_display_t!(CreateWebhookSourceSecret);

/// `HEADER [AS ...] [BYTES]`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateWebhookSourceHeader {
    pub alias: Option<Ident>,
    pub use_bytes: bool,
}

impl AstDisplay for CreateWebhookSourceHeader {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("HEADERS");

        if let Some(alias) = &self.alias {
            f.write_str(" AS ");
            f.write_node(alias);
        }

        if self.use_bytes {
            f.write_str(" BYTES");
        }
    }
}

impl_display!(CreateWebhookSourceHeader);

/// `BODY [AS ...] [BYTES]`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateWebhookSourceBody {
    pub alias: Option<Ident>,
    pub use_bytes: bool,
}

impl AstDisplay for CreateWebhookSourceBody {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("BODY");

        if let Some(alias) = &self.alias {
            f.write_str(" AS ");
            f.write_node(alias);
        }

        if self.use_bytes {
            f.write_str(" BYTES");
        }
    }
}

impl_display!(CreateWebhookSourceBody);

/// `INCLUDE [HEADER | HEADERS]`
#[derive(Default, Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateWebhookSourceIncludeHeaders {
    /// Mapping individual header names to columns in the source.
    pub mappings: Vec<CreateWebhookSourceMapHeader>,
    /// Whether or not to include the `headers` column, and any filtering we might want to do.
    pub column: Option<Vec<CreateWebhookSourceFilterHeader>>,
}

impl AstDisplay for CreateWebhookSourceIncludeHeaders {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        if !self.mappings.is_empty() {
            f.write_str(" ");
        }
        f.write_node(&display::separated(&self.mappings[..], " "));

        if let Some(column) = &self.column {
            f.write_str(" INCLUDE HEADERS");

            if !column.is_empty() {
                f.write_str(" ");
                f.write_str("(");
                f.write_node(&display::comma_separated(&column[..]));
                f.write_str(")");
            }
        }
    }
}

impl_display!(CreateWebhookSourceIncludeHeaders);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateWebhookSourceFilterHeader {
    pub block: bool,
    pub header_name: String,
}

impl AstDisplay for CreateWebhookSourceFilterHeader {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        if self.block {
            f.write_str("NOT ");
        }
        f.write_node(&display::escaped_string_literal(&self.header_name));
    }
}

impl_display!(CreateWebhookSourceFilterHeader);

/// `INCLUDE HEADER <name> [AS <alias>] [BYTES]`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateWebhookSourceMapHeader {
    pub header_name: String,
    pub column_name: Ident,
    pub use_bytes: bool,
}

impl AstDisplay for CreateWebhookSourceMapHeader {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("INCLUDE HEADER ");

        f.write_node(&display::escaped_string_literal(&self.header_name));

        f.write_str(" AS ");
        f.write_node(&self.column_name);

        if self.use_bytes {
            f.write_str(" BYTES");
        }
    }
}

impl_display!(CreateWebhookSourceMapHeader);

/// `CREATE SOURCE`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateSourceStatement<T: AstInfo> {
    pub name: UnresolvedItemName,
    pub in_cluster: Option<T::ClusterName>,
    pub col_names: Vec<Ident>,
    pub connection: CreateSourceConnection<T>,
    pub include_metadata: Vec<SourceIncludeMetadata>,
    pub format: Option<FormatSpecifier<T>>,
    pub envelope: Option<SourceEnvelope>,
    pub if_not_exists: bool,
    pub key_constraint: Option<KeyConstraint>,
    pub with_options: Vec<CreateSourceOption<T>>,
    pub external_references: Option<ExternalReferences>,
    pub progress_subsource: Option<DeferredItemName<T>>,
}

impl<T: AstInfo> AstDisplay for CreateSourceStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CREATE SOURCE ");
        if self.if_not_exists {
            f.write_str("IF NOT EXISTS ");
        }
        f.write_node(&self.name);
        if !self.col_names.is_empty() {
            f.write_str(" (");
            f.write_node(&display::comma_separated(&self.col_names));
            if let Some(key_constraint) = &self.key_constraint {
                f.write_str(", ");
                f.write_node(key_constraint);
            }
            f.write_str(")");
        } else if let Some(key_constraint) = &self.key_constraint {
            f.write_str(" (");
            f.write_node(key_constraint);
            f.write_str(")")
        }
        if let Some(cluster) = &self.in_cluster {
            f.write_str(" IN CLUSTER ");
            f.write_node(cluster);
        }
        f.write_str(" FROM ");
        f.write_node(&self.connection);
        if let Some(format) = &self.format {
            f.write_str(" ");
            f.write_node(format);
        }
        if !self.include_metadata.is_empty() {
            f.write_str(" INCLUDE ");
            f.write_node(&display::comma_separated(&self.include_metadata));
        }

        if let Some(envelope) = &self.envelope {
            f.write_str(" ENVELOPE ");
            f.write_node(envelope);
        }

        if let Some(subsources) = &self.external_references {
            f.write_str(" ");
            f.write_node(subsources);
        }

        if let Some(progress) = &self.progress_subsource {
            f.write_str(" EXPOSE PROGRESS AS ");
            f.write_node(progress);
        }

        if !self.with_options.is_empty() {
            f.write_str(" WITH (");
            f.write_node(&display::comma_separated(&self.with_options));
            f.write_str(")");
        }
    }
}
impl_display_t!(CreateSourceStatement);

/// A selected external reference in a FOR TABLES (..) statement
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ExternalReferenceExport {
    pub reference: UnresolvedItemName,
    pub alias: Option<UnresolvedItemName>,
}

impl AstDisplay for ExternalReferenceExport {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_node(&self.reference);
        if let Some(alias) = &self.alias {
            f.write_str(" AS ");
            f.write_node(alias);
        }
    }
}
impl_display!(ExternalReferenceExport);

/// Specifies which set of external references to generate a source export
/// for in a `CREATE SOURCE` statement.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum ExternalReferences {
    /// A subset defined with FOR TABLES (...)
    SubsetTables(Vec<ExternalReferenceExport>),
    /// A subset defined with FOR SCHEMAS (...)
    SubsetSchemas(Vec<Ident>),
    /// FOR ALL TABLES
    All,
}

impl AstDisplay for ExternalReferences {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            Self::SubsetTables(tables) => {
                f.write_str("FOR TABLES (");
                f.write_node(&display::comma_separated(tables));
                f.write_str(")");
            }
            Self::SubsetSchemas(schemas) => {
                f.write_str("FOR SCHEMAS (");
                f.write_node(&display::comma_separated(schemas));
                f.write_str(")");
            }
            Self::All => f.write_str("FOR ALL TABLES"),
        }
    }
}
impl_display!(ExternalReferences);

/// An option in a `CREATE SUBSOURCE` statement.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum CreateSubsourceOptionName {
    Progress,
    /// Tracks which item this subsource references in the primary source.
    ExternalReference,
    /// The `RETAIN HISTORY` option
    RetainHistory,
    /// Columns whose types you want to unconditionally format as text
    TextColumns,
    /// Columns you want to exclude when ingesting data
    ExcludeColumns,
    /// `DETAILS` for this subsource, hex-encoded protobuf type
    /// `mz_storage_types::sources::SourceExportStatementDetails`
    Details,
}

impl AstDisplay for CreateSubsourceOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str(match self {
            CreateSubsourceOptionName::Progress => "PROGRESS",
            CreateSubsourceOptionName::ExternalReference => "EXTERNAL REFERENCE",
            CreateSubsourceOptionName::RetainHistory => "RETAIN HISTORY",
            CreateSubsourceOptionName::TextColumns => "TEXT COLUMNS",
            CreateSubsourceOptionName::ExcludeColumns => "EXCLUDE COLUMNS",
            CreateSubsourceOptionName::Details => "DETAILS",
        })
    }
}

impl WithOptionName for CreateSubsourceOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            CreateSubsourceOptionName::Progress
            | CreateSubsourceOptionName::ExternalReference
            | CreateSubsourceOptionName::RetainHistory
            | CreateSubsourceOptionName::Details
            | CreateSubsourceOptionName::TextColumns
            | CreateSubsourceOptionName::ExcludeColumns => false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateSubsourceOption<T: AstInfo> {
    pub name: CreateSubsourceOptionName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(CreateSubsourceOption);

/// `CREATE SUBSOURCE`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateSubsourceStatement<T: AstInfo> {
    pub name: UnresolvedItemName,
    pub columns: Vec<ColumnDef<T>>,
    /// Tracks the primary source of this subsource if an ingestion export (i.e.
    /// not a progress subsource).
    pub of_source: Option<T::ItemName>,
    pub constraints: Vec<TableConstraint<T>>,
    pub if_not_exists: bool,
    pub with_options: Vec<CreateSubsourceOption<T>>,
}

impl<T: AstInfo> AstDisplay for CreateSubsourceStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CREATE SUBSOURCE ");
        if self.if_not_exists {
            f.write_str("IF NOT EXISTS ");
        }

        f.write_node(&self.name);
        f.write_str(" (");
        f.write_node(&display::comma_separated(&self.columns));
        if !self.constraints.is_empty() {
            f.write_str(", ");
            f.write_node(&display::comma_separated(&self.constraints));
        }
        f.write_str(")");

        if let Some(of_source) = &self.of_source {
            f.write_str(" OF SOURCE ");
            f.write_node(of_source);
        }

        if !self.with_options.is_empty() {
            f.write_str(" WITH (");
            f.write_node(&display::comma_separated(&self.with_options));
            f.write_str(")");
        }
    }
}
impl_display_t!(CreateSubsourceStatement);

/// An option in a `CREATE SINK` statement.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum CreateSinkOptionName {
    Snapshot,
    Version,
    PartitionStrategy,
    CommitInterval,
}

impl AstDisplay for CreateSinkOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            CreateSinkOptionName::Snapshot => {
                f.write_str("SNAPSHOT");
            }
            CreateSinkOptionName::Version => {
                f.write_str("VERSION");
            }
            CreateSinkOptionName::PartitionStrategy => {
                f.write_str("PARTITION STRATEGY");
            }
            CreateSinkOptionName::CommitInterval => {
                f.write_str("COMMIT INTERVAL");
            }
        }
    }
}

impl WithOptionName for CreateSinkOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            CreateSinkOptionName::Snapshot => false,
            CreateSinkOptionName::Version => false,
            CreateSinkOptionName::PartitionStrategy => false,
            CreateSinkOptionName::CommitInterval => false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct CreateSinkOption<T: AstInfo> {
    pub name: CreateSinkOptionName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(CreateSinkOption);

/// `CREATE SINK`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateSinkStatement<T: AstInfo> {
    pub name: Option<UnresolvedItemName>,
    pub in_cluster: Option<T::ClusterName>,
    pub if_not_exists: bool,
    pub from: T::ItemName,
    pub connection: CreateSinkConnection<T>,
    pub format: Option<FormatSpecifier<T>>,
    pub envelope: Option<SinkEnvelope>,
    pub mode: Option<IcebergSinkMode>,
    pub with_options: Vec<CreateSinkOption<T>>,
}

impl<T: AstInfo> AstDisplay for CreateSinkStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CREATE SINK ");
        if self.if_not_exists {
            f.write_str("IF NOT EXISTS ");
        }
        if let Some(name) = &self.name {
            f.write_node(&name);
            f.write_str(" ");
        }
        if let Some(cluster) = &self.in_cluster {
            f.write_str("IN CLUSTER ");
            f.write_node(cluster);
            f.write_str(" ");
        }
        f.write_str("FROM ");
        f.write_node(&self.from);
        f.write_str(" INTO ");
        f.write_node(&self.connection);
        if let Some(format) = &self.format {
            f.write_str(" ");
            f.write_node(format);
        }
        if let Some(envelope) = &self.envelope {
            f.write_str(" ENVELOPE ");
            f.write_node(envelope);
        }
        if let Some(mode) = &self.mode {
            f.write_str(" MODE ");
            f.write_node(mode);
        }

        if !self.with_options.is_empty() {
            f.write_str(" WITH (");
            f.write_node(&display::comma_separated(&self.with_options));
            f.write_str(")");
        }
    }
}
impl_display_t!(CreateSinkStatement);

/// An option in a `CREATE METRIC SINK` statement.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum CreateMetricSinkOptionName {
    Prefix,
}

impl AstDisplay for CreateMetricSinkOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            CreateMetricSinkOptionName::Prefix => {
                f.write_str("PREFIX");
            }
        }
    }
}

impl WithOptionName for CreateMetricSinkOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            CreateMetricSinkOptionName::Prefix => false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct CreateMetricSinkOption<T: AstInfo> {
    pub name: CreateMetricSinkOptionName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(CreateMetricSinkOption);

/// `CREATE METRIC SINK`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateMetricSinkStatement<T: AstInfo> {
    pub name: UnresolvedItemName,
    pub in_cluster: Option<T::ClusterName>,
    pub if_not_exists: bool,
    pub from: T::ItemName,
    pub with_options: Vec<CreateMetricSinkOption<T>>,
}

impl<T: AstInfo> AstDisplay for CreateMetricSinkStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CREATE METRIC SINK ");
        if self.if_not_exists {
            f.write_str("IF NOT EXISTS ");
        }
        f.write_node(&self.name);
        f.write_str(" ");
        if let Some(cluster) = &self.in_cluster {
            f.write_str("IN CLUSTER ");
            f.write_node(cluster);
            f.write_str(" ");
        }
        f.write_str("FROM ");
        f.write_node(&self.from);

        // NOTE: `create_sql` is persisted through this impl and re-parsed on boot, so dropping
        // the clause here would silently lose the prefix across a restart.
        if !self.with_options.is_empty() {
            f.write_str(" WITH (");
            f.write_node(&display::comma_separated(&self.with_options));
            f.write_str(")");
        }
    }
}
impl_display_t!(CreateMetricSinkStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ViewDefinition<T: AstInfo> {
    /// View name
    pub name: UnresolvedItemName,
    pub columns: Vec<Ident>,
    pub query: Query<T>,
}

impl<T: AstInfo> AstDisplay for ViewDefinition<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_node(&self.name);

        if !self.columns.is_empty() {
            f.write_str(" (");
            f.write_node(&display::comma_separated(&self.columns));
            f.write_str(")");
        }

        f.write_str(" AS ");
        f.write_node(&self.query);
    }
}
impl_display_t!(ViewDefinition);

/// `CREATE VIEW`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateViewStatement<T: AstInfo> {
    pub if_exists: IfExistsBehavior,
    pub temporary: bool,
    pub definition: ViewDefinition<T>,
}

impl<T: AstInfo> AstDisplay for CreateViewStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CREATE");
        if self.if_exists == IfExistsBehavior::Replace {
            f.write_str(" OR REPLACE");
        }
        if self.temporary {
            f.write_str(" TEMPORARY");
        }

        f.write_str(" VIEW");

        if self.if_exists == IfExistsBehavior::Skip {
            f.write_str(" IF NOT EXISTS");
        }

        f.write_str(" ");
        f.write_node(&self.definition);
    }
}
impl_display_t!(CreateViewStatement);

/// `CREATE MATERIALIZED VIEW`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateMaterializedViewStatement<T: AstInfo> {
    pub if_exists: IfExistsBehavior,
    pub name: UnresolvedItemName,
    pub columns: Vec<Ident>,
    pub replacement_for: Option<T::ItemName>,
    pub in_cluster: Option<T::ClusterName>,
    pub in_cluster_replica: Option<Ident>,
    pub query: Query<T>,
    pub as_of: Option<u64>,
    pub with_options: Vec<MaterializedViewOption<T>>,
}

impl<T: AstInfo> AstDisplay for CreateMaterializedViewStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CREATE");
        if self.if_exists == IfExistsBehavior::Replace {
            f.write_str(" OR REPLACE");
        }
        if self.replacement_for.is_some() {
            f.write_str(" REPLACEMENT");
        }

        f.write_str(" MATERIALIZED VIEW");

        if self.if_exists == IfExistsBehavior::Skip {
            f.write_str(" IF NOT EXISTS");
        }

        f.write_str(" ");
        f.write_node(&self.name);

        if !self.columns.is_empty() {
            f.write_str(" (");
            f.write_node(&display::comma_separated(&self.columns));
            f.write_str(")");
        }

        if let Some(target) = &self.replacement_for {
            f.write_str(" FOR ");
            f.write_node(target);
        }

        match (&self.in_cluster, &self.in_cluster_replica) {
            (Some(cluster), Some(replica)) => {
                f.write_str(" IN CLUSTER ");
                f.write_node(cluster);
                f.write_str(" REPLICA ");
                f.write_node(replica);
            }
            (Some(cluster), None) => {
                f.write_str(" IN CLUSTER ");
                f.write_node(cluster);
            }
            (None, Some(replica)) => {
                f.write_str(" IN REPLICA ");
                f.write_node(replica);
            }
            (None, None) => {}
        }

        if !self.with_options.is_empty() {
            f.write_str(" WITH (");
            f.write_node(&display::comma_separated(&self.with_options));
            f.write_str(")");
        }

        f.write_str(" AS ");
        f.write_node(&self.query);

        if let Some(time) = &self.as_of {
            f.write_str(" AS OF ");
            f.write_str(time);
        }
    }
}
impl_display_t!(CreateMaterializedViewStatement);

/// `ALTER SET CLUSTER`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterSetClusterStatement<T: AstInfo> {
    pub if_exists: bool,
    pub name: UnresolvedItemName,
    pub object_type: ObjectType,
    pub set_cluster: T::ClusterName,
}

impl<T: AstInfo> AstDisplay for AlterSetClusterStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ALTER ");
        f.write_node(&self.object_type);

        if self.if_exists {
            f.write_str(" IF EXISTS");
        }

        f.write_str(" ");
        f.write_node(&self.name);

        f.write_str(" SET CLUSTER ");
        f.write_node(&self.set_cluster);
    }
}
impl_display_t!(AlterSetClusterStatement);

/// `CREATE TABLE`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateTableStatement<T: AstInfo> {
    /// Table name
    pub name: UnresolvedItemName,
    /// Optional schema
    pub columns: Vec<ColumnDef<T>>,
    pub constraints: Vec<TableConstraint<T>>,
    pub if_not_exists: bool,
    pub temporary: bool,
    pub with_options: Vec<TableOption<T>>,
}

impl<T: AstInfo> AstDisplay for CreateTableStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        let Self {
            name,
            columns,
            constraints,
            if_not_exists,
            temporary,
            with_options,
        } = self;
        f.write_str("CREATE ");
        if *temporary {
            f.write_str("TEMPORARY ");
        }
        f.write_str("TABLE ");
        if *if_not_exists {
            f.write_str("IF NOT EXISTS ");
        }
        f.write_node(name);
        f.write_str(" (");
        f.write_node(&display::comma_separated(columns));
        if !self.constraints.is_empty() {
            if !columns.is_empty() {
                f.write_str(", ");
            }
            f.write_node(&display::comma_separated(constraints));
        }
        f.write_str(")");
        if !with_options.is_empty() {
            f.write_str(" WITH (");
            f.write_node(&display::comma_separated(&self.with_options));
            f.write_str(")");
        }
    }
}
impl_display_t!(CreateTableStatement);

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum TableOptionName {
    // The `PARTITION BY` option
    PartitionBy,
    // The `RETAIN HISTORY` option
    RetainHistory,
    /// A special option to test that we do redact values.
    RedactedTest,
}

impl AstDisplay for TableOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            TableOptionName::PartitionBy => {
                f.write_str("PARTITION BY");
            }
            TableOptionName::RetainHistory => {
                f.write_str("RETAIN HISTORY");
            }
            TableOptionName::RedactedTest => {
                f.write_str("REDACTED");
            }
        }
    }
}

impl WithOptionName for TableOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            // The value is an arbitrary user expression/literal that may embed
            // sensitive data, so redact it (mirrors `KafkaSinkConfigOptionName`).
            TableOptionName::PartitionBy => true,
            TableOptionName::RetainHistory => false,
            TableOptionName::RedactedTest => true,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct TableOption<T: AstInfo> {
    pub name: TableOptionName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(TableOption);

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum TableFromSourceOptionName {
    /// Columns whose types you want to unconditionally format as text
    TextColumns,
    /// Columns you want to exclude when ingesting data
    ExcludeColumns,
    /// Upstream `PRIMARY KEY`/`UNIQUE` constraints, by name, that Materialize
    /// should not record as keys, so that their later upstream drop is a
    /// non-event.
    ExcludeConstraints,
    /// Record no upstream constraints at all: no keys, and every column
    /// ingested as nullable.
    ExcludeAllConstraints,
    /// Ignore all `NOT NULL` constraints on columns
    ExcludeAllNotNullConstraints,
    /// Hex-encoded protobuf of a `ProtoSourceExportStatementDetails`
    /// message, which includes details necessary for planning this
    /// table as a Source Export
    Details,
    /// Partition the given table by the provided columns.
    PartitionBy,
    // The `RETAIN HISTORY` option
    RetainHistory,
}

impl AstDisplay for TableFromSourceOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str(match self {
            TableFromSourceOptionName::TextColumns => "TEXT COLUMNS",
            TableFromSourceOptionName::ExcludeColumns => "EXCLUDE COLUMNS",
            TableFromSourceOptionName::ExcludeConstraints => "EXCLUDE CONSTRAINTS",
            TableFromSourceOptionName::ExcludeAllConstraints => "EXCLUDE ALL CONSTRAINTS",
            TableFromSourceOptionName::ExcludeAllNotNullConstraints => {
                "EXCLUDE ALL NOT NULL CONSTRAINTS"
            }
            TableFromSourceOptionName::Details => "DETAILS",
            TableFromSourceOptionName::PartitionBy => "PARTITION BY",
            TableFromSourceOptionName::RetainHistory => "RETAIN HISTORY",
        })
    }
}
impl_display!(TableFromSourceOptionName);

impl WithOptionName for TableFromSourceOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            TableFromSourceOptionName::Details
            | TableFromSourceOptionName::TextColumns
            | TableFromSourceOptionName::ExcludeColumns
            | TableFromSourceOptionName::ExcludeConstraints
            | TableFromSourceOptionName::ExcludeAllConstraints
            | TableFromSourceOptionName::ExcludeAllNotNullConstraints
            | TableFromSourceOptionName::RetainHistory => false,
            // The value is an arbitrary user expression/literal that may embed
            // sensitive data, so redact it (mirrors `KafkaSinkConfigOptionName`).
            TableFromSourceOptionName::PartitionBy => true,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct TableFromSourceOption<T: AstInfo> {
    pub name: TableFromSourceOptionName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(TableFromSourceOption);

/// `CREATE TABLE .. FROM SOURCE` columns specification
/// can have 3 states:
/// Before purification they can be `NotSpecified` or `Named`
/// by the user to specify the column names to use.
/// After purification they can be in any of the 3 states.
/// For some source types we define the columns during purification
/// and for others the columns are defined during planning based
/// on the encoding option of the source.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum TableFromSourceColumns<T: AstInfo> {
    /// The user did not specify which columns to use.
    NotSpecified,
    /// The user requested the named columns. Only compatible
    /// with source types that allow user-specified column names.
    Named(Vec<Ident>),
    /// Columns defined during purification for some source types.
    Defined(Vec<ColumnDef<T>>),
}

/// `CREATE TABLE .. FROM SOURCE`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateTableFromSourceStatement<T: AstInfo> {
    pub name: UnresolvedItemName,
    pub columns: TableFromSourceColumns<T>,
    pub constraints: Vec<TableConstraint<T>>,
    pub if_not_exists: bool,
    pub source: T::ItemName,
    pub external_reference: Option<UnresolvedItemName>,
    pub with_options: Vec<TableFromSourceOption<T>>,
    pub include_metadata: Vec<SourceIncludeMetadata>,
    pub format: Option<FormatSpecifier<T>>,
    pub envelope: Option<SourceEnvelope>,
}

impl<T: AstInfo> AstDisplay for CreateTableFromSourceStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        let Self {
            name,
            columns,
            constraints,
            source,
            external_reference,
            if_not_exists,
            with_options,
            include_metadata,
            format,
            envelope,
        } = self;
        f.write_str("CREATE TABLE ");
        if *if_not_exists {
            f.write_str("IF NOT EXISTS ");
        }
        f.write_node(name);
        if !matches!(columns, TableFromSourceColumns::NotSpecified) || !constraints.is_empty() {
            f.write_str(" (");

            match columns {
                TableFromSourceColumns::NotSpecified => {}
                TableFromSourceColumns::Named(columns) => {
                    f.write_node(&display::comma_separated(columns))
                }
                TableFromSourceColumns::Defined(columns) => {
                    f.write_node(&display::comma_separated(columns))
                }
            };
            if !constraints.is_empty() {
                if !matches!(columns, TableFromSourceColumns::NotSpecified) {
                    f.write_str(", ");
                }
                f.write_node(&display::comma_separated(constraints));
            }
            f.write_str(")");
        }
        f.write_str(" FROM SOURCE ");
        f.write_node(source);
        if let Some(external_reference) = external_reference {
            f.write_str(" (REFERENCE = ");
            f.write_node(external_reference);
            f.write_str(")");
        }

        if let Some(format) = &format {
            f.write_str(" ");
            f.write_node(format);
        }
        if !include_metadata.is_empty() {
            f.write_str(" INCLUDE ");
            f.write_node(&display::comma_separated(include_metadata));
        }
        if let Some(envelope) = &envelope {
            f.write_str(" ENVELOPE ");
            f.write_node(envelope);
        }
        if !with_options.is_empty() {
            f.write_str(" WITH (");
            f.write_node(&display::comma_separated(with_options));
            f.write_str(")");
        }
    }
}
impl_display_t!(CreateTableFromSourceStatement);

/// `CREATE INDEX`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateIndexStatement<T: AstInfo> {
    /// Optional index name.
    pub name: Option<Ident>,
    pub in_cluster: Option<T::ClusterName>,
    /// `ON` table or view name
    pub on_name: T::ItemName,
    /// Expressions that form part of the index key. If not included, the
    /// key_parts will be inferred from the named object.
    pub key_parts: Option<Vec<Expr<T>>>,
    pub with_options: Vec<IndexOption<T>>,
    pub if_not_exists: bool,
}

impl<T: AstInfo> AstDisplay for CreateIndexStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CREATE ");
        if self.key_parts.is_none() {
            f.write_str("DEFAULT ");
        }
        f.write_str("INDEX ");
        if self.if_not_exists {
            f.write_str("IF NOT EXISTS ");
        }
        if let Some(name) = &self.name {
            // A bare `in` index name re-lexes as the start of the optional
            // `IN CLUSTER` clause below (`CREATE INDEX in ON …` fails to reparse
            // with "Expected ON, found IN"), so force it quoted. `in` is
            // legitimately bare in other name positions — e.g. a required
            // `CREATE SINK` name — so this is local to the optional-name +
            // `IN CLUSTER` ambiguity, not a `can_be_printed_bare` case.
            if name.as_str().eq_ignore_ascii_case("in") {
                f.write_str("\"");
                f.write_str(name.as_str());
                f.write_str("\"");
            } else {
                f.write_node(name);
            }
            f.write_str(" ");
        }
        if let Some(cluster) = &self.in_cluster {
            f.write_str("IN CLUSTER ");
            f.write_node(cluster);
            f.write_str(" ");
        }
        f.write_str("ON ");
        f.write_node(&self.on_name);
        if let Some(key_parts) = &self.key_parts {
            f.write_str(" (");
            f.write_node(&display::comma_separated(key_parts));
            f.write_str(")");
        }
        if !self.with_options.is_empty() {
            f.write_str(" WITH (");
            f.write_node(&display::comma_separated(&self.with_options));
            f.write_str(")");
        }
    }
}
impl_display_t!(CreateIndexStatement);

/// An option in a `CREATE CLUSTER` statement.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum IndexOptionName {
    // The `RETAIN HISTORY` option
    RetainHistory,
}

impl AstDisplay for IndexOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            IndexOptionName::RetainHistory => {
                f.write_str("RETAIN HISTORY");
            }
        }
    }
}

impl WithOptionName for IndexOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            IndexOptionName::RetainHistory => false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct IndexOption<T: AstInfo> {
    pub name: IndexOptionName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(IndexOption);

/// A `CREATE ROLE` statement.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateRoleStatement {
    /// The specified role.
    pub name: Ident,
    /// Any options that were attached, in the order they were presented.
    pub options: Vec<RoleAttribute>,
}

impl AstDisplay for CreateRoleStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CREATE ");
        f.write_str("ROLE ");
        f.write_node(&self.name);
        for option in &self.options {
            f.write_str(" ");
            option.fmt(f)
        }
    }
}
impl_display!(CreateRoleStatement);

/// Attributes that can be attached to roles.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum RoleAttribute {
    /// The `INHERIT` option.
    Inherit,
    /// The `NOINHERIT` option.
    NoInherit,
    /// The `PASSWORD` option.
    Password(Option<String>),
    // The following are not supported, but included to give helpful error messages.
    Login,
    NoLogin,
    SuperUser,
    NoSuperUser,
    CreateCluster,
    NoCreateCluster,
    CreateDB,
    NoCreateDB,
    CreateRole,
    NoCreateRole,
}

impl AstDisplay for RoleAttribute {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            RoleAttribute::SuperUser => f.write_str("SUPERUSER"),
            RoleAttribute::NoSuperUser => f.write_str("NOSUPERUSER"),
            RoleAttribute::Login => f.write_str("LOGIN"),
            RoleAttribute::NoLogin => f.write_str("NOLOGIN"),
            RoleAttribute::Inherit => f.write_str("INHERIT"),
            RoleAttribute::NoInherit => f.write_str("NOINHERIT"),
            RoleAttribute::CreateCluster => f.write_str("CREATECLUSTER"),
            RoleAttribute::NoCreateCluster => f.write_str("NOCREATECLUSTER"),
            RoleAttribute::CreateDB => f.write_str("CREATEDB"),
            RoleAttribute::NoCreateDB => f.write_str("NOCREATEDB"),
            RoleAttribute::CreateRole => f.write_str("CREATEROLE"),
            RoleAttribute::NoCreateRole => f.write_str("NOCREATEROLE"),
            // `PASSWORD NULL` removes the password and carries no secret, so
            // print it verbatim. A `PASSWORD '<secret>'` is always redacted (in
            // every mode, matching the prior behavior) — but as a *parseable*
            // placeholder string, not a bare `PASSWORD`, which fails to reparse
            // (the grammar requires `NULL` or a string literal after `PASSWORD`).
            RoleAttribute::Password(None) => f.write_str("PASSWORD NULL"),
            RoleAttribute::Password(Some(_)) => f.write_str("PASSWORD '<REDACTED>'"),
        }
    }
}
impl_display!(RoleAttribute);

/// `ALTER ROLE role_name [SET | RESET] ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum SetRoleVar {
    /// `SET name TO value`
    Set { name: Ident, value: SetVariableTo },
    /// `RESET name`
    Reset { name: Ident },
}

impl AstDisplay for SetRoleVar {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            SetRoleVar::Set { name, value } => {
                f.write_str("SET ");
                f.write_node(name);
                f.write_str(" = ");
                f.write_node(value);
            }
            SetRoleVar::Reset { name } => {
                f.write_str("RESET ");
                f.write_node(name);
            }
        }
    }
}
impl_display!(SetRoleVar);

/// AN `ALTER NETWORK POLICY` statement.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterNetworkPolicyStatement<T: AstInfo> {
    /// The specified Network Policy.
    pub name: Ident,
    /// Any options that were attached, in the order they were presented.
    pub options: Vec<NetworkPolicyOption<T>>,
}

impl<T: AstInfo> AstDisplay for AlterNetworkPolicyStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ALTER ");
        f.write_str("NETWORK POLICY ");
        f.write_node(&self.name);
        f.write_str(" SET (");
        f.write_node(&display::comma_separated(&self.options));
        f.write_str(" )");
    }
}
impl_display_t!(AlterNetworkPolicyStatement);

/// A `CREATE NETWORK POLICY` statement.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateNetworkPolicyStatement<T: AstInfo> {
    /// The specified network policy.
    pub name: Ident,
    /// Any options that were attached, in the order they were presented.
    pub options: Vec<NetworkPolicyOption<T>>,
}

impl<T: AstInfo> AstDisplay for CreateNetworkPolicyStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CREATE ");
        f.write_str("NETWORK POLICY ");
        f.write_node(&self.name);
        f.write_str(" (");
        f.write_node(&display::comma_separated(&self.options));
        f.write_str(" )");
    }
}
impl_display_t!(CreateNetworkPolicyStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct NetworkPolicyOption<T: AstInfo> {
    pub name: NetworkPolicyOptionName,
    pub value: Option<WithOptionValue<T>>,
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum NetworkPolicyOptionName {
    Rules,
}

impl WithOptionName for NetworkPolicyOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            NetworkPolicyOptionName::Rules => false,
        }
    }
}

impl AstDisplay for NetworkPolicyOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            NetworkPolicyOptionName::Rules => f.write_str("RULES"),
        }
    }
}
impl_display_for_with_option!(NetworkPolicyOption);

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct NetworkPolicyRuleDefinition<T: AstInfo> {
    pub name: Ident,
    pub options: Vec<NetworkPolicyRuleOption<T>>,
}

impl<T: AstInfo> AstDisplay for NetworkPolicyRuleDefinition<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_node(&self.name);
        f.write_str(" (");
        f.write_node(&display::comma_separated(&self.options));
        f.write_str(" )");
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct NetworkPolicyRuleOption<T: AstInfo> {
    pub name: NetworkPolicyRuleOptionName,
    pub value: Option<WithOptionValue<T>>,
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum NetworkPolicyRuleOptionName {
    Direction,
    Action,
    Address,
}

impl WithOptionName for NetworkPolicyRuleOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            NetworkPolicyRuleOptionName::Direction
            | NetworkPolicyRuleOptionName::Action
            | NetworkPolicyRuleOptionName::Address => false,
        }
    }
}

impl AstDisplay for NetworkPolicyRuleOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            NetworkPolicyRuleOptionName::Direction => f.write_str("DIRECTION"),
            NetworkPolicyRuleOptionName::Action => f.write_str("ACTION"),
            NetworkPolicyRuleOptionName::Address => f.write_str("ADDRESS"),
        }
    }
}

impl_display_for_with_option!(NetworkPolicyRuleOption);

/// A `CREATE SECRET` statement.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateSecretStatement<T: AstInfo> {
    pub name: UnresolvedItemName,
    pub if_not_exists: bool,
    pub value: Expr<T>,
}

impl<T: AstInfo> AstDisplay for CreateSecretStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CREATE SECRET ");
        if self.if_not_exists {
            f.write_str("IF NOT EXISTS ");
        }
        f.write_node(&self.name);
        f.write_str(" AS ");

        if f.redacted() {
            f.write_str("'<REDACTED>'");
        } else {
            f.write_node(&self.value);
        }
    }
}
impl_display_t!(CreateSecretStatement);

/// `CREATE TYPE ..`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateTypeStatement<T: AstInfo> {
    /// Name of the created type.
    pub name: UnresolvedItemName,
    /// The new type's "base type".
    pub as_type: CreateTypeAs<T>,
}

impl<T: AstInfo> AstDisplay for CreateTypeStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CREATE TYPE ");
        f.write_node(&self.name);
        f.write_str(" AS ");
        match &self.as_type {
            CreateTypeAs::List { options } => {
                f.write_str(&self.as_type);
                f.write_str("(");
                if !options.is_empty() {
                    f.write_node(&display::comma_separated(options));
                }
                f.write_str(")");
            }
            CreateTypeAs::Map { options } => {
                f.write_str(&self.as_type);
                f.write_str("(");
                if !options.is_empty() {
                    f.write_node(&display::comma_separated(options));
                }
                f.write_str(")");
            }
            CreateTypeAs::Record { column_defs } => {
                f.write_str("(");
                if !column_defs.is_empty() {
                    f.write_node(&display::comma_separated(column_defs));
                }
                f.write_str(")");
            }
        };
    }
}
impl_display_t!(CreateTypeStatement);

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum ClusterOptionName {
    /// The `AUTO SCALING STRATEGY [[=] (...)]` option.
    AutoScalingStrategy,
    /// The `AVAILABILITY ZONES [[=] '[' <values> ']' ]` option.
    AvailabilityZones,
    /// The `DISK` option.
    Disk,
    /// The `EXPERIMENTAL ARRANGEMENT COMPRESSION [[=] <enabled>]` option.
    ExperimentalArrangementCompression,
    /// The `INTROSPECTION INTERVAL [[=] <interval>]` option.
    IntrospectionInterval,
    /// The `INTROSPECTION DEBUGGING [[=] <enabled>]` option.
    IntrospectionDebugging,
    /// The `MANAGED` option.
    Managed,
    /// The `REPLICAS` option.
    Replicas,
    /// The `REPLICATION FACTOR` option.
    ReplicationFactor,
    /// The `SIZE` option.
    Size,
    /// The `SCHEDULE` option.
    Schedule,
    /// The `WORKLOAD CLASS` option.
    WorkloadClass,
}

impl AstDisplay for ClusterOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            ClusterOptionName::AutoScalingStrategy => f.write_str("AUTO SCALING STRATEGY"),
            ClusterOptionName::AvailabilityZones => f.write_str("AVAILABILITY ZONES"),
            ClusterOptionName::Disk => f.write_str("DISK"),
            ClusterOptionName::ExperimentalArrangementCompression => {
                f.write_str("EXPERIMENTAL ARRANGEMENT COMPRESSION")
            }
            ClusterOptionName::IntrospectionDebugging => f.write_str("INTROSPECTION DEBUGGING"),
            ClusterOptionName::IntrospectionInterval => f.write_str("INTROSPECTION INTERVAL"),
            ClusterOptionName::Managed => f.write_str("MANAGED"),
            ClusterOptionName::Replicas => f.write_str("REPLICAS"),
            ClusterOptionName::ReplicationFactor => f.write_str("REPLICATION FACTOR"),
            ClusterOptionName::Size => f.write_str("SIZE"),
            ClusterOptionName::Schedule => f.write_str("SCHEDULE"),
            ClusterOptionName::WorkloadClass => f.write_str("WORKLOAD CLASS"),
        }
    }
}

impl WithOptionName for ClusterOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            ClusterOptionName::AutoScalingStrategy
            | ClusterOptionName::AvailabilityZones
            | ClusterOptionName::Disk
            | ClusterOptionName::ExperimentalArrangementCompression
            | ClusterOptionName::IntrospectionDebugging
            | ClusterOptionName::IntrospectionInterval
            | ClusterOptionName::Managed
            | ClusterOptionName::Replicas
            | ClusterOptionName::ReplicationFactor
            | ClusterOptionName::Size
            | ClusterOptionName::Schedule
            | ClusterOptionName::WorkloadClass => false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
/// An option in a `CREATE CLUSTER` statement.
pub struct ClusterOption<T: AstInfo> {
    pub name: ClusterOptionName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(ClusterOption);

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum ClusterAlterUntilReadyOptionName {
    Timeout,
    OnTimeout,
}

impl AstDisplay for ClusterAlterUntilReadyOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            Self::Timeout => f.write_str("TIMEOUT"),
            Self::OnTimeout => f.write_str("ON TIMEOUT"),
        }
    }
}

impl WithOptionName for ClusterAlterUntilReadyOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            ClusterAlterUntilReadyOptionName::Timeout
            | ClusterAlterUntilReadyOptionName::OnTimeout => false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct ClusterAlterUntilReadyOption<T: AstInfo> {
    pub name: ClusterAlterUntilReadyOptionName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(ClusterAlterUntilReadyOption);

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum ClusterAlterOptionName {
    Wait,
}

impl AstDisplay for ClusterAlterOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            ClusterAlterOptionName::Wait => f.write_str("WAIT"),
        }
    }
}

impl WithOptionName for ClusterAlterOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            ClusterAlterOptionName::Wait => false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum ClusterAlterOptionValue<T: AstInfo> {
    For(Value),
    UntilReady(Vec<ClusterAlterUntilReadyOption<T>>),
}

impl<T: AstInfo> AstDisplay for ClusterAlterOptionValue<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            ClusterAlterOptionValue::For(duration) => {
                f.write_str("FOR ");
                f.write_node(duration);
            }
            ClusterAlterOptionValue::UntilReady(options) => {
                f.write_str("UNTIL READY (");
                f.write_node(&display::comma_separated(options));
                f.write_str(")");
            }
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
/// An option in a `ALTER CLUSTER... WITH` statement.
pub struct ClusterAlterOption<T: AstInfo> {
    pub name: ClusterAlterOptionName,
    pub value: Option<WithOptionValue<T>>,
}

impl_display_for_with_option!(ClusterAlterOption);

// Note: the `AstDisplay` implementation and `Parser::parse_` method for this
// enum are generated automatically by this crate's `build.rs`.
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum ClusterFeatureName {
    ReoptimizeImportedViews,
    EnableNewOuterJoinLowering,
    EnableEagerDeltaJoins,
    EnableVariadicLeftJoinLowering,
    EnableLetrecFixpointAnalysis,
    EnableJoinPrioritizeArranged,
    EnableProjectionPushdownAfterRelationCse,
    EnableUnionCancellationAfterRelationCse,
}

impl WithOptionName for ClusterFeatureName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            Self::ReoptimizeImportedViews
            | Self::EnableNewOuterJoinLowering
            | Self::EnableEagerDeltaJoins
            | Self::EnableVariadicLeftJoinLowering
            | Self::EnableLetrecFixpointAnalysis
            | Self::EnableJoinPrioritizeArranged
            | Self::EnableProjectionPushdownAfterRelationCse
            | Self::EnableUnionCancellationAfterRelationCse => false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ClusterFeature<T: AstInfo> {
    pub name: ClusterFeatureName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(ClusterFeature);

/// `CREATE CLUSTER ..`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateClusterStatement<T: AstInfo> {
    /// Name of the created cluster.
    pub name: Ident,
    /// The comma-separated options.
    pub options: Vec<ClusterOption<T>>,
    /// The comma-separated features enabled on the cluster.
    pub features: Vec<ClusterFeature<T>>,
    pub if_not_exists: bool,
}

impl<T: AstInfo> AstDisplay for CreateClusterStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CREATE CLUSTER ");
        if self.if_not_exists {
            f.write_str("IF NOT EXISTS ");
        }
        f.write_node(&self.name);
        if !self.options.is_empty() {
            f.write_str(" (");
            f.write_node(&display::comma_separated(&self.options));
            f.write_str(")");
        }
        if !self.features.is_empty() {
            f.write_str(" FEATURES (");
            f.write_node(&display::comma_separated(&self.features));
            f.write_str(")");
        }
    }
}
impl_display_t!(CreateClusterStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ReplicaDefinition<T: AstInfo> {
    /// Name of the created replica.
    pub name: Ident,
    /// The comma-separated options.
    pub options: Vec<ReplicaOption<T>>,
}

// Note that this display is meant for replicas defined inline when creating
// clusters.
impl<T: AstInfo> AstDisplay for ReplicaDefinition<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_node(&self.name);
        f.write_str(" (");
        f.write_node(&display::comma_separated(&self.options));
        f.write_str(")");
    }
}
impl_display_t!(ReplicaDefinition);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum AlterClusterAction<T: AstInfo> {
    SetOptions {
        options: Vec<ClusterOption<T>>,
        with_options: Vec<ClusterAlterOption<T>>,
    },
    ResetOptions(Vec<ClusterOptionName>),
}

/// `ALTER CLUSTER .. SET ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterClusterStatement<T: AstInfo> {
    /// The `IF EXISTS` option.
    pub if_exists: bool,
    /// Name of the altered cluster.
    pub name: Ident,
    /// The action.
    pub action: AlterClusterAction<T>,
}

impl<T: AstInfo> AstDisplay for AlterClusterStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ALTER CLUSTER ");
        if self.if_exists {
            f.write_str("IF EXISTS ");
        }
        f.write_node(&self.name);
        f.write_str(" ");
        match &self.action {
            AlterClusterAction::SetOptions {
                options,
                with_options,
            } => {
                f.write_str("SET (");
                f.write_node(&display::comma_separated(options));
                f.write_str(")");
                if !with_options.is_empty() {
                    f.write_str(" WITH (");
                    f.write_node(&display::comma_separated(with_options));
                    f.write_str(")");
                }
            }
            AlterClusterAction::ResetOptions(options) => {
                f.write_str("RESET (");
                f.write_node(&display::comma_separated(options));
                f.write_str(")");
            }
        }
    }
}
impl_display_t!(AlterClusterStatement);

/// `CREATE CLUSTER REPLICA ..`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CreateClusterReplicaStatement<T: AstInfo> {
    /// Name of the replica's cluster.
    pub of_cluster: Ident,
    /// The replica's definition.
    pub definition: ReplicaDefinition<T>,
    pub if_not_exists: bool,
}

impl<T: AstInfo> AstDisplay for CreateClusterReplicaStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CREATE CLUSTER REPLICA ");
        if self.if_not_exists {
            f.write_str("IF NOT EXISTS ");
        }
        f.write_node(&self.of_cluster);
        f.write_str(".");
        f.write_node(&self.definition.name);
        f.write_str(" (");
        f.write_node(&display::comma_separated(&self.definition.options));
        f.write_str(")");
    }
}
impl_display_t!(CreateClusterReplicaStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum ReplicaOptionName {
    /// The `BILLED AS [=] <value>` option.
    BilledAs,
    /// The `SIZE [[=] <size>]` option.
    Size,
    /// The `AVAILABILITY ZONE [[=] <id>]` option.
    AvailabilityZone,
    /// The `STORAGE ADDRESSES` option.
    StorageAddresses,
    /// The `STORAGECTL ADDRESSES` option.
    StoragectlAddresses,
    /// The `COMPUTECTL ADDRESSES` option.
    ComputectlAddresses,
    /// The `COMPUTE ADDRESSES` option.
    ComputeAddresses,
    /// The `WORKERS` option.
    Workers,
    /// The `INTERNAL` option.
    Internal,
    /// The `INTROSPECTION INTERVAL [[=] <interval>]` option.
    IntrospectionInterval,
    /// The `INTROSPECTION DEBUGGING [[=] <enabled>]` option.
    IntrospectionDebugging,
    /// The `DISK [[=] <enabled>]` option.
    Disk,
    /// The `EXPERIMENTAL ARRANGEMENT COMPRESSION [[=] <enabled>]` option.
    ExperimentalArrangementCompression,
}

impl AstDisplay for ReplicaOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            ReplicaOptionName::BilledAs => f.write_str("BILLED AS"),
            ReplicaOptionName::Size => f.write_str("SIZE"),
            ReplicaOptionName::AvailabilityZone => f.write_str("AVAILABILITY ZONE"),
            ReplicaOptionName::StorageAddresses => f.write_str("STORAGE ADDRESSES"),
            ReplicaOptionName::StoragectlAddresses => f.write_str("STORAGECTL ADDRESSES"),
            ReplicaOptionName::ComputectlAddresses => f.write_str("COMPUTECTL ADDRESSES"),
            ReplicaOptionName::ComputeAddresses => f.write_str("COMPUTE ADDRESSES"),
            ReplicaOptionName::Workers => f.write_str("WORKERS"),
            ReplicaOptionName::Internal => f.write_str("INTERNAL"),
            ReplicaOptionName::IntrospectionInterval => f.write_str("INTROSPECTION INTERVAL"),
            ReplicaOptionName::IntrospectionDebugging => f.write_str("INTROSPECTION DEBUGGING"),
            ReplicaOptionName::Disk => f.write_str("DISK"),
            ReplicaOptionName::ExperimentalArrangementCompression => {
                f.write_str("EXPERIMENTAL ARRANGEMENT COMPRESSION")
            }
        }
    }
}

impl WithOptionName for ReplicaOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            ReplicaOptionName::BilledAs
            | ReplicaOptionName::Size
            | ReplicaOptionName::AvailabilityZone
            | ReplicaOptionName::StorageAddresses
            | ReplicaOptionName::StoragectlAddresses
            | ReplicaOptionName::ComputectlAddresses
            | ReplicaOptionName::ComputeAddresses
            | ReplicaOptionName::Workers
            | ReplicaOptionName::Internal
            | ReplicaOptionName::IntrospectionInterval
            | ReplicaOptionName::IntrospectionDebugging
            | ReplicaOptionName::Disk
            | ReplicaOptionName::ExperimentalArrangementCompression => false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
/// An option in a `CREATE CLUSTER REPLICA` statement.
pub struct ReplicaOption<T: AstInfo> {
    pub name: ReplicaOptionName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(ReplicaOption);

/// `CREATE TYPE .. AS <TYPE>`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum CreateTypeAs<T: AstInfo> {
    List {
        options: Vec<CreateTypeListOption<T>>,
    },
    Map {
        options: Vec<CreateTypeMapOption<T>>,
    },
    Record {
        column_defs: Vec<ColumnDef<T>>,
    },
}

impl<T: AstInfo> AstDisplay for CreateTypeAs<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            CreateTypeAs::List { .. } => f.write_str("LIST "),
            CreateTypeAs::Map { .. } => f.write_str("MAP "),
            CreateTypeAs::Record { .. } => f.write_str("RECORD "),
        }
    }
}
impl_display_t!(CreateTypeAs);

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum CreateTypeListOptionName {
    ElementType,
}

impl AstDisplay for CreateTypeListOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str(match self {
            CreateTypeListOptionName::ElementType => "ELEMENT TYPE",
        })
    }
}

impl WithOptionName for CreateTypeListOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            CreateTypeListOptionName::ElementType => false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct CreateTypeListOption<T: AstInfo> {
    pub name: CreateTypeListOptionName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(CreateTypeListOption);

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum CreateTypeMapOptionName {
    KeyType,
    ValueType,
}

impl AstDisplay for CreateTypeMapOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str(match self {
            CreateTypeMapOptionName::KeyType => "KEY TYPE",
            CreateTypeMapOptionName::ValueType => "VALUE TYPE",
        })
    }
}

impl WithOptionName for CreateTypeMapOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            CreateTypeMapOptionName::KeyType | CreateTypeMapOptionName::ValueType => false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct CreateTypeMapOption<T: AstInfo> {
    pub name: CreateTypeMapOptionName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(CreateTypeMapOption);

/// `ALTER <OBJECT> ... OWNER TO`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterOwnerStatement<T: AstInfo> {
    pub object_type: ObjectType,
    pub if_exists: bool,
    pub name: UnresolvedObjectName,
    pub new_owner: T::RoleName,
}

impl<T: AstInfo> AstDisplay for AlterOwnerStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ALTER ");
        f.write_node(&self.object_type);
        f.write_str(" ");
        if self.if_exists {
            f.write_str("IF EXISTS ");
        }
        f.write_node(&self.name);
        f.write_str(" OWNER TO ");
        f.write_node(&self.new_owner);
    }
}
impl_display_t!(AlterOwnerStatement);

/// `ALTER <OBJECT> ... RENAME TO`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterObjectRenameStatement {
    pub object_type: ObjectType,
    pub if_exists: bool,
    pub name: UnresolvedObjectName,
    pub to_item_name: Ident,
}

impl AstDisplay for AlterObjectRenameStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ALTER ");
        f.write_node(&self.object_type);
        f.write_str(" ");
        if self.if_exists {
            f.write_str("IF EXISTS ");
        }
        f.write_node(&self.name);
        f.write_str(" RENAME TO ");
        f.write_node(&self.to_item_name);
    }
}
impl_display!(AlterObjectRenameStatement);

/// `ALTER <OBJECT> ... [RE]SET (RETAIN HISTORY [FOR ...])`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterRetainHistoryStatement<T: AstInfo> {
    pub object_type: ObjectType,
    pub if_exists: bool,
    pub name: UnresolvedObjectName,
    pub history: Option<WithOptionValue<T>>,
}

impl<T: AstInfo> AstDisplay for AlterRetainHistoryStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ALTER ");
        f.write_node(&self.object_type);
        f.write_str(" ");
        if self.if_exists {
            f.write_str("IF EXISTS ");
        }
        f.write_node(&self.name);
        if let Some(history) = &self.history {
            f.write_str(" SET (RETAIN HISTORY ");
            f.write_node(history);
        } else {
            f.write_str(" RESET (RETAIN HISTORY");
        }
        f.write_str(")");
    }
}
impl_display_t!(AlterRetainHistoryStatement);

/// `ALTER <OBJECT> SWAP ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterObjectSwapStatement {
    pub object_type: ObjectType,
    pub if_exists: bool,
    pub name_a: UnresolvedObjectName,
    pub name_b: Ident,
}

impl AstDisplay for AlterObjectSwapStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ALTER ");

        f.write_node(&self.object_type);
        f.write_str(" ");
        if self.if_exists {
            f.write_str("IF EXISTS ");
        }
        f.write_node(&self.name_a);

        f.write_str(" SWAP WITH ");
        f.write_node(&self.name_b);
    }
}
impl_display!(AlterObjectSwapStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum AlterIndexAction<T: AstInfo> {
    SetOptions(Vec<IndexOption<T>>),
    ResetOptions(Vec<IndexOptionName>),
}

/// `ALTER INDEX ... {RESET, SET}`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterIndexStatement<T: AstInfo> {
    pub index_name: UnresolvedItemName,
    pub if_exists: bool,
    pub action: AlterIndexAction<T>,
}

impl<T: AstInfo> AstDisplay for AlterIndexStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ALTER INDEX ");
        if self.if_exists {
            f.write_str("IF EXISTS ");
        }
        f.write_node(&self.index_name);
        f.write_str(" ");

        match &self.action {
            AlterIndexAction::SetOptions(options) => {
                f.write_str("SET (");
                f.write_node(&display::comma_separated(options));
                f.write_str(")");
            }
            AlterIndexAction::ResetOptions(options) => {
                f.write_str("RESET (");
                f.write_node(&display::comma_separated(options));
                f.write_str(")");
            }
        }
    }
}

impl_display_t!(AlterIndexStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum AlterSinkAction<T: AstInfo> {
    SetOptions(Vec<CreateSinkOption<T>>),
    ResetOptions(Vec<CreateSinkOptionName>),
    ChangeRelation(T::ItemName),
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterSinkStatement<T: AstInfo> {
    pub sink_name: UnresolvedItemName,
    pub if_exists: bool,
    pub action: AlterSinkAction<T>,
}

impl<T: AstInfo> AstDisplay for AlterSinkStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ALTER SINK ");
        if self.if_exists {
            f.write_str("IF EXISTS ");
        }
        f.write_node(&self.sink_name);
        f.write_str(" ");

        match &self.action {
            AlterSinkAction::ChangeRelation(from) => {
                f.write_str("SET FROM ");
                f.write_node(from);
            }
            AlterSinkAction::SetOptions(options) => {
                f.write_str("SET (");
                f.write_node(&display::comma_separated(options));
                f.write_str(")");
            }
            AlterSinkAction::ResetOptions(options) => {
                f.write_str("RESET (");
                f.write_node(&display::comma_separated(options));
                f.write_str(")");
            }
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum AlterSourceAddSubsourceOptionName {
    /// Columns whose types you want to unconditionally format as text
    TextColumns,
    /// Columns you want to ignore when ingesting data
    ExcludeColumns,
    /// Updated `DETAILS` for an ingestion, e.g.
    /// [`crate::ast::PgConfigOptionName::Details`]
    /// or
    /// [`crate::ast::MySqlConfigOptionName::Details`].
    Details,
}

impl AstDisplay for AlterSourceAddSubsourceOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str(match self {
            AlterSourceAddSubsourceOptionName::TextColumns => "TEXT COLUMNS",
            AlterSourceAddSubsourceOptionName::ExcludeColumns => "EXCLUDE COLUMNS",
            AlterSourceAddSubsourceOptionName::Details => "DETAILS",
        })
    }
}
impl_display!(AlterSourceAddSubsourceOptionName);

impl WithOptionName for AlterSourceAddSubsourceOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            AlterSourceAddSubsourceOptionName::Details
            | AlterSourceAddSubsourceOptionName::TextColumns
            | AlterSourceAddSubsourceOptionName::ExcludeColumns => false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
/// An option in an `ALTER SOURCE...ADD SUBSOURCE` statement.
pub struct AlterSourceAddSubsourceOption<T: AstInfo> {
    pub name: AlterSourceAddSubsourceOptionName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(AlterSourceAddSubsourceOption);
impl_display_t!(AlterSourceAddSubsourceOption);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum AlterSourceAction<T: AstInfo> {
    SetOptions(Vec<CreateSourceOption<T>>),
    ResetOptions(Vec<CreateSourceOptionName>),
    AddSubsources {
        external_references: Vec<ExternalReferenceExport>,
        options: Vec<AlterSourceAddSubsourceOption<T>>,
    },
    DropSubsources {
        if_exists: bool,
        cascade: bool,
        names: Vec<UnresolvedItemName>,
    },
    RefreshReferences,
}

impl<T: AstInfo> AstDisplay for AlterSourceAction<T> {
    fn fmt<W>(&self, f: &mut AstFormatter<W>)
    where
        W: fmt::Write,
    {
        match &self {
            AlterSourceAction::SetOptions(options) => {
                f.write_str("SET (");
                f.write_node(&display::comma_separated(options));
                f.write_str(")");
            }
            AlterSourceAction::ResetOptions(options) => {
                f.write_str("RESET (");
                f.write_node(&display::comma_separated(options));
                f.write_str(")");
            }
            AlterSourceAction::DropSubsources {
                if_exists,
                cascade,
                names,
            } => {
                f.write_str("DROP SUBSOURCE ");
                if *if_exists {
                    f.write_str("IF EXISTS ");
                }

                f.write_node(&display::comma_separated(names));

                if *cascade {
                    f.write_str(" CASCADE");
                }
            }
            AlterSourceAction::AddSubsources {
                external_references: subsources,
                options,
            } => {
                f.write_str("ADD SUBSOURCE ");

                f.write_node(&display::comma_separated(subsources));

                if !options.is_empty() {
                    f.write_str(" WITH (");
                    f.write_node(&display::comma_separated(options));
                    f.write_str(")");
                }
            }
            AlterSourceAction::RefreshReferences => {
                f.write_str("REFRESH REFERENCES");
            }
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterSourceStatement<T: AstInfo> {
    pub source_name: UnresolvedItemName,
    pub if_exists: bool,
    pub action: AlterSourceAction<T>,
}

impl<T: AstInfo> AstDisplay for AlterSourceStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ALTER SOURCE ");
        if self.if_exists {
            f.write_str("IF EXISTS ");
        }
        f.write_node(&self.source_name);
        f.write_str(" ");
        f.write_node(&self.action)
    }
}

impl_display_t!(AlterSourceStatement);

/// `ALTER SECRET ... AS`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterSecretStatement<T: AstInfo> {
    pub name: UnresolvedItemName,
    pub if_exists: bool,
    pub value: Expr<T>,
}

impl<T: AstInfo> AstDisplay for AlterSecretStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ALTER SECRET ");
        if self.if_exists {
            f.write_str("IF EXISTS ");
        }
        f.write_node(&self.name);
        f.write_str(" AS ");

        if f.redacted() {
            f.write_str("'<REDACTED>'");
        } else {
            f.write_node(&self.value);
        }
    }
}

impl_display_t!(AlterSecretStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum AlterConnectionAction<T: AstInfo> {
    RotateKeys,
    SetOption(ConnectionOption<T>),
    DropOption(ConnectionOptionName),
}

impl<T: AstInfo> AstDisplay for AlterConnectionAction<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            AlterConnectionAction::RotateKeys => f.write_str("ROTATE KEYS"),
            AlterConnectionAction::SetOption(option) => {
                f.write_str("SET (");
                f.write_node(option);
                f.write_str(")");
            }
            AlterConnectionAction::DropOption(option) => {
                f.write_str("DROP (");
                f.write_node(option);
                f.write_str(")");
            }
        }
    }
}
impl_display_t!(AlterConnectionAction);

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum AlterConnectionOptionName {
    Validate,
}

impl AstDisplay for AlterConnectionOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str(match self {
            AlterConnectionOptionName::Validate => "VALIDATE",
        })
    }
}
impl_display!(AlterConnectionOptionName);

impl WithOptionName for AlterConnectionOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            AlterConnectionOptionName::Validate => false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
/// An option in an `ALTER CONNECTION...` statement.
pub struct AlterConnectionOption<T: AstInfo> {
    pub name: AlterConnectionOptionName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(AlterConnectionOption);
impl_display_t!(AlterConnectionOption);

/// `ALTER CONNECTION`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterConnectionStatement<T: AstInfo> {
    pub name: UnresolvedItemName,
    pub if_exists: bool,
    pub actions: Vec<AlterConnectionAction<T>>,
    pub with_options: Vec<AlterConnectionOption<T>>,
}

impl<T: AstInfo> AstDisplay for AlterConnectionStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ALTER CONNECTION ");
        if self.if_exists {
            f.write_str("IF EXISTS ");
        }
        f.write_node(&self.name);
        f.write_str(" ");
        f.write_node(&display::comma_separated(&self.actions));

        if !self.with_options.is_empty() {
            f.write_str(" WITH (");
            f.write_node(&display::comma_separated(&self.with_options));
            f.write_str(")");
        }
    }
}

impl_display_t!(AlterConnectionStatement);

/// `ALTER ROLE`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterRoleStatement<T: AstInfo> {
    /// The specified role.
    pub name: T::RoleName,
    /// Alterations we're making to the role.
    pub option: AlterRoleOption,
}

impl<T: AstInfo> AstDisplay for AlterRoleStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ALTER ROLE ");
        f.write_node(&self.name);
        f.write_node(&self.option);
    }
}
impl_display_t!(AlterRoleStatement);

/// `ALTER ROLE ... [ WITH | SET ] ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum AlterRoleOption {
    /// Any options that were attached, in the order they were presented.
    Attributes(Vec<RoleAttribute>),
    /// A variable that we want to provide a default value for this role.
    Variable(SetRoleVar),
}

impl AstDisplay for AlterRoleOption {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            AlterRoleOption::Attributes(attrs) => {
                for attr in attrs {
                    f.write_str(" ");
                    attr.fmt(f)
                }
            }
            AlterRoleOption::Variable(var) => {
                f.write_str(" ");
                f.write_node(var);
            }
        }
    }
}
impl_display!(AlterRoleOption);

/// `ALTER TABLE ... ADD COLUMN ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterTableAddColumnStatement<T: AstInfo> {
    pub if_exists: bool,
    pub name: UnresolvedItemName,
    pub if_col_not_exist: bool,
    pub column_name: Ident,
    pub data_type: T::DataType,
}

impl<T: AstInfo> AstDisplay for AlterTableAddColumnStatement<T> {
    fn fmt<W>(&self, f: &mut AstFormatter<W>)
    where
        W: fmt::Write,
    {
        f.write_str("ALTER TABLE ");
        if self.if_exists {
            f.write_str("IF EXISTS ");
        }
        f.write_node(&self.name);

        f.write_str(" ADD COLUMN ");
        if self.if_col_not_exist {
            f.write_str("IF NOT EXISTS ");
        }

        f.write_node(&self.column_name);
        f.write_str(" ");
        f.write_node(&self.data_type);
    }
}

impl_display_t!(AlterTableAddColumnStatement);

/// `ALTER MATERIALIZED VIEW ... APPLY REPLACEMENT ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterMaterializedViewApplyReplacementStatement {
    pub if_exists: bool,
    pub name: UnresolvedItemName,
    pub replacement_name: UnresolvedItemName,
}

impl AstDisplay for AlterMaterializedViewApplyReplacementStatement {
    fn fmt<W>(&self, f: &mut AstFormatter<W>)
    where
        W: fmt::Write,
    {
        f.write_str("ALTER MATERIALIZED VIEW ");
        if self.if_exists {
            f.write_str("IF EXISTS ");
        }
        f.write_node(&self.name);

        f.write_str(" APPLY REPLACEMENT ");
        f.write_node(&self.replacement_name);
    }
}

impl_display!(AlterMaterializedViewApplyReplacementStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct DiscardStatement {
    pub target: DiscardTarget,
}

impl AstDisplay for DiscardStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("DISCARD ");
        f.write_node(&self.target);
    }
}
impl_display!(DiscardStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum DiscardTarget {
    Plans,
    Sequences,
    Temp,
    All,
}

impl AstDisplay for DiscardTarget {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            DiscardTarget::Plans => f.write_str("PLANS"),
            DiscardTarget::Sequences => f.write_str("SEQUENCES"),
            DiscardTarget::Temp => f.write_str("TEMP"),
            DiscardTarget::All => f.write_str("ALL"),
        }
    }
}
impl_display!(DiscardTarget);

/// `DROP`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct DropObjectsStatement {
    /// The type of the object to drop: TABLE, VIEW, etc.
    pub object_type: ObjectType,
    /// An optional `IF EXISTS` clause. (Non-standard.)
    pub if_exists: bool,
    /// One or more objects to drop. (ANSI SQL requires exactly one.)
    pub names: Vec<UnresolvedObjectName>,
    /// Whether `CASCADE` was specified. This will be `false` when
    /// `RESTRICT` was specified.
    pub cascade: bool,
}

impl AstDisplay for DropObjectsStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("DROP ");
        f.write_node(&self.object_type);
        f.write_str(" ");
        if self.if_exists {
            f.write_str("IF EXISTS ");
        }
        f.write_node(&display::comma_separated(&self.names));
        if self.cascade && self.object_type != ObjectType::Database {
            f.write_str(" CASCADE");
        } else if !self.cascade && self.object_type == ObjectType::Database {
            f.write_str(" RESTRICT");
        }
    }
}
impl_display!(DropObjectsStatement);

/// `DROP OWNED BY ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct DropOwnedStatement<T: AstInfo> {
    /// The roles whose owned objects are being dropped.
    pub role_names: Vec<T::RoleName>,
    /// Whether `CASCADE` was specified. `false` for `RESTRICT` and `None` if no drop behavior at
    /// all was specified.
    pub cascade: Option<bool>,
}

impl<T: AstInfo> DropOwnedStatement<T> {
    pub fn cascade(&self) -> bool {
        self.cascade == Some(true)
    }
}

impl<T: AstInfo> AstDisplay for DropOwnedStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("DROP OWNED BY ");
        f.write_node(&display::comma_separated(&self.role_names));
        if let Some(true) = self.cascade {
            f.write_str(" CASCADE");
        } else if let Some(false) = self.cascade {
            f.write_str(" RESTRICT");
        }
    }
}
impl_display_t!(DropOwnedStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct QualifiedReplica {
    pub cluster: Ident,
    pub replica: Ident,
}

impl AstDisplay for QualifiedReplica {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_node(&self.cluster);
        f.write_str(".");
        f.write_node(&self.replica);
    }
}
impl_display!(QualifiedReplica);

/// `SET <variable>`
///
/// Note: this is not a standard SQL statement, but it is supported by at
/// least MySQL and PostgreSQL. Not all MySQL-specific syntactic forms are
/// supported yet.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct SetVariableStatement {
    pub local: bool,
    pub variable: Ident,
    pub to: SetVariableTo,
}

impl AstDisplay for SetVariableStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("SET ");
        if self.local {
            f.write_str("LOCAL ");
        }
        f.write_node(&self.variable);
        f.write_str(" = ");
        f.write_node(&self.to);
    }
}
impl_display!(SetVariableStatement);

/// `RESET <variable>`
///
/// Note: this is not a standard SQL statement, but it is supported by at
/// least MySQL and PostgreSQL. Not all syntactic forms are supported yet.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ResetVariableStatement {
    pub variable: Ident,
}

impl AstDisplay for ResetVariableStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("RESET ");
        f.write_node(&self.variable);
    }
}
impl_display!(ResetVariableStatement);

/// `SHOW <variable>`
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ShowVariableStatement {
    pub variable: Ident,
}

impl AstDisplay for ShowVariableStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("SHOW ");
        f.write_node(&self.variable);
    }
}
impl_display!(ShowVariableStatement);

/// `INSPECT SHARD <id>`
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct InspectShardStatement {
    pub id: String,
}

impl AstDisplay for InspectShardStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("INSPECT SHARD ");
        f.write_str("'");
        f.write_node(&display::escape_single_quote_string(&self.id));
        f.write_str("'");
    }
}
impl_display!(InspectShardStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum ShowObjectType<T: AstInfo> {
    MaterializedView {
        in_cluster: Option<T::ClusterName>,
    },
    Index {
        in_cluster: Option<T::ClusterName>,
        on_object: Option<T::ItemName>,
    },
    Table {
        on_source: Option<T::ItemName>,
    },
    View,
    Source {
        in_cluster: Option<T::ClusterName>,
    },
    Sink {
        in_cluster: Option<T::ClusterName>,
    },
    MetricSink {
        in_cluster: Option<T::ClusterName>,
    },
    Type,
    Role,
    Cluster,
    ClusterReplica,
    Object,
    Secret,
    Connection,
    Database,
    Schema {
        from: Option<T::DatabaseName>,
    },
    Subsource {
        on_source: Option<T::ItemName>,
    },
    Privileges {
        object_type: Option<SystemObjectType>,
        role: Option<T::RoleName>,
    },
    DefaultPrivileges {
        object_type: Option<ObjectType>,
        role: Option<T::RoleName>,
    },
    RoleMembership {
        role: Option<T::RoleName>,
    },
    NetworkPolicy,
}
/// `SHOW <object>S`
///
/// ```sql
/// SHOW TABLES;
/// SHOW SOURCES;
/// SHOW VIEWS;
/// SHOW SINKS;
/// ```
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ShowObjectsStatement<T: AstInfo> {
    pub object_type: ShowObjectType<T>,
    pub from: Option<T::SchemaName>,
    pub filter: Option<ShowStatementFilter<T>>,
}

impl<T: AstInfo> AstDisplay for ShowObjectsStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("SHOW");
        f.write_str(" ");

        f.write_str(match &self.object_type {
            ShowObjectType::Table { .. } => "TABLES",
            ShowObjectType::View => "VIEWS",
            ShowObjectType::Source { .. } => "SOURCES",
            ShowObjectType::Sink { .. } => "SINKS",
            ShowObjectType::MetricSink { .. } => "METRIC SINKS",
            ShowObjectType::Type => "TYPES",
            ShowObjectType::Role => "ROLES",
            ShowObjectType::Cluster => "CLUSTERS",
            ShowObjectType::ClusterReplica => "CLUSTER REPLICAS",
            ShowObjectType::Object => "OBJECTS",
            ShowObjectType::Secret => "SECRETS",
            ShowObjectType::Connection => "CONNECTIONS",
            ShowObjectType::MaterializedView { .. } => "MATERIALIZED VIEWS",
            ShowObjectType::Index { .. } => "INDEXES",
            ShowObjectType::Database => "DATABASES",
            ShowObjectType::Schema { .. } => "SCHEMAS",
            ShowObjectType::Subsource { .. } => "SUBSOURCES",
            ShowObjectType::Privileges { .. } => "PRIVILEGES",
            ShowObjectType::DefaultPrivileges { .. } => "DEFAULT PRIVILEGES",
            ShowObjectType::RoleMembership { .. } => "ROLE MEMBERSHIP",
            ShowObjectType::NetworkPolicy => "NETWORK POLICIES",
        });

        if let ShowObjectType::Index { on_object, .. } = &self.object_type {
            if let Some(on_object) = on_object {
                f.write_str(" ON ");
                f.write_node(on_object);
            }
        }

        if let ShowObjectType::Schema { from: Some(from) } = &self.object_type {
            f.write_str(" FROM ");
            f.write_node(from);
        }

        if let Some(from) = &self.from {
            f.write_str(" FROM ");
            f.write_node(from);
        }

        // append IN CLUSTER clause
        match &self.object_type {
            ShowObjectType::MaterializedView { in_cluster }
            | ShowObjectType::Index { in_cluster, .. }
            | ShowObjectType::Sink { in_cluster }
            | ShowObjectType::MetricSink { in_cluster }
            | ShowObjectType::Source { in_cluster } => {
                if let Some(cluster) = in_cluster {
                    f.write_str(" IN CLUSTER ");
                    f.write_node(cluster);
                }
            }
            _ => (),
        }

        if let ShowObjectType::Subsource { on_source } = &self.object_type {
            if let Some(on_source) = on_source {
                f.write_str(" ON ");
                f.write_node(on_source);
            }
        }

        if let ShowObjectType::Table { on_source } = &self.object_type {
            if let Some(on_source) = on_source {
                f.write_str(" ON ");
                f.write_node(on_source);
            }
        }

        if let ShowObjectType::Privileges { object_type, role } = &self.object_type {
            if let Some(object_type) = object_type {
                f.write_str(" ON ");
                f.write_node(object_type);
                if let SystemObjectType::Object(_) = object_type {
                    f.write_str("S");
                }
            }
            if let Some(role) = role {
                f.write_str(" FOR ");
                f.write_node(role);
            }
        }

        if let ShowObjectType::DefaultPrivileges { object_type, role } = &self.object_type {
            if let Some(object_type) = object_type {
                f.write_str(" ON ");
                f.write_node(object_type);
                f.write_str("S");
            }
            if let Some(role) = role {
                f.write_str(" FOR ");
                f.write_node(role);
            }
        }

        if let ShowObjectType::RoleMembership {
            role: Some(role), ..
        } = &self.object_type
        {
            f.write_str(" FOR ");
            f.write_node(role);
        }

        if let Some(filter) = &self.filter {
            f.write_str(" ");
            f.write_node(filter);
        }
    }
}
impl_display_t!(ShowObjectsStatement);

/// `SHOW COLUMNS`
///
/// Note: this is a MySQL-specific statement.
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ShowColumnsStatement<T: AstInfo> {
    pub table_name: T::ItemName,
    pub filter: Option<ShowStatementFilter<T>>,
}

impl<T: AstInfo> AstDisplay for ShowColumnsStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("SHOW ");
        f.write_str("COLUMNS FROM ");
        f.write_node(&self.table_name);
        if let Some(filter) = &self.filter {
            f.write_str(" ");
            f.write_node(filter);
        }
    }
}
impl_display_t!(ShowColumnsStatement);

/// `SHOW [REDACTED] CREATE VIEW <view>`
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ShowCreateViewStatement<T: AstInfo> {
    pub view_name: T::ItemName,
    pub redacted: bool,
}

impl<T: AstInfo> AstDisplay for ShowCreateViewStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("SHOW ");
        if self.redacted {
            f.write_str("REDACTED ");
        }
        f.write_str("CREATE VIEW ");
        f.write_node(&self.view_name);
    }
}
impl_display_t!(ShowCreateViewStatement);

/// `SHOW [REDACTED] CREATE MATERIALIZED VIEW <name>`
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ShowCreateMaterializedViewStatement<T: AstInfo> {
    pub materialized_view_name: T::ItemName,
    pub redacted: bool,
}

impl<T: AstInfo> AstDisplay for ShowCreateMaterializedViewStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("SHOW ");
        if self.redacted {
            f.write_str("REDACTED ");
        }
        f.write_str("CREATE MATERIALIZED VIEW ");
        f.write_node(&self.materialized_view_name);
    }
}
impl_display_t!(ShowCreateMaterializedViewStatement);

/// `SHOW [REDACTED] CREATE SOURCE <source>`
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ShowCreateSourceStatement<T: AstInfo> {
    pub source_name: T::ItemName,
    pub redacted: bool,
}

impl<T: AstInfo> AstDisplay for ShowCreateSourceStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("SHOW ");
        if self.redacted {
            f.write_str("REDACTED ");
        }
        f.write_str("CREATE SOURCE ");
        f.write_node(&self.source_name);
    }
}
impl_display_t!(ShowCreateSourceStatement);

/// `SHOW [REDACTED] CREATE TABLE <table>`
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ShowCreateTableStatement<T: AstInfo> {
    pub table_name: T::ItemName,
    pub redacted: bool,
}

impl<T: AstInfo> AstDisplay for ShowCreateTableStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("SHOW ");
        if self.redacted {
            f.write_str("REDACTED ");
        }
        f.write_str("CREATE TABLE ");
        f.write_node(&self.table_name);
    }
}
impl_display_t!(ShowCreateTableStatement);

/// `SHOW [REDACTED] CREATE SINK <sink>`
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ShowCreateSinkStatement<T: AstInfo> {
    pub sink_name: T::ItemName,
    pub redacted: bool,
}

impl<T: AstInfo> AstDisplay for ShowCreateSinkStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("SHOW ");
        if self.redacted {
            f.write_str("REDACTED ");
        }
        f.write_str("CREATE SINK ");
        f.write_node(&self.sink_name);
    }
}
impl_display_t!(ShowCreateSinkStatement);

/// `SHOW [REDACTED] CREATE METRIC SINK <sink>`
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ShowCreateMetricSinkStatement<T: AstInfo> {
    pub metric_sink_name: T::ItemName,
    pub redacted: bool,
}

impl<T: AstInfo> AstDisplay for ShowCreateMetricSinkStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("SHOW ");
        if self.redacted {
            f.write_str("REDACTED ");
        }
        f.write_str("CREATE METRIC SINK ");
        f.write_node(&self.metric_sink_name);
    }
}
impl_display_t!(ShowCreateMetricSinkStatement);

/// `SHOW [REDACTED] CREATE INDEX <index>`
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ShowCreateIndexStatement<T: AstInfo> {
    pub index_name: T::ItemName,
    pub redacted: bool,
}

impl<T: AstInfo> AstDisplay for ShowCreateIndexStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("SHOW ");
        if self.redacted {
            f.write_str("REDACTED ");
        }
        f.write_str("CREATE INDEX ");
        f.write_node(&self.index_name);
    }
}
impl_display_t!(ShowCreateIndexStatement);

/// `SHOW [REDACTED] CREATE CONNECTION <connection>`
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ShowCreateConnectionStatement<T: AstInfo> {
    pub connection_name: T::ItemName,
    pub redacted: bool,
}

impl<T: AstInfo> AstDisplay for ShowCreateConnectionStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("SHOW ");
        if self.redacted {
            f.write_str("REDACTED ");
        }
        f.write_str("CREATE CONNECTION ");
        f.write_node(&self.connection_name);
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ShowCreateClusterStatement<T: AstInfo> {
    pub cluster_name: T::ClusterName,
}

impl<T: AstInfo> AstDisplay for ShowCreateClusterStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("SHOW CREATE CLUSTER ");
        f.write_node(&self.cluster_name);
    }
}

/// `{ BEGIN [ TRANSACTION | WORK ] | START TRANSACTION } ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct StartTransactionStatement {
    pub modes: Vec<TransactionMode>,
}

impl AstDisplay for StartTransactionStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("START TRANSACTION");
        if !self.modes.is_empty() {
            f.write_str(" ");
            f.write_node(&display::comma_separated(&self.modes));
        }
    }
}
impl_display!(StartTransactionStatement);

/// `SHOW [REDACTED] CREATE TYPE <type>`
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ShowCreateTypeStatement<T: AstInfo> {
    pub type_name: T::DataType,
    pub redacted: bool,
}

impl<T: AstInfo> AstDisplay for ShowCreateTypeStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("SHOW ");
        if self.redacted {
            f.write_str("REDACTED ");
        }
        f.write_str("CREATE TYPE ");
        f.write_node(&self.type_name);
    }
}

/// `SET TRANSACTION ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct SetTransactionStatement {
    pub local: bool,
    pub modes: Vec<TransactionMode>,
}

impl AstDisplay for SetTransactionStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("SET ");
        if !self.local {
            f.write_str("SESSION CHARACTERISTICS AS ");
        }
        f.write_str("TRANSACTION");
        if !self.modes.is_empty() {
            f.write_str(" ");
            f.write_node(&display::comma_separated(&self.modes));
        }
    }
}
impl_display!(SetTransactionStatement);

/// `COMMIT [ TRANSACTION | WORK ] [ AND [ NO ] CHAIN ]`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CommitStatement {
    pub chain: bool,
}

impl AstDisplay for CommitStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("COMMIT");
        if self.chain {
            f.write_str(" AND CHAIN");
        }
    }
}
impl_display!(CommitStatement);

/// `ROLLBACK [ TRANSACTION | WORK ] [ AND [ NO ] CHAIN ]`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct RollbackStatement {
    pub chain: bool,
}

impl AstDisplay for RollbackStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ROLLBACK");
        if self.chain {
            f.write_str(" AND CHAIN");
        }
    }
}
impl_display!(RollbackStatement);

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum SubscribeOptionName {
    Snapshot,
    Progress,
}

impl AstDisplay for SubscribeOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            SubscribeOptionName::Snapshot => f.write_str("SNAPSHOT"),
            SubscribeOptionName::Progress => f.write_str("PROGRESS"),
        }
    }
}
impl_display!(SubscribeOptionName);

impl WithOptionName for SubscribeOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            SubscribeOptionName::Snapshot | SubscribeOptionName::Progress => false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct SubscribeOption<T: AstInfo> {
    pub name: SubscribeOptionName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(SubscribeOption);
impl_display_t!(SubscribeOption);

/// `SUBSCRIBE`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct SubscribeStatement<T: AstInfo> {
    pub relation: SubscribeRelation<T>,
    pub options: Vec<SubscribeOption<T>>,
    pub as_of: Option<AsOf<T>>,
    pub up_to: Option<Expr<T>>,
    pub output: SubscribeOutput<T>,
}

impl<T: AstInfo> AstDisplay for SubscribeStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("SUBSCRIBE ");
        if self.relation.needs_explicit_to(f.simple()) {
            // Without the optional `TO` keyword, a relation whose first name
            // component is the bare keyword `to` (e.g. `SUBSCRIBE TO to`) would
            // display as `SUBSCRIBE to`, which re-parses with `to` consumed as
            // the optional keyword, dropping the relation name.
            f.write_str("TO ");
        }
        f.write_node(&self.relation);
        if !self.options.is_empty() {
            f.write_str(" WITH (");
            f.write_node(&display::comma_separated(&self.options));
            f.write_str(")");
        }
        if let Some(as_of) = &self.as_of {
            f.write_str(" ");
            f.write_node(as_of);
        }
        if let Some(up_to) = &self.up_to {
            f.write_str(" UP TO ");
            f.write_node(up_to);
        }
        f.write_str(&self.output);
    }
}
impl_display_t!(SubscribeStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum SubscribeRelation<T: AstInfo> {
    Name(T::ItemName),
    Query(Query<T>),
}

impl<T: AstInfo> SubscribeRelation<T> {
    /// Reports whether printing this relation after `SUBSCRIBE` requires the
    /// optional `TO` keyword to avoid reparsing the first name component as that
    /// keyword instead of as part of the relation name.
    pub fn needs_explicit_to(&self, bare_identifiers: bool) -> bool {
        let SubscribeRelation::Name(name) = self else {
            return false;
        };
        bare_identifiers && name_starts_with_bare_to(&name.to_ast_string_simple())
    }
}

fn name_starts_with_bare_to(name: &str) -> bool {
    let Some(rest) = name.strip_prefix("to") else {
        return false;
    };
    rest.is_empty() || rest.starts_with('.')
}

impl<T: AstInfo> AstDisplay for SubscribeRelation<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            SubscribeRelation::Name(name) => f.write_node(name),
            SubscribeRelation::Query(query) => {
                f.write_str("(");
                f.write_node(query);
                f.write_str(")");
            }
        }
    }
}
impl_display_t!(SubscribeRelation);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ExplainPlanStatement<T: AstInfo> {
    pub stage: Option<ExplainStage>,
    pub with_options: Vec<ExplainPlanOption<T>>,
    pub format: Option<ExplainFormat>,
    pub explainee: Explainee<T>,
}

impl<T: AstInfo> ExplainPlanStatement<T> {
    pub fn stage(&self) -> ExplainStage {
        self.stage.unwrap_or(ExplainStage::PhysicalPlan)
    }

    pub fn format(&self) -> ExplainFormat {
        self.format.unwrap_or(ExplainFormat::Text)
    }
}

impl<T: AstInfo> AstDisplay for ExplainPlanStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("EXPLAIN");
        if let Some(stage) = &self.stage {
            f.write_str(" ");
            f.write_node(stage);
        }
        if !self.with_options.is_empty() {
            f.write_str(" WITH (");
            f.write_node(&display::comma_separated(&self.with_options));
            f.write_str(")");
        }
        if let Some(format) = &self.format {
            f.write_str(" AS ");
            f.write_node(format);
        }
        if self.stage.is_some() {
            f.write_str(" FOR");
        }
        f.write_str(" ");
        f.write_node(&self.explainee);
    }
}
impl_display_t!(ExplainPlanStatement);

// Note: the `AstDisplay` implementation and `Parser::parse_` method for this
// enum are generated automatically by this crate's `build.rs`.
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum ExplainPlanOptionName {
    Arity,
    Cardinality,
    ColumnNames,
    FilterPushdown,
    HumanizedExpressions,
    JoinImplementations,
    Keys,
    LinearChains,
    NonNegative,
    NoFastPath,
    NoNotices,
    NodeIdentifiers,
    RawPlans,
    RawSyntax,
    Raw, // Listed after the `Raw~` variants to keep the parser happy!
    Redacted,
    SubtreeSize,
    Timing,
    Types,
    Equivalences,
    ReoptimizeImportedViews,
    EnableNewOuterJoinLowering,
    EnableEagerDeltaJoins,
    EnableVariadicLeftJoinLowering,
    EnableLetrecFixpointAnalysis,
    EnableJoinPrioritizeArranged,
    EnableProjectionPushdownAfterRelationCse,
    EnableFixedCorrelatedCteLowering,
    EnableUnionCancellationAfterRelationCse,
}

impl WithOptionName for ExplainPlanOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            Self::Arity
            | Self::Cardinality
            | Self::ColumnNames
            | Self::FilterPushdown
            | Self::HumanizedExpressions
            | Self::JoinImplementations
            | Self::Keys
            | Self::LinearChains
            | Self::NonNegative
            | Self::NoFastPath
            | Self::NoNotices
            | Self::NodeIdentifiers
            | Self::RawPlans
            | Self::RawSyntax
            | Self::Raw
            | Self::Redacted
            | Self::SubtreeSize
            | Self::Timing
            | Self::Types
            | Self::Equivalences
            | Self::ReoptimizeImportedViews
            | Self::EnableNewOuterJoinLowering
            | Self::EnableEagerDeltaJoins
            | Self::EnableVariadicLeftJoinLowering
            | Self::EnableLetrecFixpointAnalysis
            | Self::EnableJoinPrioritizeArranged
            | Self::EnableProjectionPushdownAfterRelationCse
            | Self::EnableFixedCorrelatedCteLowering
            | Self::EnableUnionCancellationAfterRelationCse => false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ExplainPlanOption<T: AstInfo> {
    pub name: ExplainPlanOptionName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(ExplainPlanOption);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum ExplainSinkSchemaFor {
    Key,
    Value,
}
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ExplainSinkSchemaStatement<T: AstInfo> {
    pub schema_for: ExplainSinkSchemaFor,
    pub format: Option<ExplainFormat>,
    pub statement: CreateSinkStatement<T>,
}

impl<T: AstInfo> AstDisplay for ExplainSinkSchemaStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("EXPLAIN ");
        match &self.schema_for {
            ExplainSinkSchemaFor::Key => f.write_str("KEY"),
            ExplainSinkSchemaFor::Value => f.write_str("VALUE"),
        }
        f.write_str(" SCHEMA");
        if let Some(format) = &self.format {
            f.write_str(" AS ");
            f.write_node(format);
        }
        f.write_str(" FOR ");
        f.write_node(&self.statement);
    }
}
impl_display_t!(ExplainSinkSchemaStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ExplainPushdownStatement<T: AstInfo> {
    pub explainee: Explainee<T>,
}

impl<T: AstInfo> AstDisplay for ExplainPushdownStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("EXPLAIN FILTER PUSHDOWN FOR ");
        f.write_node(&self.explainee);
    }
}
impl_display_t!(ExplainPushdownStatement);

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum ExplainAnalyzeComputationProperty {
    Cpu,
    Memory,
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum ExplainAnalyzeProperty {
    Computation(ExplainAnalyzeComputationProperties),
    Hints,
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ExplainAnalyzeComputationProperties {
    /// Must be non-empty.
    pub properties: Vec<ExplainAnalyzeComputationProperty>,
    pub skew: bool,
}
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ExplainAnalyzeObjectStatement<T: AstInfo> {
    pub properties: ExplainAnalyzeProperty,
    /// Should only be `Explainee::Index` or `Explainee::MaterializedView`
    pub explainee: Explainee<T>,
    pub as_sql: bool,
}

impl<T: AstInfo> AstDisplay for ExplainAnalyzeObjectStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("EXPLAIN ANALYZE");
        match &self.properties {
            ExplainAnalyzeProperty::Computation(ExplainAnalyzeComputationProperties {
                properties,
                skew,
            }) => {
                let mut first = true;
                for property in properties {
                    if first {
                        first = false;
                    } else {
                        f.write_str(",");
                    }
                    match property {
                        ExplainAnalyzeComputationProperty::Cpu => f.write_str(" CPU"),
                        ExplainAnalyzeComputationProperty::Memory => f.write_str(" MEMORY"),
                    }
                }
                if *skew {
                    f.write_str(" WITH SKEW");
                }
            }
            ExplainAnalyzeProperty::Hints => f.write_str(" HINTS"),
        }
        f.write_str(" FOR ");
        f.write_node(&self.explainee);
        if self.as_sql {
            f.write_str(" AS SQL");
        }
    }
}
impl_display_t!(ExplainAnalyzeObjectStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ExplainAnalyzeClusterStatement {
    pub properties: ExplainAnalyzeComputationProperties,
    pub as_sql: bool,
}

impl AstDisplay for ExplainAnalyzeClusterStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("EXPLAIN ANALYZE CLUSTER");

        let mut first = true;
        for property in &self.properties.properties {
            if first {
                first = false;
            } else {
                f.write_str(",");
            }
            match property {
                ExplainAnalyzeComputationProperty::Cpu => f.write_str(" CPU"),
                ExplainAnalyzeComputationProperty::Memory => f.write_str(" MEMORY"),
            }
        }

        if self.properties.skew {
            f.write_str(" WITH SKEW");
        }
        if self.as_sql {
            f.write_str(" AS SQL");
        }
    }
}
impl_display!(ExplainAnalyzeClusterStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ExplainTimestampStatement<T: AstInfo> {
    pub format: Option<ExplainFormat>,
    pub select: SelectStatement<T>,
}

impl<T: AstInfo> ExplainTimestampStatement<T> {
    pub fn format(&self) -> ExplainFormat {
        self.format.unwrap_or(ExplainFormat::Text)
    }
}

impl<T: AstInfo> AstDisplay for ExplainTimestampStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("EXPLAIN TIMESTAMP");
        if let Some(format) = &self.format {
            f.write_str(" AS ");
            f.write_node(format);
        }
        f.write_str(" FOR ");
        f.write_node(&self.select);
    }
}
impl_display_t!(ExplainTimestampStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum InsertSource<T: AstInfo> {
    Query(Query<T>),
    DefaultValues,
}

impl<T: AstInfo> AstDisplay for InsertSource<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            InsertSource::Query(query) => f.write_node(query),
            InsertSource::DefaultValues => f.write_str("DEFAULT VALUES"),
        }
    }
}
impl_display_t!(InsertSource);

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord, Copy)]
pub enum ObjectType {
    Table,
    View,
    MaterializedView,
    Source,
    Sink,
    MetricSink,
    Index,
    Type,
    Role,
    Cluster,
    ClusterReplica,
    Secret,
    Connection,
    Database,
    Schema,
    Func,
    Subsource,
    NetworkPolicy,
}

impl ObjectType {
    pub fn lives_in_schema(&self) -> bool {
        match self {
            ObjectType::Table
            | ObjectType::View
            | ObjectType::MaterializedView
            | ObjectType::Source
            | ObjectType::Sink
            | ObjectType::MetricSink
            | ObjectType::Index
            | ObjectType::Type
            | ObjectType::Secret
            | ObjectType::Connection
            | ObjectType::Func
            | ObjectType::Subsource => true,
            ObjectType::Database
            | ObjectType::Schema
            | ObjectType::Cluster
            | ObjectType::ClusterReplica
            | ObjectType::Role
            | ObjectType::NetworkPolicy => false,
        }
    }
}

impl AstDisplay for ObjectType {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str(match self {
            ObjectType::Table => "TABLE",
            ObjectType::View => "VIEW",
            ObjectType::MaterializedView => "MATERIALIZED VIEW",
            ObjectType::Source => "SOURCE",
            ObjectType::Sink => "SINK",
            ObjectType::MetricSink => "METRIC SINK",
            ObjectType::Index => "INDEX",
            ObjectType::Type => "TYPE",
            ObjectType::Role => "ROLE",
            ObjectType::Cluster => "CLUSTER",
            ObjectType::ClusterReplica => "CLUSTER REPLICA",
            ObjectType::Secret => "SECRET",
            ObjectType::Connection => "CONNECTION",
            ObjectType::Database => "DATABASE",
            ObjectType::Schema => "SCHEMA",
            ObjectType::Func => "FUNCTION",
            ObjectType::Subsource => "SUBSOURCE",
            ObjectType::NetworkPolicy => "NETWORK POLICY",
        })
    }
}
impl_display!(ObjectType);

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord, Copy)]
pub enum SystemObjectType {
    System,
    Object(ObjectType),
}

impl AstDisplay for SystemObjectType {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            SystemObjectType::System => f.write_str("SYSTEM"),
            SystemObjectType::Object(object) => f.write_node(object),
        }
    }
}
impl_display!(SystemObjectType);

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum ShowStatementFilter<T: AstInfo> {
    Like(String),
    Where(Expr<T>),
}

impl<T: AstInfo> AstDisplay for ShowStatementFilter<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        use ShowStatementFilter::*;
        match self {
            Like(pattern) => {
                f.write_str("LIKE '");
                f.write_node(&display::escape_single_quote_string(pattern));
                f.write_str("'");
            }
            Where(expr) => {
                f.write_str("WHERE ");
                f.write_node(expr);
            }
        }
    }
}
impl_display_t!(ShowStatementFilter);

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum WithOptionValue<T: AstInfo> {
    Value(Value),
    DataType(T::DataType),
    Secret(T::ItemName),
    Item(T::ItemName),
    UnresolvedItemName(UnresolvedItemName),
    Ident(Ident),
    Sequence(Vec<WithOptionValue<T>>),
    Map(BTreeMap<String, WithOptionValue<T>>),
    // Special cases.
    Expr(Expr<T>),
    ClusterReplicas(Vec<ReplicaDefinition<T>>),
    ConnectionKafkaBroker(KafkaBroker<T>),
    ConnectionAwsPrivatelink(ConnectionDefaultAwsPrivatelink<T>),
    KafkaMatchingBrokerRule(KafkaMatchingBrokerRule<T>),
    RetainHistoryFor(Value),
    Refresh(RefreshOptionValue<T>),
    ClusterScheduleOptionValue(ClusterScheduleOptionValue),
    ClusterAutoScalingStrategyOptionValue(ClusterAutoScalingStrategyOptionValue),
    ClusterAlterStrategy(ClusterAlterOptionValue<T>),
    NetworkPolicyRules(Vec<NetworkPolicyRuleDefinition<T>>),
}

impl<T: AstInfo> AstDisplay for WithOptionValue<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        if f.redacted() {
            // When adding branches to this match statement, think about whether it is OK for us to collect
            // the value as part of our telemetry. Check the data management policy to be sure!
            match self {
                WithOptionValue::Value(_)
                | WithOptionValue::Sequence(_)
                | WithOptionValue::Map(_)
                | WithOptionValue::RetainHistoryFor(_)
                | WithOptionValue::Refresh(_)
                | WithOptionValue::Expr(_) => {
                    // These are redact-aware.
                }
                WithOptionValue::ConnectionKafkaBroker(_) => {
                    f.write_str("'<REDACTED>'");
                    return;
                }
                // A secret reference is a catalog item name, not the secret
                // value, so it is safe to show in redacted output. An option
                // that accepts an inline credential is parsed as a `Value`,
                // which is redacted by that arm together with the option's
                // `redact_value()`.
                WithOptionValue::Secret(_) => {}
                WithOptionValue::DataType(_)
                | WithOptionValue::Item(_)
                | WithOptionValue::UnresolvedItemName(_)
                | WithOptionValue::Ident(_)
                | WithOptionValue::ConnectionAwsPrivatelink(_)
                | WithOptionValue::KafkaMatchingBrokerRule(_)
                | WithOptionValue::ClusterReplicas(_)
                | WithOptionValue::ClusterScheduleOptionValue(_)
                | WithOptionValue::ClusterAutoScalingStrategyOptionValue(_)
                | WithOptionValue::ClusterAlterStrategy(_)
                | WithOptionValue::NetworkPolicyRules(_) => {
                    // These do not need redaction.
                }
            }
        }
        match self {
            WithOptionValue::Sequence(values) => {
                f.write_str("(");
                f.write_node(&display::comma_separated(values));
                f.write_str(")");
            }
            WithOptionValue::Map(values) => {
                f.write_str("MAP[");
                let len = values.len();
                for (i, (key, value)) in values.iter().enumerate() {
                    f.write_str("'");
                    f.write_node(&display::escape_single_quote_string(key));
                    f.write_str("' => ");
                    f.write_node(value);
                    if i + 1 < len {
                        f.write_str(", ");
                    }
                }
                f.write_str("]");
            }
            WithOptionValue::Expr(e) => f.write_node(e),
            WithOptionValue::Value(value) => f.write_node(value),
            WithOptionValue::DataType(typ) => f.write_node(typ),
            WithOptionValue::Secret(name) => {
                f.write_str("SECRET ");
                f.write_node(name)
            }
            WithOptionValue::Item(obj) => f.write_node(obj),
            WithOptionValue::UnresolvedItemName(r) => f.write_node(r),
            WithOptionValue::Ident(r) => f.write_node(r),
            WithOptionValue::ClusterReplicas(replicas) => {
                f.write_str("(");
                f.write_node(&display::comma_separated(replicas));
                f.write_str(")");
            }
            WithOptionValue::NetworkPolicyRules(rules) => {
                f.write_str("(");
                f.write_node(&display::comma_separated(rules));
                f.write_str(")");
            }
            WithOptionValue::ConnectionAwsPrivatelink(aws_privatelink) => {
                f.write_node(aws_privatelink);
            }
            WithOptionValue::KafkaMatchingBrokerRule(rule) => {
                f.write_node(rule);
            }
            WithOptionValue::ConnectionKafkaBroker(broker) => {
                f.write_node(broker);
            }
            WithOptionValue::RetainHistoryFor(value) => {
                f.write_str("FOR ");
                f.write_node(value);
            }
            WithOptionValue::Refresh(opt) => f.write_node(opt),
            WithOptionValue::ClusterScheduleOptionValue(value) => f.write_node(value),
            WithOptionValue::ClusterAutoScalingStrategyOptionValue(value) => f.write_node(value),
            WithOptionValue::ClusterAlterStrategy(value) => f.write_node(value),
        }
    }
}
impl_display_t!(WithOptionValue);

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum RefreshOptionValue<T: AstInfo> {
    OnCommit,
    AtCreation,
    At(RefreshAtOptionValue<T>),
    Every(RefreshEveryOptionValue<T>),
}

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct RefreshAtOptionValue<T: AstInfo> {
    // We need an Expr because we want to support `mz_now()`.
    pub time: Expr<T>,
}

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct RefreshEveryOptionValue<T: AstInfo> {
    // The refresh interval.
    pub interval: IntervalValue,
    // We need an Expr because we want to support `mz_now()`.
    pub aligned_to: Option<Expr<T>>,
}

impl<T: AstInfo> AstDisplay for RefreshOptionValue<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            RefreshOptionValue::OnCommit => {
                f.write_str("ON COMMIT");
            }
            RefreshOptionValue::AtCreation => {
                f.write_str("AT CREATION");
            }
            RefreshOptionValue::At(RefreshAtOptionValue { time }) => {
                f.write_str("AT ");
                f.write_node(time);
            }
            RefreshOptionValue::Every(RefreshEveryOptionValue {
                interval,
                aligned_to,
            }) => {
                f.write_str("EVERY '");
                f.write_node(interval);
                if let Some(aligned_to) = aligned_to {
                    f.write_str(" ALIGNED TO ");
                    f.write_node(aligned_to)
                }
            }
        }
    }
}

#[derive(
    Debug,
    Clone,
    PartialEq,
    Eq,
    Hash,
    PartialOrd,
    Ord,
    Deserialize,
    Serialize
)]
pub enum ClusterScheduleOptionValue {
    Manual,
    Refresh {
        hydration_time_estimate: Option<IntervalValue>,
    },
}

impl Default for ClusterScheduleOptionValue {
    fn default() -> Self {
        // (Has to be consistent with `impl Default for ClusterSchedule`.)
        ClusterScheduleOptionValue::Manual
    }
}

impl AstDisplay for ClusterScheduleOptionValue {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            ClusterScheduleOptionValue::Manual => {
                f.write_str("MANUAL");
            }
            ClusterScheduleOptionValue::Refresh {
                hydration_time_estimate,
            } => {
                f.write_str("ON REFRESH");
                if let Some(hydration_time_estimate) = hydration_time_estimate {
                    f.write_str(" (HYDRATION TIME ESTIMATE = '");
                    f.write_node(hydration_time_estimate);
                    f.write_str(")");
                }
            }
        }
    }
}

/// The value of the `AUTO SCALING STRATEGY` cluster option: the autoscaling
/// policy block. Extensible: future strategies are additional optional
/// sub-policies, so the block grows without changing existing ones. An empty
/// block (all sub-policies absent) disables autoscaling for the cluster, the same
/// as `RESET (AUTO SCALING STRATEGY)`.
#[derive(
    Debug,
    Clone,
    PartialEq,
    Eq,
    Hash,
    PartialOrd,
    Ord,
    Deserialize,
    Serialize
)]
pub struct ClusterAutoScalingStrategyOptionValue {
    pub on_hydration: Option<OnHydrationOptionValue>,
}

impl AstDisplay for ClusterAutoScalingStrategyOptionValue {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("(");
        if let Some(on_hydration) = &self.on_hydration {
            f.write_node(on_hydration);
        }
        f.write_str(")");
    }
}

/// The `ON HYDRATION` autoscaling sub-policy: while objects are un-hydrated, run
/// an extra replica at `hydration_size` to accelerate hydration, lingering for
/// `linger_duration` after the steady-state replicas hydrate.
#[derive(
    Debug,
    Clone,
    PartialEq,
    Eq,
    Hash,
    PartialOrd,
    Ord,
    Deserialize,
    Serialize
)]
pub struct OnHydrationOptionValue {
    pub hydration_size: Value,
    pub linger_duration: Option<Value>,
}

impl AstDisplay for OnHydrationOptionValue {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ON HYDRATION (HYDRATION SIZE = ");
        f.write_node(&self.hydration_size);
        if let Some(linger_duration) = &self.linger_duration {
            f.write_str(", LINGER DURATION = ");
            f.write_node(linger_duration);
        }
        f.write_str(")");
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum TransactionMode {
    AccessMode(TransactionAccessMode),
    IsolationLevel(TransactionIsolationLevel),
}

impl AstDisplay for TransactionMode {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        use TransactionMode::*;
        match self {
            AccessMode(access_mode) => f.write_node(access_mode),
            IsolationLevel(iso_level) => {
                f.write_str("ISOLATION LEVEL ");
                f.write_node(iso_level);
            }
        }
    }
}
impl_display!(TransactionMode);

/// The access mode of a transaction, as specified by the `BEGIN ...` statement.
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum TransactionAccessMode {
    ReadOnly,
    ReadWrite,
}

impl AstDisplay for TransactionAccessMode {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        use TransactionAccessMode::*;
        f.write_str(match self {
            ReadOnly => "READ ONLY",
            ReadWrite => "READ WRITE",
        })
    }
}
impl_display!(TransactionAccessMode);

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum TransactionIsolationLevel {
    ReadUncommitted,
    ReadCommitted,
    RepeatableRead,
    Serializable,
    StrongSessionSerializable,
    StrictSerializable,
}

impl AstDisplay for TransactionIsolationLevel {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        use TransactionIsolationLevel::*;
        f.write_str(match self {
            ReadUncommitted => "READ UNCOMMITTED",
            ReadCommitted => "READ COMMITTED",
            RepeatableRead => "REPEATABLE READ",
            Serializable => "SERIALIZABLE",
            StrongSessionSerializable => "STRONG SESSION SERIALIZABLE",
            StrictSerializable => "STRICT SERIALIZABLE",
        })
    }
}
impl_display!(TransactionIsolationLevel);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum SetVariableTo {
    Default,
    Values(Vec<SetVariableValue>),
}

impl AstDisplay for SetVariableTo {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        use SetVariableTo::*;
        match self {
            Values(values) => f.write_node(&display::comma_separated(values)),
            Default => f.write_str("DEFAULT"),
        }
    }
}
impl_display!(SetVariableTo);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum SetVariableValue {
    Ident(Ident),
    Literal(Value),
}

impl AstDisplay for SetVariableValue {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        use SetVariableValue::*;
        match self {
            Ident(ident) => f.write_node(ident),
            Literal(literal) => f.write_node(literal),
        }
    }
}
impl_display!(SetVariableValue);

impl SetVariableValue {
    /// Returns the underlying value without quotes.
    pub fn into_unquoted_value(self) -> String {
        match self {
            // `lit.to_string` will quote a `Value::String`, so get the unquoted
            // version.
            SetVariableValue::Literal(Value::String(s)) => s,
            SetVariableValue::Literal(lit) => lit.to_string(),
            SetVariableValue::Ident(ident) => ident.into_string(),
        }
    }
}

/// SQL assignment `foo = expr` as used in SQLUpdate
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Assignment<T: AstInfo> {
    pub id: Ident,
    pub value: Expr<T>,
}

impl<T: AstInfo> AstDisplay for Assignment<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_node(&self.id);
        f.write_str(" = ");
        f.write_node(&self.value);
    }
}
impl_display_t!(Assignment);

/// Specifies what [Statement::ExplainPlan] is actually explained.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum ExplainStage {
    /// The mz_sql::HirRelationExpr after parsing
    RawPlan,
    /// The mz_expr::MirRelationExpr after decorrelation
    DecorrelatedPlan,
    /// The mz_expr::MirRelationExpr after local optimization
    LocalPlan,
    /// The mz_expr::MirRelationExpr after global optimization
    GlobalPlan,
    /// The mz_compute_types::plan::Plan
    PhysicalPlan,
    /// The complete trace of the plan through the optimizer
    Trace,
    /// Insights about the plan
    PlanInsights,
}

impl ExplainStage {
    /// Return the tracing path that corresponds to a given stage.
    pub fn paths(&self) -> Option<SmallVec<[NamedPlan; 4]>> {
        use NamedPlan::*;
        match self {
            Self::RawPlan => Some(smallvec![Raw]),
            Self::DecorrelatedPlan => Some(smallvec![Decorrelated]),
            Self::LocalPlan => Some(smallvec![Local]),
            Self::GlobalPlan => Some(smallvec![Global]),
            Self::PhysicalPlan => Some(smallvec![Physical]),
            Self::Trace => None,
            Self::PlanInsights => Some(smallvec![Raw, Global, FastPath]),
        }
    }

    // Whether instead of the plan associated with this [`ExplainStage`] we
    // should show the [`NamedPlan::FastPath`] plan if available.
    pub fn show_fast_path(&self) -> bool {
        match self {
            Self::RawPlan => false,
            Self::DecorrelatedPlan => false,
            Self::LocalPlan => false,
            Self::GlobalPlan => true,
            Self::PhysicalPlan => true,
            Self::Trace => false,
            Self::PlanInsights => false,
        }
    }
}

impl AstDisplay for ExplainStage {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            Self::RawPlan => f.write_str("RAW PLAN"),
            Self::DecorrelatedPlan => f.write_str("DECORRELATED PLAN"),
            Self::LocalPlan => f.write_str("LOCALLY OPTIMIZED PLAN"),
            Self::GlobalPlan => f.write_str("OPTIMIZED PLAN"),
            Self::PhysicalPlan => f.write_str("PHYSICAL PLAN"),
            Self::Trace => f.write_str("OPTIMIZER TRACE"),
            Self::PlanInsights => f.write_str("PLAN INSIGHTS"),
        }
    }
}
impl_display!(ExplainStage);

/// An enum of named plans that identifies specific stages in an optimizer trace
/// where these plans can be found.
#[derive(Clone)]
pub enum NamedPlan {
    Raw,
    Decorrelated,
    Local,
    Global,
    Physical,
    FastPath,
}

impl NamedPlan {
    /// Return the [`NamedPlan`] for a given `path` if it exists.
    pub fn of_path(value: &str) -> Option<Self> {
        match value {
            "optimize/raw" => Some(Self::Raw),
            "optimize/hir_to_mir" => Some(Self::Decorrelated),
            "optimize/local" => Some(Self::Local),
            "optimize/global" => Some(Self::Global),
            "optimize/finalize_dataflow" => Some(Self::Physical),
            "optimize/fast_path" => Some(Self::FastPath),
            _ => None,
        }
    }

    /// Return the tracing path under which the plan can be found in an
    /// optimizer trace.
    pub fn path(&self) -> &'static str {
        match self {
            Self::Raw => "optimize/raw",
            Self::Decorrelated => "optimize/hir_to_mir",
            Self::Local => "optimize/local",
            Self::Global => "optimize/global",
            Self::Physical => "optimize/finalize_dataflow",
            Self::FastPath => "optimize/fast_path",
        }
    }
}

/// What is being explained.
/// The bools mean whether this is an EXPLAIN BROKEN.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum Explainee<T: AstInfo> {
    View(T::ItemName),
    MaterializedView(T::ItemName),
    Index(T::ItemName),
    ReplanView(T::ItemName),
    ReplanMaterializedView(T::ItemName),
    ReplanIndex(T::ItemName),
    Select(Box<SelectStatement<T>>, bool),
    CreateView(Box<CreateViewStatement<T>>, bool),
    CreateMaterializedView(Box<CreateMaterializedViewStatement<T>>, bool),
    CreateIndex(Box<CreateIndexStatement<T>>, bool),
    Subscribe(Box<SubscribeStatement<T>>, bool),
}

impl<T: AstInfo> Explainee<T> {
    pub fn name(&self) -> Option<&T::ItemName> {
        match self {
            Self::View(name)
            | Self::ReplanView(name)
            | Self::MaterializedView(name)
            | Self::ReplanMaterializedView(name)
            | Self::Index(name)
            | Self::ReplanIndex(name) => Some(name),
            Self::Select(..)
            | Self::CreateView(..)
            | Self::CreateMaterializedView(..)
            | Self::CreateIndex(..)
            | Self::Subscribe(..) => None,
        }
    }

    pub fn is_view(&self) -> bool {
        use Explainee::*;
        matches!(self, View(_) | ReplanView(_) | CreateView(_, _))
    }
}

impl<T: AstInfo> AstDisplay for Explainee<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            Self::View(name) => {
                f.write_str("VIEW ");
                f.write_node(name);
            }
            Self::MaterializedView(name) => {
                f.write_str("MATERIALIZED VIEW ");
                f.write_node(name);
            }
            Self::Index(name) => {
                f.write_str("INDEX ");
                f.write_node(name);
            }
            Self::ReplanView(name) => {
                f.write_str("REPLAN VIEW ");
                f.write_node(name);
            }
            Self::ReplanMaterializedView(name) => {
                f.write_str("REPLAN MATERIALIZED VIEW ");
                f.write_node(name);
            }
            Self::ReplanIndex(name) => {
                f.write_str("REPLAN INDEX ");
                f.write_node(name);
            }
            Self::Select(select, broken) => {
                if *broken {
                    f.write_str("BROKEN ");
                }
                f.write_node(select);
            }
            Self::CreateView(statement, broken) => {
                if *broken {
                    f.write_str("BROKEN ");
                }
                f.write_node(statement);
            }
            Self::CreateMaterializedView(statement, broken) => {
                if *broken {
                    f.write_str("BROKEN ");
                }
                f.write_node(statement);
            }
            Self::CreateIndex(statement, broken) => {
                if *broken {
                    f.write_str("BROKEN ");
                }
                f.write_node(statement);
            }
            Self::Subscribe(statement, broken) => {
                if *broken {
                    f.write_str("BROKEN ");
                }
                f.write_node(statement);
            }
        }
    }
}
impl_display_t!(Explainee);

#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum ExplainFormat {
    /// Human readable display format
    Text,
    /// Human readable display format with full debug information
    VerboseText,
    /// Machine-consumable JSON format
    Json,
    /// Machine-consumable DOT (graphviz) format
    Dot,
}

impl AstDisplay for ExplainFormat {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            Self::Text => f.write_str("TEXT"),
            Self::VerboseText => f.write_str("VERBOSE TEXT"),
            Self::Json => f.write_str("JSON"),
            Self::Dot => f.write_str("DOT"),
        }
    }
}
impl_display!(ExplainFormat);

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum IfExistsBehavior {
    Error,
    Skip,
    Replace,
}

/// `DECLARE ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct DeclareStatement<T: AstInfo> {
    pub name: Ident,
    pub stmt: Box<T::NestedStatement>,
    pub sql: String,
}

impl<T: AstInfo> AstDisplay for DeclareStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("DECLARE ");
        f.write_node(&self.name);
        f.write_str(" CURSOR FOR ");
        f.write_node(&self.stmt);
    }
}
impl_display_t!(DeclareStatement);

/// `CLOSE ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CloseStatement {
    pub name: Ident,
}

impl AstDisplay for CloseStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("CLOSE ");
        f.write_node(&self.name);
    }
}
impl_display!(CloseStatement);

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum FetchOptionName {
    Timeout,
}

impl AstDisplay for FetchOptionName {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str(match self {
            FetchOptionName::Timeout => "TIMEOUT",
        })
    }
}

impl WithOptionName for FetchOptionName {
    /// # WARNING
    ///
    /// Whenever implementing this trait consider very carefully whether or not
    /// this value could contain sensitive user data. If you're uncertain, err
    /// on the conservative side and return `true`.
    fn redact_value(&self) -> bool {
        match self {
            FetchOptionName::Timeout => false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct FetchOption<T: AstInfo> {
    pub name: FetchOptionName,
    pub value: Option<WithOptionValue<T>>,
}
impl_display_for_with_option!(FetchOption);

/// `FETCH ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct FetchStatement<T: AstInfo> {
    pub name: Ident,
    pub count: Option<FetchDirection>,
    pub options: Vec<FetchOption<T>>,
}

impl<T: AstInfo> AstDisplay for FetchStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("FETCH ");
        if let Some(ref count) = self.count {
            f.write_str(format!("{} ", count));
        }
        // `FETCH` consumes an optional leading `FORWARD` keyword, so a cursor
        // literally named `forward` printed bare with no preceding count would
        // be swallowed on reparse, leaving no cursor name. Force it to quote.
        if self.count.is_none() && self.name.as_str().eq_ignore_ascii_case("forward") {
            f.write_str(self.name.to_ast_string_stable());
        } else {
            f.write_node(&self.name);
        }
        if !self.options.is_empty() {
            f.write_str(" WITH (");
            f.write_node(&display::comma_separated(&self.options));
            f.write_str(")");
        }
    }
}
impl_display_t!(FetchStatement);

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum FetchDirection {
    ForwardAll,
    ForwardCount(u64),
}

impl AstDisplay for FetchDirection {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            FetchDirection::ForwardAll => f.write_str("ALL"),
            FetchDirection::ForwardCount(count) => f.write_str(format!("{}", count)),
        }
    }
}
impl_display!(FetchDirection);

/// `PREPARE ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct PrepareStatement<T: AstInfo> {
    pub name: Ident,
    pub stmt: Box<T::NestedStatement>,
    pub sql: String,
}

impl<T: AstInfo> AstDisplay for PrepareStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("PREPARE ");
        f.write_node(&self.name);
        f.write_str(" AS ");
        f.write_node(&self.stmt);
    }
}
impl_display_t!(PrepareStatement);

/// `EXECUTE ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ExecuteStatement<T: AstInfo> {
    pub name: Ident,
    pub params: Vec<Expr<T>>,
}

impl<T: AstInfo> AstDisplay for ExecuteStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("EXECUTE ");
        f.write_node(&self.name);
        if !self.params.is_empty() {
            f.write_str(" (");
            f.write_node(&display::comma_separated(&self.params));
            f.write_str(")");
        }
    }
}
impl_display_t!(ExecuteStatement);

/// `EXECUTE UNIT TEST ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ExecuteUnitTestStatement<T: AstInfo> {
    pub name: Ident,
    pub target: T::ItemName,
    pub at_time: Option<Expr<T>>,
    pub mocks: Vec<MockViewDef<T>>,
    pub expected: ExpectedResultDef<T>,
}

impl<T: AstInfo> AstDisplay for ExecuteUnitTestStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("EXECUTE UNIT TEST ");
        f.write_node(&self.name);
        f.write_str(" FOR ");
        f.write_node(&self.target);
        if let Some(at_time) = &self.at_time {
            f.write_str(" AT TIME ");
            f.write_node(at_time);
        }
        for (i, mock) in self.mocks.iter().enumerate() {
            f.write_str(if i == 0 { " MOCK " } else { ", MOCK " });
            f.write_node(mock);
        }
        f.write_str(" EXPECTED ");
        f.write_node(&self.expected);
    }
}
impl_display_t!(ExecuteUnitTestStatement);

/// Mock view definition for EXECUTE UNIT TEST
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct MockViewDef<T: AstInfo> {
    pub name: T::ItemName,
    pub columns: Vec<ColumnDef<T>>,
    pub query: Query<T>,
}

impl<T: AstInfo> AstDisplay for MockViewDef<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_node(&self.name);
        f.write_str("(");
        f.write_node(&display::comma_separated(&self.columns));
        f.write_str(") AS (");
        f.write_node(&self.query);
        f.write_str(")");
    }
}
impl_display_t!(MockViewDef);

/// Expected result definition for EXECUTE UNIT TEST
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ExpectedResultDef<T: AstInfo> {
    pub columns: Vec<ColumnDef<T>>,
    pub query: Query<T>,
}

impl<T: AstInfo> AstDisplay for ExpectedResultDef<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("(");
        f.write_node(&display::comma_separated(&self.columns));
        f.write_str(") AS (");
        f.write_node(&self.query);
        f.write_str(")");
    }
}
impl_display_t!(ExpectedResultDef);

/// `DEALLOCATE ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct DeallocateStatement {
    pub name: Option<Ident>,
}

impl AstDisplay for DeallocateStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("DEALLOCATE ");
        match &self.name {
            Some(name) => f.write_node(name),
            None => f.write_str("ALL"),
        };
    }
}
impl_display!(DeallocateStatement);

/// `RAISE ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct RaiseStatement {
    pub severity: NoticeSeverity,
}

impl AstDisplay for RaiseStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("RAISE ");
        f.write_node(&self.severity);
    }
}
impl_display!(RaiseStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum NoticeSeverity {
    Debug,
    Info,
    Log,
    Notice,
    Warning,
}

impl AstDisplay for NoticeSeverity {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str(match self {
            NoticeSeverity::Debug => "DEBUG",
            NoticeSeverity::Info => "INFO",
            NoticeSeverity::Log => "LOG",
            NoticeSeverity::Notice => "NOTICE",
            NoticeSeverity::Warning => "WARNING",
        })
    }
}
impl_display!(NoticeSeverity);

/// `ALTER SYSTEM SET ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterSystemSetStatement {
    pub name: Ident,
    pub to: SetVariableTo,
}

impl AstDisplay for AlterSystemSetStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ALTER SYSTEM SET ");
        f.write_node(&self.name);
        f.write_str(" = ");
        f.write_node(&self.to);
    }
}
impl_display!(AlterSystemSetStatement);

/// `ALTER SYSTEM RESET ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterSystemResetStatement {
    pub name: Ident,
}

impl AstDisplay for AlterSystemResetStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ALTER SYSTEM RESET ");
        f.write_node(&self.name);
    }
}
impl_display!(AlterSystemResetStatement);

/// `ALTER SYSTEM RESET ALL`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterSystemResetAllStatement {}

impl AstDisplay for AlterSystemResetAllStatement {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ALTER SYSTEM RESET ALL");
    }
}
impl_display!(AlterSystemResetAllStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum AsOf<T: AstInfo> {
    At(Expr<T>),
    AtLeast(Expr<T>),
}

impl<T: AstInfo> AstDisplay for AsOf<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("AS OF ");
        match self {
            AsOf::At(expr) => f.write_node(expr),
            AsOf::AtLeast(expr) => {
                f.write_str("AT LEAST ");
                f.write_node(expr);
            }
        }
    }
}
impl_display_t!(AsOf);

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum ShowStatement<T: AstInfo> {
    ShowObjects(ShowObjectsStatement<T>),
    ShowColumns(ShowColumnsStatement<T>),
    ShowCreateView(ShowCreateViewStatement<T>),
    ShowCreateMaterializedView(ShowCreateMaterializedViewStatement<T>),
    ShowCreateSource(ShowCreateSourceStatement<T>),
    ShowCreateTable(ShowCreateTableStatement<T>),
    ShowCreateSink(ShowCreateSinkStatement<T>),
    ShowCreateMetricSink(ShowCreateMetricSinkStatement<T>),
    ShowCreateIndex(ShowCreateIndexStatement<T>),
    ShowCreateConnection(ShowCreateConnectionStatement<T>),
    ShowCreateCluster(ShowCreateClusterStatement<T>),
    ShowCreateType(ShowCreateTypeStatement<T>),
    ShowVariable(ShowVariableStatement),
    InspectShard(InspectShardStatement),
}

impl<T: AstInfo> AstDisplay for ShowStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            ShowStatement::ShowObjects(stmt) => f.write_node(stmt),
            ShowStatement::ShowColumns(stmt) => f.write_node(stmt),
            ShowStatement::ShowCreateView(stmt) => f.write_node(stmt),
            ShowStatement::ShowCreateMaterializedView(stmt) => f.write_node(stmt),
            ShowStatement::ShowCreateSource(stmt) => f.write_node(stmt),
            ShowStatement::ShowCreateTable(stmt) => f.write_node(stmt),
            ShowStatement::ShowCreateSink(stmt) => f.write_node(stmt),
            ShowStatement::ShowCreateMetricSink(stmt) => f.write_node(stmt),
            ShowStatement::ShowCreateIndex(stmt) => f.write_node(stmt),
            ShowStatement::ShowCreateConnection(stmt) => f.write_node(stmt),
            ShowStatement::ShowCreateCluster(stmt) => f.write_node(stmt),
            ShowStatement::ShowCreateType(stmt) => f.write_node(stmt),
            ShowStatement::ShowVariable(stmt) => f.write_node(stmt),
            ShowStatement::InspectShard(stmt) => f.write_node(stmt),
        }
    }
}
impl_display_t!(ShowStatement);

/// `GRANT ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct GrantRoleStatement<T: AstInfo> {
    /// The roles that are gaining members.
    pub role_names: Vec<T::RoleName>,
    /// The roles that will be added to `role_name`.
    pub member_names: Vec<T::RoleName>,
}

impl<T: AstInfo> AstDisplay for GrantRoleStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("GRANT ");
        f.write_node(&display::comma_separated(&self.role_names));
        f.write_str(" TO ");
        f.write_node(&display::comma_separated(&self.member_names));
    }
}
impl_display_t!(GrantRoleStatement);

/// `REVOKE ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct RevokeRoleStatement<T: AstInfo> {
    /// The roles that are losing members.
    pub role_names: Vec<T::RoleName>,
    /// The roles that will be removed from `role_name`.
    pub member_names: Vec<T::RoleName>,
}

impl<T: AstInfo> AstDisplay for RevokeRoleStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("REVOKE ");
        f.write_node(&display::comma_separated(&self.role_names));
        f.write_str(" FROM ");
        f.write_node(&display::comma_separated(&self.member_names));
    }
}
impl_display_t!(RevokeRoleStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum Privilege {
    SELECT,
    INSERT,
    UPDATE,
    DELETE,
    USAGE,
    CREATE,
    CREATEROLE,
    CREATEDB,
    CREATECLUSTER,
    CREATENETWORKPOLICY,
}

impl AstDisplay for Privilege {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str(match self {
            Privilege::SELECT => "SELECT",
            Privilege::INSERT => "INSERT",
            Privilege::UPDATE => "UPDATE",
            Privilege::DELETE => "DELETE",
            Privilege::CREATE => "CREATE",
            Privilege::USAGE => "USAGE",
            Privilege::CREATEROLE => "CREATEROLE",
            Privilege::CREATEDB => "CREATEDB",
            Privilege::CREATECLUSTER => "CREATECLUSTER",
            Privilege::CREATENETWORKPOLICY => "CREATENETWORKPOLICY",
        });
    }
}
impl_display!(Privilege);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum PrivilegeSpecification {
    All,
    Privileges(Vec<Privilege>),
}

impl AstDisplay for PrivilegeSpecification {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            PrivilegeSpecification::All => f.write_str("ALL"),
            PrivilegeSpecification::Privileges(privileges) => {
                f.write_node(&display::comma_separated(privileges))
            }
        }
    }
}
impl_display!(PrivilegeSpecification);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum GrantTargetSpecification<T: AstInfo> {
    Object {
        /// The type of object.
        ///
        /// Note: For views, materialized views, and sources this will be [`ObjectType::Table`].
        object_type: ObjectType,
        /// Specification of each object affected.
        object_spec_inner: GrantTargetSpecificationInner<T>,
    },
    System,
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum GrantTargetSpecificationInner<T: AstInfo> {
    All(GrantTargetAllSpecification<T>),
    Objects { names: Vec<T::ObjectName> },
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum GrantTargetAllSpecification<T: AstInfo> {
    All,
    AllDatabases { databases: Vec<T::DatabaseName> },
    AllSchemas { schemas: Vec<T::SchemaName> },
}

impl<T: AstInfo> GrantTargetAllSpecification<T> {
    pub fn len(&self) -> usize {
        match self {
            GrantTargetAllSpecification::All => 1,
            GrantTargetAllSpecification::AllDatabases { databases } => databases.len(),
            GrantTargetAllSpecification::AllSchemas { schemas } => schemas.len(),
        }
    }
}

/// Writes the plural keyword for `object_type` as `GRANT`/`REVOKE ... ON ALL`
/// expects it. Most object types just take a trailing `S` (`TABLES`, `SECRETS`,
/// ...), but `NETWORK POLICY` pluralizes to the `POLICIES` keyword the parser
/// accepts — naively appending `S` would emit `NETWORK POLICYS`, which fails to
/// reparse.
fn write_grant_object_type_plural<W: fmt::Write>(
    f: &mut AstFormatter<W>,
    object_type: &ObjectType,
) {
    match object_type {
        ObjectType::NetworkPolicy => f.write_str("POLICIES"),
        other => {
            f.write_node(other);
            f.write_str("S");
        }
    }
}

impl<T: AstInfo> AstDisplay for GrantTargetSpecification<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            GrantTargetSpecification::Object {
                object_type,
                object_spec_inner,
            } => match object_spec_inner {
                GrantTargetSpecificationInner::All(all_spec) => match all_spec {
                    GrantTargetAllSpecification::All => {
                        f.write_str("ALL ");
                        write_grant_object_type_plural(f, object_type);
                    }
                    GrantTargetAllSpecification::AllDatabases { databases } => {
                        f.write_str("ALL ");
                        write_grant_object_type_plural(f, object_type);
                        f.write_str(" IN DATABASE ");
                        f.write_node(&display::comma_separated(databases));
                    }
                    GrantTargetAllSpecification::AllSchemas { schemas } => {
                        f.write_str("ALL ");
                        write_grant_object_type_plural(f, object_type);
                        f.write_str(" IN SCHEMA ");
                        f.write_node(&display::comma_separated(schemas));
                    }
                },
                GrantTargetSpecificationInner::Objects { names } => {
                    f.write_node(object_type);
                    f.write_str(" ");
                    f.write_node(&display::comma_separated(names));
                }
            },
            GrantTargetSpecification::System => f.write_str("SYSTEM"),
        }
    }
}
impl_display_t!(GrantTargetSpecification);

/// `GRANT ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct GrantPrivilegesStatement<T: AstInfo> {
    /// The privileges being granted on an object.
    pub privileges: PrivilegeSpecification,
    /// The objects that are affected by the GRANT.
    pub target: GrantTargetSpecification<T>,
    /// The roles that will granted the privileges.
    pub roles: Vec<T::RoleName>,
}

impl<T: AstInfo> AstDisplay for GrantPrivilegesStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("GRANT ");
        f.write_node(&self.privileges);
        f.write_str(" ON ");
        f.write_node(&self.target);
        f.write_str(" TO ");
        f.write_node(&display::comma_separated(&self.roles));
    }
}
impl_display_t!(GrantPrivilegesStatement);

/// `REVOKE ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct RevokePrivilegesStatement<T: AstInfo> {
    /// The privileges being revoked.
    pub privileges: PrivilegeSpecification,
    /// The objects that are affected by the REVOKE.
    pub target: GrantTargetSpecification<T>,
    /// The roles that will have privileges revoked.
    pub roles: Vec<T::RoleName>,
}

impl<T: AstInfo> AstDisplay for RevokePrivilegesStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("REVOKE ");
        f.write_node(&self.privileges);
        f.write_str(" ON ");
        f.write_node(&self.target);
        f.write_str(" FROM ");
        f.write_node(&display::comma_separated(&self.roles));
    }
}
impl_display_t!(RevokePrivilegesStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum TargetRoleSpecification<T: AstInfo> {
    /// Specific list of roles.
    Roles(Vec<T::RoleName>),
    /// All current and future roles.
    AllRoles,
}

impl<T: AstInfo> AstDisplay for TargetRoleSpecification<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            TargetRoleSpecification::Roles(roles) => f.write_node(&display::comma_separated(roles)),
            TargetRoleSpecification::AllRoles => f.write_str("ALL ROLES"),
        }
    }
}
impl_display_t!(TargetRoleSpecification);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AbbreviatedGrantStatement<T: AstInfo> {
    /// The privileges being granted.
    pub privileges: PrivilegeSpecification,
    /// The type of object.
    ///
    /// Note: For views, materialized views, and sources this will be [`ObjectType::Table`].
    pub object_type: ObjectType,
    /// The roles that will granted the privileges.
    pub grantees: Vec<T::RoleName>,
}

impl<T: AstInfo> AstDisplay for AbbreviatedGrantStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("GRANT ");
        f.write_node(&self.privileges);
        f.write_str(" ON ");
        write_grant_object_type_plural(f, &self.object_type);
        f.write_str(" TO ");
        f.write_node(&display::comma_separated(&self.grantees));
    }
}
impl_display_t!(AbbreviatedGrantStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AbbreviatedRevokeStatement<T: AstInfo> {
    /// The privileges being revoked.
    pub privileges: PrivilegeSpecification,
    /// The type of object.
    ///
    /// Note: For views, materialized views, and sources this will be [`ObjectType::Table`].
    pub object_type: ObjectType,
    /// The roles that the privilege will be revoked from.
    pub revokees: Vec<T::RoleName>,
}

impl<T: AstInfo> AstDisplay for AbbreviatedRevokeStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("REVOKE ");
        f.write_node(&self.privileges);
        f.write_str(" ON ");
        write_grant_object_type_plural(f, &self.object_type);
        f.write_str(" FROM ");
        f.write_node(&display::comma_separated(&self.revokees));
    }
}
impl_display_t!(AbbreviatedRevokeStatement);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum AbbreviatedGrantOrRevokeStatement<T: AstInfo> {
    Grant(AbbreviatedGrantStatement<T>),
    Revoke(AbbreviatedRevokeStatement<T>),
}

impl<T: AstInfo> AbbreviatedGrantOrRevokeStatement<T> {
    pub fn privileges(&self) -> &PrivilegeSpecification {
        match self {
            AbbreviatedGrantOrRevokeStatement::Grant(grant) => &grant.privileges,
            AbbreviatedGrantOrRevokeStatement::Revoke(revoke) => &revoke.privileges,
        }
    }

    pub fn object_type(&self) -> &ObjectType {
        match self {
            AbbreviatedGrantOrRevokeStatement::Grant(grant) => &grant.object_type,
            AbbreviatedGrantOrRevokeStatement::Revoke(revoke) => &revoke.object_type,
        }
    }

    pub fn roles(&self) -> &Vec<T::RoleName> {
        match self {
            AbbreviatedGrantOrRevokeStatement::Grant(grant) => &grant.grantees,
            AbbreviatedGrantOrRevokeStatement::Revoke(revoke) => &revoke.revokees,
        }
    }
}

impl<T: AstInfo> AstDisplay for AbbreviatedGrantOrRevokeStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        match self {
            AbbreviatedGrantOrRevokeStatement::Grant(grant) => f.write_node(grant),
            AbbreviatedGrantOrRevokeStatement::Revoke(revoke) => f.write_node(revoke),
        }
    }
}
impl_display_t!(AbbreviatedGrantOrRevokeStatement);

/// `ALTER DEFAULT PRIVILEGES ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct AlterDefaultPrivilegesStatement<T: AstInfo> {
    /// The roles for which created objects are affected.
    pub target_roles: TargetRoleSpecification<T>,
    /// The objects that are affected by the default privilege.
    pub target_objects: GrantTargetAllSpecification<T>,
    /// The privilege to grant or revoke.
    pub grant_or_revoke: AbbreviatedGrantOrRevokeStatement<T>,
}

impl<T: AstInfo> AstDisplay for AlterDefaultPrivilegesStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("ALTER DEFAULT PRIVILEGES");
        match &self.target_roles {
            TargetRoleSpecification::Roles(_) => {
                f.write_str(" FOR ROLE ");
                f.write_node(&self.target_roles);
            }
            TargetRoleSpecification::AllRoles => {
                f.write_str(" FOR ");
                f.write_node(&self.target_roles);
            }
        }
        match &self.target_objects {
            GrantTargetAllSpecification::All => {}
            GrantTargetAllSpecification::AllDatabases { databases } => {
                f.write_str(" IN DATABASE ");
                f.write_node(&display::comma_separated(databases));
            }
            GrantTargetAllSpecification::AllSchemas { schemas } => {
                f.write_str(" IN SCHEMA ");
                f.write_node(&display::comma_separated(schemas));
            }
        }
        f.write_str(" ");
        f.write_node(&self.grant_or_revoke);
    }
}
impl_display_t!(AlterDefaultPrivilegesStatement);

/// `REASSIGN OWNED ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ReassignOwnedStatement<T: AstInfo> {
    /// The roles whose owned objects are being reassigned.
    pub old_roles: Vec<T::RoleName>,
    /// The new owner of the objects.
    pub new_role: T::RoleName,
}

impl<T: AstInfo> AstDisplay for ReassignOwnedStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("REASSIGN OWNED BY ");
        f.write_node(&display::comma_separated(&self.old_roles));
        f.write_str(" TO ");
        f.write_node(&self.new_role);
    }
}
impl_display_t!(ReassignOwnedStatement);

/// `COMMENT ON ...`
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CommentStatement<T: AstInfo> {
    pub object: CommentObjectType<T>,
    pub comment: Option<String>,
}

impl<T: AstInfo> AstDisplay for CommentStatement<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_str("COMMENT ON ");
        f.write_node(&self.object);

        f.write_str(" IS ");
        match &self.comment {
            Some(s) => {
                if f.redacted() {
                    // The comment body is arbitrary free text and may contain PII,
                    // so redact it like every other user-supplied value.
                    f.write_str("'<REDACTED>'");
                } else {
                    f.write_str("'");
                    f.write_node(&display::escape_single_quote_string(s));
                    f.write_str("'");
                }
            }
            None => f.write_str("NULL"),
        }
    }
}
impl_display_t!(CommentStatement);

#[derive(Debug, PartialEq, Eq, Hash, PartialOrd, Ord, Clone)]
pub struct ColumnName<T: AstInfo> {
    pub relation: T::ItemName,
    pub column: T::ColumnReference,
}

impl<T: AstInfo> AstDisplay for ColumnName<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        f.write_node(&self.relation);
        f.write_str(".");
        f.write_node(&self.column);
    }
}
impl_display_t!(ColumnName);

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum CommentObjectType<T: AstInfo> {
    Table { name: T::ItemName },
    View { name: T::ItemName },
    Column { name: ColumnName<T> },
    MaterializedView { name: T::ItemName },
    Source { name: T::ItemName },
    Sink { name: T::ItemName },
    Index { name: T::ItemName },
    Func { name: T::ItemName },
    Connection { name: T::ItemName },
    Type { ty: T::DataType },
    Secret { name: T::ItemName },
    Role { name: T::RoleName },
    Database { name: T::DatabaseName },
    Schema { name: T::SchemaName },
    Cluster { name: T::ClusterName },
    ClusterReplica { name: QualifiedReplica },
    NetworkPolicy { name: T::NetworkPolicyName },
}

impl<T: AstInfo> AstDisplay for CommentObjectType<T> {
    fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
        use CommentObjectType::*;

        match self {
            Table { name } => {
                f.write_str("TABLE ");
                f.write_node(name);
            }
            View { name } => {
                f.write_str("VIEW ");
                f.write_node(name);
            }
            Column { name } => {
                f.write_str("COLUMN ");
                f.write_node(name);
            }
            MaterializedView { name } => {
                f.write_str("MATERIALIZED VIEW ");
                f.write_node(name);
            }
            Source { name } => {
                f.write_str("SOURCE ");
                f.write_node(name);
            }
            Sink { name } => {
                f.write_str("SINK ");
                f.write_node(name);
            }
            Index { name } => {
                f.write_str("INDEX ");
                f.write_node(name);
            }
            Func { name } => {
                f.write_str("FUNCTION ");
                f.write_node(name);
            }
            Connection { name } => {
                f.write_str("CONNECTION ");
                f.write_node(name);
            }
            Type { ty } => {
                f.write_str("TYPE ");
                f.write_node(ty);
            }
            Secret { name } => {
                f.write_str("SECRET ");
                f.write_node(name);
            }
            Role { name } => {
                f.write_str("ROLE ");
                f.write_node(name);
            }
            Database { name } => {
                f.write_str("DATABASE ");
                f.write_node(name);
            }
            Schema { name } => {
                f.write_str("SCHEMA ");
                f.write_node(name);
            }
            Cluster { name } => {
                f.write_str("CLUSTER ");
                f.write_node(name);
            }
            ClusterReplica { name } => {
                f.write_str("CLUSTER REPLICA ");
                f.write_node(name);
            }
            NetworkPolicy { name } => {
                f.write_str("NETWORK POLICY ");
                f.write_node(name);
            }
        }
    }
}

impl_display_t!(CommentObjectType);

// Include the `AstDisplay` implementations for simple options derived by the
// crate's build.rs script.
include!(concat!(env!("OUT_DIR"), "/display.simple_options.rs"));