Copyright	(c) CNRS 2017-Present
License	AGPL + CECILL v3
Maintainer	team@gargantext.org
Stability	experimental
Portability	POSIX
Safe Haskell	Safe-Inferred
Language	Haskell2010

Gargantext.Database.Action.Flow

Description

- TODO-ACCESS:
- check userId CanFillUserCorpus userCorpusId
- check masterUserId CanFillMasterCorpus masterCorpusId
- TODO-ACCESS: check uId CanInsertDoc pId && checkDocType nodeType
- TODO-EVENTS: InsertedNodes

Synopsis

data DataText
- = DataOld ![NodeId]
- | DataNew !(Maybe Integer, ConduitT () HyperdataDocument IO ())
getDataText :: HasNodeError err => DataOrigin -> TermType Lang -> RawQuery -> Maybe APIKey -> Maybe AuthKey -> Maybe Limit -> DBCmd err (Either GetCorpusError DataText)
getDataText_Debug :: HasNodeError err => DataOrigin -> TermType Lang -> RawQuery -> Maybe Limit -> DBCmd err ()
flowDataText :: forall env err m. (DbCmd' env err m, HasNodeStory env err m, MonadLogger m, HasNLPServer env, HasTreeError err, HasValidationError err, MonadJobStatus m) => User -> DataText -> TermType Lang -> CorpusId -> Maybe FlowSocialListWith -> JobHandle m -> m CorpusId
flow :: forall env err m a c. (DbCmd' env err m, HasNodeStory env err m, MonadLogger m, HasNLPServer env, HasTreeError err, HasValidationError err, FlowCorpus a, MkCorpus c, MonadJobStatus m) => Maybe c -> MkCorpusUser -> TermType Lang -> Maybe FlowSocialListWith -> (Integer, ConduitT () a m ()) -> JobHandle m -> m CorpusId
flowCorpusFile :: (DbCmd' env err m, HasNodeStory env err m, MonadLogger m, HasNLPServer env, HasTreeError err, HasValidationError err, MonadJobStatus m) => MkCorpusUser -> Limit -> TermType Lang -> FileType -> FileFormat -> FilePath -> Maybe FlowSocialListWith -> JobHandle m -> m CorpusId
flowCorpus :: (DbCmd' env err m, HasNodeStory env err m, MonadLogger m, HasNLPServer env, HasTreeError err, HasValidationError err, FlowCorpus a, MonadJobStatus m) => MkCorpusUser -> TermType Lang -> Maybe FlowSocialListWith -> (Integer, ConduitT () a m ()) -> JobHandle m -> m CorpusId
flowCorpusUser :: (HasNodeError err, HasValidationError err, HasNLPServer env, HasTreeError err, HasNodeStory env err m, MkCorpus c) => Lang -> User -> CorpusId -> ListId -> Maybe c -> Maybe FlowSocialListWith -> m CorpusId
flowAnnuaire :: (DbCmd' env err m, HasNodeStory env err m, MonadLogger m, HasNLPServer env, HasTreeError err, HasValidationError err, MonadJobStatus m) => MkCorpusUser -> TermType Lang -> FilePath -> JobHandle m -> m AnnuaireId
insertMasterDocs :: (DbCmd' env err m, HasNodeError err, FlowCorpus a, MkCorpus c) => NLPServerConfig -> Maybe c -> TermType Lang -> [a] -> m [DocId]
saveDocNgramsWith :: DbCmd' env err m => ListId -> HashMap ExtractedNgrams (Map NgramsType (Map NodeId (Int, TermsCount))) -> m ()
addDocumentsToHyperCorpus :: (DbCmd' env err m, HasNodeError err, FlowCorpus document, MkCorpus corpus) => NLPServerConfig -> Maybe corpus -> TermType Lang -> CorpusId -> [document] -> m [DocId]
reIndexWith :: HasNodeStory env err m => CorpusId -> ListId -> NgramsType -> Set ListType -> m ()
getOrMkRoot :: HasNodeError err => User -> DBCmd err (UserId, RootId)
getOrMkRootWithCorpus :: (HasNodeError err, MkCorpus a) => MkCorpusUser -> Maybe a -> DBCmd err (UserId, RootId, CorpusId)
data TermType lang
- = Mono {
  - _tt_lang :: !lang
  }
- | Multi {
  - _tt_lang :: !lang
  }
- | MonoMulti {
  - _tt_lang :: !lang
  }
- | Unsupervised {
  - _tt_lang :: !lang
  - _tt_windowSize :: !Int
  - _tt_ngramsSize :: !Int
  - _tt_model :: !(Maybe (Tries Token ()))
  }
data DataOrigin
- = InternalOrigin {
  - _do_api :: ExternalAPIs
  }
- | ExternalOrigin {
  - _do_api :: ExternalAPIs
  }
allDataOrigins :: [DataOrigin]
do_api :: Lens' DataOrigin ExternalAPIs

Documentation

data DataText #

Constructors

DataOld ![NodeId]
DataNew !(Maybe Integer, ConduitT () HyperdataDocument IO ())

getDataText :: HasNodeError err => DataOrigin -> TermType Lang -> RawQuery -> Maybe APIKey -> Maybe AuthKey -> Maybe Limit -> DBCmd err (Either GetCorpusError DataText) #

getDataText_Debug :: HasNodeError err => DataOrigin -> TermType Lang -> RawQuery -> Maybe Limit -> DBCmd err () #

flowDataText :: forall env err m. (DbCmd' env err m, HasNodeStory env err m, MonadLogger m, HasNLPServer env, HasTreeError err, HasValidationError err, MonadJobStatus m) => User -> DataText -> TermType Lang -> CorpusId -> Maybe FlowSocialListWith -> JobHandle m -> m CorpusId #

flow :: forall env err m a c. (DbCmd' env err m, HasNodeStory env err m, MonadLogger m, HasNLPServer env, HasTreeError err, HasValidationError err, FlowCorpus a, MkCorpus c, MonadJobStatus m) => Maybe c -> MkCorpusUser -> TermType Lang -> Maybe FlowSocialListWith -> (Integer, ConduitT () a m ()) -> JobHandle m -> m CorpusId #

flowCorpusFile :: (DbCmd' env err m, HasNodeStory env err m, MonadLogger m, HasNLPServer env, HasTreeError err, HasValidationError err, MonadJobStatus m) => MkCorpusUser -> Limit -> TermType Lang -> FileType -> FileFormat -> FilePath -> Maybe FlowSocialListWith -> JobHandle m -> m CorpusId #

flowCorpus :: (DbCmd' env err m, HasNodeStory env err m, MonadLogger m, HasNLPServer env, HasTreeError err, HasValidationError err, FlowCorpus a, MonadJobStatus m) => MkCorpusUser -> TermType Lang -> Maybe FlowSocialListWith -> (Integer, ConduitT () a m ()) -> JobHandle m -> m CorpusId #

TODO improve the needed type to create/update a corpus (For now, Either is enough)

flowCorpusUser :: (HasNodeError err, HasValidationError err, HasNLPServer env, HasTreeError err, HasNodeStory env err m, MkCorpus c) => Lang -> User -> CorpusId -> ListId -> Maybe c -> Maybe FlowSocialListWith -> m CorpusId #

flowAnnuaire :: (DbCmd' env err m, HasNodeStory env err m, MonadLogger m, HasNLPServer env, HasTreeError err, HasValidationError err, MonadJobStatus m) => MkCorpusUser -> TermType Lang -> FilePath -> JobHandle m -> m AnnuaireId #

insertMasterDocs :: (DbCmd' env err m, HasNodeError err, FlowCorpus a, MkCorpus c) => NLPServerConfig -> Maybe c -> TermType Lang -> [a] -> m [DocId] #

saveDocNgramsWith :: DbCmd' env err m => ListId -> HashMap ExtractedNgrams (Map NgramsType (Map NodeId (Int, TermsCount))) -> m () #

addDocumentsToHyperCorpus :: (DbCmd' env err m, HasNodeError err, FlowCorpus document, MkCorpus corpus) => NLPServerConfig -> Maybe corpus -> TermType Lang -> CorpusId -> [document] -> m [DocId] #

Given a list of corpus documents and a NodeId identifying the CorpusId, adds the given documents to the corpus. Returns the Ids of the inserted documents.

reIndexWith :: HasNodeStory env err m => CorpusId -> ListId -> NgramsType -> Set ListType -> m () #

Re-index documents of a corpus with ngrams in the list

getOrMkRoot :: HasNodeError err => User -> DBCmd err (UserId, RootId) #

getOrMkRootWithCorpus :: (HasNodeError err, MkCorpus a) => MkCorpusUser -> Maybe a -> DBCmd err (UserId, RootId, CorpusId) #

data TermType lang #

Constructors

Mono
Fields _tt_lang :: !lang
Multi
Fields _tt_lang :: !lang
MonoMulti
Fields _tt_lang :: !lang
Unsupervised
Fields _tt_lang :: !lang _tt_windowSize :: !Int _tt_ngramsSize :: !Int _tt_model :: !(Maybe (Tries Token ()))

Instances

Instances details

Generic (TermType lang) #
Instance details Defined in Gargantext.Core.Text.Terms Associated Types type Rep (TermType lang) :: Type -> Type # Methods from :: TermType lang -> Rep (TermType lang) x # to :: Rep (TermType lang) x -> TermType lang #
Show lang => Show (TermType lang) #
Instance details Defined in Gargantext.Core.Text.Terms Methods showsPrec :: Int -> TermType lang -> ShowS # show :: TermType lang -> String # showList :: [TermType lang] -> ShowS #
type Rep (TermType lang) #
Instance details Defined in Gargantext.Core.Text.Terms type Rep (TermType lang) = D1 ('MetaData "TermType" "Gargantext.Core.Text.Terms" "gargantext-0.0.7.1.5.3-inplace" 'False) ((C1 ('MetaCons "Mono" 'PrefixI 'True) (S1 ('MetaSel ('Just "_tt_lang") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 lang)) :+: C1 ('MetaCons "Multi" 'PrefixI 'True) (S1 ('MetaSel ('Just "_tt_lang") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 lang))) :+: (C1 ('MetaCons "MonoMulti" 'PrefixI 'True) (S1 ('MetaSel ('Just "_tt_lang") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 lang)) :+: C1 ('MetaCons "Unsupervised" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_tt_lang") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 lang) :: S1 ('MetaSel ('Just "_tt_windowSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "_tt_ngramsSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "_tt_model") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe (Tries Token ())))))))

data DataOrigin #

Constructors

InternalOrigin
Fields _do_api :: ExternalAPIs
ExternalOrigin
Fields _do_api :: ExternalAPIs

Instances

Instances details

FromJSON DataOrigin #
Instance details Defined in Gargantext.Database.Action.Flow.Types Methods parseJSON :: Value -> Parser DataOrigin # parseJSONList :: Value -> Parser [DataOrigin] #
ToJSON DataOrigin #
Instance details Defined in Gargantext.Database.Action.Flow.Types Methods toJSON :: DataOrigin -> Value # toEncoding :: DataOrigin -> Encoding # toJSONList :: [DataOrigin] -> Value # toEncodingList :: [DataOrigin] -> Encoding #
Generic DataOrigin #
Instance details Defined in Gargantext.Database.Action.Flow.Types Associated Types type Rep DataOrigin :: Type -> Type # Methods from :: DataOrigin -> Rep DataOrigin x # to :: Rep DataOrigin x -> DataOrigin #
Eq DataOrigin #
Instance details Defined in Gargantext.Database.Action.Flow.Types Methods (==) :: DataOrigin -> DataOrigin -> Bool # (/=) :: DataOrigin -> DataOrigin -> Bool #
ToSchema DataOrigin #
Instance details Defined in Gargantext.Database.Action.Flow.Types Methods declareNamedSchema :: Proxy DataOrigin -> Declare (Definitions Schema) NamedSchema #
type Rep DataOrigin #
Instance details Defined in Gargantext.Database.Action.Flow.Types type Rep DataOrigin = D1 ('MetaData "DataOrigin" "Gargantext.Database.Action.Flow.Types" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "InternalOrigin" 'PrefixI 'True) (S1 ('MetaSel ('Just "_do_api") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExternalAPIs)) :+: C1 ('MetaCons "ExternalOrigin" 'PrefixI 'True) (S1 ('MetaSel ('Just "_do_api") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExternalAPIs)))

allDataOrigins :: [DataOrigin] #

do_api :: Lens' DataOrigin ExternalAPIs #