Copyright	Flipstone Technology Partners 2023
License	MIT
Stability	Stable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Orville.PostgreSQL.Expr.Name

Description

Since: 1.0.0.0

Synopsis

data TableName
tableName :: String -> TableName
data SequenceName
sequenceName :: String -> SequenceName
data SchemaName
schemaName :: String -> SchemaName
data SavepointName
savepointName :: String -> SavepointName
data Qualified name
qualifyTable :: Maybe SchemaName -> TableName -> Qualified TableName
qualifySequence :: Maybe SchemaName -> SequenceName -> Qualified SequenceName
qualifyColumn :: Maybe SchemaName -> TableName -> ColumnName -> Qualified ColumnName
data IndexName
indexName :: String -> IndexName
data Identifier
identifier :: String -> Identifier
identifierFromBytes :: ByteString -> Identifier
class IdentifierExpression name where
- toIdentifier :: name -> Identifier
- fromIdentifier :: Identifier -> name
data FunctionName
functionName :: String -> FunctionName
data CursorName
cursorName :: String -> CursorName
data ConstraintName
constraintName :: String -> ConstraintName
data ColumnName
columnName :: String -> ColumnName

Documentation

data TableName Source #

Type to represent a SQL table name. TableName values constructed via the tableName function will be properly escaped as part of the generated SQL. E.G.

"some_table_name"

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

Since: 1.0.0.0

Instances

Instances details

IdentifierExpression TableName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.TableName Methods toIdentifier :: TableName -> Identifier Source # fromIdentifier :: Identifier -> TableName Source #
SqlExpression TableName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.TableName Methods toRawSql :: TableName -> RawSql Source # unsafeFromRawSql :: RawSql -> TableName Source #

tableName :: String -> TableName Source #

Construct a TableName from a String with proper escaping as part of the generated SQL.

Since: 1.0.0.0

data SequenceName Source #

Type to represent a SQL sequence name. SequenceName values constructed via the sequenceName function will be properly escaped as part of the generated SQL. E.G.

"some_sequence_name"

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

Since: 1.0.0.0

Instances

Instances details

IdentifierExpression SequenceName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.SequenceName Methods toIdentifier :: SequenceName -> Identifier Source # fromIdentifier :: Identifier -> SequenceName Source #
SqlExpression SequenceName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.SequenceName Methods toRawSql :: SequenceName -> RawSql Source # unsafeFromRawSql :: RawSql -> SequenceName Source #

sequenceName :: String -> SequenceName Source #

Construct a SequenceName from a String with proper escaping as part of the generated SQL.

Since: 1.0.0.0

data SchemaName Source #

Type to represent a SQL schema name. SchemaName values constructed via the schemaName function will be properly escaped as part of the generated SQL. E.G.

"some_schema_name"

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

Since: 1.0.0.0

Instances

Instances details

IdentifierExpression SchemaName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.SchemaName Methods toIdentifier :: SchemaName -> Identifier Source # fromIdentifier :: Identifier -> SchemaName Source #
SqlExpression SchemaName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.SchemaName Methods toRawSql :: SchemaName -> RawSql Source # unsafeFromRawSql :: RawSql -> SchemaName Source #

schemaName :: String -> SchemaName Source #

Construct a SchemaName from a String with proper escaping as part of the generated SQL.

Since: 1.0.0.0

data SavepointName Source #

Type to represent a SQL savepoint name. SavepointName values constructed via the savepointName function will be properly escaped as part of the generated SQL. E.G.

"some_savepoint_name"

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

Since: 1.0.0.0

Instances

Instances details

IdentifierExpression SavepointName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.SavepointName Methods toIdentifier :: SavepointName -> Identifier Source # fromIdentifier :: Identifier -> SavepointName Source #
SqlExpression SavepointName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.SavepointName Methods toRawSql :: SavepointName -> RawSql Source # unsafeFromRawSql :: RawSql -> SavepointName Source #

savepointName :: String -> SavepointName Source #

