Copyright	(c) Soostone Inc 2020
License	AllRightsReserved
Stability	experimental
Portability	POSIX
Safe Haskell	Safe-Inferred
Language	GHC2021

Napkin.Run.PGCommon

Contents

Orphan instances

Description

Synopsis

newtype PrettySqlError = PrettySqlError SqlError
data Named a = Named {
- _namedName :: Text
- _namedItem :: a
}
namedMap :: [Named a] -> Map Text a
class HasPostgresConn a where
- getPostgresConn :: BackendConn a -> Pool Connection
listTables :: (MonadNapkin b m, HasPostgresConn b) => b -> BackendConn b -> Set Prefix -> m (Set ListedTable)
query :: (Katip m, RenderSql q b, HasPostgresConn b) => b -> BackendConn b -> q -> m [Map Text Value]
query' :: forall r b q m. (Katip m, RenderSql q b, HasPostgresConn b, FromRow r) => b -> BackendConn b -> q -> m [r]
execute :: (Katip m, RenderSql q b, HasPostgresConn b) => b -> BackendConn b -> q -> m Int64
obtainTableKind :: (MonadNapkin b m, HasPostgresConn b) => b -> BackendConn b -> GetTableKind -> m TableKind
annotate :: (MonadNapkin b m, HasPostgresConn b, RenderSql AnnotateTableOrView b) => b -> BackendConn b -> AnnotateCommand -> m ()
readAnnotations :: (MonadNapkin b m, HasPostgresConn b) => b -> BackendConn b -> ReadAnnotationCommand -> m TableAnnotations
perform :: (Katip m, RenderSql q b, HasPostgresConn b) => (Connection -> Query -> IO r) -> Text -> b -> BackendConn b -> q -> m r
getDefaultSchema :: (MonadNapkin bk m, HasPostgresConn bk) => bk -> BackendConn bk -> m Name
checkTableExists :: (MonadNapkin bk m, HasPostgresConn bk) => bk -> BackendConn bk -> Ref Table -> m Bool
normalizedTableMap :: (MonadNapkin bk m, HasPostgresConn bk) => bk -> BackendConn bk -> Set (Ref Table) -> m (Map (Ref Table) NormalizedTable)
qry_checkTable :: SrcLitStr -> SrcLitStr -> Q ()
data PGSchemaField = PGSchemaField {
- scdName :: Text
- scdPos :: Int
- scdType :: Text
- scdMaxLen :: Maybe Int
- scdNullable :: Text
}
relationSchema :: forall bk f viewMeta. (HasPostgresConn bk, viewMeta ~ BackendViewMeta bk, Command DropView () bk, RenderSql DropView bk, Command (CreateView viewMeta) () bk, MonadNapkin bk f, Default viewMeta) => bk -> BackendConn bk -> Relation -> Ref Table -> f [PGSchemaField]
refFqTable :: Ref a -> (String, String)
getPostgresSchema :: (MonadNapkin b m, HasPostgresConn b) => b -> BackendConn b -> (String, String) -> m [PGSchemaField]
renameTableAndMoveSchema :: (MonadNapkin bk m, RenderSql SetTableSchema bk, HasPostgresConn bk, RenderSql RenameTable bk) => bk -> BackendConn bk -> RenameTable -> m ()
tellRowsAffected :: (HasBackendQueryStats bk, LocalQueryStats bk m) => bk -> Int64 -> m ()
fieldTypeByName :: Text -> Type

Documentation

newtype PrettySqlError #

Constructors

PrettySqlError SqlError

Instances

Instances details

Exception PrettySqlError #
Instance details Defined in Napkin.Run.PGCommon Methods toException :: PrettySqlError -> SomeException # fromException :: SomeException -> Maybe PrettySqlError # displayException :: PrettySqlError -> String #
Show PrettySqlError #
Instance details Defined in Napkin.Run.PGCommon Methods showsPrec :: Int -> PrettySqlError -> ShowS # show :: PrettySqlError -> String # showList :: [PrettySqlError] -> ShowS #

data Named a #

Constructors

Named
Fields _namedName :: Text _namedItem :: a

Instances

Instances details

Show a => Show (Named a) #
Instance details Defined in Napkin.Run.PGCommon Methods showsPrec :: Int -> Named a -> ShowS # show :: Named a -> String # showList :: [Named a] -> ShowS #
Eq a => Eq (Named a) #
Instance details Defined in Napkin.Run.PGCommon Methods (==) :: Named a -> Named a -> Bool # (/=) :: Named a -> Named a -> Bool #
Ord a => Ord (Named a) #
Instance details Defined in Napkin.Run.PGCommon Methods compare :: Named a -> Named a -> Ordering # (<) :: Named a -> Named a -> Bool # (<=) :: Named a -> Named a -> Bool # (>) :: Named a -> Named a -> Bool # (>=) :: Named a -> Named a -> Bool # max :: Named a -> Named a -> Named a # min :: Named a -> Named a -> Named a #
FromField (Named Value) #
Instance details Defined in Napkin.Run.PGCommon Methods fromField :: FieldParser (Named Value) #

