Safe Haskell	None
Language	Haskell2010

Database.HsSqlPpp.Syntax

Contents

Name and TypeName
Scalar expressions
Query expressions
Statements
utility
misc

Description

This module contains the ast node data types. They are very permissive, in that they allow a lot of invalid SQL to be represented. The type checking process should catch all invalid trees, but doesn't quite manage at the moment. Sorry about all the seemingly pointless type synonyms below, they are an artefact of using UUAGC. You can see labels for the fields by looking at the ag source here: https://github.com/JakeWheat/hssqlppp/blob/master/src/Database/HsSqlPpp/Internals/AstInternal.ag

Synopsis

Name and TypeName

data Name Source

Constructors

Name Annotation [NameComponent]
AntiName String

Instances

Eq Name Source
Data Name Source
Show Name Source

data NameComponent Source

Constructors

Nmc String
QNmc String
AntiNameComponent String

Instances

Eq NameComponent Source
Data NameComponent Source
Ord NameComponent Source
Show NameComponent Source

nameComponents :: Name -> [NameComponent] Source

ncStr :: NameComponent -> String Source

Scalar expressions

data ScalarExpr Source

Constructors

NumberLit Annotation String
StringLit Annotation String
NullLit Annotation
BooleanLit Annotation Bool
TypedStringLit Annotation TypeName String
Interval Annotation String IntervalField (Maybe Int)
Identifier Annotation Name
Star Annotation
QStar Annotation NameComponent
PositionalArg Annotation Integer
Placeholder Annotation
PrefixOp Annotation Name ScalarExpr
PostfixOp Annotation Name ScalarExpr
BinaryOp Annotation Name ScalarExpr ScalarExpr
SpecialOp Annotation Name ScalarExprList
Extract Annotation ExtractField ScalarExpr
App Annotation Name ScalarExprList
AggregateApp Annotation Distinct ScalarExpr ScalarExprDirectionPairList
WindowApp Annotation ScalarExpr ScalarExprList ScalarExprDirectionPairList (Maybe FrameClause)
Cast Annotation ScalarExpr TypeName
ImplicitCast Annotation ScalarExpr TypeExtra
Case Annotation CaseScalarExprListScalarExprPairList MaybeScalarExpr
CaseSimple Annotation ScalarExpr CaseScalarExprListScalarExprPairList MaybeScalarExpr
Parens Annotation ScalarExpr
InPredicate Annotation ScalarExpr Bool InList
Exists Annotation QueryExpr
ScalarSubQuery Annotation QueryExpr
LiftApp Annotation Name LiftFlavour ScalarExprList
OdbcLiteral Annotation OdbcLiteralType String
OdbcFunc Annotation ScalarExpr
AntiScalarExpr String

Instances

Eq ScalarExpr Source
Data ScalarExpr Source
Show ScalarExpr Source

data InList Source

Constructors

InList Annotation ScalarExprList
InQueryExpr Annotation QueryExpr

Instances

Eq InList Source
Data InList Source
Show InList Source

data LiftFlavour Source

Constructors

LiftAny
LiftAll

Instances

Eq LiftFlavour Source
Data LiftFlavour Source
Show LiftFlavour Source

data Direction Source

Constructors

Asc
Desc

Instances

Eq Direction Source
Data Direction Source
Show Direction Source

data NullsOrder Source

Constructors

NullsDefault
NullsFirst
NullsLast

Instances

Eq NullsOrder Source
Data NullsOrder Source
Show NullsOrder Source

data Distinct Source

Constructors

Distinct
All

Instances

Eq Distinct Source
Data Distinct Source
Show Distinct Source

data CombineType Source

Constructors

Except
Union
Intersect
UnionAll

Instances

Eq CombineType Source
Data CombineType Source
Show CombineType Source

data FrameClause Source

Constructors

FrameUnboundedPreceding
FrameUnboundedFull
FrameRowsUnboundedPreceding

Instances

Eq FrameClause Source
Data FrameClause Source
Show FrameClause Source

data OdbcLiteralType Source

Constructors

OLDate
OLTime
OLTimestamp

Instances