Construct a SavepointName from a String with proper escaping as part of the generated SQL.

Since: 1.0.0.0

data Qualified name Source #

Type to represent a qualified SQL name. E.G.

"some_schema_name"."some_table_name"

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

Since: 1.0.0.0

Instances

Instances details

SqlExpression (Qualified name) Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.Qualified Methods toRawSql :: Qualified name -> RawSql Source # unsafeFromRawSql :: RawSql -> Qualified name Source #

qualifyTable :: Maybe SchemaName -> TableName -> Qualified TableName Source #

Optionally qualifies a TableName with a SchemaName.

Note: If you already have a TableIdentifier in hand you should probably use tableIdQualifiedName instead. @since 1.0.0.0

qualifySequence :: Maybe SchemaName -> SequenceName -> Qualified SequenceName Source #

Optionally qualifies a SequenceName with a SchemaName.

Note: If you already have a SequenceIdentifier in hand you should probably use sequenceIdQualifiedName instead.

Since: 1.0.0.0

qualifyColumn :: Maybe SchemaName -> TableName -> ColumnName -> Qualified ColumnName Source #

Qualifies a ColumnName with a TableName and, optionally, a SchemaName. This should be used to refer to the column in SQL queries where a qualified reference is appropriate.

Since: 1.0.0.0

data IndexName Source #

Type to represent a SQL index name. IndexName values constructed via the indexName function will be properly escaped as part of the generated SQL. E.G.

"some_index_name"

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

Since: 1.0.0.0

Instances

Instances details

IdentifierExpression IndexName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.IndexName Methods toIdentifier :: IndexName -> Identifier Source # fromIdentifier :: Identifier -> IndexName Source #
SqlExpression IndexName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.IndexName Methods toRawSql :: IndexName -> RawSql Source # unsafeFromRawSql :: RawSql -> IndexName Source #

indexName :: String -> IndexName Source #

Construct an IndexName from a String with proper escaping as part of the generated SQL.

Since: 1.0.0.0

data Identifier Source #

Type to represent a SQL identifier. Identifier values constructed via the identifier function will be properly escaped as part of the generated SQL. E.G.

"some_identifier"

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

Since: 1.0.0.0

Instances

Instances details

IdentifierExpression Identifier Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.Identifier Methods toIdentifier :: Identifier -> Identifier Source # fromIdentifier :: Identifier -> Identifier Source #
SqlExpression Identifier Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.Identifier Methods toRawSql :: Identifier -> RawSql Source # unsafeFromRawSql :: RawSql -> Identifier Source #

identifier :: String -> Identifier Source #

Construct an Identifier from a String with proper escaping as part of the generated SQL.

Since: 1.0.0.0

identifierFromBytes :: ByteString -> Identifier Source #

Construct an Identifier from a ByteString with proper escaping as part of the generated SQL.

Since: 1.0.0.0

class IdentifierExpression name where Source #

This class aids in giving additional polymorphism so that many different identifiers can be created without being forced to only use the Identifier type.

Since: 1.0.0.0

Methods

toIdentifier :: name -> Identifier Source #

Since: 1.0.0.0

fromIdentifier :: Identifier -> name Source #

Since: 1.0.0.0

Instances

Instances details

