Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/marsupialtail/quokka

Making data lake work for time series
https://github.com/marsupialtail/quokka

data-lake-analytics distributed etl-framework mlops sql

Last synced: 25 days ago
JSON representation

Making data lake work for time series

Awesome Lists containing this project

README 

        




  Title



**Making data lakes work for time series.
**

**Built on Python with [DuckDB](https://github.com/duckdb/duckdb), [Polars](https://github.com/pola-rs/polars), [Ray](https://github.com/ray-project/ray), [Arrow](https://github.com/apache/arrow), [Redis](https://github.com/redis/redis) and [SQLGlot](https://github.com/tobymao/sqlglot).
**

# **Quokka's Focus: [New Blog Post](https://github.com/marsupialtail/quokka/blob/master/blog/time.md) 
**





    Join Discord





    rust docs





    PyPi Latest Release








If you would like to support Quokka, please give us a star! 🙏 



## Showcases



* **[Tick-level backtesting](https://github.com/marsupialtail/quokka/blob/master/blog/backtest.md):** backtest a mid-high frequency trading strategy against SIP trade stream for the last four years in 10 minutes.



* **[Vector embedding analytics](https://blog.lancedb.com/why-dataframe-libraries-need-to-understand-vector-embeddings-291343efd5c8):** easily add new input readers in Python, like for the [Lance](https://github.com/lancedb/lance) format.



* **[Extreme feature engineering on 10k columns](https://github.com/marsupialtail/quokka/blob/master/blog/approxquant.md):** easily integrate with Arrow-compatible C++ Plugins.



* **[TPC-H](https://github.com/marsupialtail/quokka/blob/master/blog/release.md):** Several times faster than SparkSQL in many TPC-H queries. (EMR, not DBR!)





  Title




* **Detect iceberg orders in quote stream (upcoming):** use complex event processing to easily detect iceberg order in the MBO stream.

* **Backtest an online learning algorithm on clickstream data (upcoming):** test incremental training algorithms on historical data.



## What is Quokka?



In technical terms, Quokka is a **push-based distributed query engine with lineage-based fault tolerance**.



In practical terms, Quokka is a tool for you to run **custom stateful and windowed computation over terabytes of historical time series data**. It supports regular SQL like filter, selection and joins with relational optimizations like predicate pushdown, early selection and join reordering, but truly excels on time series workloads like complicated windows, asof/range joins, complex pattern recognition (SPL transactions, EQL sequence, SQL Match_Recognize) and custom stateful computations like building a limit order book or testing online learning strategies.



Unlike most other query engines, Quokka is implemented completely in Python and is meant to be easily extensible for new operations and use cases, e.g. time series analytics and feature engineering. It is truly simple to extend, because *all* you have to do is raise a Github issue and more likely than not I'll write the operator for you.



Quokka operates on DataStreams, which are basically Spark RDDs except data partitions can be produced serially. A data partition can be consumed immediately after it's produced, unlike Spark where all the partitions have to be present in the RDD before the shuffle happens. This allows Quokka to pipeline multiple shuffles and I/O, leading to large performance gains.



## Quick Start



Quokka requires Redis > 6.2. You can install latest Redis using: 



~~~bash

curl -fsSL https://packages.redis.io/gpg | sudo gpg --dearmor -o /usr/share/keyrings/redis-archive-keyring.gpg

echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list

sudo apt-get update

sudo apt-get install redis

~~~



Make sure to run `redis-server -v` to check the Redis Server version! The default `apt-get install` version is most likely wrong.



~~~python

pip3 install pyquokka

~~~

**Docs**: https://marsupialtail.github.io/quokka/



Quokka offers a DataStream API that resembles Spark's DataFrame API. You can create a DataStream from a Polars Dataframe easily for local testing. 



~~~python

>>> from pyquokka import QuokkaContext

>>> qc = QuokkaContext()

>>> import polars

>>> a = polars.from_dict({"a":[1,1,2,2], "b":['{"my_field": "quack"}','{"my_field": "quack"}','{"my_field": "quack"}','{"my_field": "quack"}']})

>>> a

shape: (4, 2)

┌─────┬───────────────────────┐

│ a   ┆ b                     │

│ --- ┆ ---                   │

│ i64 ┆ str                   │

╞═════╪═══════════════════════╡

│ 1   ┆ {"my_field": "quack"} │

│ 1   ┆ {"my_field": "quack"} │

│ 2   ┆ {"my_field": "quack"} │

│ 2   ┆ {"my_field": "quack"} │

└─────┴───────────────────────┘

>>> b = qc.from_polars(a)

>>> b

DataStream[a,b]



# DataStreams are lazy, you must call collect to get the values, like a Polars LazyFrame or Spark DataFrame.

>>> b.collect()

shape: (4, 2)

┌─────┬───────────────────────┐

│ a   ┆ b                     │

│ --- ┆ ---                   │

│ i64 ┆ str                   │

╞═════╪═══════════════════════╡

│ 1   ┆ {"my_field": "quack"} │

│ 1   ┆ {"my_field": "quack"} │

│ 2   ┆ {"my_field": "quack"} │

│ 2   ┆ {"my_field": "quack"} │

└─────┴───────────────────────┘



# Quokka supports filtering by a SQL statement directly

>>> b.filter_sql("a==1").collect()

shape: (2, 2)

┌─────┬───────────────────────┐

│ a   ┆ b                     │

│ --- ┆ ---                   │

│ i64 ┆ str                   │

╞═════╪═══════════════════════╡

│ 1   ┆ {"my_field": "quack"} │

│ 1   ┆ {"my_field": "quack"} │

└─────┴───────────────────────┘



~~~



Currently Quokka supports reading data from CSV/Parquet on disk/S3, Apache Iceberg through AWS Glue and Ray Datasets, though theoretically any data source can be supported: Delta Lake/Hudi, S3 bucket of images, transactional database CDC endpoints etc. If you have some esoteric data source that you want to run analytics on, please send me a challenge as a Github issue, or better yet make a pull request. The following code showcases some more of Quokka's APIs.



~~~python

>>> lineitem = qc.read_parquet(s3_path_parquet + "lineitem.parquet/*")

>>> orders = qc.read_parquet(s3_path_parquet + "orders.parquet/*")

# filter with dataframe syntax

>>> d = lineitem.filter(lineitem["l_commitdate"] < lineitem["l_receiptdate"])

>>> d = orders.join(d, left_on="o_orderkey", right_on="l_orderkey", how = "semi")

# filter with SQL syntax

>>> d = d.filter_sql("o_orderdate >= date '1993-07-01'")

>>> d = d.select(["o_orderkey", "o_custkey", "o_orderstatus", "o_totalprice", "o_orderdate", "o_orderpriority", "o_clerk", "o_shippriority"])

>>> d.explain() # this will produce a PDF execution graph you can visualize 

>>> d = d.compute()

>>> dataset = d.to_ray_dataset()

~~~



## Fineprint



Quokka should not be used as a replacement for SparkSQL (it doesn't parse SQL directly yet, though it is on the roadmap). Instead you can play with it to see if it can give you better performance for your use cases. Another strength of Quokka is that it's Python-native, so you will never have to worry about JVM errors when you start using hairy UDFs with custom Python packages.



Quokka stands on the shoulders of giants. It uses [Ray](https://github.com/ray-project/ray) for task scheduling, Redis for lineage logging, [Polars](https://github.com/pola-rs/polars) and DuckDB for relational algebra kernels and [Apache Arrow](https://github.com/apache/arrow) for I/O. All of those are backed by efficient C++/Rust implementations. 



Please refer to the [docs](https://marsupialtail.github.io/quokka/) and examples in the apps directory. 



For any questions/concerns/just want to chat: [email protected], or join the [Discord](https://discord.gg/6ujVV9HAg3) channel. Please do reach out before you use Quokka for anything real. Please raise a Github issue if you encounter any issues.



Shoutout to Emanuel Adamiak and Sarah Fujimori, who contributed significantly to this project. Also huge thanks to my advisor, Alex Aiken, as well as Tim Tully, Matei Zaharia, Peter Kraft, Qian Li and Toby Mao for all the help throughput the years.