Skip to content
2024
Initializing search
quixio/quix-docs
Quix Docs
quixio/quix-docs
Get started
Get started
Welcome
Get started!
Core concepts
Core concepts
Streaming
Stream processing
Stream processing pipelines
Quix Streams
Quix Streams
Introduction
Quickstart
Tutorials
Tutorials
Word Count
Anomaly Detection
Purchase Filtering
How to
How to
Produce Data to Kafka
Process & Transform Data
GroupBy Operation
Windows & Aggregations
Configuration
StreamingDataFrame Branching
Consuming Multiple Topics
Advanced Usage
Advanced Usage
Checkpointing
Serialization Formats
Schema Registry
Stateful Processing
Managing Kafka Topics
Using Producer & Consumer
StreamingDataFrame Assignment Rules
Connecting to Quix Cloud
Connectors [beta]
Connectors [beta]
Sinks
Sinks
Apache Iceberg Sink
CSV Sink
InfluxDB v3 Sink
Creating a Custom Sink
Sources
Sources
CSV Source
Kafka Replicator Source
Quix Source
Creating a Custom Source
Contribution Guide
Community and Core Connectors
Upgrading Guide
Upgrading Guide
Upgrading from Quix Streams v0.5
API Docs
API Docs
StreamingDataFrame API
Topics API
Context API
Serializers API
Application API
State API
Kafka Producer & Consumer API
Sources API
Sinks API
Kafka Producer & Consumer API
Full Reference
Quix CLI
Quix CLI
Overview
Quickstart
Local Development
Local Development
Running applications locally
Managing secrets locally
Managing YAML variables
Commands Summary
How-To guides
How-To guides
Using the CLI with GitHub Actions
Yaml Reference
Yaml Reference
Pipeline YAML (quix.yaml)
Application YAML (app.yaml)
CLI Reference
CLI Reference
Cloud Commands
Cloud Commands
cloud apps
cloud apps
cloud apps get
cloud apps list
cloud apps library
cloud apps library
cloud apps library list
cloud deployments
cloud deployments
cloud deployments get
cloud deployments list
cloud deployments logs
cloud deployments metrics
cloud deployments start
cloud deployments stop
cloud environments
cloud environments
cloud environments get
cloud environments list
cloud environments use
cloud environments sync
cloud environments tokens
cloud environments tokens
cloud environments tokens get
cloud environments tokens rotate
cloud organisations
cloud organisations
cloud organisations get
cloud projects
cloud projects
cloud projects patch
cloud projects get
cloud projects list
cloud topics
cloud topics
cloud topics get
cloud topics list
cloud users
cloud users
cloud users audit
cloud users permissions
cloud users permissions
cloud users permissions copy
cloud users permissions delete
cloud users permissions edit
cloud users permissions get
cloud users permissions list
cloud users permissions set
cloud users tokens
cloud users tokens
cloud users tokens create
cloud users tokens edit
cloud users tokens list
cloud users tokens revoke
cloud users current
cloud users list
Local Commands
Local Commands
apps
apps
apps library
apps update
apps convert
apps create
apps delete
apps edit
apps list
apps variables
apps variables
apps variables create
apps variables delete
apps variables edit
apps variables export
apps variables import
apps variables list
broker
broker
broker down
broker up
broker topics
broker topics
broker topics list
broker topics read
broker topics update
broker topics write
init
pipeline
pipeline
pipeline deployments
pipeline deployments
pipeline deployments create
pipeline deployments delete
pipeline deployments edit
pipeline deployments get
pipeline deployments list
pipeline down
pipeline logs
pipeline start
pipeline status
pipeline stop
pipeline sync
pipeline up
pipeline update
pipeline view
pipeline topics
pipeline topics
pipeline topics create
pipeline topics delete
pipeline topics edit
pipeline topics get
pipeline topics list
run
sdk
sdk
sdk broker
sdk broker
sdk broker cloud
sdk broker current
sdk broker local
sdk broker pipeline
sdk broker set
sdk broker update
Other Commands
Other Commands
logout
login
contexts
contexts
contexts create
contexts current
contexts list
contexts delete
contexts reset
contexts use
contexts environments
contexts environments
contexts environments clear
contexts environments get
contexts environments use
status
update
use
Quix Cloud
Quix Cloud
Overview
Quickstart
Why Use Quix Cloud
Quix Cloud Tour
Quix Cloud Tour
1. Create your project
1. Create your project
Overview
Clone a project
Fork a project
Create a project
Create an environment
Protected environments
Syncing an environment
Project structure
Create a topic
2. Develop an application
2. Develop an application
Overview
Create an application
Authentication
Authentication
Authenticating Quix Streams
Personal Access Token (PAT)
Streaming Token
Using Code Samples
Integrate your data
Integrate your data
Overview
Ingest your data - source
Ingest your data - source
Using a prebuilt source connector
Reading a CSV file
Polling a REST API
Handling inbound webhooks
Using an external source
Using the Quix Streaming APIs
Using Quix Streams
Posting data to a Quix web app
Handling compressed data
Handling IoT data with MessagePack
Publish your data - sink
Publish your data - sink
Using a prebuilt destination connector
Using an external destination
Exporting Quix data to Jupyter notebooks
Process your data
Process your data
Overview
Types of processing
Types of transform
Generating events
Using Quix Streaming APIs
Using Quix Streaming APIs
Overview
Streaming Writer API
Streaming Writer API
Overview
Setup
HTTP requests
Create a new Stream
Add Stream metadata
Send Parameter data
Send an Event
Streaming Reader API
Streaming Reader API
Overview
Setup
Reading data
Subscription and events
3. Deploy a service
3. Deploy a service
Overview
Environment variables
Secrets management
YAML variables
Configuring network ports
State management
Deploy public services
4. Manage your pipelines
4. Manage your pipelines
Overview
Troubleshooting
Security
MLOps
Using replay service
Testing using Quix data store
Testing multiple environments
Query API
Query API
Overview
Setup
HTTP requests
Paged streams
Filtered streams
Streams with models
Raw data
Aggregate data by time
Aggregate data by tags
Tag filtering
Portal API
Portal API
Overview
Setup
HTTP requests
Security
Connectors
Connectors
Sources
Sources
Confluent Kafka Source
Environment Source
InfluxDB 2.0 Source
InfluxDB 3.0 Source
Kafka Connect Source
MQTT Source
Postgres CDC Source
Redis Source
SQL Change Data Capture Source
Segment Source
Snowplow Source
Destinations
Destinations
AWS S3 Iceberg Sink
BigQuery Sink
Confluent Kafka Sink
InfluxDB 3.0 Sink
Kafka Connect Sink
MQTT Sink
Redis Sink
Slack Sink
Websocket Destination
Integrations
Integrations
Overview
Brokers
Brokers
Overview
Broker settings
Quix
Confluent
Redpanda
Aiven
Upstash
Databases
Databases
InfluxDB
InfluxDB
Overview
Quickstart
Guides
Guides
Using Telegraf
Replacing Flux
Replacing Kapacitor
Alerting
Migrating from v2 to v3
PostgreSQL
PostgreSQL
Overview
Redis
Redis
Overview
Vector Databases
Vector Databases
Overview
Upstash
Upstash
Overview
Qdrant
Qdrant
Overview
Weaviate
Weaviate
Overview
Bring Your Own Cluster (BYOC)
Bring Your Own Cluster (BYOC)
Overview
Requirements
Installation
BYOC vs. Cloud
Knowledge base
Knowledge base
Guides
Guides
What is Quix?
Why stream processing?
What is Kafka?
Reference
Reference
Glossary
Contribute
Tutorials
Tutorials
Overview
Event detection and alerting featuring InfluxDB and PagerDuty
Event detection and alerting featuring InfluxDB and PagerDuty
Overview
1. Write the Python client
2. Add an external source
3. Add InfluxDB destination
4. Add threshold detection
5. Add PagerDuty alerting
6. Summary
Migrating InfluxDB v2 to v3
Migrating InfluxDB v2 to v3
Overview
1. Install InfluxDB v2
2. Create the project
3. Add InfluxDB v2 source
4. Add InfluxDB v3 destination
5. Summary
Vector Store Embeddings
Predictive maintenance
Predictive maintenance
Overview
1. Get the project
2. Data generator
3. Downsampling
4. Forecast
5. Alerts
6. InfluxDB - raw data
7. InfluxDB - alerts
8. Summary
Blog Index
Blog Index
Archive
Archive
2024
2024
Table of contents
Quix Release: Scratchpads
Streaming Game Telemetry to DuckDB using Quix Streams
How to enrich a stream of data in real time with Quix and Redis
Navigating stateful stream processing
A guide to windowing in stream processing
Understanding Kafka’s auto offset reset configuration: Use cases and pitfalls
2023
Categories
Categories
ecosystem
industry-insights
releases
tutorials
Table of contents
Quix Release: Scratchpads
Streaming Game Telemetry to DuckDB using Quix Streams
How to enrich a stream of data in real time with Quix and Redis
Navigating stateful stream processing
A guide to windowing in stream processing
Understanding Kafka’s auto offset reset configuration: Use cases and pitfalls
Star Quix Streams
Install Quix Streams
Edit on GitHub
2024
Quix Release: Scratchpads
Streaming Game Telemetry to DuckDB using Quix Streams
How to enrich a stream of data in real time with Quix and Redis
Navigating stateful stream processing
A guide to windowing in stream processing
Understanding Kafka’s auto offset reset configuration: Use cases and pitfalls
Back to top