hets/Persistence/Schema.hs

	Schema.hs revision 649fdc0d0502d62d160c150684356fef2c273484
{-# LANGUAGE DeriveGeneric              #-}
{-# LANGUAGE EmptyDataDecls             #-}
{-# LANGUAGE FlexibleContexts           #-}
{-# LANGUAGE FlexibleInstances          #-}
{-# LANGUAGE GADTs                      #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE MultiParamTypeClasses      #-}
{-# LANGUAGE OverloadedStrings          #-}
{-# LANGUAGE QuasiQuotes                #-}
{-# LANGUAGE TemplateHaskell            #-}
{-# LANGUAGE TypeFamilies               #-}

{- |
Module      :  ./Persistence.DevGraph.hs
Copyright   :  (c) Uni Magdeburg 2017
License     :  GPLv2 or higher, see LICENSE.txt

Maintainer  :  Eugen Kuksa <kuksa@iks.cs.ovgu.de>
Stability   :  provisional
Portability :  portable
-}

module Persistence.Schema where

import Database.Persist.Sql
import Database.Persist.TH

import Data.Text (Text)

import qualified Persistence.Schema.Enums as Enums
import Persistence.Schema.EvaluationStateType (EvaluationStateType)
import Persistence.Schema.MappingOrigin (MappingOrigin)
import Persistence.Schema.MappingType (MappingType)
import Persistence.Schema.OMSOrigin (OMSOrigin)
import Persistence.Schema.ReasoningStatusOnConjectureType (ReasoningStatusOnConjectureType)
import Persistence.Schema.ReasoningStatusOnReasoningAttemptType (ReasoningStatusOnReasoningAttemptType)

indexes :: [(String, [String])]
indexes =
  [ ("languages", ["slug"])
  , ("logics", ["slug"])
  , ("language_mappings", ["source_id", "target_id"])
  , ("logic_mappings", ["language_mapping_id", "slug"])
  , ("signature_morphisms", ["logic_mapping_id", "source_id", "target_id"])
  , ("symbol_mappings", ["signature_morphism_id", "source_id", "target_id"])
  ]

share [ mkPersist sqlSettings
      , mkDeleteCascade sqlSettings
      , mkMigrate "migrateAll"
      ] [persistLowerCase|
Hets sql=hets
  key String maxlen=255
  Primary key
  value String
  deriving Show

Language sql=languages
  slug String maxlen=255
  UniqueLanguageSlug slug
  name String
  description String
  standardizationStatus String
  definedBy String
  deriving Show

Logic sql=logics
  languageId LanguageId
  slug String maxlen=247 -- 255 - 8 (8 for the languageId)
  UniqueLanguageIdLogicSlug languageId slug
  name String
  deriving Show

LanguageMapping sql=language_mappings
  sourceId LanguageId
  targetId LanguageId
  deriving Show

LogicMapping sql=logic_mappings
  languageMappingId LanguageMappingId
  sourceId LogicId
  targetId LogicId
  slug String maxlen=247 -- 255 - 8 (8 for the languageMappingId)
  UniqueLanguageMappingIdLogicMappingSlug languageMappingId slug
  name String
  isInclusion Bool
  hasModelExpansion Bool
  isWeaklyAmalgamable Bool
  deriving Show

Serialization sql=serializations
  languageId LanguageId
  slug String maxlen=247 -- 255 - 8 (8 for the languageId)
  UniqueSerializationLanguageIdSerializationSlug languageId slug
  name String
  deriving Show

Signature sql=signatures
  languageId LanguageId
  asJson String

SignatureMorphism sql=signature_morphisms
  logicMappingId LogicMappingId
  asJson String
  sourceId SignatureId
  targetId SignatureId
  deriving Show

ConservativityStatus sql=conservativity_statuses
  -- Use "Unknown String" for non-Common.Consistency.Conservativtiy statuses
  required String
  proved String
  deriving Show


-- We leave out the other columns here because we don't need them in Hets
OrganizationalUnit sql=organizational_units
  kind String
  slug String maxlen=255
  UniqueOrganizationalUnitSlug slug
  deriving Show

-- We leave out the other columns here because we don't need them in Hets
Repository sql=repositories
  ownerId OrganizationalUnitId
  deriving Show

-- We leave out the other columns here because we don't need them in Hets
FileVersion sql=file_versions
  repositoryId RepositoryId
  path String
  commitSha String
  evaluationState EvaluationStateType
  deriving Show

-- This table is only needed for a SELECT JOIN by Ontohub. It needs to at least
-- exist for running with SQLite
FileVersionParent sql=file_version_parents
  lastChangedFileVersionId FileVersionId
  queriedSha String maxlen=40 -- A SHA1 hash always has 40 characters
  Primary lastChangedFileVersionId queriedSha
  deriving Show

LocIdBase sql=loc_id_bases
  fileVersionId FileVersionId -- FileVersionId is LocIdBaseId
  kind Enums.LocIdBaseKindType maxlen=16
  locId String maxlen=255
  UniqueLocIdBaseLocId fileVersionId kind locId
  deriving Show

Document sql=documents
  displayName String
  name String
  location String Maybe
  version String Maybe
  deriving Show

DocumentLink sql=document_links
  sourceId LocIdBaseId -- DocumentId is LocIdBaseId
  targetId LocIdBaseId -- DocumentId is LocIdBaseId
  deriving Show

FileRange sql=file_ranges
  path String
  startLine Int
  startColumn Int
  endLine Int Maybe
  endColumn Int Maybe
  deriving Show

Diagnosis sql=diagnoses
  fileVersionId FileVersionId
  fileRangeId FileRangeId Maybe
  kind Enums.DiagnosisKindType
  text Text
  deriving Show

OMS sql=oms
  documentId LocIdBaseId -- DocumentId is LocIdBaseId
  logicId LogicId
  languageId LanguageId
  serializationId SerializationId Maybe
  signatureId SignatureId
  normalFormId LocIdBaseId Maybe
  normalFormSignatureMorphismId SignatureMorphismId Maybe
  freeNormalFormId LocIdBaseId Maybe
  freeNormalFormSignatureMorphismId SignatureMorphismId Maybe
  origin OMSOrigin
  conservativityStatusId ConservativityStatusId
  nameFileRangeId FileRangeId Maybe -- Represents NodeName
  displayName String        -- Represents NodeName
  name String               -- Represents NodeName
  nameExtension String      -- Represents NodeName
  nameExtensionIndex Int    -- Represents NodeName
  labelHasHiding Bool
  labelHasFree Bool
  deriving Show

Mapping sql=mappings
  sourceId LocIdBaseId -- OMSId is a LocIdBaseId
  targetId LocIdBaseId -- OMSId is a LocIdBaseId
  signatureMorphismId SignatureMorphismId
  conservativityStatusId ConservativityStatusId Maybe

  -- Exactly one of the following two is not `Nothing`:
  freenessParameterOMSId LocIdBaseId Maybe sql=freeness_parameter_oms_id -- DocumentId is a LocIdBaseId
  freenessParameterLanguageId LanguageId Maybe

  displayName String
  name String
  origin MappingOrigin
  pending Bool
  type MappingType
  deriving Show

Sentence sql=sentences
  omsId LocIdBaseId -- OMSId is LocIdBaseId
  fileRangeId FileRangeId Maybe
  name String
  text Text
  deriving Show

Axiom sql=axioms
  deriving Show

Conjecture sql=conjectures
  evaluationState EvaluationStateType
  reasoningStatus ReasoningStatusOnConjectureType
  deriving Show

Symbol sql=symbols
  omsId LocIdBaseId -- OMSId is LocIdBaseId
  fileRangeId FileRangeId Maybe
  symbolKind String
  name String
  fullName Text
  deriving Show

SymbolMapping sql=symbol_mappings
  signatureMorphismId SignatureMorphismId
  sourceId LocIdBaseId -- SymbolId is LocIdBaseId
  targetId LocIdBaseId -- SymbolId is LocIdBaseId
  deriving Show

SentenceSymbol sql=sentences_symbols
  sentenceId LocIdBaseId -- SentenceId is LocIdBaseId
  symbolId LocIdBaseId -- SymbolId is LocIdBaseId
  Primary sentenceId symbolId
  deriving Show

SignatureSymbol sql=signature_symbols
  signatureId SignatureId
  symbolId LocIdBaseId -- SymbolId is LocIdBaseId
  Primary signatureId symbolId
  imported Bool
  deriving Show

Reasoner sql=reasoners
  slug String maxlen=255
  UniqueReasonerSlug slug
  displayName String
  deriving Show

ReasonerConfiguration sql=reasoner_configurations
  configuredReasonerId ReasonerId Maybe
  timeLimit Int Maybe
  deriving Show

PremiseSelection sql=premise_selections
  reasonerConfigurationId ReasonerConfigurationId
  deriving Show

PremiseSelectedSentence sql=premise_selected_sentences
  premiseId LocIdBaseId -- SentenceId is LocIdBaseId
  premiseSelectionId PremiseSelectionId
  Primary premiseId premiseSelectionId
  deriving Show

ManualPremiseSelection sql=manual_premise_selections
  deriving Show

SinePremiseSelection sql=sine_premise_selections
  depthLimit Int Maybe
  tolerance Double Maybe
  axiomNumberLimit Int Maybe
  deriving Show

SineSymbolPremiseTrigger sql=sine_symbol_premise_triggers
  sinePremiseSelectionId SinePremiseSelectionId
  premiseId LocIdBaseId -- AxiomId is LocIdBaseId
  symbolId LocIdBaseId -- SymbolId is LocIdBaseId
  minTolerance Double
  deriving Show

SineSymbolCommonness sql=sine_symbol_commonnesses
  sinePremiseSelectionId SinePremiseSelectionId
  symbolId LocIdBaseId -- SymbolId is LocIdBaseId
  commonness Int
  deriving Show

ReasoningAttempt sql=reasoning_attempts
  reasonerConfigurationId ReasonerConfigurationId
  usedReasonerId ReasonerId Maybe
  timeTaken Int Maybe
  evaluationState EvaluationStateType
  reasoningStatus ReasoningStatusOnReasoningAttemptType
  deriving Show

ProofAttempt sql=proof_attempts
  conjectureId LocIdBaseId Maybe

ConsistencyCheckAttempt sql=consistency_check_attempts
  omsId LocIdBaseId Maybe

GeneratedAxiom sql=generated_axioms
  reasoningAttemptId ReasoningAttemptId
  text Text
  deriving Show

ReasonerOutput sql=reasoner_outputs
  reasoningAttemptId ReasoningAttemptId
  reasonerId ReasonerId
  text Text
  deriving Show
|]