https://github.com/mtwilliams/bourne

:speedboat: Better streaming for Ecto.
https://github.com/mtwilliams/bourne

ecto elixir genstage streaming

Last synced: 6 days ago
JSON representation

:speedboat: Better streaming for Ecto.

• Host: GitHub
• URL: https://github.com/mtwilliams/bourne
• Owner: mtwilliams
• License: unlicense
• Created: 2017-03-05T00:34:55.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-12-19T16:07:27.000Z (almost 5 years ago)
• Last Synced: 2024-10-29T12:33:32.931Z (8 days ago)
• Topics: ecto, elixir, genstage, streaming
• Language: Elixir
• Size: 19.5 KB
• Stars: 75
• Watchers: 5
• Forks: 12
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bourne

[![Continuous Integration](https://img.shields.io/travis/mtwilliams/bourne/master.svg)](https://travis-ci.org/mtwilliams/bourne)

[![Code Coverage](https://img.shields.io/coveralls/mtwilliams/bourne/master.svg)](https://coveralls.io/github/mtwilliams/bourne)

[![Documentation](http://inch-ci.org/github/mtwilliams/bourne.svg)](http://inch-ci.org/github/mtwilliams/bourne)

[![Package](https://img.shields.io/hexpm/v/bourne.svg)](https://hex.pm/packages/bourne)

Bourne provides more powerful streaming mechanisms than those offered by [Ecto](https://github.com/elixir-ecto/ecto) or [Tributary](https://github.com/DavidAntaramian/tributary). Notably, it provides both *cursor* and *keyset* pagination methods, as well as the ability to create a `GenStage` producer with similar semantics to `GenStage.from_enumerable`.

## Example

```elixir

defmodule My.Repo do

  use Ecto.Repo, otp_app: :mine

  use Bourne

end

import Ecto.Query

q = from(actor in Actor, where: actor.born <= 1980)

# You can stream through an `Enumerable`:

My.Repo.stream(q) |> Stream.each(&IO.inspect) |> Stream.run

# Alternatively, you can stream through a GenStage producer:

defmodule InspectorConsumer do

  use GenStage

  def start_link do

    GenStage.start_link(InspectorConsumer, [])

  end

  def init([]) do

    {:consumer, :ok}

  end

  def handle_events(rows, _from, state) do

    Enum.each(rows, &IO.inspect/1)

    {:noreply, [], state}

  end

end

method = Enum.take_random(~W{cursor keyset}a, 1)

{:ok, producer} = My.Repo.streamer(q, method: method)

{:ok, consumer} = InspectorConsumer.start_link

GenStage.sync_subscribe(consumer, to: producer)

```

## Installation

  1. Add `bourne` to your list of dependencies in `mix.exs`:

  ```elixir

  def deps do

    [{:bourne, "~> 1.0"}]

  end

  ```

  2. Fetch and compile your new dependency:

  ```

  mix do deps.get bourne, deps.compile

  ```

  3. Drink your :tea:

  4. That's it!

## Usage

Refer to the [documentation](https://hexdocs.pm/bourne/Bourne.html).

## License

Bourne is free and unencumbered software released into the public domain, with fallback provisions for jurisdictions that don't recognize the public domain.

For details, see `LICENSE.md`.