namedMap :: [Named a] -> Map Text a #

class HasPostgresConn a where #

Methods

getPostgresConn :: BackendConn a -> Pool Connection #

Instances

Instances details

HasPostgresConn Postgres #
Instance details Defined in Napkin.Run.Postgres Methods getPostgresConn :: BackendConn Postgres -> Pool Connection #
HasPostgresConn Redshift #
Instance details Defined in Napkin.Run.Redshift Methods getPostgresConn :: BackendConn Redshift -> Pool Connection #

listTables :: (MonadNapkin b m, HasPostgresConn b) => b -> BackendConn b -> Set Prefix -> m (Set ListedTable) #

query :: (Katip m, RenderSql q b, HasPostgresConn b) => b -> BackendConn b -> q -> m [Map Text Value] #

query' :: forall r b q m. (Katip m, RenderSql q b, HasPostgresConn b, FromRow r) => b -> BackendConn b -> q -> m [r] #

execute :: (Katip m, RenderSql q b, HasPostgresConn b) => b -> BackendConn b -> q -> m Int64 #

obtainTableKind :: (MonadNapkin b m, HasPostgresConn b) => b -> BackendConn b -> GetTableKind -> m TableKind #

annotate :: (MonadNapkin b m, HasPostgresConn b, RenderSql AnnotateTableOrView b) => b -> BackendConn b -> AnnotateCommand -> m () #

readAnnotations :: (MonadNapkin b m, HasPostgresConn b) => b -> BackendConn b -> ReadAnnotationCommand -> m TableAnnotations #

perform :: (Katip m, RenderSql q b, HasPostgresConn b) => (Connection -> Query -> IO r) -> Text -> b -> BackendConn b -> q -> m r #

getDefaultSchema :: (MonadNapkin bk m, HasPostgresConn bk) => bk -> BackendConn bk -> m Name #

checkTableExists #

Arguments

:: (MonadNapkin bk m, HasPostgresConn bk)
=> bk
-> BackendConn bk
-> Ref Table	table
-> m Bool

Check if tableviewrelation exists. Schema is inferred if Ref contains multiple segments.

normalizedTableMap :: (MonadNapkin bk m, HasPostgresConn bk) => bk -> BackendConn bk -> Set (Ref Table) -> m (Map (Ref Table) NormalizedTable) #

qry_checkTable :: SrcLitStr -> SrcLitStr -> Q () #

Check if tableviewrelation exists in given schema.

http://stackoverflow.com/questions/20582500/how-to-check-if-a-table-exists-in-a-given-schema

data PGSchemaField #

Constructors

PGSchemaField
Fields scdName :: Text scdPos :: Int scdType :: Text scdMaxLen :: Maybe Int scdNullable :: Text

Instances

Instances details

Show PGSchemaField #
Instance details Defined in Napkin.Run.PGCommon Methods showsPrec :: Int -> PGSchemaField -> ShowS # show :: PGSchemaField -> String # showList :: [PGSchemaField] -> ShowS #
Eq PGSchemaField #
Instance details Defined in Napkin.Run.PGCommon Methods (==) :: PGSchemaField -> PGSchemaField -> Bool # (/=) :: PGSchemaField -> PGSchemaField -> Bool #
FromRow PGSchemaField #
Instance details Defined in Napkin.Run.PGCommon Methods fromRow :: RowParser PGSchemaField #

relationSchema :: forall bk f viewMeta. (HasPostgresConn bk, viewMeta ~ BackendViewMeta bk, Command DropView () bk, RenderSql DropView bk, Command (CreateView viewMeta) () bk, MonadNapkin bk f, Default viewMeta) => bk -> BackendConn bk -> Relation -> Ref Table -> f [PGSchemaField] #

Introspect schema of a Relation

refFqTable :: Ref a -> (String, String) #

getPostgresSchema :: (MonadNapkin b m, HasPostgresConn b) => b -> BackendConn b -> (String, String) -> m [PGSchemaField] #

renameTableAndMoveSchema :: (MonadNapkin bk m, RenderSql SetTableSchema bk, HasPostgresConn bk, RenderSql RenameTable bk) => bk -> BackendConn bk -> RenameTable -> m () #

tellRowsAffected :: (HasBackendQueryStats bk, LocalQueryStats bk m) => bk -> Int64 -> m () #

fieldTypeByName :: Text -> Type #

Orphan instances

FromField Name #
Instance details Methods fromField :: FieldParser Name #
FromRow AnnotationRow #
Instance details Methods fromRow :: RowParser AnnotationRow #
FromRow TableKind #
Instance details Methods fromRow :: RowParser TableKind #
FromRow Name #
Instance details Methods fromRow :: RowParser Name #
FromRow (Map Text Value) #
Instance details Methods fromRow :: RowParser (Map Text Value) #