{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Athena.Types.TableMetadata
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Athena.Types.TableMetadata where

import Amazonka.Athena.Types.Column
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | Contains metadata for a table.
--
-- /See:/ 'newTableMetadata' smart constructor.
data TableMetadata = TableMetadata'
  { -- | A list of the columns in the table.
    TableMetadata -> Maybe [Column]
columns :: Prelude.Maybe [Column],
    -- | The time that the table was created.
    TableMetadata -> Maybe POSIX
createTime :: Prelude.Maybe Data.POSIX,
    -- | The last time the table was accessed.
    TableMetadata -> Maybe POSIX
lastAccessTime :: Prelude.Maybe Data.POSIX,
    -- | A set of custom key\/value pairs for table properties.
    TableMetadata -> Maybe (HashMap Text Text)
parameters :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text),
    -- | A list of the partition keys in the table.
    TableMetadata -> Maybe [Column]
partitionKeys :: Prelude.Maybe [Column],
    -- | The type of table. In Athena, only @EXTERNAL_TABLE@ is supported.
    TableMetadata -> Maybe Text
tableType :: Prelude.Maybe Prelude.Text,
    -- | The name of the table.
    TableMetadata -> Text
name :: Prelude.Text
  }
  deriving (TableMetadata -> TableMetadata -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: TableMetadata -> TableMetadata -> Bool
$c/= :: TableMetadata -> TableMetadata -> Bool
== :: TableMetadata -> TableMetadata -> Bool
$c== :: TableMetadata -> TableMetadata -> Bool
Prelude.Eq, ReadPrec [TableMetadata]
ReadPrec TableMetadata
Int -> ReadS TableMetadata
ReadS [TableMetadata]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [TableMetadata]
$creadListPrec :: ReadPrec [TableMetadata]
readPrec :: ReadPrec TableMetadata
$creadPrec :: ReadPrec TableMetadata
readList :: ReadS [TableMetadata]
$creadList :: ReadS [TableMetadata]
readsPrec :: Int -> ReadS TableMetadata
$creadsPrec :: Int -> ReadS TableMetadata
Prelude.Read, Int -> TableMetadata -> ShowS
[TableMetadata] -> ShowS
TableMetadata -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [TableMetadata] -> ShowS
$cshowList :: [TableMetadata] -> ShowS
show :: TableMetadata -> String
$cshow :: TableMetadata -> String
showsPrec :: Int -> TableMetadata -> ShowS
$cshowsPrec :: Int -> TableMetadata -> ShowS
Prelude.Show, forall x. Rep TableMetadata x -> TableMetadata
forall x. TableMetadata -> Rep TableMetadata x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep TableMetadata x -> TableMetadata
$cfrom :: forall x. TableMetadata -> Rep TableMetadata x
Prelude.Generic)

-- |
-- Create a value of 'TableMetadata' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'columns', 'tableMetadata_columns' - A list of the columns in the table.
--
-- 'createTime', 'tableMetadata_createTime' - The time that the table was created.
--
-- 'lastAccessTime', 'tableMetadata_lastAccessTime' - The last time the table was accessed.
--
-- 'parameters', 'tableMetadata_parameters' - A set of custom key\/value pairs for table properties.
--
-- 'partitionKeys', 'tableMetadata_partitionKeys' - A list of the partition keys in the table.
--
-- 'tableType', 'tableMetadata_tableType' - The type of table. In Athena, only @EXTERNAL_TABLE@ is supported.
--
-- 'name', 'tableMetadata_name' - The name of the table.
newTableMetadata ::
  -- | 'name'
  Prelude.Text ->
  TableMetadata
newTableMetadata :: Text -> TableMetadata
newTableMetadata Text
pName_ =
  TableMetadata'
    { $sel:columns:TableMetadata' :: Maybe [Column]
columns = forall a. Maybe a
Prelude.Nothing,
      $sel:createTime:TableMetadata' :: Maybe POSIX
createTime = forall a. Maybe a
Prelude.Nothing,
      $sel:lastAccessTime:TableMetadata' :: Maybe POSIX
lastAccessTime = forall a. Maybe a
Prelude.Nothing,
      $sel:parameters:TableMetadata' :: Maybe (HashMap Text Text)
parameters = forall a. Maybe a
Prelude.Nothing,
      $sel:partitionKeys:TableMetadata' :: Maybe [Column]
partitionKeys = forall a. Maybe a
Prelude.Nothing,
      $sel:tableType:TableMetadata' :: Maybe Text
tableType = forall a. Maybe a
Prelude.Nothing,
      $sel:name:TableMetadata' :: Text
name = Text
pName_
    }

