Safe Haskell	Safe-Inferred

Language.SQL.SimpleSQL.Syntax

Contents

Value expressions
Query expressions
- From

Description

The AST for SQL queries.

Synopsis

Value expressions

data ValueExpr Source

Represents a value expression. This is used for the expressions in select lists. It is also used for expressions in where, group by, having, order by and so on.

Constructors

NumLit String	a numeric literal optional decimal point, e+- integral exponent, e.g 10 10. .1 10.1 1e5 12.34e-6
StringLit String	string literal, currently only basic strings between single quotes with a single quote escaped using ''
IntervalLit	text of interval literal, units of interval precision, e.g. interval 3 days (3)
Fields ilLiteral :: String literal text ilUnits :: String units ilPrecision :: Maybe Int precision
Iden Name	identifier without dots
Star	star, as in select , t., count(*)
App Name [ValueExpr]	function application (anything that looks like c style function application syntactically)
AggregateApp	aggregate application, which adds distinct or all, and order by, to regular function application
Fields aggName :: Name aggregate function name aggDistinct :: Maybe SetQuantifier distinct aggArgs :: [ValueExpr] args aggOrderBy :: [SortSpec] order by
WindowApp	window application, which adds over (partition by a order by b) to regular function application. Explicit frames are not currently supported
Fields wnName :: Name window function name wnArgs :: [ValueExpr] args wnPartition :: [ValueExpr] partition by wnOrderBy :: [SortSpec] order by wnFrame :: Maybe Frame frame clause
BinOp ValueExpr Name ValueExpr	Infix binary operators. This is used for symbol operators (a + b), keyword operators (a and b) and multiple keyword operators (a is similar to b)
PrefixOp Name ValueExpr	Prefix unary operators. This is used for symbol operators, keyword operators and multiple keyword operators.
PostfixOp Name ValueExpr	Postfix unary operators. This is used for symbol operators, keyword operators and multiple keyword operators.
SpecialOp Name [ValueExpr]	Used for ternary, mixfix and other non orthodox operators. Currently used for row constructors, and for between.
SpecialOpK Name (Maybe ValueExpr) [(String, ValueExpr)]	Used for the operators which look like functions except the arguments are separated by keywords instead of commas. The maybe is for the first unnamed argument if it is present, and the list is for the keyword argument pairs.
Case	case expression. both flavours supported
Fields caseTest :: Maybe ValueExpr test value caseWhens :: [([ValueExpr], ValueExpr)] when branches caseElse :: Maybe ValueExpr else value
Parens ValueExpr
Cast ValueExpr TypeName	cast(a as typename)
TypedLit TypeName String	prefix 'typed literal', e.g. int '42'
SubQueryExpr SubQueryExprType QueryExpr	exists, all, any, some subqueries
In Bool ValueExpr InPredValue	in list literal and in subquery, if the bool is false it means not in was used ('a not in (1,2)')
Parameter	Represents a ? in a parameterized query

Instances

Eq ValueExpr
Read ValueExpr
Show ValueExpr

data Name Source

Represents an identifier name, which can be quoted or unquoted.

Constructors

Name String
QName String

Instances

Eq Name
Read Name
Show Name

data TypeName Source

Represents a type name, used in casts.

Constructors

TypeName String
PrecTypeName String Int
PrecScaleTypeName String Int Int

Instances

Eq TypeName
Read TypeName
Show TypeName

data SetQuantifier Source

Represents the Distinct or All keywords, which can be used before a select list, in an aggregate/window function application, or in a query expression set operator.

Constructors

Distinct
All

Instances

Eq SetQuantifier
Read SetQuantifier
Show SetQuantifier

data SortSpec Source

Represents one field in an order by list.

Constructors

SortSpec ValueExpr Direction NullsOrder

Instances

Eq SortSpec
Read SortSpec
Show SortSpec

data Direction Source

The direction for a column in order by.

Constructors

Asc
Desc

Instances

Eq Direction
Read Direction
Show Direction

data NullsOrder Source

Represents 'nulls first' or 'nulls last' in an order by clause.

Constructors

NullsOrderDefault
NullsFirst
NullsLast

Instances

Eq NullsOrder
Read NullsOrder
Show NullsOrder

data InPredValue Source

Used for 'expr in (value expression list)', and 'expr in (subquery)' syntax.

Constructors

InList [ValueExpr]
InQueryExpr QueryExpr

Instances

Eq InPredValue
Read InPredValue
Show InPredValue

data SubQueryExprType Source

A subquery in a value expression.

