logo
Tip use
Initializing search
    quixio/quix-docs
    quixio/quix-docs
      • Welcome
        • Streaming
        • Stream processing
        • Stream processing pipelines
      • Introduction
      • Quickstart
      • Tutorials
        • Anomaly Detection
        • Purchase Filtering
        • Word Count
        • Websocket Source
        • Produce Data to Kafka
        • Process & Transform Data
        • Inspecting Data & Debugging
        • Handling Missing Data
        • GroupBy Operation
        • Windowing
        • Aggregations
        • Concatenating Topics
        • Branching StreamingDataFrames
        • Configuration
        • Checkpointing
        • Serialization Formats
        • Schema Registry
        • Stateful Processing
        • Managing Kafka Topics
        • Using Producer & Consumer
        • StreamingDataFrame Assignment Rules
      • Connecting to Quix Cloud
        • Upgrading from Quix Streams v0.5
        • StreamingDataFrame API
        • Topics API
        • Context API
        • Serializers API
        • Application API
        • State API
        • Sources API
        • Sinks API
        • Kafka Producer & Consumer API
        • Full Reference
        • Sources
          • Amazon Kinesis Source
          • Amazon S3 Source
          • Azure Blob Storage Source
          • CSV Source
          • Google Cloud Pub/Sub Source
          • InfluxDB v3 Source
          • Kafka Replicator Source
          • Local File Source
          • Pandas DataFrame Source
          • Quix Environment Source
          • Creating a Custom Source
        • Sinks
          • Amazon Kinesis Sink
          • Amazon S3 Sink
          • Apache Iceberg Sink
          • Azure Blob Storage Sink
          • CSV Sink
          • Elasticsearch Sink
          • Google Cloud BigQuery Sink
          • Google Cloud Pub/Sub Sink
          • InfluxDB v3 Sink
          • Local File Sink
          • MongoDB Sink
          • Neo4j Sink
          • PostgreSQL Sink
          • Redis Sink
          • Creating a Custom Sink
        • Contribution Guide
        • Community and Core Connectors
      • Quix Cloud
          • Confluent Kafka
          • Environment
          • InfluxDB 2.0
          • InfluxDB 3.0
          • Kafka Connect
          • MQTT
          • Postgres CDC
          • Redis
          • SQL Change Data Capture
          • Segment
          • Snowplow
          • Telegraf
          • AWS S3 Iceberg
          • BigQuery
          • Confluent Kafka
          • InfluxDB 3.0
          • Kafka Connect
          • MQTT
          • Slack
          • Websocket
          • Amazon Glue source
          • Amazon SQS source
          • Apache Iceberg source
          • Apache Pulsar source
          • Astra source
          • Cassandra source
          • Chroma source
          • Clickhouse source
          • Convex source
          • Cumulio source
          • Databend source
          • Databricks source
          • Doris source
          • DuckDB source
          • DynamoDB source
          • ElasticSearch source
          • Exasol source
          • Firebolt source
          • Google Cloud BigQuery source
          • Google Cloud Firestore source
          • Google Cloud Storage source
          • Google Sheets source
          • Keen source
          • Kvdb source
          • Langchain source
          • Mariadb Columnstore source
          • Meilisearch source
          • MicrosoftSQL source
          • Milvus source
          • MongoDB source
          • Motherduck source
          • MQTT source
          • MySQL source
          • Oracle source
          • Pgvector source
          • Pinecone source
          • Postgres source
          • PostgresCDC source
          • PubSub source
          • Qdrant source
          • R2 source
          • RabbitMQ source
          • Redis source
          • Redpanda source
          • Redshift source
          • Rockset source
          • Scylla source
          • Selectdb source
          • SftpJson source
          • Snowflake source
          • Snowflake Cortex source
          • Sqlite source
          • Starburst Galaxy source
          • Teradata source
          • Tidb source
          • Timeplus source
          • Typesense source
          • Vectara source
          • Vertica source
          • Weaviate source
          • Xata source
          • Yellowbrick source
          • Yugabytedb source
          • Amazon Glue sink
          • Amazon SQS sink
          • Apache Pulsar sink
          • Astra sink
          • Cassandra sink
          • Chroma sink
          • Clickhouse sink
          • Convex sink
          • Cumulio sink
          • Databend sink
          • Databricks sink
          • Doris sink
          • DuckDB sink
          • DynamoDB sink
          • Exasol sink
          • Firebolt sink
          • Google Cloud Firestore sink
          • Google Cloud Storage sink
          • Google Sheets sink
          • Keen sink
          • Kvdb sink
          • Langchain sink
          • Mariadb Columnstore sink
          • Meilisearch sink
          • MicrosoftSQL sink
          • Milvus sink
          • MongoDB sink
          • Motherduck sink
          • MQTT sink
          • MySQL sink
          • Oracle sink
          • Pgvector sink
          • Pinecone sink
          • PostgresCDC sink
          • Qdrant sink
          • R2 sink
          • RabbitMQ sink
          • Redpanda sink
          • Redshift sink
          • Rockset sink
          • Scylla sink
          • Selectdb sink
          • SftpJson sink
          • Snowflake sink
          • Snowflake Cortex sink
          • Sqlite sink
          • Starburst Galaxy sink
          • Teradata sink
          • Tidb sink
          • Timeplus sink
          • Typesense sink
          • Vectara sink
          • Vertica sink
          • Weaviate sink
          • Xata sink
          • Yellowbrick sink
          • Yugabytedb sink
      • Overview
      • Quickstart
        • Running applications locally
        • Managing secrets locally
        • Managing YAML variables
      • Commands Summary
        • Using the CLI with GitHub Actions
        • Pipeline YAML (quix.yaml)
        • Application YAML (app.yaml)
        • Docker Configuration (dockerfile)
        • Cloud Commands
          • cloud apps
            • cloud apps get
            • cloud apps list
            • cloud apps library
              • cloud apps library list
          • cloud deployments
            • cloud deployments get
            • cloud deployments list
            • cloud deployments logs
            • cloud deployments metrics
            • cloud deployments start
            • cloud deployments stop
          • cloud environments
            • cloud environments get
            • cloud environments list
            • cloud environments use
            • cloud environments sync
            • cloud environments tokens
              • cloud environments tokens get
              • cloud environments tokens rotate
          • cloud organisations
            • cloud organisations get
          • cloud projects
            • cloud projects patch
            • cloud projects get
            • cloud projects list
          • cloud topics
            • cloud topics get
            • cloud topics list
          • cloud users
            • cloud users audit
            • 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 create
              • cloud users tokens edit
              • cloud users tokens list
              • cloud users tokens revoke
            • cloud users current
            • cloud users list
          • apps
            • apps library
            • apps update
            • apps convert
            • apps create
            • apps delete
            • apps edit
            • apps list
            • apps variables
              • apps variables create
              • apps variables delete
              • apps variables edit
              • apps variables export
              • apps variables import
              • apps variables list
          • broker
            • broker down
            • broker up
            • broker topics
              • broker topics list
              • broker topics read
              • broker topics update
              • broker topics write
          • init
          • pipeline
            • 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 create
              • pipeline topics delete
              • pipeline topics edit
              • pipeline topics get
              • pipeline topics list
          • run
          • sdk
            • sdk broker
              • sdk broker cloud
              • sdk broker current
              • sdk broker local
              • sdk broker pipeline
              • sdk broker set
              • sdk broker update
          • logout
          • login
          • contexts
            • contexts create
            • contexts current
            • contexts list
            • contexts delete
            • contexts reset
            • contexts use
            • contexts environments
              • contexts environments clear
              • contexts environments get
              • contexts environments use
          • status
          • update
          • use
      • Overview
      • Quickstart
      • Why Use Quix Cloud
          • Overview
          • Clone a project
          • Fork a project
          • Create a project
          • Create an environment
          • Protected environments
          • Syncing an environment
          • Project structure
          • Create a topic
          • Data tiers
          • Create a scratchpad
          • Create a linked project
          • Overview
          • Create an application
            • Authenticating Quix Streams
            • Personal Access Token (PAT)
            • Streaming Token
          • Using Code Samples
          • Including Shared Folders
            • Overview
              • 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
              • Using a prebuilt destination connector
              • Using an external destination
              • Exporting Quix data to Jupyter notebooks
            • Overview
            • Types of processing
            • Types of transform
            • Generating events
            • Overview
              • Overview
              • Setup
              • HTTP requests
              • Create a new Stream
              • Add Stream metadata
              • Send Parameter data
              • Send an Event
              • Overview
              • Setup
              • Reading data
              • Subscription and events
          • Overview
          • Environment variables
          • Quix variables
          • Secrets management
          • YAML variables
          • Configuring network ports
          • State management
          • Deploy public services
          • Deploy an external image
          • Private container registries
          • Overview
          • Troubleshooting
          • Security
          • MLOps
          • Using replay service
          • Testing using Quix data store
          • Testing multiple environments
            • Overview
            • Setup
            • HTTP requests
            • Paged streams
            • Filtered streams
            • Streams with models
            • Raw data
            • Aggregate data by time
            • Aggregate data by tags
            • Tag filtering
            • Overview
            • Setup
            • HTTP requests
        • Pipeline YAML (quix.yaml)
        • Application YAML (app.yaml)
        • Docker Configuration (dockerfile)
      • Security
        • Overview
          • Overview
          • Broker settings
          • Quix
          • Confluent
          • Redpanda
          • Aiven
          • Upstash
            • Overview
            • Quickstart
              • Using Telegraf
              • Replacing Flux
              • Replacing Kapacitor
              • Alerting
              • Migrating from v2 to v3
            • Overview
            • Overview
          • Overview
            • Overview
            • Overview
            • Overview
        • Overview
        • What is Quix?
        • Why stream processing?
        • What is Kafka?
        • Glossary
        • Contribute
          • kafka-to-apache-airflow
          • kafka-to-apache-ambari
          • kafka-to-apache-arrow
          • kafka-to-apache-atlas
          • kafka-to-apache-avro
          • kafka-to-apache-beam
          • kafka-to-apache-bookkeeper
          • kafka-to-apache-calcite
          • kafka-to-apache-camel
          • kafka-to-apache-cassandra
          • kafka-to-apache-crunch
          • kafka-to-apache-curator
          • kafka-to-apache-drill
          • kafka-to-apache-druid
          • kafka-to-apache-flink
          • kafka-to-apache-gobblin
          • kafka-to-apache-hadoop
          • kafka-to-apache-hbase
          • kafka-to-apache-helix
          • kafka-to-apache-hudi
          • kafka-to-apache-iceberg
          • kafka-to-apache-kafka
          • kafka-to-apache-karaf
          • kafka-to-apache-knox
          • kafka-to-apache-kylin
          • kafka-to-apache-lens
          • kafka-to-apache-mahout
          • kafka-to-apache-manifoldcf
          • kafka-to-apache-marmotta
          • kafka-to-apache-mesos
          • kafka-to-apache-metron
          • kafka-to-apache-mxnet
          • kafka-to-apache-nifi
          • kafka-to-apache-nutch
          • kafka-to-apache-oozie
          • kafka-to-apache-opennlp
          • kafka-to-apache-orc
          • kafka-to-apache-parquet
          • kafka-to-apache-pig
          • kafka-to-apache-pinot
          • kafka-to-apache-predictionio
          • kafka-to-apache-pulsar
          • kafka-to-apache-ranger
          • kafka-to-apache-reef
          • kafka-to-apache-sentry
          • kafka-to-apache-shiro
          • kafka-to-apache-singa
          • kafka-to-apache-solr
          • kafka-to-apache-spark
          • kafka-to-apache-sqoop
          • kafka-to-apache-storm
          • kafka-to-apache-superset
          • kafka-to-apache-tajo
          • kafka-to-apache-tez
          • kafka-to-apache-tika
          • kafka-to-apache-uima
          • kafka-to-apache-vxquery
          • kafka-to-apache-wicket
          • kafka-to-apache-zeppelin
          • kafka-to-apache-zookeeper
          • kafka-to-aws-amplify
          • kafka-to-aws-app-runner
          • kafka-to-aws-appsync
          • kafka-to-aws-athena
          • kafka-to-aws-auto-scaling
          • kafka-to-aws-backup
          • kafka-to-aws-batch
          • kafka-to-aws-certificate-manager
          • kafka-to-aws-cloudformation
          • kafka-to-aws-cloudfront
          • kafka-to-aws-cloudtrail
          • kafka-to-aws-cloudwatch
          • kafka-to-aws-codebuild
          • kafka-to-aws-codecommit
          • kafka-to-aws-codedeploy
          • kafka-to-aws-codepipeline
          • kafka-to-aws-codestar
          • kafka-to-aws-cognito
          • kafka-to-aws-config
          • kafka-to-aws-data-pipeline
          • kafka-to-aws-database-migration-service
          • kafka-to-aws-direct-connect
          • kafka-to-aws-directory-service
          • kafka-to-aws-dynamodb
          • kafka-to-aws-ec2
          • kafka-to-aws-elastic-beanstalk
          • kafka-to-aws-elastic-load-balancing
          • kafka-to-aws-elemental-mediaconvert
          • kafka-to-aws-elemental-medialive
          • kafka-to-aws-elemental-mediapackage
          • kafka-to-aws-elemental-mediastore
          • kafka-to-aws-elemental-mediatailor
          • kafka-to-aws-eventbridge
          • kafka-to-aws-fargate
          • kafka-to-aws-firewall-manager
          • kafka-to-aws-glue
          • kafka-to-aws-iam
          • kafka-to-aws-iot-core
          • kafka-to-aws-kinesis
          • kafka-to-aws-lambda
          • kafka-to-aws-lightsail
          • kafka-to-aws-macie
          • kafka-to-aws-managed-blockchain
          • kafka-to-aws-marketplace
          • kafka-to-aws-migration-hub
          • kafka-to-aws-mobile-hub
          • kafka-to-aws-opsworks
          • kafka-to-aws-organizations
          • kafka-to-aws-outposts
          • kafka-to-aws-personal-health-dashboard
          • kafka-to-aws-pinpoint
          • kafka-to-aws-polly
          • kafka-to-aws-privatelink
          • kafka-to-aws-rds
          • kafka-to-aws-redshift
          • kafka-to-aws-rekognition
          • kafka-to-aws-resource-access-manager
          • kafka-to-aws-robomaker
          • kafka-to-aws-route-53
          • kafka-to-aws-s3
          • kafka-to-aws-sagemaker
          • kafka-to-aws-secrets-manager
          • kafka-to-aws-security-hub
          • kafka-to-aws-server-migration-service
          • kafka-to-aws-service-catalog
          • kafka-to-aws-shield
          • kafka-to-aws-snowball
          • kafka-to-aws-step-functions
          • kafka-to-aws-storage-gateway
          • kafka-to-aws-systems-manager
          • kafka-to-aws-timestream
          • kafka-to-aws-transfer-family
          • kafka-to-aws-transit-gateway
          • kafka-to-aws-trusted-advisor
          • kafka-to-aws-vpc
          • kafka-to-aws-waf
          • kafka-to-aws-well-architected-tool
          • kafka-to-aws-x-ray
          • kafka-to-azure-synapse
          • kafka-to-bigquery
          • kafka-to-bitbucket
          • kafka-to-bokeh
          • kafka-to-circleci
          • kafka-to-clickhouse
          • kafka-to-cloudflare
          • kafka-to-couchbase
          • kafka-to-dagster
          • kafka-to-databricks
          • kafka-to-datadog
          • kafka-to-django
          • kafka-to-domo
          • kafka-to-dropbox
          • kafka-to-elasticsearch
          • kafka-to-exasol
          • kafka-to-faunadb
          • kafka-to-firebase
          • kafka-to-fivetran
          • kafka-to-flask
          • kafka-to-git
          • kafka-to-google-cloud-platform
          • kafka-to-google-drive
          • kafka-to-grafana
          • kafka-to-greenplum
          • kafka-to-h2o-ai
          • kafka-to-hasura
          • kafka-to-heroku
          • kafka-to-hugo
          • kafka-to-ibm-db2
          • kafka-to-informatica
          • kafka-to-insightly
          • kafka-to-jenkins
          • kafka-to-jira
          • kafka-to-jupyter
          • kafka-to-kibana
          • kafka-to-knime
          • kafka-to-kubernetes
          • kafka-to-linkedin
          • kafka-to-looker
          • kafka-to-lookml
          • kafka-to-luigi
          • kafka-to-mailchimp
          • kafka-to-mariadb
          • kafka-to-matplotlib
          • kafka-to-medium
          • kafka-to-meltano
          • kafka-to-memcached
          • kafka-to-microsoft-azure
          • kafka-to-microsoft-onedrive
          • kafka-to-microsoft-teams
          • kafka-to-mongodb
          • kafka-to-mysql
          • kafka-to-netezza
          • kafka-to-netlify
          • kafka-to-notion
          • kafka-to-numpy
          • kafka-to-opencart
          • kafka-to-oracle
          • kafka-to-pandas
          • kafka-to-perl
          • kafka-to-plotly
          • kafka-to-postgresql
          • kafka-to-power-bi
          • kafka-to-prefect
          • kafka-to-presto
          • kafka-to-pytorch
          • kafka-to-qlik
          • kafka-to-rapidminer
          • kafka-to-redis-cloud
          • kafka-to-redis-enterprise
          • kafka-to-redis
          • kafka-to-redisai
          • kafka-to-redisbloom
          • kafka-to-redisgears
          • kafka-to-redisgraph
          • kafka-to-redisinsight
          • kafka-to-redisjson
          • kafka-to-redshift
          • kafka-to-ringcentral
          • kafka-to-rust
          • kafka-to-salesforce
          • kafka-to-sas
          • kafka-to-scikit-learn
          • kafka-to-seaborn
          • kafka-to-segment
          • kafka-to-sendgrid
          • kafka-to-shopify
          • kafka-to-slack
          • kafka-to-snowflake
          • kafka-to-spss
          • kafka-to-sqlite
          • kafka-to-supabase
          • kafka-to-tableau
          • kafka-to-talend
          • kafka-to-tensorflow
          • kafka-to-terraform
          • kafka-to-trino
          • kafka-to-twilio
          • kafka-to-vercel
          • kafka-to-vertica
          • kafka-to-vultr
          • kafka-to-wasabi
          • kafka-to-webex
          • kafka-to-webflow
          • kafka-to-weebly
          • kafka-to-woocommerce
          • kafka-to-wordpress
          • kafka-to-wrike
          • kafka-to-xml-commons
          • kafka-to-xml-graphics
          • kafka-to-xml-security
          • kafka-to-xmlbeans
          • kafka-to-zoho
          • kafka-to-zoom
        • Overview
          • 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
          • Overview
          • 1. Install InfluxDB v2
          • 2. Create the project
          • 3. Add InfluxDB v2 source
          • 4. Add InfluxDB v3 destination
          • 5. Summary
        • Vector Store Embeddings
          • 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
        • 2025
        • 2024
        • 2023
        • ecosystem
        • industry-insights
        • releases
        • tutorials
     Star Quix Streams
     Install Quix Streams
     Edit on GitHub

    Tip use

    Tip

    This command requires you to specify a workspace and will prompt for it unless you use the quix use command to set the workspace in advance.

    Was this page helpful?
    Thanks for your feedback!
    Thanks for your feedback!
    Help us improve this page by letting us know what went wrong in our Quix Community.
    © 2020 - 2024 Quix Analytics, Ltd. Privacy Terms License Terms Cookie settings
    Slack
    YouTube
    GitHub

    Cookie consent

    We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.