-- | A list of the columns in the table.
tableMetadata_columns :: Lens.Lens' TableMetadata (Prelude.Maybe [Column])
tableMetadata_columns :: Lens' TableMetadata (Maybe [Column])
tableMetadata_columns = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TableMetadata' {Maybe [Column]
columns :: Maybe [Column]
$sel:columns:TableMetadata' :: TableMetadata -> Maybe [Column]
columns} -> Maybe [Column]
columns) (\s :: TableMetadata
s@TableMetadata' {} Maybe [Column]
a -> TableMetadata
s {$sel:columns:TableMetadata' :: Maybe [Column]
columns = Maybe [Column]
a} :: TableMetadata) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The time that the table was created.
tableMetadata_createTime :: Lens.Lens' TableMetadata (Prelude.Maybe Prelude.UTCTime)
tableMetadata_createTime :: Lens' TableMetadata (Maybe UTCTime)
tableMetadata_createTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TableMetadata' {Maybe POSIX
createTime :: Maybe POSIX
$sel:createTime:TableMetadata' :: TableMetadata -> Maybe POSIX
createTime} -> Maybe POSIX
createTime) (\s :: TableMetadata
s@TableMetadata' {} Maybe POSIX
a -> TableMetadata
s {$sel:createTime:TableMetadata' :: Maybe POSIX
createTime = Maybe POSIX
a} :: TableMetadata) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | The last time the table was accessed.
tableMetadata_lastAccessTime :: Lens.Lens' TableMetadata (Prelude.Maybe Prelude.UTCTime)
tableMetadata_lastAccessTime :: Lens' TableMetadata (Maybe UTCTime)
tableMetadata_lastAccessTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TableMetadata' {Maybe POSIX
lastAccessTime :: Maybe POSIX
$sel:lastAccessTime:TableMetadata' :: TableMetadata -> Maybe POSIX
lastAccessTime} -> Maybe POSIX
lastAccessTime) (\s :: TableMetadata
s@TableMetadata' {} Maybe POSIX
a -> TableMetadata
s {$sel:lastAccessTime:TableMetadata' :: Maybe POSIX
lastAccessTime = Maybe POSIX
a} :: TableMetadata) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | A set of custom key\/value pairs for table properties.
tableMetadata_parameters :: Lens.Lens' TableMetadata (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
tableMetadata_parameters :: Lens' TableMetadata (Maybe (HashMap Text Text))
tableMetadata_parameters = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TableMetadata' {Maybe (HashMap Text Text)
parameters :: Maybe (HashMap Text Text)
$sel:parameters:TableMetadata' :: TableMetadata -> Maybe (HashMap Text Text)
parameters} -> Maybe (HashMap Text Text)
parameters) (\s :: TableMetadata
s@TableMetadata' {} Maybe (HashMap Text Text)
a -> TableMetadata
s {$sel:parameters:TableMetadata' :: Maybe (HashMap Text Text)
parameters = Maybe (HashMap Text Text)
a} :: TableMetadata) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | A list of the partition keys in the table.
tableMetadata_partitionKeys :: Lens.Lens' TableMetadata (Prelude.Maybe [Column])
tableMetadata_partitionKeys :: Lens' TableMetadata (Maybe [Column])
tableMetadata_partitionKeys = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TableMetadata' {Maybe [Column]
partitionKeys :: Maybe [Column]
$sel:partitionKeys:TableMetadata' :: TableMetadata -> Maybe [Column]
partitionKeys} -> Maybe [Column]
partitionKeys) (\s :: TableMetadata
s@TableMetadata' {} Maybe [Column]
a -> TableMetadata
s {$sel:partitionKeys:TableMetadata' :: Maybe [Column]
partitionKeys = Maybe [Column]
a} :: TableMetadata) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The type of table. In Athena, only @EXTERNAL_TABLE@ is supported.
tableMetadata_tableType :: Lens.Lens' TableMetadata (Prelude.Maybe Prelude.Text)
tableMetadata_tableType :: Lens' TableMetadata (Maybe Text)
tableMetadata_tableType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TableMetadata' {Maybe Text
tableType :: Maybe Text
$sel:tableType:TableMetadata' :: TableMetadata -> Maybe Text
tableType} -> Maybe Text
tableType) (\s :: TableMetadata
s@TableMetadata' {} Maybe Text
a -> TableMetadata
s {$sel:tableType:TableMetadata' :: Maybe Text
tableType = Maybe Text
a} :: TableMetadata)

