Safe Haskell | None |
---|
Gitson is a simple document store library for Git + JSON.
- type TransactionWriter = WriterT [IO ()] IO ()
- createRepo :: FilePath -> IO ()
- transaction :: FilePath -> TransactionWriter -> IO ()
- saveEntry :: ToJSON a => FilePath -> String -> a -> TransactionWriter
- saveNextEntry :: ToJSON a => FilePath -> String -> a -> TransactionWriter
- listCollections :: IO [FilePath]
- listEntryKeys :: FilePath -> IO [String]
- listEntries :: FromJSON a => FilePath -> IO [a]
- readEntry :: FromJSON a => FilePath -> String -> IO (Maybe a)
- readEntryById :: FromJSON a => FilePath -> Int -> IO (Maybe a)
- readEntryByName :: FromJSON a => FilePath -> String -> IO (Maybe a)
Documentation
type TransactionWriter = WriterT [IO ()] IO ()Source
A transaction monad.
createRepo :: FilePath -> IO ()Source
Creates a git repository under a given path.
transaction :: FilePath -> TransactionWriter -> IO ()Source
Executes a blocking transaction on a repository, committing the results to git.
saveEntry :: ToJSON a => FilePath -> String -> a -> TransactionWriterSource
Adds a write action to a transaction.
saveNextEntry :: ToJSON a => FilePath -> String -> a -> TransactionWriterSource
Adds a write action to a transaction. The key will start with a numeric id, incremented from the last id in the collection.
listCollections :: IO [FilePath]Source
Lists collections in the current repository.
listEntryKeys :: FilePath -> IO [String]Source
Lists entry keys in a collection.
listEntries :: FromJSON a => FilePath -> IO [a]Source
Lists entries in a collection.
readEntry :: FromJSON a => FilePath -> String -> IO (Maybe a)Source
Reads an entry from a collection by key.
readEntryById :: FromJSON a => FilePath -> Int -> IO (Maybe a)Source
Reads an entry from a collection by numeric id (for example, key 00001-hello has id 1)..
readEntryByName :: FromJSON a => FilePath -> String -> IO (Maybe a)Source
Reads an entry from a collection by name (for example, key 00001-hello has name hello).