The nakadi-client package

[ Tags: bsd3, library, network ] [ Propose Tags ]

This package implements a client library for interacting with the Nakadi event broker system developed by Zalando.


[Skip to Readme]

Properties

Versions 0.2.0.0, 0.2.0.1, 0.3.0.0
Dependencies aeson, aeson-casing, base (>=4.7 && <5), bytestring, conduit, conduit-combinators, conduit-extra, containers, hashable, http-client, http-client-tls, http-conduit, http-types, iso8601-time, lens, monad-logger, mtl, resourcet, retry, safe-exceptions, scientific, split, tasty, template-haskell, text, time, transformers, unordered-containers, uuid, vector [details]
License BSD3
Copyright (c) 2017 Moritz Schulte
Author Moritz Schulte
Maintainer mtesseract@silverratio.net
Category Network
Home page https://github.com/mtesseract/nakadi-haskell#readme
Bug tracker https://github.com/mtesseract/nakadi-haskell/issues
Source repository head: git clone https://github.com/mtesseract/nakadi-haskell
Uploaded Fri Sep 29 08:54:00 UTC 2017 by mtesseract
Distributions NixOS:0.2.0.0, Stackage:0.3.0.0
Downloads 75 total (47 in the last 30 days)
Rating 0.0 (0 ratings) [clear rating]
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-09-29 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for nakadi-client-0.3.0.0

[back to package description]

nakadi-client Hackage version Stackage version Build Status

About

nakadi-client is a BSD2/BSD3 licensed Haskell client library for interacting with the Nakadi event broker system developed by Zalando. The streaming is built on top of Conduit.

Please note that the API is not considered stable yet.

nakadi-client provides:

  • Docker based test suite testing against the official Nakadi docker image (in progress).

  • A rather direct translation of Nakadi's REST API to Haskell. Thus, if you are familiar with Nakadi's REST API, the API exposed by nakadi-client will feel very familiar.

  • Where suitable, nakadi-client provides additional higher-level interfaces.

  • A type-safe API for interacting with Nakadi. For example, the name of an event type has type EventTypeName, not Text or something generic.

  • Integrated and configurable retry mechanism.

  • Conduit based interfaces for streaming events.

  • Convenient Subscription API interface (subscriptionSource & runSubscription), which frees the user from any manual bookkeeping of the Subscription Stream ID necessary for commiting cursors.

  • Mechanism for registering callbacks for logging and token injection.

  • Correct types for values like CursorOffset (which must be treated as opaque strings).

  • Basically each API function is exposed in two versions: One which requires the caller to pass in a Nakadi configuration value containing the information about how to connect to Nakadi and one which is suffixed with R (think: Reader monad), which expects to find the Nakadi configuration in the environment provided by a reader monad in your application's monad stack.

Example

Example using the Subscription API:

import qualified Network.Nakadi as Nakadi

processSubscription :: Nakadi.SubscriptionId -> IO ()
processSubscription subscriptionId = do
  runResourceT $ do
    (connection, source) <- Nakadi.subscriptionSource config Nothing subscriptionId
    Nakadi.runSubscription config connection $
      source .| iterMC processEvent .| Nakadi.subscriptionSink