Database.Beam.Sqlite

Documentation

module Database.Beam.Sqlite.Connection

sqliteText :: DataType Sqlite Text

sqliteBlob :: DataType Sqlite ByteString

sqliteBigInt :: DataType Sqlite Int64

SQLite syntaxes

data SqliteCommandSyntax

A SQLite command. INSERT is special cased to handle AUTO INCREMENT columns. The fromSqliteCommand function will take an SqliteCommandSyntax and convert it into the correct SqliteSyntax.

Constructors

SqliteCommandSyntax SqliteSyntax

SqliteCommandInsert SqliteInsertSyntax

Instances

IsSql92Syntax SqliteCommandSyntax

Defined in Database.Beam.Sqlite.Syntax

Associated Types

type Sql92SelectSyntax SqliteCommandSyntax :: Type

type Sql92InsertSyntax SqliteCommandSyntax :: Type

type Sql92UpdateSyntax SqliteCommandSyntax :: Type

type Sql92DeleteSyntax SqliteCommandSyntax :: Type

Methods

selectCmd :: Sql92SelectSyntax SqliteCommandSyntax -> SqliteCommandSyntax

insertCmd :: Sql92InsertSyntax SqliteCommandSyntax -> SqliteCommandSyntax

updateCmd :: Sql92UpdateSyntax SqliteCommandSyntax -> SqliteCommandSyntax

deleteCmd :: Sql92DeleteSyntax SqliteCommandSyntax -> SqliteCommandSyntax

IsSql92DdlCommandSyntax SqliteCommandSyntax

Defined in Database.Beam.Sqlite.Syntax

Associated Types

type Sql92DdlCommandCreateTableSyntax SqliteCommandSyntax :: Type

type Sql92DdlCommandAlterTableSyntax SqliteCommandSyntax :: Type

type Sql92DdlCommandDropTableSyntax SqliteCommandSyntax :: Type

Methods

createTableCmd :: Sql92DdlCommandCreateTableSyntax SqliteCommandSyntax -> SqliteCommandSyntax

dropTableCmd :: Sql92DdlCommandDropTableSyntax SqliteCommandSyntax -> SqliteCommandSyntax

alterTableCmd :: Sql92DdlCommandAlterTableSyntax SqliteCommandSyntax -> SqliteCommandSyntax

type Sql92DeleteSyntax SqliteCommandSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92DeleteSyntax SqliteCommandSyntax = SqliteDeleteSyntax

type Sql92UpdateSyntax SqliteCommandSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92UpdateSyntax SqliteCommandSyntax = SqliteUpdateSyntax

type Sql92InsertSyntax SqliteCommandSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92InsertSyntax SqliteCommandSyntax = SqliteInsertSyntax

type Sql92SelectSyntax SqliteCommandSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92SelectSyntax SqliteCommandSyntax = SqliteSelectSyntax

type Sql92DdlCommandDropTableSyntax SqliteCommandSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92DdlCommandDropTableSyntax SqliteCommandSyntax

type Sql92DdlCommandAlterTableSyntax SqliteCommandSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92DdlCommandAlterTableSyntax SqliteCommandSyntax

type Sql92DdlCommandCreateTableSyntax SqliteCommandSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92DdlCommandCreateTableSyntax SqliteCommandSyntax

data SqliteSyntax

The syntax for SQLite is stored as a Builder along with a list of data that hasn't been serialized yet.

The first argument is a function that receives a builder for SQLData and returns the concrete syntax to embed into the query. For queries sent to the backend, this is simply a function that returns "?". Thus, the syntax sent to the backend includes proper placeholders. The list of data is sent to the SQLite library for proper escaping.

When the syntax is being serialized for display (for use in beam migrate for example), the data builder attempts to properly format and escape the data. This returns syntax suitable for inclusion in scripts. In this case, the value list is ignored.

Instances

Eq SqliteSyntax

Defined in Database.Beam.Sqlite.Syntax

Methods

(==) :: SqliteSyntax -> SqliteSyntax -> Bool

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

Show SqliteSyntax

Defined in Database.Beam.Sqlite.Syntax

Methods

showsPrec :: Int -> SqliteSyntax -> ShowS

show :: SqliteSyntax -> String

showList :: [SqliteSyntax] -> ShowS

Semigroup SqliteSyntax

Defined in Database.Beam.Sqlite.Syntax

Methods

(<>) :: SqliteSyntax -> SqliteSyntax -> SqliteSyntax

sconcat :: NonEmpty SqliteSyntax -> SqliteSyntax

stimes :: Integral b => b -> SqliteSyntax -> SqliteSyntax

Monoid SqliteSyntax

Defined in Database.Beam.Sqlite.Syntax

Methods

mempty :: SqliteSyntax

mappend :: SqliteSyntax -> SqliteSyntax -> SqliteSyntax

mconcat :: [SqliteSyntax] -> SqliteSyntax

Hashable SqliteSyntax

Defined in Database.Beam.Sqlite.Syntax

Methods

hashWithSalt :: Int -> SqliteSyntax -> Int

hash :: SqliteSyntax -> Int

Sql92DisplaySyntax SqliteSyntax

Defined in Database.Beam.Sqlite.Syntax

Methods

displaySyntax :: SqliteSyntax -> String

data SqliteSelectSyntax

SQLite SELECT syntax

Instances

IsSql92SelectSyntax SqliteSelectSyntax

Defined in Database.Beam.Sqlite.Syntax

Associated Types

type Sql92SelectSelectTableSyntax SqliteSelectSyntax :: Type