Constructors

SqExists	exists (query expr)
SqSq	a scalar subquery
SqAll	all (query expr)
SqSome	some (query expr)
SqAny	any (query expr)

Instances

Eq SubQueryExprType
Read SubQueryExprType
Show SubQueryExprType

data Frame Source

Represents the frame clause of a window this can be [range | rows] frame_start or [range | rows] between frame_start and frame_end

Constructors

FrameFrom FrameRows FramePos
FrameBetween FrameRows FramePos FramePos

Instances

Eq Frame
Read Frame
Show Frame

data FrameRows Source

Represents whether a window frame clause is over rows or ranges.

Constructors

FrameRows
FrameRange

Instances

Eq FrameRows
Read FrameRows
Show FrameRows

data FramePos Source

represents the start or end of a frame

Constructors

UnboundedPreceding
Preceding ValueExpr
Current
Following ValueExpr
UnboundedFollowing

Instances

Eq FramePos
Read FramePos
Show FramePos

Query expressions

data QueryExpr Source

Represents a query expression, which can be:

a regular select;
a set operator (union, except, intersect);
a common table expression (with);
a table value constructor (values (1,2),(3,4)); or
an explicit table (table t).

Constructors

Select
Fields qeSetQuantifier :: SetQuantifier qeSelectList :: [(ValueExpr, Maybe Name)] the expressions and the column aliases qeFrom :: [TableRef] qeWhere :: Maybe ValueExpr qeGroupBy :: [GroupingExpr] qeHaving :: Maybe ValueExpr qeOrderBy :: [SortSpec] qeOffset :: Maybe ValueExpr qeFetchFirst :: Maybe ValueExpr
CombineQueryExpr
Fields qe0 :: QueryExpr qeCombOp :: CombineOp qeSetQuantifier :: SetQuantifier qeCorresponding :: Corresponding qe1 :: QueryExpr
With
Fields qeWithRecursive :: Bool qeViews :: [(Alias, QueryExpr)] qeQueryExpression :: QueryExpr
Values [[ValueExpr]]
Table Name

Instances

Eq QueryExpr
Read QueryExpr
Show QueryExpr

makeSelect :: QueryExpr Source

Helper/'default' value for query exprs to make creating query expr values a little easier. It is defined like this:

 makeSelect :: QueryExpr
 makeSelect = Select {qeSetQuantifier = All
                     ,qeSelectList = []
                     ,qeFrom = []
                     ,qeWhere = Nothing
                     ,qeGroupBy = []
                     ,qeHaving = Nothing
                     ,qeOrderBy = []
                     ,qeOffset = Nothing
                     ,qeFetchFirst = Nothing}

data CombineOp Source

Query expression set operators.

Constructors

Union
Except
Intersect

Instances

Eq CombineOp
Read CombineOp
Show CombineOp

data Corresponding Source

Corresponding, an option for the set operators.

Constructors

Corresponding
Respectively

Instances

Eq Corresponding
Read Corresponding
Show Corresponding

data Alias Source

Represents an alias for a table valued expression, used in with queries and in from alias, e.g. select a from t u, select a from t u(b), with a(c) as select 1, select * from a.

Constructors

Alias Name (Maybe [Name])

Instances

Eq Alias
Read Alias
Show Alias

data GroupingExpr Source

Represents an item in a group by clause.

Constructors

GroupingParens [GroupingExpr]
Cube [GroupingExpr]
Rollup [GroupingExpr]
GroupingSets [GroupingExpr]
SimpleGroup ValueExpr

Instances

Eq GroupingExpr
Read GroupingExpr
Show GroupingExpr

From

data TableRef Source

Represents a entry in the csv of tables in the from clause.

Constructors

TRSimple Name	from t
TRJoin TableRef JoinType TableRef (Maybe JoinCondition)	from a join b
TRParens TableRef	from (a)
TRAlias TableRef Alias	from a as b(c,d)
TRQueryExpr QueryExpr	from (query expr)
TRFunction Name [ValueExpr]	from function(args)
TRLateral TableRef	from lateral t

Instances

Eq TableRef
Read TableRef
Show TableRef

data JoinType Source

The type of a join.

Constructors

JInner
JLeft
JRight
JFull
JCross

Instances

Eq JoinType
Read JoinType
Show JoinType

data JoinCondition Source

The join condition.

Constructors

JoinOn ValueExpr	on expr
JoinUsing [Name]	using (column list)
JoinNatural	natural join was used

Instances

Eq JoinCondition
Read JoinCondition
Show JoinCondition