IdentifierExpression ColumnName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.ColumnName Methods toIdentifier :: ColumnName -> Identifier Source # fromIdentifier :: Identifier -> ColumnName Source #
IdentifierExpression ConstraintName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.ConstraintName Methods toIdentifier :: ConstraintName -> Identifier Source # fromIdentifier :: Identifier -> ConstraintName Source #
IdentifierExpression CursorName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.CursorName Methods toIdentifier :: CursorName -> Identifier Source # fromIdentifier :: Identifier -> CursorName Source #
IdentifierExpression FunctionName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.FunctionName Methods toIdentifier :: FunctionName -> Identifier Source # fromIdentifier :: Identifier -> FunctionName Source #
IdentifierExpression Identifier Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.Identifier Methods toIdentifier :: Identifier -> Identifier Source # fromIdentifier :: Identifier -> Identifier Source #
IdentifierExpression IndexName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.IndexName Methods toIdentifier :: IndexName -> Identifier Source # fromIdentifier :: Identifier -> IndexName Source #
IdentifierExpression SavepointName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.SavepointName Methods toIdentifier :: SavepointName -> Identifier Source # fromIdentifier :: Identifier -> SavepointName Source #
IdentifierExpression SchemaName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.SchemaName Methods toIdentifier :: SchemaName -> Identifier Source # fromIdentifier :: Identifier -> SchemaName Source #
IdentifierExpression SequenceName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.SequenceName Methods toIdentifier :: SequenceName -> Identifier Source # fromIdentifier :: Identifier -> SequenceName Source #
IdentifierExpression TableName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.TableName Methods toIdentifier :: TableName -> Identifier Source # fromIdentifier :: Identifier -> TableName Source #

data FunctionName Source #

Type to represent a SQL function name. FunctionName values constructed via the functionName function will be properly escaped as part of the generated SQL. E.G.

"some_function_name"

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

Since: 1.0.0.0

Instances

Instances details

IdentifierExpression FunctionName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.FunctionName Methods toIdentifier :: FunctionName -> Identifier Source # fromIdentifier :: Identifier -> FunctionName Source #
SqlExpression FunctionName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.FunctionName Methods toRawSql :: FunctionName -> RawSql Source # unsafeFromRawSql :: RawSql -> FunctionName Source #

functionName :: String -> FunctionName Source #

Construct a FunctionName from a String with proper escaping as part of the generated SQL.

Since: 1.0.0.0

data CursorName Source #

Type to represent a SQL cursor name. CursorName values constructed via the cursorName function will be properly escaped as part of the generated SQL. E.G.

"some_cursor_name"

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

Since: 1.0.0.0

Instances

Instances details

IdentifierExpression CursorName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.CursorName Methods toIdentifier :: CursorName -> Identifier Source # fromIdentifier :: Identifier -> CursorName Source #
SqlExpression CursorName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.CursorName Methods toRawSql :: CursorName -> RawSql Source # unsafeFromRawSql :: RawSql -> CursorName Source #

cursorName :: String -> CursorName Source #

Construct a CursorName from a String with proper escaping as part of the generated SQL.

Since: 1.0.0.0

data ConstraintName Source #

Type to represent a SQL constraint name. ConstraintName values constructed via the constraintName function will be properly escaped as part of the generated SQL. E.G.

"some_constraint_name"

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

Since: 1.0.0.0

Instances

Instances details

IdentifierExpression ConstraintName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.ConstraintName Methods toIdentifier :: ConstraintName -> Identifier Source # fromIdentifier :: Identifier -> ConstraintName Source #
SqlExpression ConstraintName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.ConstraintName Methods toRawSql :: ConstraintName -> RawSql Source # unsafeFromRawSql :: RawSql -> ConstraintName Source #

constraintName :: String -> ConstraintName Source #

Construct a ConstraintName from a String with proper escaping as part of the generated SQL.

Since: 1.0.0.0

data ColumnName Source #

Type to represent a SQL column name. ColumnName values constructed via the columnName function will be properly escaped as part of the generated SQL. E.G.

"some_column_name"

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

Since: 1.0.0.0

Instances

Instances details

IdentifierExpression ColumnName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.ColumnName Methods toIdentifier :: ColumnName -> Identifier Source # fromIdentifier :: Identifier -> ColumnName Source #
SqlExpression ColumnName Source #	Since: 1.0.0.0
Instance details Defined in Orville.PostgreSQL.Expr.Internal.Name.ColumnName Methods toRawSql :: ColumnName -> RawSql Source # unsafeFromRawSql :: RawSql -> ColumnName Source #

columnName :: String -> ColumnName Source #

Construct a ColumnName from a String with proper escaping as part of the generated SQL.

Since: 1.0.0.0