-- | The name of the table.
tableMetadata_name :: Lens.Lens' TableMetadata Prelude.Text
tableMetadata_name :: Lens' TableMetadata Text
tableMetadata_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TableMetadata' {Text
name :: Text
$sel:name:TableMetadata' :: TableMetadata -> Text
name} -> Text
name) (\s :: TableMetadata
s@TableMetadata' {} Text
a -> TableMetadata
s {$sel:name:TableMetadata' :: Text
name = Text
a} :: TableMetadata)

instance Data.FromJSON TableMetadata where
  parseJSON :: Value -> Parser TableMetadata
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"TableMetadata"
      ( \Object
x ->
          Maybe [Column]
-> Maybe POSIX
-> Maybe POSIX
-> Maybe (HashMap Text Text)
-> Maybe [Column]
-> Maybe Text
-> Text
-> TableMetadata
TableMetadata'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Columns" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"CreateTime")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"LastAccessTime")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Parameters" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"PartitionKeys" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"TableType")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"Name")
      )

instance Prelude.Hashable TableMetadata where
  hashWithSalt :: Int -> TableMetadata -> Int
hashWithSalt Int
_salt TableMetadata' {Maybe [Column]
Maybe Text
Maybe (HashMap Text Text)
Maybe POSIX
Text
name :: Text
tableType :: Maybe Text
partitionKeys :: Maybe [Column]
parameters :: Maybe (HashMap Text Text)
lastAccessTime :: Maybe POSIX
createTime :: Maybe POSIX
columns :: Maybe [Column]
$sel:name:TableMetadata' :: TableMetadata -> Text
$sel:tableType:TableMetadata' :: TableMetadata -> Maybe Text
$sel:partitionKeys:TableMetadata' :: TableMetadata -> Maybe [Column]
$sel:parameters:TableMetadata' :: TableMetadata -> Maybe (HashMap Text Text)
$sel:lastAccessTime:TableMetadata' :: TableMetadata -> Maybe POSIX
$sel:createTime:TableMetadata' :: TableMetadata -> Maybe POSIX
$sel:columns:TableMetadata' :: TableMetadata -> Maybe [Column]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Column]
columns
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
createTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
lastAccessTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (HashMap Text Text)
parameters
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Column]
partitionKeys
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
tableType
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
name

instance Prelude.NFData TableMetadata where
  rnf :: TableMetadata -> ()
rnf TableMetadata' {Maybe [Column]
Maybe Text
Maybe (HashMap Text Text)
Maybe POSIX
Text
name :: Text
tableType :: Maybe Text
partitionKeys :: Maybe [Column]
parameters :: Maybe (HashMap Text Text)
lastAccessTime :: Maybe POSIX
createTime :: Maybe POSIX
columns :: Maybe [Column]
$sel:name:TableMetadata' :: TableMetadata -> Text
$sel:tableType:TableMetadata' :: TableMetadata -> Maybe Text
$sel:partitionKeys:TableMetadata' :: TableMetadata -> Maybe [Column]
$sel:parameters:TableMetadata' :: TableMetadata -> Maybe (HashMap Text Text)
$sel:lastAccessTime:TableMetadata' :: TableMetadata -> Maybe POSIX
$sel:createTime:TableMetadata' :: TableMetadata -> Maybe POSIX
$sel:columns:TableMetadata' :: TableMetadata -> Maybe [Column]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Column]
columns
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
createTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
lastAccessTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text Text)
parameters
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Column]
partitionKeys
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
tableType
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
name