]> Git — Sourcephile - gargantext.git/blob - src/Gargantext/Database/Bashql.hs
Merge branch 'dev-phylo' of ssh://gitlab.iscpif.fr:20022/gargantext/haskell-gargantex...
[gargantext.git] / src / Gargantext / Database / Bashql.hs
1 {-# OPTIONS_GHC -fno-warn-unused-top-binds #-}
2 {-|
3 Module : Gargantext.Database.Bashql
4 Description : BASHQL to deal with Gargantext Database.
5 Copyright : (c) CNRS, 2017-Present
6 License : AGPL + CECILL v3
7 Maintainer : team@gargantext.org
8 Stability : experimental
9 Portability : POSIX
10
11 * BASHQL is a Domain Specific Language to deal with the Database
12
13 * BASHQL = functional (Bash * SQL)
14
15 * Which language to chose when working with a database ? To make it
16 simple, instead of all common Object Relational Mapping (ORM) [1]
17 strategy used nowadays inspired more by object logic than functional
18 logic, the semantics of BASHQL with focus on the function first.
19
20 * BASHQL focus on the function, i.e. use bash language function name,
21 and make it with SQL behind the scene. Then BASHQL is inspired more
22 by Bash language [2] than SQL and then follows its main commands as
23 specification and documentation.
24
25 * Main arguments:
26 1. Theoritical: database and FileSystems are each thought as a single
27 category, assumption based on theoretical work on databases by David Spivak [0].
28 2. Practical argument: basic bash commands are a daily practice among
29 developper community.
30
31 * How to help ?
32 1. Choose a command you like in Bash
33 2. Implement it in Haskell-SQL according to Gargantext Shema (Tree like
34 filesystem)
35 3. Translate it in BASHQL (follow previous implementations)
36 4. Make a pull request (enjoy the community)
37
38 * Implementation strategy: Functional adapations are made to the
39 gargantext languages options and SQL optimization are done continuously
40 during the project. For the Haskellish part, you may be inspired by
41 Turtle implementation written by Gabriel Gonzales [3] which shows how to
42 write Haskell bash translations.
43
44 * Semantics
45 - FileSystem is now a NodeSystem where each File is a Node in a Directed Graph (DG).
46
47 * References
48
49 [0] MIT Press has published "Category theory for the sciences". The book
50 can also be purchased on Amazon. Here are reviews by the MAA, by the
51 AMS, and by SIAM.
52
53 [1] https://en.wikipedia.org/wiki/Object-relational_mapping
54
55 [2] https://en.wikipedia.org/wiki/Bash_(Unix_shell)
56
57 [3] https://github.com/Gabriel439/Haskell-Turtle-Library
58
59 TODO-ACCESS: should the checks be done here or before.
60
61 -}
62
63 {-# LANGUAGE NoImplicitPrelude #-}
64 {-# LANGUAGE FlexibleContexts #-}
65 {-# LANGUAGE RankNTypes #-}
66
67 module Gargantext.Database.Bashql () {-( get
68 , ls
69 , home
70 , post
71 , del
72 , mv
73 , put
74 , rename
75 , tree
76 -- , mkCorpus, mkAnnuaire
77 )-}
78 where
79
80 import Control.Monad.Reader -- (Reader, ask)
81
82 import Data.Text (Text)
83 import Data.List (concat, last)
84
85 import Gargantext.Core.Types
86 import Gargantext.Database.Utils (runOpaQuery, Cmd)
87 import Gargantext.Database.Schema.Node
88 import qualified Gargantext.Database.Node.Update as U (Update(..), update)
89 import Gargantext.Prelude
90
91
92 -- List of NodeId
93 -- type PWD a = PWD UserId [a]
94 type PWD = [NodeId]
95 --data PWD' a = a | PWD' [a]
96
97 rename :: NodeId -> Text -> Cmd err [Int]
98 rename n t = U.update $ U.Rename n t
99
100 mv :: NodeId -> ParentId -> Cmd err [Int]
101 mv n p = U.update $ U.Move n p
102
103 -- | TODO get Children or Node
104 get :: PWD -> Cmd err [Node HyperdataAny]
105 get [] = pure []
106 get pwd = runOpaQuery $ selectNodesWithParentID (last pwd)
107
108 -- | Home, need to filter with UserId
109 home :: Cmd err PWD
110 home = map _node_id <$> getNodesWithParentId 0 Nothing
111
112 -- | ls == get Children
113 ls :: PWD -> Cmd err [Node HyperdataAny]
114 ls = get
115
116 tree :: PWD -> Cmd err [Node HyperdataAny]
117 tree p = do
118 ns <- get p
119 children <- mapM (\n -> get [_node_id n]) ns
120 pure $ ns <> concat children
121
122 -- | TODO
123 post :: PWD -> [NodeWrite] -> Cmd err Int64
124 post [] _ = pure 0
125 post _ [] = pure 0
126 post pth ns = insertNodesWithParent (Just $ last pth) ns
127
128 --postR :: PWD -> [NodeWrite'] -> Cmd err [Int]
129 --postR [] _ _ = pure [0]
130 --postR _ [] _ = pure [0]
131 --postR pth ns c = mkNodeR (last pth) ns c
132
133 -- | WIP
134 -- rm : mv to trash
135 -- del : empty trash
136 --rm :: PWD -> [NodeId] -> IO Int
137 --rm = del
138 del :: [NodeId] -> Cmd err Int
139 del [] = pure 0
140 del ns = deleteNodes ns
141
142 -- | TODO
143 put :: U.Update -> Cmd err [Int]
144 put = U.update
145
146 -- | TODO
147 -- cd (Home UserId) | (Node NodeId)
148 -- cd Path
149 -- jump NodeId
150 -- touch Dir
151
152 -- type Name = Text
153