Eq OdbcLiteralType Source
Data OdbcLiteralType Source
Show OdbcLiteralType Source

Query expressions

data QueryExpr Source

Constructors

Select
Fields ann :: Annotation selDistinct :: Distinct selSelectList :: SelectList selTref :: TableRefList selWhere :: MaybeBoolExpr selGroupBy :: ScalarExprList selHaving :: MaybeBoolExpr selOrderBy :: ScalarExprDirectionPairList selLimit :: MaybeScalarExpr selOffset :: MaybeScalarExpr selOption :: [QueryHint]
CombineQueryExpr
Fields ann :: Annotation cqType :: CombineType cqQe0 :: QueryExpr cqQe1 :: QueryExpr
Values
Fields ann :: Annotation qeValues :: ScalarExprListList
WithQueryExpr
Fields ann :: Annotation withs :: WithQueryList withQe :: QueryExpr

Instances

Eq QueryExpr Source
Data QueryExpr Source
Show QueryExpr Source

makeSelect :: QueryExpr Source

'default' valued select, use for creating select values

makeSelect :: QueryExpr
makeSelect = Select
             {ann = emptyAnnotation
             ,selDistinct = All
             ,selSelectList = (SelectList emptyAnnotation [])
             ,selTref = []
             ,selWhere = Nothing
             ,selGroupBy = []
             ,selHaving = Nothing
             ,selOrderBy = []
             ,selLimit = Nothing
             ,selOffset = Nothing
             ,selOption = []}

On its own, it isn't valid syntax: to use it you have to replace the select list at minimum

use something like this

s = makeSelect {selSelectList = sl [se $ i "a"]
               ,selTref = [tref "t"]}
    where
        a = emptyAnnotation
        sl = SelectList a
        se = SelExp a
        i = Identifier a
        tref t = Tref a (Name a [Nmc t])

data WithQuery Source

Constructors

WithQuery Annotation NameComponent (Maybe [NameComponent]) QueryExpr

Instances

Eq WithQuery Source
Data WithQuery Source
Show WithQuery Source

data SelectList Source

Constructors

SelectList Annotation SelectItemList

Instances

Eq SelectList Source
Data SelectList Source
Show SelectList Source

data SelectItem Source

Constructors

SelExp Annotation ScalarExpr
SelectItem Annotation ScalarExpr NameComponent

Instances

Eq SelectItem Source
Data SelectItem Source
Show SelectItem Source

data JoinExpr Source

Constructors

JoinOn Annotation ScalarExpr
JoinUsing Annotation [NameComponent]

Instances

Eq JoinExpr Source
Data JoinExpr Source
Show JoinExpr Source

data JoinType Source

Constructors

Inner
LeftOuter
RightOuter
FullOuter
Cross

Instances

Eq JoinType Source
Data JoinType Source
Show JoinType Source

data JoinHint Source

Constructors

Loop
Hash
Merge

Instances

Eq JoinHint Source
Data JoinHint Source
Show JoinHint Source

data QueryHint Source

Constructors

QueryHintPartitionGroup
QueryHintColumnarHostGroup

Instances

Eq QueryHint Source
Data QueryHint Source
Show QueryHint Source

type OnExpr = Maybe JoinExpr Source

data Natural Source

Constructors

Natural
Unnatural

Instances

Eq Natural Source
Data Natural Source
Show Natural Source

Statements

data Statement Source

Constructors

