DOCSEARCHbyAlgolia
Submit Docs

Timeplus Documentation

website·Indexed 34 days ago

https://docs.timeplus.com

A simple, powerful, and cost-efficient stream processing platform. Documentation covers core features like Append Streams, Changelog Key Value Streams, and alerts, as well as architecture, SQL reference, and the timeplus CLI for managing Enterprise deployments. Includes guides for bare-metal installation, AutoMQ integration, and release notes for Timeplus Enterprise versions 2.3 through 2.7.

Tokens
84.8K
Snippets
302
Records
835
Agent score
67%

What's inside Timeplus

  1. Overview of Python UDFs in Timeplus

    Starting from v2.7, Timeplus Enterprise supports Python-based User-Defined Functions (UDFs) and User-Defined Aggregate Functions (UDAFs) using an embedded Python 3.10 runtime. This allows developers to implement complex parsing, data transformation, masking, and encryption logic directly within the Timeplus core engine without deploying external servers.

  2. Overview of Timeplus Architecture

    Timeplus is a single-binary (~150MB) SQL stream processing engine that eliminates the need for a JVM or ZooKeeper. It unifies streaming and historical data processing by using a Write Ahead Log (WAL) for fast inserts/updates and a Historical Store for efficient historical queries. This architecture can often replace the need for Apache Kafka as a commit log or a separate downstream database.

  3. Overview of Timeplus downstream data destinations

    Timeplus supports exporting streaming data to the following downstream systems:

    • Apache Kafka topics
    • Pulsar topics
    • ClickHouse tables
    • Other Timeplus deployments
    • Webhook endpoints
    • Slack (notifications)
    • Various systems via Redpanda Connect (Enterprise 2.5+)

  4. Overview of Timeplus External Streams

    Timeplus External Streams allow reading and writing data between different Timeplus Enterprise or Timeplus Proton deployments. This enables hybrid deployments (e.g., edge to cloud), federation searches without data replication, and data migration between staging and production clusters or across major releases.

  6. Overview of supported External Streams

    Timeplus supports several types of external streams for integrating with external message platforms and systems:

    • Kafka External Stream: Officially supported.
    • Pulsar External Stream: Supported.
    • Local Log Files: Available in technical preview.
    • Timeplus External Stream: Supported in Timeplus Enterprise for remote Timeplus Enterprise connectivity.

  7. Overview of Timeplus Dictionaries

    Starting from Timeplus Enterprise 2.7, dictionaries allow you to store key-value pairs in memory for fast lookup. Dictionaries are automatically replicated to all nodes in a cluster. They are typically used to join static or slowly-changing metadata (like lookup tables) with real-time data streams.

  8. Overview of Timeplus Proton

    Timeplus Proton is an open-source, unified streaming and historical data processing engine. It is the core engine powering Timeplus Enterprise and is designed to be deployed on bare metal, edge devices, containers, or orchestrated cloud environments without external service dependencies. It builds upon the ClickHouse project for historical data, storage, computing, and parts of its query engine, adding mature OLAP capabilities and unified streaming processing.

  9. Overview of HTTP External Streams

    HTTP External Streams allow Timeplus Enterprise (v2.9 and v2.8.2+) to send data to HTTP endpoints. This is primarily used to trigger notifications (e.g., Slack) or push streaming data to downstream systems like Splunk, Datadog, Elasticsearch, Databricks, and other HTTP-based services. Note that this feature currently only supports writing data to HTTP endpoints; reading data from HTTP endpoints is not supported.

  10. Overview of the Timeplus Terraform Provider

    The Timeplus Terraform Provider allows users to manage Timeplus infrastructure as code using a declarative approach. This enables GitOps integration, version-controlled access to data streams, and automated deployment workflows. It is supported for Timeplus Enterprise self-hosting starting from v0.1.6.

  11. Overview of Timeplus Proton

    Timeplus Proton is a fast, lightweight stream processing engine and database designed as an alternative to ksqlDB or Apache Flink. It is written in C++ and powered by ClickHouse libraries, enabling developers to handle streaming data processing, multi-stream JOINs, incremental materialized views, and routing from sources like Apache Kafka, Redpanda, and Pulsar. Unlike pure stream processors, Proton stores queryable analytical/row-based materialized views internally for use in dashboards and applications.

  12. Overview of Timeplus Tiered Storage

    Introduced in Timeplus Enterprise 2.8, Tiered Storage allows users to store 'hot' data on local high-performance storage (e.g., NVMe SSD) for fast access and automatically move 'cold' data to remote object storage (e.g., S3) for long-term retention. This is managed via storage policies applied to specific streams.