Safe Haskell	Safe
Language	Haskell2010

Ringo.Types

Synopsis

Documentation

data Table Source #

A table representing a physical table in the database

The following example represents a set of tables from a multi-publisher blog system:

>>> :set -XOverloadedStrings
>>> :{
let publishersTable =
      Table { tableName = "publishers"
            , tableColumns =
              [ Column "id" "integer"        NotNull
              , Column "name" "varchar(100)" NotNull
              ]
            , tableConstraints =
              [ PrimaryKey "id"
              , UniqueKey [ "name" ]
              ]
            }
    usersTable =
      Table { tableName = "users"
            , tableColumns =
              [ Column "id" "uuid"               NotNull
              , Column "created_at" "timestamp"  NotNull
              , Column "pub_id" "integer"        NotNull
              , Column "username" "varchar(100)" NotNull
              , Column "email" "varchar(500)"    Null
              ]
            , tableConstraints =
              [ PrimaryKey "id"
              , ForeignKey "publishers" [ ("pub_id", "id") ]
              , UniqueKey [ "pub_id", "username" ]
              ]
            }
    -- This table records the time spent by each user on a post
    postViewEventsTable =
      Table { tableName = "post_view_events"
            , tableColumns =
              [ Column "id" "uuid"                    NotNull
              , Column "created_at" "timestamp"       NotNull
              , Column "user_id" "uuid"               NotNull
              , Column "pub_id" "integer"             NotNull
              , Column "post_id" "uuid"               NotNull
              , Column "geo_city" "varchar(100)"      Null
              , Column "geo_country" "varchar(100)"   Null
              , Column "device_version" "varchar(25)" Null
              , Column "device_name" "varchar(100)"   Null
              , Column "device_type" "varchar(50)"    Null
              , Column "time_spent" "integer"         NotNull
              ]
            , tableConstraints =
              [ PrimaryKey "id"
              , ForeignKey "users" [ ("user_id", "id") ]
              , ForeignKey "publishers" [ ("pub_id", "id") ]
              ]
            }
:}

Constructors

Table
Fields tableName :: !TableName Name of the table tableColumns :: ![Column] A list of the columns in the table tableConstraints :: ![TableConstraint] A list of the constraints on the table

Instances

Eq Table Source #
Methods (==) :: Table -> Table -> Bool # (/=) :: Table -> Table -> Bool #
Show Table Source #
Methods showsPrec :: Int -> Table -> ShowS # show :: Table -> String # showList :: [Table] -> ShowS #

type TableName = Text Source #

Name of a Table

data TableConstraint Source #

A constraint on a Table

Constructors

PrimaryKey	A primary key constraint
Fields tableConstrPrimaryKeyColumn :: !ColumnName Name of the primary key column
UniqueKey	A unique key contraint
Fields tableConstrUniqueKeyColumns :: ![ColumnName] Name of the unique key columns
ForeignKey	A foreign key constraint
Fields tableConstrForeignKeyTable :: !TableName Name of the table referenced by the foreign key tableConstrForeignKeyColumnMapping :: ![(ColumnName, ColumnName)] Mapping of the columns as an associative list for the foreign key. keys: this table's column names, values: referenced table's column names.

Instances

Eq TableConstraint Source #
Methods (==) :: TableConstraint -> TableConstraint -> Bool # (/=) :: TableConstraint -> TableConstraint -> Bool #
Show TableConstraint Source #
Methods showsPrec :: Int -> TableConstraint -> ShowS # show :: TableConstraint -> String # showList :: [TableConstraint] -> ShowS #

data Column Source #

A column of a Table

Constructors

Column
Fields columnName :: !ColumnName Name of the column columnType :: !ColumnType Type of the column columnNullable :: !Nullable Nullness of the column

Instances

Eq Column Source #
Methods (==) :: Column -> Column -> Bool # (/=) :: Column -> Column -> Bool #
Show Column Source #
Methods showsPrec :: Int -> Column -> ShowS # show :: Column -> String # showList :: [Column] -> ShowS #

type ColumnName = Text Source #