QueryStatement Annotation QueryExpr
Insert Annotation Name [NameComponent] QueryExpr MaybeSelectList
Update Annotation Name SetClauseList TableRefList MaybeBoolExpr MaybeSelectList
Delete Annotation Name TableRefList MaybeBoolExpr MaybeSelectList
CopyFrom Annotation Name [NameComponent] CopyFromSource [CopyFromOption]
CopyData Annotation String
CopyTo Annotation CopyToSource String [CopyToOption]
Truncate Annotation [Name] RestartIdentity Cascade
CreateTable Annotation Name AttributeDefList ConstraintList MaybeTablePartitionDef Replace
AlterTable Annotation Name AlterTableOperation
AlterDatabase Annotation Name AlterDatabaseOperation
CreateSequence Annotation Name Integer (Maybe Integer) (Maybe Integer) Integer Integer
AlterSequence Annotation Name AlterSequenceOperation
CreateTableAs Annotation Name Replace QueryExpr
CreateView Annotation Name MaybeNameComponentList QueryExpr
AlterView Annotation Name MaybeNameComponentList QueryExpr
CreateType Annotation Name TypeAttributeDefList
CreateUser Annotation Name String
CreateLogin Annotation Name String
AlterUser Annotation Name String
AlterLogin Annotation Name String
CreateSchema Annotation NameComponent (Maybe Name)
AlterSchema Annotation NameComponent AlterSchemaOperation
CreateFunction Annotation Name ParamDefList TypeName Replace Language FnBody Volatility
CreateDomain Annotation Name TypeName String MaybeBoolExpr
CreateLanguage Annotation String
CreateTrigger Annotation NameComponent TriggerWhen [TriggerEvent] Name TriggerFire Name ScalarExprList
DropFunction Annotation IfExists NameTypeNameListPairList Cascade
DropSomething Annotation DropType IfExists [Name] Cascade
DropTrigger Annotation IfExists NameComponent Name Cascade
CreateDatabase Annotation Name
Set Annotation String [SetValue]
Notify Annotation String
Into Annotation Bool [Name] Statement
Assignment Annotation Name ScalarExpr
Return Annotation MaybeScalarExpr
ReturnNext Annotation ScalarExpr
ReturnQuery Annotation QueryExpr
Raise Annotation RaiseType String ScalarExprList
NullStatement Annotation
Perform Annotation ScalarExpr
Execute Annotation ScalarExpr
ForQueryStatement Annotation (Maybe String) NameComponent QueryExpr StatementList
ForIntegerStatement Annotation (Maybe String) NameComponent ScalarExpr ScalarExpr StatementList
LoopStatement Annotation (Maybe String) StatementList
WhileStatement Annotation (Maybe String) ScalarExpr StatementList
ContinueStatement Annotation (Maybe String)
ExitStatement Annotation (Maybe String)
CaseStatementSimple Annotation ScalarExpr ScalarExprListStatementListTripleList StatementList
CaseStatement Annotation ScalarExprListStatementListTripleList StatementList
If Annotation ScalarExprStatementListPairList StatementList
Block Annotation (Maybe String) VarDefList StatementList
AntiStatement String
DeclareStatement Annotation [(String, TypeName, Maybe ScalarExpr)]
ExecStatement Annotation Name ScalarExprList
CreateIndexTSQL Annotation NameComponent Name [NameComponent]

Instances

Eq Statement Source
Data Statement Source
Show Statement Source

dml components

data CopyToSource Source

Constructors

CopyTable Name [NameComponent]
CopyQuery QueryExpr

Instances

Eq CopyToSource Source
Data CopyToSource Source
Show CopyToSource Source

data CopyFromSource Source

Constructors

CopyFilename String
Stdin

Instances

Eq CopyFromSource Source
Data CopyFromSource Source
Show CopyFromSource Source

data CopyToOption Source

Constructors

CopyToFormat String
CopyToDelimiter String
CopyToErrorLog String
CopyToErrorVerbosity Int

Instances

Eq CopyToOption Source
Data CopyToOption Source
Show CopyToOption Source

data SetClause Source

Constructors

SetClause Annotation NameComponent ScalarExpr
MultiSetClause Annotation [NameComponent] ScalarExpr

Instances

Eq SetClause Source
Data SetClause Source
Show SetClause Source

ddl components

data AttributeDef Source

Constructors

AttributeDef Annotation NameComponent TypeName MaybeScalarExpr RowConstraintList

Instances

Eq AttributeDef Source
Data AttributeDef Source
Show AttributeDef Source

data TablePartitionDef Source

Constructors

TablePartitionDef Annotation NameComponent Integer TablePartitionDateTimeInterval

Instances

Eq TablePartitionDef Source
Data TablePartitionDef Source
Show TablePartitionDef Source

