eventstore
EventStore TCP Client
https://github.com/YoEight/eventstore
Version on this page: | 1.4.1 |
LTS Haskell 21.25: | 1.4.2 |
Stackage Nightly 2023-06-21: | 1.4.2 |
Latest on Hackage: | 1.4.3 |
BSD-3-Clause licensed by Yorick Laupa
Maintained by [email protected]
This version can be pinned in stack with:
eventstore-1.4.1@sha256:f1d21104a61b3871a4aea83058aa945c8d74773fc875130913612e17fc34397a,5667
Module documentation for 1.4.1
- Database
- Database.EventStore
- Database.EventStore.Internal
- Database.EventStore.Internal.Test
- Database.EventStore.Streaming
- Database.EventStore.Internal
- Database.EventStore
Depends on 36 packages(full list with versions):
aeson, array, base, bifunctors, bytestring, cereal, clock, connection, containers, dns, dotnet-timespan, exceptions, fast-logger, hashable, http-client, interpolate, lifted-async, lifted-base, monad-control, monad-logger, mono-traversable, mtl, protobuf, random, safe, safe-exceptions, semigroups, stm, stm-chans, streaming, text, time, transformers-base, unordered-containers, uuid, vector
EventStore Haskell TCP client
Talk and exchange ideas in our dedicated Discord Server
That driver supports 100% of EventStore features ! More information about the GetEventStore database can be found there: https://eventstore.com/
Requirements
- 64bits system
- GHC >= 8.0.3
- Cabal >= 1.18
- EventStore >= 4 (Doesn’t support EventStore 2020 Preview yet, previously named version 6).
Note: If you use this client version >= to 1.1
, it will only supports EventStore >= 4.0.0.
Install
- Using Hackage
$ cabal update
$ cabal install eventstore
- From source
$ git clone https://github.com/YoEight/eventstore.git
$ cd eventstore
$ cabal install
How to test
Tests are available. Those assume a server is running on 127.0.0.1
and 1113
port.
$ cabal test
How to use
{-# LANGUAGE OverloadedStrings #-} -- That library uses `Text` pervasively. This pragma permits to use
-- String literal when a Text is needed.
module Main where
import Control.Concurrent.Async (wait)
import Data.Aeson
-- It requires to have `aeson` package installed. Note that EventStore doesn't constraint you to JSON
-- format but putting common use aside, by doing so you'll be able to use some interesting EventStore
-- features like its Complex Event Processing (CEP) capabality.
import Database.EventStore
-- Note that imports 'NonEmpty' data constructor and 'nonEmpty' function from
-- 'Data.List.NonEmpty'.
main :: IO ()
main = do
-- A common pattern with an EventStore connection is to create a single instance only and pass it
-- wherever you need it (it's threadsafe). It's very important to not consider an EventStore connection like
-- its regular SQL counterpart. An EventStore connection will try its best to reconnect
-- automatically to the server if the connection dropped. Of course that behavior can be tuned
-- through some settings.
conn <- connect defaultSettings (Static "127.0.0.1" 1113)
let js = object ["isHaskellTheBest" .= True] -- (.=) comes from Data.Aeson module.
evt = createEvent "programming" Nothing (withJson js)
-- Appends an event to a stream named `languages`.
as <- sendEvent conn (StreamName "languages") anyVersion evt Nothing
-- EventStore interactions are fundamentally asynchronous. Nothing requires you to wait
-- for the completion of an operation, but it's good to know if something went wrong.
_ <- wait as
-- Again, if you decide to `shutdown` an EventStore connection, it means your application is
-- about to terminate.
shutdown conn
-- Make sure the EventStore connection completes every ongoing operation. For instance, if
-- at the moment we call `shutdown` and some operations (or subscriptions) were still pending,
-- the connection aborted all of them.
waitTillClosed conn
Notes
That library was tested on Linux and OSX.
Contributions and bug reports are welcome!
BSD3 License
-Yorick Laupa
Changes
1.4.1
- Update EventStore website link in documentation.
1.4.0
- Internal: Refactor operation and registry tcp internals.
- Introduces
MonitoringBackend
to stop relying exclusively onekg-core
. - Supports GHC 8.8.*.
- Exposes a stream processing interface for subscriptions.
1.3.3
- Add
Pinned
system consumer strategy.
1.3.2
- Bug fix: Driver could end in a situation where it receives a close-connection message during Authentication/Identification phase. Close-connection message was wrongly ignored letting pending operations unanwsered at call-site. If the user forced the result of an operation, it could have lead the current thread to block indefinately. The client state-machine switched to a wrong state.
1.3.1
- Better encoding of streaming interface ReadError.
- Expose more internal functions of the streaming interface.
- Internal: Reset heartbeat tracking on force reconnect request.
- Bug fix: Increment package number unless connection is init or closed (prevent false heartbeat timeout).
- Bug fix: Was also using
s_heartbeatInterval
value fors_heartbeatTimeout
causing false heartbeat timeout exceptions. - Bug fix: Stop trying to reconnect to the most recent node that failed (cluster connection mode).
1.3.0
- Discard
machines
dependency. - Remove
connection
upper bound version.
1.2.4
- Fix possible connection issues if Authentication or Identification processes takes too long to complete.
1.2.3
- No longer terminate the connection in case of
IdentificationTimeout
.
1.2.2
- Fix ACL JSON (de)serialization.
- Fix rare situation where the user send a command before the connection with the
server is available, causing that operation to be sent only after
s_operationTimeout
milliseconds. - Fix “thread blocked indefinitely in an STM transaction” error when failed to create a connection with the server and exceeded the maximun attempt count.
- Fix: Cluster connection, in the discovery process using gossip seed, we try for the next seed if the current one is unreachable.
1.2.1
- Bump
http-client
version.
1.2.0
- Introduce a type-safe
EventNumber
setting. - Introduce a type-safe
ResolveLink
setting. - Support GHC 8.6 but drop GHC < 8.
- Refactor
Slice
api. - Implement a stream-processing interface.
- typeful stream id representation.
- Uniform batch-read and subscription interface.
1.1.6
- Update package metadata information.
1.1.5
- Bump
aeson
version.
1.1.4
- Fix compilation on GHC 8.4
1.1.3
- Remove
text-format
dependency.
1.1.2
- Aeson bump version.
1.1.1
- Fix connection-manager connection reference. The issue was the client was starting to send requests to server even if the confirmation hasn’t been confirmed yet.
1.1.0
- Supports GetEventStore >= 4.0.0 protocol changes.
- No longer support GetEventStore < 4.0.0.
- Stream versions are
Int64
.
1.0.0
- Support SemVer versioning.
0.15.0.2
- Support GHC 8.2.1.
- Support Stackage LTS 9.
0.15.0.1
- Discard version restriction on
hashable
library.
0.15.0.0
- Overall internal components refactoring.
- Decrease memory pressure by 10 folds.
- Improve general performance.
- Provide proper logging support using
fast-logger
library. - Support operation timeout detection.
- Detects if the server is overwhelmed and act accordingly.
- Improve connection management code.
- Expose EKG monitoring metrics.
0.14.0.1
- Fix subscription deadlock on connection drop.
- Fix subscription catchup state tracking on connection drop.
- Fix internal connection dispose lock implementation.
- Bump
aeson
version.
0.14.0.0
- Fix deadlock issues in subscription code.
- Improve cluster connection fiability.
- Internal refactoring.
- Typeful
EventType
0.13.1.7
- Report stream name when facing a ‘Stream not found’ error from the server on catchup subscription.
- Prevent the driver from deadlocking when asking for catchup subscription on a stream that doesn’t exist.
0.13.1.6
- Fix a deadlock on user side when asking a catchup subscription on a stream that doesn’t exist.
0.13.1.5
- Fix an internal connection bug.
0.13.1.4
- Bump
aeson
version. - Internal connection refactoring.
0.13.1.3
- Bump
http-client
version.
0.13.1.2
- Restrain
http-client
package version.
0.13.1.1
- Typo on
streamExists
implementation.
0.13.1.0
- Add
streamExists
ExpectedVersion
smart constructor.
0.13.0.1
- Bump protobuf version
0.13.0.0
- Implement SSL Connection
- Implement
waitConfirmation
function
0.12.0.0
- Quit using internal .NET TimeSpan for dotnet-timespan TimeSpan
0.11.0.0
- Implement Cluster connection.
- Domain can be used to connect to a server instance.
0.10.0.2
- Bump aeson version.
0.10.0.1
- Bump async version.
0.10.0.0
- Fix $maxAge and $cacheControl TimeSpan metadata serialization.
- Fix
timeSpanFrom*
functions. - Implement
timeSpanTotalDays
,timeSpanTotalHours
,timeSpanTotalMinutes
andtimeSpanTotalSeconds
. - Add
withBinary
andwithBinaryAndMetadata
. - Remove useless
TimeSpan
ToJSON
andFromJSON
instances. - Drop
attoparsec
dependency.
0.9.1.3
- Increase cereal upper bound to <0.6
0.9.1.2
- Increase aeson upper bound to <0.11
0.9.1.1
- Fix stackage integration.
0.9.1.0
- Introduce convinient persistent subscription functions.
- Add multi GHC version testing.
0.9.0.0
- Rewrite entirely the internals.
- Implement integration tests.
- Rename every
ExpectedVersion
smart constructors. - Improve internal and public documentation.
- Improve failure reports when the connection dropped.
- Implement more robust internal connection.
0.8.0.0
- Implement competing consumers.
- Expose an uniform API among all kind of subscriptions.
- Rewrite internal subscription management.
- Add missing
Eq
orShow
instances for exposed datatypes. - Add
streamMetadataCustomPropertyValue
andstreamMetadataCustomProperty
. - Add logging capability.
0.7.2.1
- Fix compilation issue
0.7.2.0
- Add
setStreamMetadata
- Add
getStreamMetadata
0.7.1.0
- Internal connection changes
- Allow creating an event with an existing ID
0.7.0.1
- Tight package channnel to connection instance in order to prevent loss on connection drops.
Connection
has asynchronous operation for real now.
0.7.0.0
- Fix date conversion.
recordedEventCreateEpoch
is no longer exposed. - Add
waitTillCatchup
andhasCaughtUp
functions. - Add
exactStream
ExpectedVersion
smart constructor. As the result,ExpectedVersion
constructors are no longer exposed. You have to useanyStream
,noStream
,emptyStream
orexactStream
instead.
0.6.0.1
No changes
0.6.0.0
- Support
keepRetrying
reconnection strategy.