
<h1 align="center">
    <img src="https://raw.githubusercontent.com/ArroyoSystems/arroyo/760aabdbdb019d95f0c5ebb60933233aa735f830/images/arroyo_logo.png" width="400px" alt="Arroyo" />
</h1>


<h4 align="center">
  <a href="https://doc.arroyo.dev/getting-started">Getting started</a> |
  <a href="https://doc.arroyo.dev">Docs</a> |
  <a href="https://discord.gg/cjCr5rVmyR">Discord</a> |
  <a href="https://www.arroyo.dev">Website</a>
</h4>

<h4 align="center">
  <a href="https://github.com/ArroyoSystems/arroyo/blob/master/LICENSE-APACHE">
    <img src="https://img.shields.io/badge/license-MIT%2FApache--2.0-orange" alt="Arroyo is dual-licensed under Apache 2 and MIT licenses." />
  </a>
  <a href="https://github.com/ArroyoSystems/arroyo/blob/master/CONTRIBUTING.md">
    <img src="https://img.shields.io/badge/PRs-Welcome-brightgreen" alt="PRs welcome!" />
  </a>
  <a href="https://github.com/ArroyoSystems/arroyo/commits">
    <img src="https://img.shields.io/github/commit-activity/m/ArroyoSystems/arroyo" alt="git commit activity" />
  </a>
  <img alt="CI" src="https://github.com/ArroyoSystems/arroyo/actions/workflows/ci.yml/badge.svg">

  <a href="https://github.com/ArroyoSystems/arroyo/releases">
    <img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/ArroyoSystems/arroyo?display_name=release">
  </a>
</h4>


[Arroyo](https://arroyo.dev) is a distributed stream processing engine written in Rust, designed to efficiently
perform stateful computations on streams of data. Unlike traditional batch processing, streaming engines can operate
on both bounded and unbounded sources, emitting results as soon as they are available.

In short: Arroyo lets you ask complex questions of high-volume real-time data with subsecond results.

![running job](https://raw.githubusercontent.com/ArroyoSystems/arroyo/760aabdbdb019d95f0c5ebb60933233aa735f830/images/header_image.png)

## Features

🦀 SQL streaming pipelines

🚀 Scales up to millions of events per second

🪟 Stateful operations including windows and joins

🔥State checkpointing for fault-tolerance and recovery of pipelines

🕒 Time-oriented stream processing via the [Dataflow model](https://www.oreilly.com/radar/the-world-beyond-batch-streaming-101/)

🔌 A wide variety of [connectors](https://doc.arroyo.dev/connectors), including Kafka and Iceberg

## Use cases

Some example use cases include:

* Detecting fraud and security incidents
* Real-time product and business analytics
* Real-time ingestion into your data warehouse or data lake
* Real-time ML feature generation

## Why Arroyo

There are already a number of existing streaming engines out there, including [Apache Flink](https://flink.apache.org),
[Spark Streaming](https://spark.apache.org/docs/latest/streaming-programming-guide.html), and
[Kafka Streams](https://kafka.apache.org/documentation/streams/). Why create a new one?

* _Serverless operations_: Arroyo pipelines are designed to run in modern cloud environments, supporting seamless scaling,
    recovery, and rescheduling
* _High performance SQL_: SQL is a first-class concern, with consistently excellent performance
* _Designed for non-experts_: Arroyo cleanly separates the pipeline APIs from its internal implementation. You don't
    need to be a streaming expert to build real-time data pipelines.

## Installing

Arroyo ships as a single binary. You can install it locally on MacOS using Homebrew

```shellsession
brew install arroyosystems/tap/arroyo
```

or on MacOS or Linux with this script:

```shellsession
curl -LsSf https://arroyo.dev/install.sh | sh
```

or you can download a binary for your platform from the [releases page](https://github.com/ArroyoSystems/arroyo/releases).

Once you have Arroyo installed, start a cluster with

```shellsession
$ arroyo cluster
```

You can also run a cluster in Docker, with

```shellsession
docker run -p 5115:5115 \
      ghcr.io/arroyosystems/arroyo:latest
```

Then, load the Web UI at http://localhost:5115.

For a more in-depth guide, see the [getting started guide](https://doc.arroyo.dev/getting-started).

Once you have Arroyo running, follow the [tutorial](https://doc.arroyo.dev/tutorial/first-pipeline/) to create your first real-time
pipeline.


## Cloudflare Pipelines

If you don't want to self-host, Arroyo is available as a fully-managed solution on the 
Cloudflare Developer Platform: [Cloudflare Pipelines](https://developers.cloudflare.com/pipelines/),
now available in beta. Currently, stateless pipelines ingesting into R2 are supported, and we'll
be expanding to stateful pipelines in the near future.

## Developing Arroyo

We love contributions from the community! See the [developer setup](https://doc.arroyo.dev/developing/dev-setup) guide
to get started, and reach out to the team on [discord](https://discord.gg/cjCr5rVmyR) or create an issue.

## Community

* [Discord](https://discord.gg/cjCr5rVmyR) &mdash; support and project discussion
* [GitHub issues](https://github.com/ArroyoSystems/arroyo/issues) &mdash; bugs and feature requests
* [Arroyo Blog](https://arroyo.dev/blog) &mdash; updates from the Arroyo team
