Safe Haskell	None
Language	Haskell2010

Database.PostgreSQL.PQTypes.Model.Index

Synopsis

data TableIndex = TableIndex {
- idxColumns :: [RawSQL ()]
- idxMethod :: IndexMethod
- idxUnique :: Bool
- idxValid :: Bool
- idxWhere :: Maybe (RawSQL ())
}
data IndexMethod
- = BTree
- | GIN
tblIndex :: TableIndex
indexOnColumn :: RawSQL () -> TableIndex
indexOnColumns :: [RawSQL ()] -> TableIndex
indexOnColumnWithMethod :: RawSQL () -> IndexMethod -> TableIndex
indexOnColumnsWithMethod :: [RawSQL ()] -> IndexMethod -> TableIndex
uniqueIndexOnColumn :: RawSQL () -> TableIndex
uniqueIndexOnColumnWithCondition :: RawSQL () -> RawSQL () -> TableIndex
uniqueIndexOnColumns :: [RawSQL ()] -> TableIndex
indexName :: RawSQL () -> TableIndex -> RawSQL ()
sqlCreateIndex :: RawSQL () -> TableIndex -> RawSQL ()
sqlCreateIndexSequentially :: RawSQL () -> TableIndex -> RawSQL ()
sqlCreateIndexConcurrently :: RawSQL () -> TableIndex -> RawSQL ()
sqlDropIndex :: RawSQL () -> TableIndex -> RawSQL ()

Documentation

data TableIndex Source #

Constructors

TableIndex
Fields idxColumns :: [RawSQL ()] idxMethod :: IndexMethod idxUnique :: Bool idxValid :: Bool If creation of index with CONCURRENTLY fails, index will be marked as invalid. Set it to `False` if such situation is expected. idxWhere :: Maybe (RawSQL ())

Instances

Eq TableIndex Source #
Instance details Defined in Database.PostgreSQL.PQTypes.Model.Index Methods (==) :: TableIndex -> TableIndex -> Bool # (/=) :: TableIndex -> TableIndex -> Bool #
Ord TableIndex Source #
Instance details Defined in Database.PostgreSQL.PQTypes.Model.Index Methods compare :: TableIndex -> TableIndex -> Ordering # (<) :: TableIndex -> TableIndex -> Bool # (<=) :: TableIndex -> TableIndex -> Bool # (>) :: TableIndex -> TableIndex -> Bool # (>=) :: TableIndex -> TableIndex -> Bool # max :: TableIndex -> TableIndex -> TableIndex # min :: TableIndex -> TableIndex -> TableIndex #
Show TableIndex Source #
Instance details Defined in Database.PostgreSQL.PQTypes.Model.Index Methods showsPrec :: Int -> TableIndex -> ShowS # show :: TableIndex -> String # showList :: [TableIndex] -> ShowS #

data IndexMethod Source #

Constructors

BTree
GIN

Instances

Eq IndexMethod Source #
Instance details Defined in Database.PostgreSQL.PQTypes.Model.Index Methods (==) :: IndexMethod -> IndexMethod -> Bool # (/=) :: IndexMethod -> IndexMethod -> Bool #
Ord IndexMethod Source #
Instance details Defined in Database.PostgreSQL.PQTypes.Model.Index Methods compare :: IndexMethod -> IndexMethod -> Ordering # (<) :: IndexMethod -> IndexMethod -> Bool # (<=) :: IndexMethod -> IndexMethod -> Bool # (>) :: IndexMethod -> IndexMethod -> Bool # (>=) :: IndexMethod -> IndexMethod -> Bool # max :: IndexMethod -> IndexMethod -> IndexMethod # min :: IndexMethod -> IndexMethod -> IndexMethod #
Read IndexMethod Source #
Instance details Defined in Database.PostgreSQL.PQTypes.Model.Index Methods readsPrec :: Int -> ReadS IndexMethod # readList :: ReadS [IndexMethod] # readPrec :: ReadPrec IndexMethod # readListPrec :: ReadPrec [IndexMethod] #
Show IndexMethod Source #
Instance details Defined in Database.PostgreSQL.PQTypes.Model.Index Methods showsPrec :: Int -> IndexMethod -> ShowS # show :: IndexMethod -> String # showList :: [IndexMethod] -> ShowS #

tblIndex :: TableIndex Source #

indexOnColumn :: RawSQL () -> TableIndex Source #

indexOnColumns :: [RawSQL ()] -> TableIndex Source #

indexOnColumnWithMethod :: RawSQL () -> IndexMethod -> TableIndex Source #

Create an index on the given column with the specified method. No checks are made that the method is appropriate for the type of the column.

indexOnColumnsWithMethod :: [RawSQL ()] -> IndexMethod -> TableIndex Source #

Create an index on the given columns with the specified method. No checks are made that the method is appropriate for the type of the column; cf. the PostgreSQL manual.

uniqueIndexOnColumn :: RawSQL () -> TableIndex Source #

uniqueIndexOnColumnWithCondition :: RawSQL () -> RawSQL () -> TableIndex Source #

uniqueIndexOnColumns :: [RawSQL ()] -> TableIndex Source #

indexName :: RawSQL () -> TableIndex -> RawSQL () Source #

sqlCreateIndex :: RawSQL () -> TableIndex -> RawSQL () Source #

Deprecated: Use sqlCreateIndexSequentially instead

Deprecated version of sqlCreateIndexSequentially.

sqlCreateIndexSequentially :: RawSQL () -> TableIndex -> RawSQL () Source #

Create index sequentially. Warning: if the affected table is large, this will prevent the table from being modified during the creation. If this is not acceptable, use sqlCreateIndexConcurrently. See https://www.postgresql.org/docs/current/sql-createindex.html for more information.

sqlCreateIndexConcurrently :: RawSQL () -> TableIndex -> RawSQL () Source #

Create index concurrently.

sqlDropIndex :: RawSQL () -> TableIndex -> RawSQL () Source #