Name of a Column

type ColumnType = Text Source #

Type of a Column

data Nullable Source #

Nullness of a Column

Constructors

Null	the column is nullable
NotNull	the column is not nullable

Instances

Enum Nullable Source #
Methods succ :: Nullable -> Nullable # pred :: Nullable -> Nullable # toEnum :: Int -> Nullable # fromEnum :: Nullable -> Int # enumFrom :: Nullable -> [Nullable] # enumFromThen :: Nullable -> Nullable -> [Nullable] # enumFromTo :: Nullable -> Nullable -> [Nullable] # enumFromThenTo :: Nullable -> Nullable -> Nullable -> [Nullable] #
Eq Nullable Source #
Methods (==) :: Nullable -> Nullable -> Bool # (/=) :: Nullable -> Nullable -> Bool #
Show Nullable Source #
Methods showsPrec :: Int -> Nullable -> ShowS # show :: Nullable -> String # showList :: [Nullable] -> ShowS #

data Fact Source #

A fact is a table that records measurements or metrics for a specific event

The following represents a fact for the same multi-publisher blog system:

>>> :{
let postFact =
      Fact { factName            = "post_views"
           , factTableName       = "post_view_events"
           , factTablePersistent = True
           , factParentNames     = []
           , factColumns         =
             [ FactColumn "created_at"       $ DimTime
             , FactColumn "publisher_id"     $ TenantId
             , FactColumn "user_id"          $ DimId "users"
             , FactColumn "post_id"          $ NoDimId
             , FactColumn "geo_city"         $ DimVal "geo"
             , FactColumn "geo_country"      $ DimVal "geo"
             , FactColumn "device_name"      $ DimVal "device"
             , FactColumn "device_type"      $ DimVal "device"
             , FactColumn "count"            $ FactCount Nothing
             , FactColumn "unq_device_count" $ FactCountDistinct $ Just "device_name"
             , FactColumn "time_spent"       $ FactSum "time_spent"
             , FactColumn "max_time_spent"   $ FactMax "time_spent"
             ]
           }
:}

Constructors

Fact

Fields

factName :: !TableName
Name of the fact
factTableName :: !TableName
Name of the table from which the fact is derived
factTablePersistent :: !Bool
If true, the generated fact table is actually created; if false, the generated fact table is just used for intermidiate computations and is not actually created
factParentNames :: ![TableName]
Names of the parent facts
factColumns :: ![FactColumn]
A list of fact columns in the fact

Instances

Show Fact Source #
Methods showsPrec :: Int -> Fact -> ShowS # show :: Fact -> String # showList :: [Fact] -> ShowS #

data FactColumn Source #

A column in a fact table

Constructors

FactColumn
Fields factColTargetColumn :: !ColumnName Name of the fact column in the generated table factColType :: FactColumnType a Type of the fact column

Instances

Show FactColumn Source #
Methods showsPrec :: Int -> FactColumn -> ShowS # show :: FactColumn -> String # showList :: [FactColumn] -> ShowS #

data FactColumnType a where Source #

Type of a fact column

Constructors

