squeal-postgresql-0.9.0.0: Squeal PostgreSQL Library
Copyright(c) Eitan Chatav 2020
Maintainereitan@morphism.tech
Stabilityexperimental
Safe HaskellNone
LanguageHaskell2010

Squeal.PostgreSQL.Definition.Comment

Description

comments

Synopsis

Documentation

commentOnTable Source #

Arguments

:: (KnownSymbol sch, KnownSymbol tab, Has sch db schema, Has tab schema ('Table table)) 
=> QualifiedAlias sch tab

table

-> Text

comment

-> Definition db db 

When a user views a table in the database (i.e. with d+ table), it is useful to be able to read a description of the table.

commentOnType Source #

Arguments

:: (KnownSymbol sch, KnownSymbol typ, Has sch db schema, Has typ schema ('Typedef type_)) 
=> QualifiedAlias sch typ

type

-> Text

comment

-> Definition db db 

When a user views a type in the database (i.e with dT type), it is useful to be able to read a description of the type.

commentOnView Source #

Arguments

:: (KnownSymbol sch, KnownSymbol vie, Has sch db schema, Has vie schema ('View view)) 
=> QualifiedAlias sch vie

view

-> Text

comment

-> Definition db db 

When a user views a view in the database (i.e. with dv view), it is useful to be able to read a description of the view.

commentOnFunction Source #

Arguments

:: (KnownSymbol sch, KnownSymbol fun, Has sch db schema, Has fun schema ('Function function)) 
=> QualifiedAlias sch fun

function

-> Text

comment

-> Definition db db 

When a user views a function in the database (i.e. with df+ function), it is useful to be able to read a description of the function.

commentOnIndex Source #

Arguments

:: (KnownSymbol sch, KnownSymbol ind, Has sch db schema, Has ind schema ('Index index)) 
=> QualifiedAlias sch ind

index

-> Text

comment

-> Definition db db 

When a user views an index in the database (i.e. with di+ index), it is useful to be able to read a description of the index.

commentOnColumn Source #

Arguments

:: (KnownSymbol sch, KnownSymbol tab, KnownSymbol col, Has sch db schema, Has tab schema ('Table '(cons, cols)), Has col cols '(def, nulltyp)) 
=> QualifiedAlias sch tab

table

-> Alias col

column

-> Text

comment

-> Definition db db 

When a user views a table in the database (i.e. with d+ table), it is useful to be able to view descriptions of the columns in that table.

commentOnSchema Source #

Arguments

:: (KnownSymbol sch, Has sch db schema) 
=> Alias sch

schema

-> Text

comment

-> Definition db db 

When a user views a schema in the database (i.e. with dn+ schema), it is useful to be able to read a description.