dbcrossbarlib 0.5.3

//! PostgreSQL columns.

use std::fmt;

use super::{Ident, PgDataType, PgScalarDataType};
use crate::common::*;
use crate::schema::Column;

/// A column in a PostgreSQL table.
#[derive(Clone, Debug, Eq, PartialEq)]
pub(crate) struct PgColumn {
    /// The name of this column.
    pub(crate) name: String,
    /// The type of data stored in this column.
    pub(crate) data_type: PgDataType,
    /// Can this column be `NULL`?
    pub(crate) is_nullable: bool,
}

impl PgColumn {
    /// Given a portable `Column`, construct a `PgColumn`.
    pub(crate) fn from_column(schema: &Schema, col: &Column) -> Result<PgColumn> {
        let data_type = PgDataType::from_data_type(schema, &col.data_type)?;
        Ok(PgColumn {
            name: col.name.clone(),
            data_type,
            is_nullable: col.is_nullable,
        })
    }

    /// Given a `PgColumn`, construct a portable `Column`.
    pub(crate) fn to_column(&self) -> Result<Column> {
        Ok(Column {
            name: self.name.clone(),
            data_type: self.data_type.to_data_type()?,
            is_nullable: self.is_nullable,
            comment: None,
        })
    }

    /// Write a `SELECT` expression for this column.
    pub(crate) fn write_export_select_expr(&self, f: &mut dyn Write) -> Result<()> {
        let name = Ident(&self.name);
        let check_dimension = |dimension_count: i32| -> Result<()> {
            if dimension_count == 1 {
                Ok(())
            } else {
                Err(format_err!(
                    "cannot output column {:} because it has dimension {}",
                    self.name,
                    dimension_count,
                ))
            }
        };
        match &self.data_type {
            // `bigint[]` needs to be converted to a `text[]`, or
            // PostgreSQL will lose precision by writing `bigint` values as
            // `f64`.
            PgDataType::Array {
                dimension_count,
                ty: PgScalarDataType::Bigint,
            } => {
                check_dimension(*dimension_count)?;
                write!(
                    f,
                    r#"(SELECT array_to_json(array_agg((elem))) FROM (SELECT elem::text FROM unnest({name}) AS elem) AS elems) AS {name}"#,
                    name = name,
                )?;
            }
            // Format timestamps as ISO 8601 instead of Postgres's format.
            PgDataType::Array {
                dimension_count,
                ty: PgScalarDataType::TimestampWithoutTimeZone,
            } => {
                check_dimension(*dimension_count)?;
                write!(
                    f,
                    r#"(SELECT array_to_json(array_agg((elem))) FROM (SELECT TRIM(TRAILING '.' FROM TRIM(TRAILING '0' FROM to_char(elem, 'YYYY-MM-DD"T"HH24:MI:SS.US'))) AS elem FROM unnest({name}) AS elem) AS elems) AS {name}"#,
                    name = name,
                )?;
            }
            PgDataType::Array {
                dimension_count,
                ty: PgScalarDataType::TimestampWithTimeZone,
            } => {
                check_dimension(*dimension_count)?;
                write!(
                    f,
                    r#"(SELECT array_to_json(array_agg((elem))) FROM (SELECT TRIM(TRAILING '.' FROM TRIM(TRAILING '0' FROM to_char(elem AT TIME ZONE 'UTC', 'YYYY-MM-DD"T"HH24:MI:SS.US'))) || 'Z' AS elem FROM unnest({name}) AS elem) AS elems) AS {name}"#,
                    name = name,
                )?;
            }
            // Regular arrays can be dumped directly.
            PgDataType::Array { .. } => {
                write!(f, "array_to_json({name}) AS {name}", name = name)?;
            }
            PgDataType::Scalar(PgScalarDataType::Geometry(_srid)) => {
                // TODO: This will preserve the current SRID of the column, so
                // let's hope `_srid` matches the database's if we make it this far.
                write!(f, "ST_AsGeoJSON({name}) AS {name}", name = name)?;
            }
            PgDataType::Scalar(PgScalarDataType::TimestampWithoutTimeZone) => {
                write!(
                    f,
                    r#"TRIM(TRAILING '.' FROM TRIM(TRAILING '0' FROM to_char({name}, 'YYYY-MM-DD"T"HH24:MI:SS.US'))) AS {name}"#,
                    name = name,
                )?;
            }
            PgDataType::Scalar(PgScalarDataType::TimestampWithTimeZone) => {
                write!(
                    f,
                    r#"TRIM(TRAILING '.' FROM TRIM(TRAILING '0' FROM to_char({name} AT TIME ZONE 'UTC', 'YYYY-MM-DD"T"HH24:MI:SS.US'))) || 'Z' AS {name}"#,
                    name = name,
                )?;
            }
            _ => {
                write!(f, "{}", name)?;
            }
        }
        Ok(())
    }
}

impl fmt::Display for PgColumn {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{} {}", Ident(&self.name), self.data_type)?;
        if !self.is_nullable {
            write!(f, " NOT NULL")?;
        }
        Ok(())
    }
}