src/Gargantext/Database/NodeNgram.hs

   1 {-|
   2 Module      : Gargantext.Database.NodeNgrams
   3 Description : NodeNgram for Ngram indexation or Lists
   4 Copyright   : (c) CNRS, 2017-Present
   5 License     : AGPL + CECILL v3
   6 Maintainer  : team@gargantext.org
   7 Stability   : experimental
   8 Portability : POSIX
   9
  10 NodeNgram: relation between a Node and a Ngrams
  11
  12 if Node is a Document then it is indexing
  13 if Node is a List     then it is listing (either Stop, Candidate or Map)
  14
  15 -}
  16
  17 {-# OPTIONS_GHC -fno-warn-orphans   #-}
  18
  19 {-# LANGUAGE Arrows                 #-}
  20 {-# LANGUAGE FlexibleInstances      #-}
  21 {-# LANGUAGE FunctionalDependencies #-}
  22 {-# LANGUAGE MultiParamTypeClasses  #-}
  23 {-# LANGUAGE NoImplicitPrelude      #-}
  24 {-# LANGUAGE OverloadedStrings      #-}
  25 {-# LANGUAGE QuasiQuotes            #-}
  26 {-# LANGUAGE TemplateHaskell        #-}
  27
  28
  29 -- TODO NodeNgrams
  30 module Gargantext.Database.NodeNgram where
  31
  32 import Data.Text (Text)
  33 import Control.Lens.TH (makeLensesWith, abbreviatedFields)
  34 import Data.Profunctor.Product.TH (makeAdaptorAndInstance)
  35 import Database.PostgreSQL.Simple.Types (Values(..), QualifiedIdentifier(..))
  36 import Database.PostgreSQL.Simple.SqlQQ (sql)
  37 import Gargantext.Core.Types.Main (ListId, ListTypeId)
  38 import Gargantext.Database.Node (mkCmd, Cmd(..))
  39 import Gargantext.Prelude
  40 import Opaleye
  41 import qualified Database.PostgreSQL.Simple as PGS (Connection, query, Only(..))
  42
  43 -- | TODO : remove id
  44 data NodeNgramPoly id node_id ngram_id weight ngrams_type
  45    = NodeNgram { nodeNgram_NodeNgramId      :: id
  46                , nodeNgram_NodeNgramNodeId  :: node_id
  47                , nodeNgram_NodeNgramNgramId :: ngram_id
  48                , nodeNgram_NodeNgramWeight  :: weight
  49                , nodeNgram_NodeNgramType    :: ngrams_type
  50                } deriving (Show)
  51
  52 type NodeNgramWrite =
  53      NodeNgramPoly
  54         (Maybe (Column PGInt4  ))
  55                (Column PGInt4  )
  56                (Column PGInt4  )
  57                (Column PGFloat8)
  58                (Column PGInt4  )
  59
  60 type NodeNgramRead =
  61      NodeNgramPoly
  62        (Column PGInt4  )
  63        (Column PGInt4  )
  64        (Column PGInt4  )
  65        (Column PGFloat8)
  66        (Column PGInt4  )
  67
  68 type NodeNgram =
  69      NodeNgramPoly (Maybe Int) Int Int Double Int
  70
  71 $(makeAdaptorAndInstance "pNodeNgram" ''NodeNgramPoly)
  72 $(makeLensesWith abbreviatedFields    ''NodeNgramPoly)
  73
  74
  75 nodeNgramTable :: Table NodeNgramWrite NodeNgramRead
  76 nodeNgramTable  = Table "nodes_ngrams"
  77   ( pNodeNgram NodeNgram
  78     { nodeNgram_NodeNgramId      = optional "id"
  79     , nodeNgram_NodeNgramNodeId  = required "node_id"
  80     , nodeNgram_NodeNgramNgramId = required "ngram_id"
  81     , nodeNgram_NodeNgramWeight  = required "weight"
  82     , nodeNgram_NodeNgramType    = required "ngrams_type"
  83     }
  84   )
  85
  86 queryNodeNgramTable :: Query NodeNgramRead
  87 queryNodeNgramTable = queryTable nodeNgramTable
  88
  89 insertNodeNgrams :: [NodeNgram] -> Cmd Int
  90 insertNodeNgrams = insertNodeNgramW
  91                  . map (\(NodeNgram _ n g w t) ->
  92                           NodeNgram Nothing (pgInt4 n)   (pgInt4 g)
  93                                             (pgDouble w) (pgInt4 t)
  94                         )
  95
  96 insertNodeNgramW :: [NodeNgramWrite] -> Cmd Int
  97 insertNodeNgramW nns =
  98   mkCmd $ \c -> fromIntegral
  99        <$> runInsertMany c nodeNgramTable nns
 100
 101 type NgramsText = Text
 102
 103 updateNodeNgrams :: PGS.Connection -> [(ListId, NgramsText, ListTypeId)] -> IO [PGS.Only Int]
 104 updateNodeNgrams c input = PGS.query c updateQuery (PGS.Only $ Values fields $ input)
 105   where
 106     fields = map (\t-> QualifiedIdentifier Nothing t) ["int4","text","int4"]
 107     updateQuery = [sql| UPDATE nodes_ngrams as old SET
 108                  ngrams_type = new.typeList
 109                  from (?) as new(node_id,terms,typeList)
 110                  JOIN ngrams ON ngrams.terms = new.terms
 111                  WHERE old.node_id = new.node_id
 112                  AND   old.ngram_id = ngrams.id;
 113                  -- RETURNING new.ngram_id
 114                  |]
 115