DimTime :: FactColumnType FCKNone	A fact column which contains a time dimension data (e.g. `created_at`). This is not exatracted as a dimension table and instead just converted to an int which depends on `settingTimeUnit`. Every fact must have one of this.
NoDimId :: FactColumnType FCKNone	A fact column which contains an id of a dimension which does not need to extracted as a table and does not exist already.
TenantId :: FactColumnType FCKNone	A fact column which constains an id of a tenant in a multi-tenant database (e.g. `organization_id`). This is not extracted as a dimension table.
DimId :: {..} -> FactColumnType FCKTargetTable	A fact column which constains an id of a dimension which does not need to extracted as a table and exists already.
Fields factColTargetTable :: !TableName Name of the target dimension table
DimVal :: {..} -> FactColumnType FCKTargetTable	A fact column which constains a value which needs to be extracted to a dimension table. Multiple DimVal fact columns can be extracted to the same dimension table.
Fields factColTargetTable :: !TableName Name of the target dimension table
FactCount :: {..} -> FactColumnType FCKMaybeSourceColumn	A fact column which will contain the count of the rows (`count(*)`) or count of a source column if provided.
Fields factColMaybeSourceColumn :: !(Maybe ColumnName) Name of the optional source column
FactCountDistinct :: {..} -> FactColumnType FCKMaybeSourceColumn	A fact column which will contain the count of the unique values of a source column if provided or the primary key of the table.
Fields factColMaybeSourceColumn :: !(Maybe ColumnName) Name of the optional source column
FactSum :: {..} -> FactColumnType FCKSourceColumn	A fact column which will contain the sum of the values of the provided source column.
Fields factColSourceColumn :: !ColumnName Name of the source column
FactAverage :: {..} -> FactColumnType FCKSourceColumn	A fact column which will contain the average of the values of the provided source column.
Fields factColSourceColumn :: !ColumnName Name of the source column
FactMax :: {..} -> FactColumnType FCKSourceColumn	A fact column which will contain the maximum of the values of the provided source column.
Fields factColSourceColumn :: !ColumnName Name of the source column
FactMin :: {..} -> FactColumnType FCKSourceColumn	A fact column which will contain the minimum of the values of the provided source column.
Fields factColSourceColumn :: !ColumnName Name of the source column

Instances

Show (FactColumnType a) Source #
Methods showsPrec :: Int -> FactColumnType a -> ShowS # show :: FactColumnType a -> String # showList :: [FactColumnType a] -> ShowS #

data FactColumnKind Source #

Type of a FactColumnType

Constructors

FCKNone	A FactColumnType without any parameters
FCKTargetTable	A FactColumnType with `factColTargetTable` as the only parameter
FCKMaybeSourceColumn	A FactColumnType with `factColMaybeSourceColumn` as the only parameter
FCKSourceColumn	A FactColumnType with `factColSourceColumn` as the only parameter

factSourceColumnName :: FactColumn -> Maybe ColumnName Source #

Returns the name of the optional source column of a fact column

data TimeUnit Source #

Units of time

Constructors

Second
Minute
Hour
Day
Week

Instances

Enum TimeUnit Source #
Methods succ :: TimeUnit -> TimeUnit # pred :: TimeUnit -> TimeUnit # toEnum :: Int -> TimeUnit # fromEnum :: TimeUnit -> Int # enumFrom :: TimeUnit -> [TimeUnit] # enumFromThen :: TimeUnit -> TimeUnit -> [TimeUnit] # enumFromTo :: TimeUnit -> TimeUnit -> [TimeUnit] # enumFromThenTo :: TimeUnit -> TimeUnit -> TimeUnit -> [TimeUnit] #
Eq TimeUnit Source #
Methods (==) :: TimeUnit -> TimeUnit -> Bool # (/=) :: TimeUnit -> TimeUnit -> Bool #
Read TimeUnit Source #
Methods readsPrec :: Int -> ReadS TimeUnit # readList :: ReadS [TimeUnit] # readPrec :: ReadPrec TimeUnit # readListPrec :: ReadPrec [TimeUnit] #
Show TimeUnit Source #
Methods showsPrec :: Int -> TimeUnit -> ShowS # show :: TimeUnit -> String # showList :: [TimeUnit] -> ShowS #

timeUnitName :: TimeUnit -> Text Source #

Returns the name of a time unit

timeUnitToSeconds :: TimeUnit -> Int Source #

Returns the number of seconds in a time unit

data Config Source #

The config for the library

Instances

Show Config Source #
Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #

configTables :: Config -> [Table] Source #

Return the list of source tables from the config

configFacts :: Config -> [Fact] Source #

Return the list of facts to be generated from the config

configSettings :: Config -> Settings Source #

Return the settings from the config

configTypeDefaults :: Config -> TypeDefaults Source #

Return the defaults for the SQL types from the config

data Settings Source #

Global settings for the library

Constructors

Settings

Fields

