{-# LANGUAGE GeneralizedNewtypeDeriving #-}

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

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

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

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

> "some_savepoint_name"

'SavepointName' 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 SavepointName
  = SavepointName Identifier
  deriving
    ( -- | @since 1.0.0.0
      RawSql -> SavepointName
SavepointName -> RawSql
(SavepointName -> RawSql)
-> (RawSql -> SavepointName) -> SqlExpression SavepointName
forall a. (a -> RawSql) -> (RawSql -> a) -> SqlExpression a
$ctoRawSql :: SavepointName -> RawSql
toRawSql :: SavepointName -> RawSql
$cunsafeFromRawSql :: RawSql -> SavepointName
unsafeFromRawSql :: RawSql -> SavepointName
RawSql.SqlExpression
    , -- | @since 1.0.0.0
      Identifier -> SavepointName
SavepointName -> Identifier
(SavepointName -> Identifier)
-> (Identifier -> SavepointName)
-> IdentifierExpression SavepointName
forall name.
(name -> Identifier)
-> (Identifier -> name) -> IdentifierExpression name
$ctoIdentifier :: SavepointName -> Identifier
toIdentifier :: SavepointName -> Identifier
$cfromIdentifier :: Identifier -> SavepointName
fromIdentifier :: Identifier -> SavepointName
IdentifierExpression
    )

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

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