type Sql92SelectOrderingSyntax SqliteSelectSyntax :: Type

Methods

selectStmt :: Sql92SelectSelectTableSyntax SqliteSelectSyntax -> [Sql92SelectOrderingSyntax SqliteSelectSyntax] -> Maybe Integer -> Maybe Integer -> SqliteSelectSyntax

type Sql92SelectOrderingSyntax SqliteSelectSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92SelectOrderingSyntax SqliteSelectSyntax

type Sql92SelectSelectTableSyntax SqliteSelectSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92SelectSelectTableSyntax SqliteSelectSyntax

data SqliteInsertSyntax

SQLite INSERT syntax. This doesn't directly wrap SqliteSyntax because we need to do some processing on INSERT statements to deal with AUTO INCREMENT columns. Use formatSqliteInsert to turn SqliteInsertSyntax into SqliteSyntax.

Instances

IsSql92InsertSyntax SqliteInsertSyntax

Defined in Database.Beam.Sqlite.Syntax

Associated Types

type Sql92InsertValuesSyntax SqliteInsertSyntax :: Type

type Sql92InsertTableNameSyntax SqliteInsertSyntax :: Type

Methods

insertStmt :: Sql92InsertTableNameSyntax SqliteInsertSyntax -> [Text] -> Sql92InsertValuesSyntax SqliteInsertSyntax -> SqliteInsertSyntax

type Sql92InsertTableNameSyntax SqliteInsertSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92InsertTableNameSyntax SqliteInsertSyntax = SqliteTableNameSyntax

type Sql92InsertValuesSyntax SqliteInsertSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92InsertValuesSyntax SqliteInsertSyntax = SqliteInsertValuesSyntax

data SqliteUpdateSyntax

SQLite UPDATE syntax

Instances

IsSql92UpdateSyntax SqliteUpdateSyntax

Defined in Database.Beam.Sqlite.Syntax

Associated Types

type Sql92UpdateTableNameSyntax SqliteUpdateSyntax :: Type

type Sql92UpdateFieldNameSyntax SqliteUpdateSyntax :: Type

type Sql92UpdateExpressionSyntax SqliteUpdateSyntax :: Type

Methods

updateStmt :: Sql92UpdateTableNameSyntax SqliteUpdateSyntax -> [(Sql92UpdateFieldNameSyntax SqliteUpdateSyntax, Sql92UpdateExpressionSyntax SqliteUpdateSyntax)] -> Maybe (Sql92UpdateExpressionSyntax SqliteUpdateSyntax) -> SqliteUpdateSyntax

type Sql92UpdateExpressionSyntax SqliteUpdateSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92UpdateExpressionSyntax SqliteUpdateSyntax = SqliteExpressionSyntax

type Sql92UpdateFieldNameSyntax SqliteUpdateSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92UpdateFieldNameSyntax SqliteUpdateSyntax

type Sql92UpdateTableNameSyntax SqliteUpdateSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92UpdateTableNameSyntax SqliteUpdateSyntax = SqliteTableNameSyntax

data SqliteDeleteSyntax

SQLite DELETE syntax

Instances

IsSql92DeleteSyntax SqliteDeleteSyntax

Defined in Database.Beam.Sqlite.Syntax

Associated Types

type Sql92DeleteTableNameSyntax SqliteDeleteSyntax :: Type

type Sql92DeleteExpressionSyntax SqliteDeleteSyntax :: Type

Methods

deleteStmt :: Sql92DeleteTableNameSyntax SqliteDeleteSyntax -> Maybe Text -> Maybe (Sql92DeleteExpressionSyntax SqliteDeleteSyntax) -> SqliteDeleteSyntax

deleteSupportsAlias :: Proxy SqliteDeleteSyntax -> Bool

type Sql92DeleteExpressionSyntax SqliteDeleteSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92DeleteExpressionSyntax SqliteDeleteSyntax = SqliteExpressionSyntax

type Sql92DeleteTableNameSyntax SqliteDeleteSyntax

Defined in Database.Beam.Sqlite.Syntax

type Sql92DeleteTableNameSyntax SqliteDeleteSyntax = SqliteTableNameSyntax

fromSqliteCommand :: SqliteCommandSyntax -> SqliteSyntax

Convert a SqliteCommandSyntax into a renderable SqliteSyntax

sqliteRenderSyntaxScript :: SqliteSyntax -> ByteString

Render a SqliteSyntax as a lazy ByteString, for purposes of displaying to a user. Embedded SQLData is directly embedded into the concrete syntax, with a best effort made to escape strings.

Sqlite functions and aggregates

sqliteGroupConcat :: (BeamSqlBackendCanSerialize Sqlite a, BeamSqlBackendIsString Sqlite str, BeamSqlBackendIsString Sqlite str2) => QExpr Sqlite s a -> QExpr Sqlite s str -> QAgg Sqlite s (Maybe str2)

The SQLite group_concat function. Joins the value in each row of the first argument, using the second argument as a delimiter. See sqliteGroupConcatOver if you want to provide explicit quantification.

sqliteGroupConcatOver :: (BeamSqlBackendCanSerialize Sqlite a, BeamSqlBackendIsString Sqlite str) => Maybe SqliteAggregationSetQuantifierSyntax -> QExpr Sqlite s a -> QAgg Sqlite s (Maybe str)

The SQLite group_concat function. Joins the value in each row of the first argument using ','. See sqliteGroupConcat if you want to change the delimiter. Choosing a custom delimiter and quantification isn't allowed by SQLite.