beam.yaml

# The docs machinery can be used to generate examples using multiple
# backends, including those not included as part of the beam-core
# repository
#
# This configuration contains the defaults for the main beam documentation
#
# To restrict which backends should be included in a local build,
# modify the mkdocs.yaml file, and set enabled_backends to a list of
# backend names that should be included

backends:

  beam-postgres:
    backend-name: Postgres
    backend-module: Database.Beam.Postgres
    backend-options: '"host=localhost port=5432" beam_docs_chinook'
    src:
      file: ./beam-postgres
    haskell-names:
      package: beam-postgres
      backend: Postgres
      monad: Pg
      select-syntax: PgSelectSyntax
      mnemonic: Pg
      with-database-debug: runBeamPostgresDebug
    extra-packages:
      - postgresql-simple
    extra-imports:
      - Database.PostgreSQL.Simple
      - "qualified Database.Beam.Postgres.Full as Pg"
    backend-extra: >-
      docsWithTransaction = withTransaction
    supports:
      - utf8
      - t611
      - outer-join
      - window
      - intersect
      - except
      - cte

  beam-sqlite:
    backend-name: Sqlite
    backend-module: Database.Beam.Sqlite
    backend-options: chinook.db
    src:
      file: ./beam-sqlite
    haskell-names:
      package: beam-sqlite
      backend: Sqlite
      monad: SqliteM
      select-syntax: SqliteSelectSyntax
      mnemonic: Sqlite
      with-database-debug: runBeamSqliteDebug
    extra-packages:
      - sqlite-simple
    extra-imports:
      - Database.SQLite.Simple
    backend-extra: >-
      docsWithTransaction = withTransaction
    supports:
      - utf8
      - intersect
      - except

#  beam-mysql:
#    backend-name: MySQL
#    backend-module: Database.Beam.MySQL
#    backend-options: "127.0.0.1 3306 root '' beam_docs_chinook"
#    src:
#      local: ../beam-mysql
##      github: tathougies/beam-mysql
##      revision: f4b5d6d6fc1bd88ae5628cd9c03c83e3eb66d873
##      sha256: 87e091f7bb98a1265bf87793f7ddd07f90029d33fd6b6fe6018f8723d746d7a5
#    haskell-names:
#      package: beam-mysql
#      backend: MySQL
#      monad: MySQLM
#      select-syntax: MysqlSelectSyntax
#      mnemonic: My
#      with-database-debug: runBeamMySQLDebug
#    extra-packages:
#      - mysql-simple
#    extra-imports:
#      - Database.MySQL.Simple
#      - "qualified Database.MySQL.Base as Base"
#    backend-extra: >-
#      docsWithTransaction = withTransaction
#    supports:
#      - utf8

#  beam-mssql:
#    backend-name: MsSQL
#    backend-module: Database.Beam.MsSQL
#    backend-options: "sa Testtest1 test2"
#    src:
#      local: ../beam-mssql
#    haskell-names:
#      package: beam-mssql
#      backend: MsSQL
#      monad: MsSQLM
#      select-syntax: MssqlSelectSyntax
#      mnemonic: Ms
#      with-database-debug: runBeamMsSQLDebug
#    extra-packages:
#      - tds
#    extra-imports:
#      - Database.TDS
#    backend-extra: >-
#      docsWithTransaction = withTransaction
#    supports:
#      - utf8