data TablePartitionDateTimeInterval Source

Constructors

Year
Month
Day
Hour
Minute
Second
Millisecond

Instances

Eq TablePartitionDateTimeInterval Source
Data TablePartitionDateTimeInterval Source
Show TablePartitionDateTimeInterval Source

data TypeAttributeDef Source

Constructors

TypeAttDef Annotation NameComponent TypeName

Instances

Eq TypeAttributeDef Source
Data TypeAttributeDef Source
Show TypeAttributeDef Source

data AlterDatabaseOperation Source

Constructors

RenameDatabase Annotation Name

Instances

Eq AlterDatabaseOperation Source
Data AlterDatabaseOperation Source
Show AlterDatabaseOperation Source

data AlterSchemaOperation Source

Constructors

AlterSchemaName Annotation NameComponent
AlterSchemaOwner Annotation Name

Instances

Eq AlterSchemaOperation Source
Data AlterSchemaOperation Source
Show AlterSchemaOperation Source

data AlterTableOperation Source

Constructors

RenameTable Annotation Name
RenameColumn Annotation NameComponent NameComponent
AlterTableActions Annotation AlterTableActionList

Instances

Eq AlterTableOperation Source
Data AlterTableOperation Source
Show AlterTableOperation Source

data AlterSequenceOperation Source

Constructors

AlterSequenceOwned Annotation Name
AlterSequenceRename Annotation Name
AlterSequenceActions Annotation AlterSequenceActionList

Instances

Eq AlterSequenceOperation Source
Data AlterSequenceOperation Source
Show AlterSequenceOperation Source

data AlterColumnAction Source

run canonicalizeTypeName on all the TypeName nodes in an ast

Constructors

SetDataType Annotation TypeName
SetNotNull Annotation
DropNotNull Annotation
SetDefault Annotation ScalarExpr
DropDefault Annotation

Instances

Eq AlterColumnAction Source
Data AlterColumnAction Source
Show AlterColumnAction Source

data TriggerWhen Source

Constructors

TriggerBefore
TriggerAfter

Instances

Eq TriggerWhen Source
Data TriggerWhen Source
Show TriggerWhen Source

data TriggerEvent Source

Constructors

TInsert
TUpdate
TDelete
AntiTriggerEvent String

Instances

Eq TriggerEvent Source
Data TriggerEvent Source
Show TriggerEvent Source

data TriggerFire Source

Constructors

EachRow
EachStatement

Instances

Eq TriggerFire Source
Data TriggerFire Source
Show TriggerFire Source

data DropType Source

Constructors

Table
Domain
View
Type
Database
User
Login
Schema

Instances

Eq DropType Source
Data DropType Source
Show DropType Source

data Cascade Source

Constructors

Cascade
Restrict

Instances

Eq Cascade Source
Data Cascade Source
Show Cascade Source

data IfExists Source

Constructors

Require
IfExists

Instances

Eq IfExists Source
Data IfExists Source
Show IfExists Source

data RestartIdentity Source

Constructors

RestartIdentity
ContinueIdentity

Instances

Eq RestartIdentity Source
Data RestartIdentity Source
Show RestartIdentity Source

function ddl components

data Replace Source

Constructors

Replace
NoReplace

Instances

Eq Replace Source
Data Replace Source
Show Replace Source

data Volatility Source

Constructors

Volatile
Stable
Immutable

Instances

Eq Volatility Source
Data Volatility Source
Show Volatility Source

data Language Source

Constructors

Sql
Plpgsql

Instances

Eq Language Source
Data Language Source
Show Language Source

data FnBody Source

Constructors

SqlFnBody Annotation StatementList
PlpgsqlFnBody Annotation Statement

Instances

Eq FnBody Source
Data FnBody Source
Show FnBody Source

PlPgsql components

data ParamDef Source

Constructors

ParamDef Annotation NameComponent TypeName
ParamDefTp Annotation TypeName

Instances

Eq ParamDef Source
Data ParamDef Source
Show ParamDef Source

data VarDef Source

Constructors

