{-# LANGUAGE GeneralizedNewtypeDeriving #-}

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

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

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

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

> "some_index_name"

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

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

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