{-# LANGUAGE GeneralizedNewtypeDeriving #-}

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

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

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

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

> "some_sequence_name"

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

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

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