VarDef Annotation NameComponent TypeName (Maybe ScalarExpr)
ParamAlias Annotation NameComponent Integer
VarAlias Annotation NameComponent Name

Instances

Eq VarDef Source
Data VarDef Source
Show VarDef Source

data RaiseType Source

Constructors

RNotice
RException
RError

Instances

Eq RaiseType Source
Data RaiseType Source
Show RaiseType Source

utility

data SetValue Source

Constructors

SetStr Annotation String
SetId Annotation String
SetNum Annotation Double

Instances

Eq SetValue Source
Data SetValue Source
Show SetValue Source

SimpleTypeName Annotation Name
PrecTypeName Annotation Name Integer
Prec2TypeName Annotation Name Integer Integer
ArrayTypeName Annotation TypeName
SetOfTypeName Annotation TypeName

IntervalYear
IntervalMonth
IntervalDay
IntervalHour
IntervalMinute
IntervalSecond
IntervalYearToMonth
IntervalDayToHour
IntervalDayToMinute
IntervalDayToSecond
IntervalHourToMinute
IntervalHourToSecond
IntervalMinuteToSecond

ExtractCentury
ExtractDay
ExtractDecade
ExtractDow
ExtractDoy
ExtractEpoch
ExtractHour
ExtractIsodow
ExtractIsoyear
ExtractMicroseconds
ExtractMillennium
ExtractMilliseconds
ExtractMinute
ExtractMonth
ExtractQuarter
ExtractSecond
ExtractTimezone
ExtractTimezoneHour
ExtractTimezoneMinute
ExtractWeek
ExtractYear

Tref Annotation Name
FunTref Annotation ScalarExpr
SubTref Annotation QueryExpr
JoinTref Annotation TableRef Natural JoinType (Maybe JoinHint) TableRef OnExpr
TableAlias Annotation NameComponent TableRef
FullAlias Annotation NameComponent [NameComponent] TableRef
TableRefParens Annotation TableRef
OdbcTableRef Annotation TableRef

CopyFromFormat String
CopyFromDelimiter String
CopyFromErrorLog String
CopyFromErrorVerbosity Int
CopyFromParsers String
CopyFromDirectory
CopyFromOffset Integer
CopyFromLimit Integer
CopyFromErrorThreshold Int
CopyFromNewlineFormat String

Eq IntervalField Source
Data IntervalField Source
Show IntervalField Source

Eq ExtractField Source
Data ExtractField Source
Show ExtractField Source

Eq CopyFromOption Source
Data CopyFromOption Source
Show CopyFromOption Source

NullConstraint Annotation String
NotNullConstraint Annotation String
IdentityConstraint Annotation String (Maybe (Integer, Integer))
RowCheckConstraint Annotation String ScalarExpr
RowUniqueConstraint Annotation String
RowPrimaryKeyConstraint Annotation String
RowReferenceConstraint Annotation String Name (Maybe NameComponent) Cascade Cascade

Eq RowConstraint Source
Data RowConstraint Source
Show RowConstraint Source

UniqueConstraint Annotation String [NameComponent]
PrimaryKeyConstraint Annotation String [NameComponent]
CheckConstraint Annotation String ScalarExpr
ReferenceConstraint Annotation String [NameComponent] Name [NameComponent] Cascade Cascade

Eq Constraint Source
Data Constraint Source
Show Constraint Source

AddColumn Annotation AttributeDef
DropColumn Annotation NameComponent
AlterColumn Annotation NameComponent AlterColumnAction
AddConstraint Annotation Constraint

Eq AlterTableAction Source
Data AlterTableAction Source
Show AlterTableAction Source

AlterSequenceIncrement Annotation Integer
AlterSequenceMin Annotation (Maybe Integer)
AlterSequenceMax Annotation (Maybe Integer)
AlterSequenceStart Annotation Integer
AlterSequenceRestart Annotation (Maybe Integer)
AlterSequenceCache Annotation Integer

Eq AlterSequenceAction Source
Data AlterSequenceAction Source
Show AlterSequenceAction Source

Name and TypeName

Scalar expressions

Query expressions

Statements

dml components

ddl components

function ddl components

PlPgsql components

utility

misc