settingDimPrefix :: !Text
Prefix for the names of the generated dimension tables. Default: "dim_".
settingFactPrefix :: !Text
Prefix for the names of the generated fact tables. Default: "fact_".
settingFactInfix :: !Text
Infix for the names of the generated fact tables. Default: "_by_".
settingTimeUnit :: !TimeUnit
Time unit used to summarize the fact table data. Default: Minute.
settingAvgCountColumnSuffix :: !Text
Suffix for the names of the generated average-count fact columns. Default: "_count".
settingAvgSumColumnSuffix :: !Text
Suffix for the names of the generated average-sum fact columns. Default: "_sum".
settingDimTableIdColumnName :: !Text
Name of the id columns of the generated dimension tables. Default: "id".
settingDimTableIdColumnType :: !Text
Type of the id columns of the generated dimension tables. Default: "serial".
settingFactCountColumnType :: !Text
Type of the count fact columns of the generated dimension tables. Default: "integer".
settingFactCountDistinctErrorRate :: !Double
Maximum error rate for the hyperloglog algorithm for computing count distinct fact columns of the generated dimension tables. Default: 0.05.
settingDependenciesJSONFileName :: !Text
Name of the generated JSON file containing the dependency graph. Default: "dependencies.json".
settingFactsJSONFileName :: !Text
Name of the generated JSON file containing the list of name of the generated fact tables. Default: "facts.json".
settingDimensionsJSONFileName :: !Text
Name of the generated JSON file containing the list of name of the generated dimension tables. Default: "dimensions.json".
settingForeignKeyIdCoalesceValue :: !Int
Value to coalesce the missing foreign key id column values to in the generated fact tables. Default: -1.
settingTableNameSuffixTemplate :: !Text
Suffix template for names of all the generated tables. Default: "{{suff}}".

Instances

Eq Settings Source #
Methods (==) :: Settings -> Settings -> Bool # (/=) :: Settings -> Settings -> Bool #
Show Settings Source #
Methods showsPrec :: Int -> Settings -> ShowS # show :: Settings -> String # showList :: [Settings] -> ShowS #

defSettings :: Settings Source #

Settings with default values

type TypeDefaults = Map Text Text Source #

A mapping of SQL types to their default values used to coleasce null column values in the generated dimension and fact tables

data ValidationError Source #

Errors possible while validating the config

Constructors

MissingTable !TableName	When referencing a table which is missing from the config
MissingFact !TableName	When referencing a fact which is missing from the config
MissingColumn !TableName !ColumnName	When referencing a column which is missing from the config
MissingTimeColumn !TableName	When a fact has no `DimTime` columns
MissingNotNullConstraint !TableName !ColumnName	When a `DimTime` fact column of a fact is nullable
MissingTypeDefault !Text	When the default value of a type is missing from the config
DuplicateTable !TableName	When there are multiple tables with the same name in the config
DuplicateFact !TableName	When there are multiple facts with the same name in the config
DuplicateColumn !TableName !ColumnName	When there are multiple columns with the same name in a table in the config
DuplicateDimension !TableName	When there are multiple dimensions with the same name in the config

Instances

Eq ValidationError Source #
Methods (==) :: ValidationError -> ValidationError -> Bool # (/=) :: ValidationError -> ValidationError -> Bool #
Show ValidationError Source #
Methods showsPrec :: Int -> ValidationError -> ShowS # show :: ValidationError -> String # showList :: [ValidationError] -> ShowS #

data TablePopulationMode Source #

The mode for population of the generated tables; used to switch the SQL for table population

Constructors

FullPopulation	Populating the tables fully, starting with empty ones
IncrementalPopulation	Populating the tables incrementally

Instances

Eq TablePopulationMode Source #
Methods (==) :: TablePopulationMode -> TablePopulationMode -> Bool # (/=) :: TablePopulationMode -> TablePopulationMode -> Bool #
Show TablePopulationMode Source #
Methods showsPrec :: Int -> TablePopulationMode -> ShowS # show :: TablePopulationMode -> String # showList :: [TablePopulationMode] -> ShowS #

type Dependencies = Map TableName [TableName] Source #

The dependency graph of the generated tables describing the order in which they have to be populated