{-# LANGUAGE GeneralizedNewtypeDeriving #-}

{- |
Copyright : Flipstone Technology Partners 2023
License   : MIT
Stability : Stable

@since 1.0.0.0
-}
module Orville.PostgreSQL.Expr.Internal.Name.ColumnName
  ( ColumnName
  , columnName
  )
where

import Orville.PostgreSQL.Expr.Internal.Name.Identifier (Identifier, IdentifierExpression, identifier)
import qualified Orville.PostgreSQL.Raw.RawSql as RawSql

{- |
Type to represent a SQL column name. 'ColumnName' values constructed via the
'columnName' function will be properly escaped as part of the generated SQL. E.G.

> "some_column_name"

'ColumnName' provides a 'RawSql.SqlExpression' instance. See
'RawSql.unsafeSqlExpression' for how to construct a value with your own custom
SQL.

@since 1.0.0.0
-}
newtype ColumnName
  = ColumnName Identifier
  deriving
    ( -- | @since 1.0.0.0
      RawSql -> ColumnName
ColumnName -> RawSql
(ColumnName -> RawSql)
-> (RawSql -> ColumnName) -> SqlExpression ColumnName
forall a. (a -> RawSql) -> (RawSql -> a) -> SqlExpression a
$ctoRawSql :: ColumnName -> RawSql
toRawSql :: ColumnName -> RawSql
$cunsafeFromRawSql :: RawSql -> ColumnName
unsafeFromRawSql :: RawSql -> ColumnName
RawSql.SqlExpression
    , -- | @since 1.0.0.0
      Identifier -> ColumnName
ColumnName -> Identifier
(ColumnName -> Identifier)
-> (Identifier -> ColumnName) -> IdentifierExpression ColumnName
forall name.
(name -> Identifier)
-> (Identifier -> name) -> IdentifierExpression name
$ctoIdentifier :: ColumnName -> Identifier
toIdentifier :: ColumnName -> Identifier
$cfromIdentifier :: Identifier -> ColumnName
fromIdentifier :: Identifier -> ColumnName
IdentifierExpression
    )

{- |
Construct a 'ColumnName' from a 'String' with proper escaping as part of the generated SQL.

@since 1.0.0.0
-}
columnName :: String -> ColumnName
columnName :: String -> ColumnName
columnName = Identifier -> ColumnName
ColumnName (Identifier -> ColumnName)
-> (String -> Identifier) -> String -> ColumnName
forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> Identifier
identifier