Database.PostgreSQL.PQTypes.Model.Index

Documentation

data TableIndex

Constructors

TableIndex

Fields

• idxColumns :: [IndexColumn]
• idxInclude :: [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

Defined in Database.PostgreSQL.PQTypes.Model.Index

Methods

(==) :: TableIndex -> TableIndex -> Bool

(/=) :: TableIndex -> TableIndex -> Bool

Ord TableIndex

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

Defined in Database.PostgreSQL.PQTypes.Model.Index

Methods

showsPrec :: Int -> TableIndex -> ShowS

show :: TableIndex -> String

showList :: [TableIndex] -> ShowS

data IndexColumn

Constructors

IndexColumn (RawSQL ()) (Maybe (RawSQL ()))

Instances

Eq IndexColumn

Defined in Database.PostgreSQL.PQTypes.Model.Index

Methods

(==) :: IndexColumn -> IndexColumn -> Bool

(/=) :: IndexColumn -> IndexColumn -> Bool

Ord IndexColumn

Defined in Database.PostgreSQL.PQTypes.Model.Index

Methods

compare :: IndexColumn -> IndexColumn -> Ordering

(<) :: IndexColumn -> IndexColumn -> Bool

(<=) :: IndexColumn -> IndexColumn -> Bool

(>) :: IndexColumn -> IndexColumn -> Bool

(>=) :: IndexColumn -> IndexColumn -> Bool

max :: IndexColumn -> IndexColumn -> IndexColumn

min :: IndexColumn -> IndexColumn -> IndexColumn

Show IndexColumn

Defined in Database.PostgreSQL.PQTypes.Model.Index

Methods

showsPrec :: Int -> IndexColumn -> ShowS

show :: IndexColumn -> String

showList :: [IndexColumn] -> ShowS

IsString IndexColumn

Defined in Database.PostgreSQL.PQTypes.Model.Index

Methods

fromString :: String -> IndexColumn

indexColumn :: RawSQL () -> IndexColumn

indexColumnWithOperatorClass :: RawSQL () -> RawSQL () -> IndexColumn

data IndexMethod

Constructors

BTree

GIN

Instances

Eq IndexMethod

Defined in Database.PostgreSQL.PQTypes.Model.Index

Methods

(==) :: IndexMethod -> IndexMethod -> Bool

(/=) :: IndexMethod -> IndexMethod -> Bool

Ord IndexMethod

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

Defined in Database.PostgreSQL.PQTypes.Model.Index

Methods

readsPrec :: Int -> ReadS IndexMethod

readList :: ReadS [IndexMethod]

readPrec :: ReadPrec IndexMethod

readListPrec :: ReadPrec [IndexMethod]

Show IndexMethod

Defined in Database.PostgreSQL.PQTypes.Model.Index

Methods

showsPrec :: Int -> IndexMethod -> ShowS

show :: IndexMethod -> String

showList :: [IndexMethod] -> ShowS

tblIndex :: TableIndex

indexOnColumn :: IndexColumn -> TableIndex

indexOnColumns :: [IndexColumn] -> TableIndex

indexOnColumnWithMethod :: IndexColumn -> IndexMethod -> TableIndex

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 :: [IndexColumn] -> IndexMethod -> TableIndex

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 :: IndexColumn -> TableIndex

uniqueIndexOnColumnWithCondition :: IndexColumn -> RawSQL () -> TableIndex

uniqueIndexOnColumns :: [IndexColumn] -> TableIndex

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

sqlCreateIndexMaybeDowntime :: RawSQL () -> TableIndex -> RawSQL ()

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

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

Create index concurrently.

sqlDropIndexMaybeDowntime :: RawSQL () -> TableIndex -> RawSQL ()

Drop an index. Warning: if you don't want to lock out concurrent operations on the index's table, use DropIndexConcurrentlyMigration. See https://www.postgresql.org/docs/current/sql-dropindex.html for more information.

sqlDropIndexConcurrently :: RawSQL () -> TableIndex -> RawSQL ()