Orville.PostgreSQL.Expr.SequenceDefinition

Since: 1.0.0.0

Documentation

data CreateSequenceExpr

Type to represent a CREATE SEQUENCE statement. E.G.

CREATE SEQUENCE foo INCREMENT 2

CreateSequenceExpr provides a SqlExpression instance. See unsafeSqlExpression for how to construct a value with your own custom SQL.

Since: 1.0.0.0

Instances

SqlExpression CreateSequenceExpr

Defined in Orville.PostgreSQL.Expr.SequenceDefinition

Methods

toRawSql :: CreateSequenceExpr -> RawSql

unsafeFromRawSql :: RawSql -> CreateSequenceExpr

createSequenceExpr

Arguments

:: Qualified SequenceName

The name to be used for the sequence.

-> Maybe IncrementByExpr

An optional INCREMENT expression.

-> Maybe MinValueExpr

An optional MINVALUE expression.

-> Maybe MaxValueExpr

An optional MAXVALUE expression.

-> Maybe StartWithExpr

An optional START WITH expression.

-> Maybe CacheExpr

An optional CACHE expression.

-> Maybe CycleExpr

An optional CYCLE expression.

-> CreateSequenceExpr

Constructs a CreateSequenceExpr with the given sequence options.

Since: 1.0.0.0

data AlterSequenceExpr

Type to represent a CREATE SEQUENCE statement. E.G.

ALTER SEQUENCE foo START WITH 0

AlterSequenceExpr provides a SqlExpression instance. See unsafeSqlExpression for how to construct a value with your own custom SQL.

Since: 1.0.0.0

Instances

SqlExpression AlterSequenceExpr

Defined in Orville.PostgreSQL.Expr.SequenceDefinition

Methods

toRawSql :: AlterSequenceExpr -> RawSql

unsafeFromRawSql :: RawSql -> AlterSequenceExpr

alterSequenceExpr

Arguments

:: Qualified SequenceName

The name of the sequence to alter

-> Maybe IncrementByExpr

An optional INCREMENT expression

-> Maybe MinValueExpr

An optional MINVALUE expression

-> Maybe MaxValueExpr

An optional MAXVALUE expression

-> Maybe StartWithExpr

An optional START WITH expression

-> Maybe CacheExpr

An optional CACHE expression

-> Maybe CycleExpr

An optional CYCLE expression

-> AlterSequenceExpr

Constructs an AlterSequenceExpr with the given sequence options.

Since: 1.0.0.0

data IncrementByExpr

Type to represent an INCREMENT BY expression for sequences. E.G.

INCREMENT BY 0

IncrementByExpr provides a SqlExpression instance. See unsafeSqlExpression for how to construct a value with your own custom SQL.

Since: 1.0.0.0

Instances

SqlExpression IncrementByExpr

Defined in Orville.PostgreSQL.Expr.SequenceDefinition

Methods

toRawSql :: IncrementByExpr -> RawSql

unsafeFromRawSql :: RawSql -> IncrementByExpr

incrementBy :: Int64 -> IncrementByExpr

Constructs an IncrementByExpr that will make the sequence increment by the given value.

Since: 1.0.0.0

data MinValueExpr

Type to represent a MINVALUE expression for sequences. E.G.

MINVALUE 0

MinValueExpr provides a SqlExpression instance. See unsafeSqlExpression for how to construct a value with your own custom SQL.

Since: 1.0.0.0

Instances

SqlExpression MinValueExpr

Defined in Orville.PostgreSQL.Expr.SequenceDefinition

Methods

toRawSql :: MinValueExpr -> RawSql

unsafeFromRawSql :: RawSql -> MinValueExpr

minValue :: Int64 -> MinValueExpr

Constructs a MinValueExpr which gives the sequence the specified minimum value.

Since: 1.0.0.0

noMinValue :: MinValueExpr

Constructs a MinValueExpr which gives the sequence no minimum value (i.e. NO MINVALUE).

Since: 1.0.0.0

data MaxValueExpr

Type to represent a MAXVALUE expression for sequences. E.G.

MAXVALUE 1000000

MaxValueExpr provides a SqlExpression instance. See unsafeSqlExpression for how to construct a value with your own custom SQL.

Since: 1.0.0.0

Instances

SqlExpression MaxValueExpr

Defined in Orville.PostgreSQL.Expr.SequenceDefinition

Methods

toRawSql :: MaxValueExpr -> RawSql

unsafeFromRawSql :: RawSql -> MaxValueExpr

maxValue :: Int64 -> MaxValueExpr

