Gitson

Gitson is a simple document store library for Git + JSON.

Documentation

type TransactionWriter = WriterT [IO ()] IO ()

A transaction monad.

createRepo :: FilePath -> IO ()

Creates a git repository under a given path.

transaction :: FilePath -> TransactionWriter -> IO ()

Executes a blocking transaction on a repository, committing the results to git.

saveDocument :: ToJSON a => FilePath -> FileName -> a -> TransactionWriter

Adds a write action to a transaction.

saveNextDocument :: ToJSON a => FilePath -> FileName -> a -> TransactionWriter

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]

Lists collections in the current repository.

listDocumentKeys :: FilePath -> IO [FileName]

Lists document keys in a collection.

listEntries :: FromJSON a => FilePath -> IO [a]

Lists entries in a collection.

readDocument :: FromJSON a => FilePath -> FileName -> IO (Maybe a)

Reads a document from a collection by key.

readDocumentById :: FromJSON a => FilePath -> Int -> IO (Maybe a)

Reads a document from a collection by numeric id (for example, key 00001-hello has id 1).

readDocumentByName :: FromJSON a => FilePath -> String -> IO (Maybe a)

Reads a document from a collection by name (for example, key 00001-hello has name hello).

documentIdFromName :: FilePath -> String -> IO (Maybe Int)

Returns a document's id by name (for example, hello will return 23 when key 00023-hello exists). Does not read the document!

documentNameFromId :: FilePath -> Int -> IO (Maybe String)

Returns a document's name by id (for example, 23 will return hello when key 00023-hello exists). Does not read the document!