-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Backend for the persistent library using postgresql.
--
-- Based on the postgresql-simple package
@package persistent-postgresql
@version 2.10.0
-- | A postgresql backend for persistent.
module Database.Persist.Postgresql
-- | Create a PostgreSQL connection pool and run the given action. The pool
-- is properly released after the action finishes using it. Note that you
-- should not use the given ConnectionPool outside the action
-- since it may already have been released.
withPostgresqlPool :: (MonadLogger m, MonadUnliftIO m) => ConnectionString -> Int -> (Pool SqlBackend -> m a) -> m a
-- | Same as withPostgresPool, but takes a callback for obtaining
-- the server version (to work around an Amazon Redshift bug).
withPostgresqlPoolWithVersion :: (MonadUnliftIO m, MonadLogger m) => (Connection -> IO (Maybe Double)) -> ConnectionString -> Int -> (Pool SqlBackend -> m a) -> m a
-- | Same as withPostgresqlPool, but instead of opening a pool of
-- connections, only one connection is opened.
withPostgresqlConn :: (MonadUnliftIO m, MonadLogger m) => ConnectionString -> (SqlBackend -> m a) -> m a
-- | Same as withPostgresqlConn, but takes a callback for obtaining
-- the server version (to work around an Amazon Redshift bug).
withPostgresqlConnWithVersion :: (MonadUnliftIO m, MonadLogger m) => (Connection -> IO (Maybe Double)) -> ConnectionString -> (SqlBackend -> m a) -> m a
-- | Create a PostgreSQL connection pool. Note that it's your
-- responsibility to properly close the connection pool when unneeded.
-- Use withPostgresqlPool for an automatic resource control.
createPostgresqlPool :: (MonadUnliftIO m, MonadLogger m) => ConnectionString -> Int -> m (Pool SqlBackend)
-- | Same as createPostgresqlPool, but additionally takes a callback
-- function for some connection-specific tweaking to be performed after
-- connection creation. This could be used, for example, to change the
-- schema. For more information, see:
--
--
-- https://groups.google.com/d/msg/yesodweb/qUXrEN_swEo/O0pFwqwQIdcJ
createPostgresqlPoolModified :: (MonadUnliftIO m, MonadLogger m) => (Connection -> IO ()) -> ConnectionString -> Int -> m (Pool SqlBackend)
-- | Same as other similarly-named functions in this module, but takes
-- callbacks for obtaining the server version (to work around an Amazon
-- Redshift bug) and connection-specific tweaking (to change the schema).
createPostgresqlPoolModifiedWithVersion :: (MonadUnliftIO m, MonadLogger m) => (Connection -> IO (Maybe Double)) -> (Connection -> IO ()) -> ConnectionString -> Int -> m (Pool SqlBackend)
-- | A libpq connection string. A simple example of connection
-- string would be "host=localhost port=5432 user=test dbname=test
-- password=test". Please read libpq's documentation at
-- https://www.postgresql.org/docs/current/static/libpq-connect.html
-- for more details on how to create such strings.
type ConnectionString = ByteString
-- | Information required to connect to a PostgreSQL database using
-- persistent's generic facilities. These values are the same
-- that are given to withPostgresqlPool.
data PostgresConf
PostgresConf :: ConnectionString -> Int -> PostgresConf
-- | The connection string.
[pgConnStr] :: PostgresConf -> ConnectionString
-- | How many connections should be held in the connection pool.
[pgPoolSize] :: PostgresConf -> Int
-- | Generate a SqlBackend from a Connection.
openSimpleConn :: LogFunc -> Connection -> IO SqlBackend
-- | Generate a SqlBackend from a Connection, but takes a
-- callback for obtaining the server version.
openSimpleConnWithVersion :: (Connection -> IO (Maybe Double)) -> LogFunc -> Connection -> IO SqlBackend
-- | Get the SQL string for the table that a PeristEntity represents.
-- Useful for raw SQL queries.
tableName :: PersistEntity record => record -> Text
-- | Get the SQL string for the field that an EntityField represents.
-- Useful for raw SQL queries.
fieldName :: PersistEntity record => EntityField record typ -> Text
-- | Mock a migration even when the database is not present. This function
-- performs the same functionality of printMigration with the
-- difference that an actual database is not needed.
mockMigration :: Migration -> IO ()
-- | Enable a Postgres extension. See
-- https://www.postgresql.org/docs/current/static/contrib.html for
-- a list.
migrateEnableExtension :: Text -> Migration
instance Data.Data.Data Database.Persist.Postgresql.PostgresConf
instance GHC.Read.Read Database.Persist.Postgresql.PostgresConf
instance GHC.Show.Show Database.Persist.Postgresql.PostgresConf
instance GHC.Classes.Ord Database.Persist.Postgresql.Unknown
instance GHC.Read.Read Database.Persist.Postgresql.Unknown
instance GHC.Show.Show Database.Persist.Postgresql.Unknown
instance GHC.Classes.Eq Database.Persist.Postgresql.Unknown
instance Data.Aeson.Types.FromJSON.FromJSON Database.Persist.Postgresql.PostgresConf
instance Database.Persist.Class.PersistConfig.PersistConfig Database.Persist.Postgresql.PostgresConf
instance Database.PostgreSQL.Simple.ToField.ToField Database.Persist.Postgresql.P
instance Database.PostgreSQL.Simple.FromField.FromField Database.Persist.Postgresql.Unknown
instance Database.PostgreSQL.Simple.ToField.ToField Database.Persist.Postgresql.Unknown
instance GHC.Show.Show Database.Persist.Postgresql.PostgresServerVersionError
instance GHC.Exception.Type.Exception Database.Persist.Postgresql.PostgresServerVersionError
-- | Filter operators for JSON values added to PostgreSQL 9.4
module Database.Persist.Postgresql.JSON
-- | This operator checks inclusion of the JSON value on the right hand
-- side in the JSON value on the left hand side.
--
-- Objects
--
-- An empty Object matches any object
--
--
-- {} @> {} == True
-- {"a":1,"b":false} @> {} == True
--
--
-- Any key-value will be matched top-level
--
--
-- {"a":1,"b":{"c":true"}} @> {"a":1} == True
-- {"a":1,"b":{"c":true"}} @> {"b":1} == False
-- {"a":1,"b":{"c":true"}} @> {"b":{}} == True
-- {"a":1,"b":{"c":true"}} @> {"c":true} == False
-- {"a":1,"b":{"c":true"}} @> {"b":{c":true}} == True
--
--
-- Arrays
--
-- An empty Array matches any array
--
--
-- [] @> [] == True
-- [1,2,"hi",false,null] @> [] == True
--
--
-- Any array has to be a sub-set. Any object or array will also be
-- compared as being a subset of.
--
--
-- [1,2,"hi",false,null] @> [1] == True
-- [1,2,"hi",false,null] @> [null,"hi"] == True
-- [1,2,"hi",false,null] @> ["hi",true] == False
-- [1,2,"hi",false,null] @> ["hi",2,null,false,1] == True
-- [1,2,"hi",false,null] @> [1,2,"hi",false,null,{}] == False
--
--
-- Arrays and objects inside arrays match the same way they'd be matched
-- as being on their own.
--
--
-- [1,"hi",[false,3],{"a":[null]}] @> [{}] == True
-- [1,"hi",[false,3],{"a":[null]}] @> [{"a":[]}] == True
-- [1,"hi",[false,3],{"a":[null]}] @> [{"b":[null]}] == False
-- [1,"hi",[false,3],{"a":[null]}] @> [[]] == True
-- [1,"hi",[false,3],{"a":[null]}] @> [[3]] == True
-- [1,"hi",[false,3],{"a":[null]}] @> [[true,3]] == False
--
--
-- A regular value has to be a member
--
--
-- [1,2,"hi",false,null] @> 1 == True
-- [1,2,"hi",false,null] @> 5 == False
-- [1,2,"hi",false,null] @> "hi" == True
-- [1,2,"hi",false,null] @> false == True
-- [1,2,"hi",false,null] @> "2" == False
--
--
-- An object will never match with an array
--
--
-- [1,2,"hi",[false,3],{"a":null}] @> {} == False
-- [1,2,"hi",[false,3],{"a":null}] @> {"a":null} == False
--
--
-- Other values
--
-- For any other JSON values the `(@>.)` operator functions like an
-- equivalence operator.
--
--
-- "hello" @> "hello" == True
-- "hello" @> "Hello" == False
-- "hello" @> "h" == False
-- "hello" @> {"hello":1} == False
-- "hello" @> ["hello"] == False
--
-- 5 @> 5 == True
-- 5 @> 5.00 == True
-- 5 @> 1 == False
-- 5 @> 7 == False
-- 12345 @> 1234 == False
-- 12345 @> 2345 == False
-- 12345 @> "12345" == False
-- 12345 @> [1,2,3,4,5] == False
--
-- true @> true == True
-- true @> false == False
-- false @> true == False
-- true @> "true" == False
--
-- null @> null == True
-- null @> 23 == False
-- null @> "null" == False
-- null @> {} == False
--
(@>.) :: EntityField record Value -> Value -> Filter record
infix 4 @>.
-- | Same as @>. except the inclusion check is reversed. i.e. is
-- the JSON value on the left hand side included in the JSON value of the
-- right hand side.
(<@.) :: EntityField record Value -> Value -> Filter record
infix 4 <@.
-- | This operator takes a column and a string to find a top-level
-- key/field in an object.
--
--
-- column ?. string
--
--
-- N.B. This operator might have some unexpected interactions with
-- non-object values. Please reference the examples.
--
-- Objects
--
--
-- {"a":null} ? "a" == True
-- {"test":false,"a":500} ? "a" == True
-- {"b":{"a":[]}} ? "a" == False
-- {} ? "a" == False
-- {} ? "{}" == False
-- {} ? "" == False
-- {"":9001} ? "" == True
--
--
-- Arrays
--
-- This operator will match an array if the string to be matched is an
-- element of that array, but nothing else.
--
--
-- ["a"] ? "a" == True
-- [["a"]] ? "a" == False
-- [9,false,"1",null] ? "1" == True
-- [] ? "[]" == False
-- [{"a":true}] ? "a" == False
--
--
-- Other values
--
-- This operator functions like an equivalence operator on strings only.
-- Any other value does not match.
--
--
-- "a" ? "a" == True
-- "1" ? "1" == True
-- "ab" ? "a" == False
-- 1 ? "1" == False
-- null ? "null" == False
-- true ? "true" == False
-- 1.5 ? "1.5" == False
--
(?.) :: EntityField record Value -> Text -> Filter record
infix 4 ?.
-- | This operator takes a column and a list of strings to test whether ANY
-- of the elements of the list are top level fields in an object.
--
--
-- column ?|. list
--
--
-- /N.B. An empty list will never match anything. Also, this
-- operator might have some unexpected interactions with non-object
-- values. Please reference the examples./
--
-- Objects
--
--
-- {"a":null} ?| ["a","b","c"] == True
-- {"test":false,"a":500} ?| ["a","b","c"] == True
-- {} ?| ["a","{}"] == False
-- {"b":{"a":[]}} ?| ["a","c"] == False
-- {"b":{"a":[]},"test":null} ?| [] == False
--
--
-- Arrays
--
-- This operator will match an array if any of the elements of the
-- list are matching string elements of the array.
--
--
-- ["a"] ?| ["a","b","c"] == True
-- [["a"]] ?| ["a","b","c"] == False
-- [9,false,"1",null] ?| ["a","false"] == False
-- [] ?| ["a","b","c"] == False
-- [] ?| [] == False
-- [{"a":true}] ?| ["a","b","c"] == False
-- [null,4,"b",[]] ?| ["a","b","c"] == True
--
--
-- Other values
--
-- This operator functions much like an equivalence operator on strings
-- only. If a string matches with any element of the given list,
-- the comparison matches. No other values match.
--
--
-- "a" ?| ["a","b","c"] == True
-- "1" ?| ["a","b","1"] == True
-- "ab" ?| ["a","b","c"] == False
-- 1 ?| ["a","1"] == False
-- null ?| ["a","null"] == False
-- true ?| ["a","true"] == False
-- "a" ?| [] == False
--
(?|.) :: EntityField record Value -> [Text] -> Filter record
infix 4 ?|.
-- | This operator takes a column and a list of strings to test whether ALL
-- of the elements of the list are top level fields in an object.
--
--
-- column ?&. list
--
--
-- /N.B. An empty list will match anything. Also, this operator
-- might have some unexpected interactions with non-object values. Please
-- reference the examples./
--
-- Objects
--
--
-- {"a":null} ?& ["a"] == True
-- {"a":null} ?& ["a","a"] == True
-- {"test":false,"a":500} ?& ["a"] == True
-- {"test":false,"a":500} ?& ["a","b"] == False
-- {} ?& ["{}"] == False
-- {"b":{"a":[]}} ?& ["a"] == False
-- {"b":{"a":[]},"c":false} ?& ["a","c"] == False
-- {"a":1,"b":2,"c":3,"d":4} ?& ["b","d"] == True
-- {} ?& [] == True
-- {"b":{"a":[]},"test":null} ?& [] == True
--
--
-- Arrays
--
-- This operator will match an array if all of the elements of the
-- list are matching string elements of the array.
--
--
-- ["a"] ?& ["a"] == True
-- ["a"] ?& ["a","a"] == True
-- [["a"]] ?& ["a"] == False
-- ["a","b","c"] ?& ["a","b","d"] == False
-- [9,"false","1",null] ?& ["1","false"] == True
-- [] ?& ["a","b"] == False
-- [{"a":true}] ?& ["a"] == False
-- ["a","b","c","d"] ?& ["b","c","d"] == True
-- [null,4,{"test":false}] ?& [] == True
-- [] ?& [] == True
--
--
-- Other values
--
-- This operator functions much like an equivalence operator on strings
-- only. If a string matches with all elements of the given list, the
-- comparison matches.
--
--
-- "a" ?& ["a"] == True
-- "1" ?& ["a","1"] == False
-- "b" ?& ["b","b"] == True
-- "ab" ?& ["a","b"] == False
-- 1 ?& ["1"] == False
-- null ?& ["null"] == False
-- true ?& ["true"] == False
-- 31337 ?& [] == True
-- true ?& [] == True
-- null ?& [] == True
--
(?&.) :: EntityField record Value -> [Text] -> Filter record
infix 4 ?&.
-- | A JSON value represented as a Haskell value.
data Value
instance Database.Persist.Class.PersistField.PersistField a => Database.Persist.Class.PersistField.PersistField (Database.Persist.Postgresql.JSON.PostgresArray a)
instance Database.Persist.Class.PersistField.PersistField Data.Aeson.Types.Internal.Value
instance Database.Persist.Sql.Class.PersistFieldSql Data.Aeson.Types.Internal.Value