Gitson

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

Documentation

type TransactionWriter = WriterT [IO ()]

A transaction monad.

createRepo :: FilePath -> IO ()

Creates a git repository under a given path.

transaction :: (MonadIO i, MonadBaseControl IO i) => FilePath -> TransactionWriter i () -> i ()

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

saveDocument :: (MonadIO i, ToJSON a) => FilePath -> FileName -> a -> TransactionWriter i ()

Adds a write action to a transaction.

saveNextDocument :: (MonadIO i, ToJSON a) => FilePath -> FileName -> a -> TransactionWriter i ()

Adds a write action to a transaction. The key will start with a numeric id, incremented from the last id in the collection.

saveDocumentById :: (MonadIO i, ToJSON a) => FilePath -> Int -> a -> TransactionWriter i ()

Adds a write action to a transaction. Will update the document with the given numeric id.

saveDocumentByName :: (MonadIO i, ToJSON a) => FilePath -> String -> a -> TransactionWriter i ()

Adds a write action to a transaction. Will update the document with the given numeric id.

listCollections :: MonadIO i => i [FilePath]

Lists collections in the current repository.

listDocumentKeys :: MonadIO i => FilePath -> i [FileName]

Lists document keys in a collection.

listEntries :: (MonadIO i, FromJSON a) => FilePath -> i [a]

Lists entries in a collection.

readDocument :: (MonadIO i, FromJSON a) => FilePath -> FileName -> i (Maybe a)

Reads a document from a collection by key.

readDocumentById :: (MonadIO i, FromJSON a) => FilePath -> Int -> i (Maybe a)

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

readDocumentByName :: (MonadIO i, FromJSON a) => FilePath -> String -> i (Maybe a)

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

documentIdFromName :: MonadIO i => FilePath -> String -> i (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 :: MonadIO i => FilePath -> Int -> i (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!