Constructs a MaxValueExpr which gives the sequence the specified maximum value.

Since: 1.0.0.0

noMaxValue :: MaxValueExpr

Constructs a MaxValueExpr which gives the sequence no maximum value (i.e. NO MAXVALUE).

Since: 1.0.0.0

data StartWithExpr

Type to represent a START WITH expression for sequences. E.G.

START WITH 1

StartWithExpr provides a SqlExpression instance. See unsafeSqlExpression for how to construct a value with your own custom SQL.

Since: 1.0.0.0

Instances

SqlExpression StartWithExpr

Defined in Orville.PostgreSQL.Expr.SequenceDefinition

Methods

toRawSql :: StartWithExpr -> RawSql

unsafeFromRawSql :: RawSql -> StartWithExpr

startWith :: Int64 -> StartWithExpr

Constructs a StartWithExpr which gives the sequence the specified start value.

Since: 1.0.0.0

data CacheExpr

Type to represent a CACHE expression for sequences. E.G.

CACHE 16

CacheExpr provides a SqlExpression instance. See unsafeSqlExpression for how to construct a value with your own custom SQL.

Since: 1.0.0.0

Instances

SqlExpression CacheExpr

Defined in Orville.PostgreSQL.Expr.SequenceDefinition

Methods

toRawSql :: CacheExpr -> RawSql

unsafeFromRawSql :: RawSql -> CacheExpr

cache :: Int64 -> CacheExpr

Constructs a CacheExpr that will make the sequence pre-allocate the specified number of sequence values.

Since: 1.0.0.0

data CycleExpr

Type to represent a CYCLE expression for sequences. E.G.

CYCLE

or

NO CYCLE

CycleExpr provides a SqlExpression instance. See unsafeSqlExpression for how to construct a value with your own custom SQL.

Since: 1.0.0.0

Instances

SqlExpression CycleExpr

Defined in Orville.PostgreSQL.Expr.SequenceDefinition

Methods

toRawSql :: CycleExpr -> RawSql

unsafeFromRawSql :: RawSql -> CycleExpr

cycle :: CycleExpr

Constructs a CycleExpr that indicates that the sequence should cycle.

Since: 1.0.0.0

noCycle :: CycleExpr

Constructs a CycleExpr that indicates that the sequence should not cycle.

Since: 1.0.0.0

cycleIfTrue :: Bool -> CycleExpr

Constructs a CycleExpr that will cause the sequence to cycle if the flag passed is True.

Since: 1.0.0.0

data DropSequenceExpr

Type to represent a DROP SEQUENCE statement. E.G.

DROP SEQUENCE foo

DropSequenceExpr provides a SqlExpression instance. See unsafeSqlExpression for how to construct a value with your own custom SQL.

Since: 1.0.0.0

Instances

SqlExpression DropSequenceExpr

Defined in Orville.PostgreSQL.Expr.SequenceDefinition

Methods

toRawSql :: DropSequenceExpr -> RawSql

unsafeFromRawSql :: RawSql -> DropSequenceExpr

dropSequenceExpr :: Maybe IfExists -> Qualified SequenceName -> DropSequenceExpr

Constructs a DropSequenceExpr that will drop sequence with the given name. You may specify an IfExists argument if you want to include an IF EXISTS condition in the statement.

Since: 1.0.0.0

nextVal :: Qualified SequenceName -> ValueExpression

Constructs a ValueExpression that will use the nextval PostgreSQL function to get the next value from the given sequence. If you're trying to construct your own SELECT to get the value of the sequence, you can use the constructed ValueExpression with deriveColumnAs to build the item to select.

Since: 1.0.0.0

nextValFunction :: FunctionName

The nextval PostgreSQL function.

Since: 1.0.0.0

currVal :: Qualified SequenceName -> ValueExpression

Constructs a ValueExpression that will use the currval PostgreSQL function to get the current value from the given sequence. If you're trying to construct your own SELECT to get the value of the sequence, you can use the constructed ValueExpression with deriveColumnAs to build the item to select.

Since: 1.0.0.0

currValFunction :: FunctionName

The currval PostgreSQL function.

Since: 1.0.0.0

setVal :: Qualified SequenceName -> Int64 -> ValueExpression

Constructs a ValueExpression that will use the setval PostgreSQL function to set the value from the given sequence. If you're trying to construct your own SELECT to set the value of the sequence, you can use the constructed ValueExpression with deriveColumnAs to build the item to select.

Since: 1.0.0.0

setValFunction :: FunctionName

The setval PostgreSQL function.

Since: 1.0.0.0