Commit 0655415e authored by Alexandre Delanoë's avatar Alexandre Delanoë

[DOC] improving haddock doc in Import, need more work.

parent 9a3c78ea
...@@ -7,7 +7,9 @@ Maintainer : team@gargantext.org ...@@ -7,7 +7,9 @@ Maintainer : team@gargantext.org
Stability : experimental Stability : experimental
Portability : POSIX Portability : POSIX
* Main purpose of this module: enabling "common goods" of text data and respecting privacy. * Purpose of this module
Enabling "common goods" of text data and respecting privacy.
Gargantext shares as "common good" the links between context of texts Gargantext shares as "common good" the links between context of texts
and terms / words / ngrams. and terms / words / ngrams.
...@@ -39,21 +41,14 @@ instance). ...@@ -39,21 +41,14 @@ instance).
- Hash policy: this UniqId is a sha256 uniq id which is the result of - Hash policy: this UniqId is a sha256 uniq id which is the result of
the concatenation of the parameters defined by @hashParameters@. the concatenation of the parameters defined by @hashParameters@.
* Database configuration
Administrator of the database has to create a uniq index as following SQL command:
`create unique index on nodes (typename, parent_id, (hyperdata ->> 'uniqId'));`
-} -}
------------------------------------------------------------------------
{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE NoImplicitPrelude #-} {-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE QuasiQuotes #-} {-# LANGUAGE QuasiQuotes #-}
{-# LANGUAGE DeriveDataTypeable #-} {-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE TypeSynonymInstances #-} {-# LANGUAGE TypeSynonymInstances #-}
------------------------------------------------------------------------
------------------------------------------------------------------------ ------------------------------------------------------------------------
module Gargantext.Database.Node.Document.Import where module Gargantext.Database.Node.Document.Import where
...@@ -97,6 +92,10 @@ import GHC.Generics (Generic) ...@@ -97,6 +92,10 @@ import GHC.Generics (Generic)
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
-- * Main Insert functions -- * Main Insert functions
-- ** Database configuration
-- Administrator of the database has to create a uniq index as following SQL command:
-- `create unique index on nodes (typename, parent_id, (hyperdata ->> 'uniqId'));`
-- | Insert Document main function -- | Insert Document main function
-- UserId : user who is inserting the documents -- UserId : user who is inserting the documents
-- ParentId : folder ID which is parent of the inserted documents -- ParentId : folder ID which is parent of the inserted documents
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment