-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathmkdocs.yml
939 lines (916 loc) · 58.7 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
site_name: 'Quix Docs'
site_description: 'Quix Developer Documentation. Includes documentation (guides, tutorials, references) for Quix Cloud, Quix Streams client library, and REST and websocket APIs.'
site_author: 'Quix.io'
site_url: 'https://quix.io/docs'
copyright: >
Copyright © 2020 - 2024 Quix Analytics, Ltd. –
<a href="#__consent">Change cookie settings</a>
docs_dir: docs/
repo_name: quixio/quix-docs
repo_url: https://github.com/quixio/quix-docs
edit_uri: tree/dev/docs
nav:
- 'Get started':
- 'Welcome': 'get-started/welcome.md'
- 'Get started!': 'get-started/quix-start.md'
- 'Core concepts':
- 'get-started/streaming.md'
- 'get-started/stream-processing.md'
- 'get-started/stream-processing-pipelines.md'
# - 'Quickstart':
# - 'Produce data': 'get-started/produce.md'
# - 'Consume data': 'get-started/consume.md'
# - 'Process data': 'get-started/process.md'
# Mostly out of date
# - 'Project templates': 'get-started/project-templates.md'
- 'Quix Streams': '!import https://github.com/quixio/quix-streams?branch=v3.7.0'
- 'Quix Connectors':
# Pages for "Quix Streams" section are imported from https://github.com/quixio/quix-streams
- Quix Streams:
- Sources:
- 'quix-streams/connectors/sources/README.md'
- Amazon Kinesis Source: 'quix-streams/connectors/sources/amazon-kinesis-source.md'
- Amazon S3 Source: 'quix-streams/connectors/sources/amazon-s3-source.md'
- Azure Blob Storage Source: 'quix-streams/connectors/sources/microsoft-azure-file-source.md'
- CSV Source: 'quix-streams/connectors/sources/csv-source.md'
- Google Cloud Pub/Sub Source: 'quix-streams/connectors/sources/google-cloud-pubsub-source.md'
- Kafka Replicator Source: 'quix-streams/connectors/sources/kafka-source.md'
- Local File Source: 'quix-streams/connectors/sources/local-file-source.md'
- Quix Environment Source: 'quix-streams/connectors/sources/quix-source.md'
- Creating a Custom Source: 'quix-streams/connectors/sources/custom-sources.md'
- Sinks:
- 'quix-streams/connectors/sinks/README.md'
- Amazon Kinesis Sink: 'quix-streams/connectors/sinks/amazon-kinesis-sink.md'
- Amazon S3 Sink: 'quix-streams/connectors/sinks/amazon-s3-sink.md'
- Apache Iceberg Sink: 'quix-streams/connectors/sinks/apache-iceberg-sink.md'
- Azure Blob Storage Sink: 'quix-streams/connectors/sinks/microsoft-azure-file-sink.md'
- CSV Sink: 'quix-streams/connectors/sinks/csv-sink.md'
- Google Cloud BigQuery Sink: 'quix-streams/connectors/sinks/google-cloud-bigquery-sink.md'
- Google Cloud Pub/Sub Sink: 'quix-streams/connectors/sinks/google-cloud-pubsub-sink.md'
- InfluxDB v3 Sink: 'quix-streams/connectors/sinks/influxdb3-sink.md'
- Local File Sink: 'quix-streams/connectors/sinks/local-file-sink.md'
- PostgreSQL Sink: 'quix-streams/connectors/sinks/postgresql-sink.md'
- Redis Sink: 'quix-streams/connectors/sinks/redis-sink.md'
- Creating a Custom Sink: 'quix-streams/connectors/sinks/custom-sinks.md'
- Contribution Guide: 'quix-streams/connectors/contribution-guide'
- Community and Core Connectors: 'quix-streams/connectors/community-and-core.md'
- Quix Cloud:
- 'Index': 'quix-connectors/templates/index.md'
- 'Sources':
- 'Confluent Kafka': 'quix-connectors/templates/confluentkafkasource-source.md'
- 'Environment': 'quix-connectors/templates/environmentsource-source.md'
- 'InfluxDB 2.0': 'quix-connectors/templates/influxdb20source-source.md'
- 'InfluxDB 3.0': 'quix-connectors/templates/influxdb30source-source.md'
- 'Kafka Connect': 'quix-connectors/templates/kafkaconnectsource-source.md'
- 'MQTT': 'quix-connectors/templates/mqttsource-source.md'
- 'Postgres CDC': 'quix-connectors/templates/postgrescdcsource-source.md'
- 'Redis': 'quix-connectors/templates/redissource-source.md'
- 'SQL Change Data Capture': 'quix-connectors/templates/sqlchangedatacapturesource-source.md'
- 'Segment': 'quix-connectors/templates/segmentsource-source.md'
- 'Snowplow': 'quix-connectors/templates/snowplowsource-source.md'
- 'Telegraf': 'quix-connectors/templates/telegraf-source.md'
- 'Sinks':
- 'AWS S3 Iceberg': 'quix-connectors/templates/awss3icebergsink-destination.md'
- 'BigQuery': 'quix-connectors/templates/bigquerysink-destination.md'
- 'Confluent Kafka': 'quix-connectors/templates/confluentkafkasink-destination.md'
- 'InfluxDB 3.0': 'quix-connectors/templates/influxdb30sink-destination.md'
- 'Kafka Connect': 'quix-connectors/templates/kafkaconnectsink-destination.md'
- 'MQTT': 'quix-connectors/templates/mqttsink-destination.md'
- 'Slack': 'quix-connectors/templates/slacksink-destination.md'
- 'Websocket': 'quix-connectors/templates/websocketdestination-destination.md'
- Coming Soon:
- Sources:
- Amazon Glue source: quix-connectors/quix-streams/sources/coming-soon/AmazonGlue-source.md
- Amazon SQS source: quix-connectors/quix-streams/sources/coming-soon/AmazonSQS-source.md
- Apache Iceberg source: quix-connectors/quix-streams/sources/coming-soon/ApacheIceberg-source.md
- Apache Pulsar source: quix-connectors/quix-streams/sources/coming-soon/ApachePulsar-source.md
- Astra source: quix-connectors/quix-streams/sources/coming-soon/Astra-source.md
- Cassandra source: quix-connectors/quix-streams/sources/coming-soon/Cassandra-source.md
- Chroma source: quix-connectors/quix-streams/sources/coming-soon/Chroma-source.md
- Clickhouse source: quix-connectors/quix-streams/sources/coming-soon/Clickhouse-source.md
- Convex source: quix-connectors/quix-streams/sources/coming-soon/Convex-source.md
- Cumulio source: quix-connectors/quix-streams/sources/coming-soon/Cumulio-source.md
- Databend source: quix-connectors/quix-streams/sources/coming-soon/Databend-source.md
- Databricks source: quix-connectors/quix-streams/sources/coming-soon/Databricks-source.md
- Doris source: quix-connectors/quix-streams/sources/coming-soon/Doris-source.md
- DuckDB source: quix-connectors/quix-streams/sources/coming-soon/DuckDB-source.md
- DynamoDB source: quix-connectors/quix-streams/sources/coming-soon/DynamoDB-source.md
- ElasticSearch source: quix-connectors/quix-streams/sources/coming-soon/ElasticSearch-source.md
- Exasol source: quix-connectors/quix-streams/sources/coming-soon/Exasol-source.md
- Firebolt source: quix-connectors/quix-streams/sources/coming-soon/Firebolt-source.md
- Google Cloud BigQuery source: quix-connectors/quix-streams/sources/coming-soon/GoogleCloudBigQuery-source.md
- Google Cloud Firestore source: quix-connectors/quix-streams/sources/coming-soon/GoogleCloudFirestore-source.md
- Google Cloud Storage source: quix-connectors/quix-streams/sources/coming-soon/GoogleCloudStorage-source.md
- Google Sheets source: quix-connectors/quix-streams/sources/coming-soon/GoogleSheets-source.md
- Keen source: quix-connectors/quix-streams/sources/coming-soon/Keen-source.md
- Kvdb source: quix-connectors/quix-streams/sources/coming-soon/Kvdb-source.md
- Langchain source: quix-connectors/quix-streams/sources/coming-soon/Langchain-source.md
- Mariadb Columnstore source: quix-connectors/quix-streams/sources/coming-soon/MariadbColumnstore-source.md
- Meilisearch source: quix-connectors/quix-streams/sources/coming-soon/Meilisearch-source.md
- MicrosoftSQL source: quix-connectors/quix-streams/sources/coming-soon/MicrosoftSQL-source.md
- Milvus source: quix-connectors/quix-streams/sources/coming-soon/Milvus-source.md
- MongoDB source: quix-connectors/quix-streams/sources/coming-soon/MongoDB-source.md
- Motherduck source: quix-connectors/quix-streams/sources/coming-soon/Motherduck-source.md
- MQTT source: quix-connectors/quix-streams/sources/coming-soon/MQTT-source.md
- MySQL source: quix-connectors/quix-streams/sources/coming-soon/MySQL-source.md
- Oracle source: quix-connectors/quix-streams/sources/coming-soon/Oracle-source.md
- Pgvector source: quix-connectors/quix-streams/sources/coming-soon/Pgvector-source.md
- Pinecone source: quix-connectors/quix-streams/sources/coming-soon/Pinecone-source.md
- Postgres source: quix-connectors/quix-streams/sources/coming-soon/Postgres-source.md
- PostgresCDC source: quix-connectors/quix-streams/sources/coming-soon/PostgresCDC-source.md
- PubSub source: quix-connectors/quix-streams/sources/coming-soon/PubSub-source.md
- Qdrant source: quix-connectors/quix-streams/sources/coming-soon/Qdrant-source.md
- R2 source: quix-connectors/quix-streams/sources/coming-soon/R2-source.md
- RabbitMQ source: quix-connectors/quix-streams/sources/coming-soon/RabbitMQ-source.md
- Redis source: quix-connectors/quix-streams/sources/coming-soon/Redis-source.md
- Redpanda source: quix-connectors/quix-streams/sources/coming-soon/Redpanda-source.md
- Redshift source: quix-connectors/quix-streams/sources/coming-soon/Redshift-source.md
- Rockset source: quix-connectors/quix-streams/sources/coming-soon/Rockset-source.md
- Scylla source: quix-connectors/quix-streams/sources/coming-soon/Scylla-source.md
- Selectdb source: quix-connectors/quix-streams/sources/coming-soon/Selectdb-source.md
- SftpJson source: quix-connectors/quix-streams/sources/coming-soon/SftpJson-source.md
- Snowflake source: quix-connectors/quix-streams/sources/coming-soon/Snowflake-source.md
- Snowflake Cortex source: quix-connectors/quix-streams/sources/coming-soon/SnowflakeCortex-source.md
- Sqlite source: quix-connectors/quix-streams/sources/coming-soon/Sqlite-source.md
- Starburst Galaxy source: quix-connectors/quix-streams/sources/coming-soon/StarburstGalaxy-source.md
- Teradata source: quix-connectors/quix-streams/sources/coming-soon/Teradata-source.md
- Tidb source: quix-connectors/quix-streams/sources/coming-soon/Tidb-source.md
- Timeplus source: quix-connectors/quix-streams/sources/coming-soon/Timeplus-source.md
- Typesense source: quix-connectors/quix-streams/sources/coming-soon/Typesense-source.md
- Vectara source: quix-connectors/quix-streams/sources/coming-soon/Vectara-source.md
- Vertica source: quix-connectors/quix-streams/sources/coming-soon/Vertica-source.md
- Weaviate source: quix-connectors/quix-streams/sources/coming-soon/Weaviate-source.md
- Xata source: quix-connectors/quix-streams/sources/coming-soon/Xata-source.md
- Yellowbrick source: quix-connectors/quix-streams/sources/coming-soon/Yellowbrick-source.md
- Yugabytedb source: quix-connectors/quix-streams/sources/coming-soon/Yugabytedb-source.md
- Sinks:
- Amazon Glue sink: quix-connectors/quix-streams/sinks/coming-soon/AmazonGlue-sink.md
- Amazon SQS sink: quix-connectors/quix-streams/sinks/coming-soon/AmazonSQS-sink.md
- Apache Pulsar sink: quix-connectors/quix-streams/sinks/coming-soon/ApachePulsar-sink.md
- Astra sink: quix-connectors/quix-streams/sinks/coming-soon/Astra-sink.md
- Cassandra sink: quix-connectors/quix-streams/sinks/coming-soon/Cassandra-sink.md
- Chroma sink: quix-connectors/quix-streams/sinks/coming-soon/Chroma-sink.md
- Clickhouse sink: quix-connectors/quix-streams/sinks/coming-soon/Clickhouse-sink.md
- Convex sink: quix-connectors/quix-streams/sinks/coming-soon/Convex-sink.md
- Cumulio sink: quix-connectors/quix-streams/sinks/coming-soon/Cumulio-sink.md
- Databend sink: quix-connectors/quix-streams/sinks/coming-soon/Databend-sink.md
- Databricks sink: quix-connectors/quix-streams/sinks/coming-soon/Databricks-sink.md
- Doris sink: quix-connectors/quix-streams/sinks/coming-soon/Doris-sink.md
- DuckDB sink: quix-connectors/quix-streams/sinks/coming-soon/DuckDB-sink.md
- DynamoDB sink: quix-connectors/quix-streams/sinks/coming-soon/DynamoDB-sink.md
- ElasticSearch sink: quix-connectors/quix-streams/sinks/coming-soon/ElasticSearch-sink.md
- Exasol sink: quix-connectors/quix-streams/sinks/coming-soon/Exasol-sink.md
- Firebolt sink: quix-connectors/quix-streams/sinks/coming-soon/Firebolt-sink.md
- Google Cloud Firestore sink: quix-connectors/quix-streams/sinks/coming-soon/GoogleCloudFirestore-sink.md
- Google Cloud Storage sink: quix-connectors/quix-streams/sinks/coming-soon/GoogleCloudStorage-sink.md
- Google Sheets sink: quix-connectors/quix-streams/sinks/coming-soon/GoogleSheets-sink.md
- Keen sink: quix-connectors/quix-streams/sinks/coming-soon/Keen-sink.md
- Kvdb sink: quix-connectors/quix-streams/sinks/coming-soon/Kvdb-sink.md
- Langchain sink: quix-connectors/quix-streams/sinks/coming-soon/Langchain-sink.md
- Mariadb Columnstore sink: quix-connectors/quix-streams/sinks/coming-soon/MariadbColumnstore-sink.md
- Meilisearch sink: quix-connectors/quix-streams/sinks/coming-soon/Meilisearch-sink.md
- MicrosoftSQL sink: quix-connectors/quix-streams/sinks/coming-soon/MicrosoftSQL-sink.md
- Milvus sink: quix-connectors/quix-streams/sinks/coming-soon/Milvus-sink.md
- MongoDB sink: quix-connectors/quix-streams/sinks/coming-soon/MongoDB-sink.md
- Motherduck sink: quix-connectors/quix-streams/sinks/coming-soon/Motherduck-sink.md
- MQTT sink: quix-connectors/quix-streams/sinks/coming-soon/MQTT-sink.md
- MySQL sink: quix-connectors/quix-streams/sinks/coming-soon/MySQL-sink.md
- Oracle sink: quix-connectors/quix-streams/sinks/coming-soon/Oracle-sink.md
- Pgvector sink: quix-connectors/quix-streams/sinks/coming-soon/Pgvector-sink.md
- Pinecone sink: quix-connectors/quix-streams/sinks/coming-soon/Pinecone-sink.md
- PostgresCDC sink: quix-connectors/quix-streams/sinks/coming-soon/PostgresCDC-sink.md
- Qdrant sink: quix-connectors/quix-streams/sinks/coming-soon/Qdrant-sink.md
- R2 sink: quix-connectors/quix-streams/sinks/coming-soon/R2-sink.md
- RabbitMQ sink: quix-connectors/quix-streams/sinks/coming-soon/RabbitMQ-sink.md
- Redpanda sink: quix-connectors/quix-streams/sinks/coming-soon/Redpanda-sink.md
- Redshift sink: quix-connectors/quix-streams/sinks/coming-soon/Redshift-sink.md
- Rockset sink: quix-connectors/quix-streams/sinks/coming-soon/Rockset-sink.md
- Scylla sink: quix-connectors/quix-streams/sinks/coming-soon/Scylla-sink.md
- Selectdb sink: quix-connectors/quix-streams/sinks/coming-soon/Selectdb-sink.md
- SftpJson sink: quix-connectors/quix-streams/sinks/coming-soon/SftpJson-sink.md
- Snowflake sink: quix-connectors/quix-streams/sinks/coming-soon/Snowflake-sink.md
- Snowflake Cortex sink: quix-connectors/quix-streams/sinks/coming-soon/SnowflakeCortex-sink.md
- Sqlite sink: quix-connectors/quix-streams/sinks/coming-soon/Sqlite-sink.md
- Starburst Galaxy sink: quix-connectors/quix-streams/sinks/coming-soon/StarburstGalaxy-sink.md
- Teradata sink: quix-connectors/quix-streams/sinks/coming-soon/Teradata-sink.md
- Tidb sink: quix-connectors/quix-streams/sinks/coming-soon/Tidb-sink.md
- Timeplus sink: quix-connectors/quix-streams/sinks/coming-soon/Timeplus-sink.md
- Typesense sink: quix-connectors/quix-streams/sinks/coming-soon/Typesense-sink.md
- Vectara sink: quix-connectors/quix-streams/sinks/coming-soon/Vectara-sink.md
- Vertica sink: quix-connectors/quix-streams/sinks/coming-soon/Vertica-sink.md
- Weaviate sink: quix-connectors/quix-streams/sinks/coming-soon/Weaviate-sink.md
- Xata sink: quix-connectors/quix-streams/sinks/coming-soon/Xata-sink.md
- Yellowbrick sink: quix-connectors/quix-streams/sinks/coming-soon/Yellowbrick-sink.md
- Yugabytedb sink: quix-connectors/quix-streams/sinks/coming-soon/Yugabytedb-sink.md
- 'Quix CLI': '!import https://github.com/quixio/quix-cli/?branch=1.2.0'
- 'Quix Cloud':
- 'Overview': 'quix-cloud/overview.md'
- 'Quickstart': 'quix-cloud/quickstart.md'
- 'Why Use Quix Cloud': 'quix-cloud/why-quix-cloud.md'
# - 'Quix Cloud Tour':
# - 'Overview': 'quix-cloud/quixtour/overview.md'
# - '1. Ingest': 'quix-cloud/quixtour/ingest.md'
# - '2. Process': 'quix-cloud/quixtour/process-threshold.md'
# - '3. Serve': 'quix-cloud/quixtour/serve-sms.md'
- 'Quix Cloud Tour':
- '1. Create your project':
- 'Overview': 'create/overview.md'
- 'Clone a project': 'create/clone-project.md'
- 'Fork a project': 'create/fork-project.md'
- 'Create a project': 'create/create-project.md'
- 'Create an environment': 'create/create-environment.md'
- 'Protected environments': 'create/protected-environment.md'
- 'Syncing an environment': 'create/syncing-environment.md'
- 'Project structure': 'create/project-structure.md'
- 'Create a topic': 'create/create-topic.md'
- 'Data tiers': 'create/data-tiers.md'
- 'Create a scratchpad': 'create/create-scratchpad.md'
- 'Create a linked project': 'create/create-linked-project.md'
- '2. Develop an application':
- 'Overview': 'develop/overview.md'
- 'Create an application': 'develop/create-application.md'
- 'Authentication':
- 'Authenticating Quix Streams': 'develop/authentication/quix-streams.md'
- 'Personal Access Token (PAT)': 'develop/authentication/personal-access-token.md'
- 'Streaming Token': 'develop/authentication/streaming-token.md'
- 'Using Code Samples': 'develop/code-samples.md'
- 'Integrate your data':
- 'Overview': 'develop/integrate-data/overview.md'
- 'Ingest your data - source':
- 'Using a prebuilt source connector': 'develop/integrate-data/prebuilt-connector.md'
- 'Reading a CSV file': 'develop/integrate-data/read-csv.md'
- 'Polling a REST API': 'develop/integrate-data/polling.md'
- 'Handling inbound webhooks': 'develop/integrate-data/inbound-webhooks.md'
- 'Using an external source': 'develop/integrate-data/external-source.md'
- 'Using the Quix Streaming APIs': 'develop/integrate-data/streaming-apis.md'
- 'Using Quix Streams': 'develop/integrate-data/quix-streams.md'
- 'Posting data to a Quix web app': 'develop/integrate-data/web-app.md'
- 'Handling compressed data': 'develop/integrate-data/compressed-data.md'
- 'Handling IoT data with MessagePack': 'develop/integrate-data/iot-data.md'
- 'Publish your data - sink':
- 'Using a prebuilt destination connector': 'develop/integrate-data/prebuilt-connector-destination.md'
- 'Using an external destination': 'develop/integrate-data/external-destination.md'
- 'Exporting Quix data to Jupyter notebooks': 'develop/integrate-data/jupyter-nb.md'
- 'Process your data':
- 'Overview': 'develop/process/overview.md'
- 'Types of processing': 'develop/process/types-of-processing.md'
- 'Types of transform': 'develop/process/types-of-transform.md'
- 'Generating events': 'develop/process/timeseries-events.md'
- 'Using Quix Streaming APIs':
- 'Overview': 'develop/apis-overview.md'
- 'Streaming Writer API':
- 'Overview': 'apis/streaming-writer-api/overview.md'
- 'Setup': 'apis/streaming-writer-api/setup.md'
- 'HTTP requests': 'apis/streaming-writer-api/http-requests.md'
- 'Create a new Stream': 'apis/streaming-writer-api/create-stream.md'
- 'Add Stream metadata': 'apis/streaming-writer-api/stream-metadata.md'
- 'Send Parameter data': 'apis/streaming-writer-api/send-data.md'
- 'Send an Event': 'apis/streaming-writer-api/send-event.md'
- 'Streaming Reader API':
- 'Overview': 'apis/streaming-reader-api/overview.md'
- 'Setup': 'apis/streaming-reader-api/setup.md'
- 'Reading data': 'apis/streaming-reader-api/reading-data.md'
- 'Subscription and events': 'apis/streaming-reader-api/subscriptions.md'
- '3. Deploy a service':
- 'Overview': 'deploy/overview.md'
- 'Environment variables': 'deploy/environment-variables.md'
- 'Quix variables': 'deploy/quix-variables.md'
- 'Secrets management': 'deploy/secrets-management.md'
- 'YAML variables': 'deploy/yaml-variables.md'
- 'Configuring network ports': 'deploy/ports.md'
- 'State management': 'deploy/state-management.md'
- 'Deploy public services': 'deploy/deploy-public-page.md'
- 'Deploy an external image': 'deploy/deploy-external-image.md'
- '4. Manage your pipelines':
- 'Overview': 'manage/overview.md'
- 'Troubleshooting': 'manage/troubleshooting.md'
- 'Security': 'manage/security.md'
- 'MLOps': 'manage/MLOps.md'
- 'Using replay service': 'manage/replay.md'
- 'Testing using Quix data store': 'manage/testing-data-store.md'
- 'Testing multiple environments': 'manage/testing-environments.md'
- 'Query API':
- 'Overview': 'apis/query-api/overview.md'
- 'Setup': 'apis/query-api/setup.md'
- 'HTTP requests': 'apis/query-api/http-requests.md'
- 'Paged streams': 'apis/query-api/streams-paged.md'
- 'Filtered streams': 'apis/query-api/streams-filtered.md'
- 'Streams with models': 'apis/query-api/streams-models.md'
- 'Raw data': 'apis/query-api/raw-data.md'
- 'Aggregate data by time': 'apis/query-api/aggregate-time.md'
- 'Aggregate data by tags': 'apis/query-api/aggregate-tags.md'
- 'Tag filtering': 'apis/query-api/filter-tags.md'
- 'Portal API':
- 'Overview': 'apis/portal-api/overview.md'
- 'Setup': 'apis/portal-api/setup.md'
- 'HTTP requests': 'apis/portal-api/http-requests.md'
- 'Security': 'quix-cloud/security.md'
- 'Integrations':
- 'Overview': 'integrations/overview.md'
- 'Brokers':
- 'Overview': 'integrations/brokers/overview.md'
- 'Broker settings': 'integrations/brokers/broker-settings.md'
- 'Quix': 'integrations/brokers/quix.md'
- 'Confluent': 'integrations/brokers/confluent.md'
- 'Redpanda': 'integrations/brokers/redpanda.md'
- 'Aiven': 'integrations/brokers/aiven.md'
- 'Upstash': 'integrations/brokers/upstash.md'
- 'Databases':
- 'InfluxDB':
- 'Overview': 'integrations/databases/influxdb/overview.md'
- 'Quickstart': 'integrations/databases/influxdb/quickstart.md'
- 'Guides':
- 'Using Telegraf': 'integrations/databases/influxdb/telegraf.md'
- 'Replacing Flux': 'integrations/databases/influxdb/replacing-flux.md'
- 'Replacing Kapacitor': 'integrations/databases/influxdb/replacing-kapacitor.md'
- 'Alerting': 'integrations/databases/influxdb/alerting.md'
- 'Migrating from v2 to v3': 'integrations/databases/influxdb/migrating-v2-v3.md'
- 'PostgreSQL':
- 'Overview': 'integrations/databases/postgressql/overview.md'
- 'Redis':
- 'Overview': 'integrations/databases/redis/overview.md'
- 'Vector Databases':
- 'Overview': 'integrations/vector-databases/overview.md'
- 'Upstash':
- 'Overview': 'integrations/vector-databases/upstash/overview.md'
- 'Qdrant':
- 'Overview': 'integrations/vector-databases/qdrant/overview.md'
- 'Weaviate':
- 'Overview': 'integrations/vector-databases/weaviate/overview.md'
- 'Bring Your Own Cluster (BYOC)':
- 'Overview': 'byoc/overview.md'
- 'Requirements': 'byoc/requirements.md'
- 'Installation': 'byoc/installation.md'
- 'BYOC vs. Cloud': 'byoc/byoc-vs-cloud.md'
- 'Knowledge base':
- 'Guides':
- 'What is Quix?': 'kb/what-is-quix.md'
- 'Why stream processing?': 'kb/why-stream-processing.md'
- 'What is Kafka?': 'kb/what-is-kafka.md'
- 'Reference':
- 'Glossary': 'kb/glossary.md'
- 'Contribute': 'kb/contribute.md'
- 'Planned Connectors':
- kafka-to-apache-airflow: connect/kafka-to-apache-airflow.md
- kafka-to-apache-ambari: connect/kafka-to-apache-ambari.md
- kafka-to-apache-arrow: connect/kafka-to-apache-arrow.md
- kafka-to-apache-atlas: connect/kafka-to-apache-atlas.md
- kafka-to-apache-avro: connect/kafka-to-apache-avro.md
- kafka-to-apache-beam: connect/kafka-to-apache-beam.md
- kafka-to-apache-bookkeeper: connect/kafka-to-apache-bookkeeper.md
- kafka-to-apache-calcite: connect/kafka-to-apache-calcite.md
- kafka-to-apache-camel: connect/kafka-to-apache-camel.md
- kafka-to-apache-cassandra: connect/kafka-to-apache-cassandra.md
- kafka-to-apache-crunch: connect/kafka-to-apache-crunch.md
- kafka-to-apache-curator: connect/kafka-to-apache-curator.md
- kafka-to-apache-drill: connect/kafka-to-apache-drill.md
- kafka-to-apache-druid: connect/kafka-to-apache-druid.md
- kafka-to-apache-flink: connect/kafka-to-apache-flink.md
- kafka-to-apache-gobblin: connect/kafka-to-apache-gobblin.md
- kafka-to-apache-hadoop: connect/kafka-to-apache-hadoop.md
- kafka-to-apache-hbase: connect/kafka-to-apache-hbase.md
- kafka-to-apache-helix: connect/kafka-to-apache-helix.md
- kafka-to-apache-hudi: connect/kafka-to-apache-hudi.md
- kafka-to-apache-iceberg: connect/kafka-to-apache-iceberg.md
- kafka-to-apache-kafka: connect/kafka-to-apache-kafka.md
- kafka-to-apache-karaf: connect/kafka-to-apache-karaf.md
- kafka-to-apache-knox: connect/kafka-to-apache-knox.md
- kafka-to-apache-kylin: connect/kafka-to-apache-kylin.md
- kafka-to-apache-lens: connect/kafka-to-apache-lens.md
- kafka-to-apache-mahout: connect/kafka-to-apache-mahout.md
- kafka-to-apache-manifoldcf: connect/kafka-to-apache-manifoldcf.md
- kafka-to-apache-marmotta: connect/kafka-to-apache-marmotta.md
- kafka-to-apache-mesos: connect/kafka-to-apache-mesos.md
- kafka-to-apache-metron: connect/kafka-to-apache-metron.md
- kafka-to-apache-mxnet: connect/kafka-to-apache-mxnet.md
- kafka-to-apache-nifi: connect/kafka-to-apache-nifi.md
- kafka-to-apache-nutch: connect/kafka-to-apache-nutch.md
- kafka-to-apache-oozie: connect/kafka-to-apache-oozie.md
- kafka-to-apache-opennlp: connect/kafka-to-apache-opennlp.md
- kafka-to-apache-orc: connect/kafka-to-apache-orc.md
- kafka-to-apache-parquet: connect/kafka-to-apache-parquet.md
- kafka-to-apache-pig: connect/kafka-to-apache-pig.md
- kafka-to-apache-pinot: connect/kafka-to-apache-pinot.md
- kafka-to-apache-predictionio: connect/kafka-to-apache-predictionio.md
- kafka-to-apache-pulsar: connect/kafka-to-apache-pulsar.md
- kafka-to-apache-ranger: connect/kafka-to-apache-ranger.md
- kafka-to-apache-reef: connect/kafka-to-apache-reef.md
- kafka-to-apache-sentry: connect/kafka-to-apache-sentry.md
- kafka-to-apache-shiro: connect/kafka-to-apache-shiro.md
- kafka-to-apache-singa: connect/kafka-to-apache-singa.md
- kafka-to-apache-solr: connect/kafka-to-apache-solr.md
- kafka-to-apache-spark: connect/kafka-to-apache-spark.md
- kafka-to-apache-sqoop: connect/kafka-to-apache-sqoop.md
- kafka-to-apache-storm: connect/kafka-to-apache-storm.md
- kafka-to-apache-superset: connect/kafka-to-apache-superset.md
- kafka-to-apache-tajo: connect/kafka-to-apache-tajo.md
- kafka-to-apache-tez: connect/kafka-to-apache-tez.md
- kafka-to-apache-tika: connect/kafka-to-apache-tika.md
- kafka-to-apache-uima: connect/kafka-to-apache-uima.md
- kafka-to-apache-vxquery: connect/kafka-to-apache-vxquery.md
- kafka-to-apache-wicket: connect/kafka-to-apache-wicket.md
- kafka-to-apache-zeppelin: connect/kafka-to-apache-zeppelin.md
- kafka-to-apache-zookeeper: connect/kafka-to-apache-zookeeper.md
- kafka-to-aws-amplify: connect/kafka-to-aws-amplify.md
- kafka-to-aws-app-runner: connect/kafka-to-aws-app-runner.md
- kafka-to-aws-appsync: connect/kafka-to-aws-appsync.md
- kafka-to-aws-athena: connect/kafka-to-aws-athena.md
- kafka-to-aws-auto-scaling: connect/kafka-to-aws-auto-scaling.md
- kafka-to-aws-backup: connect/kafka-to-aws-backup.md
- kafka-to-aws-batch: connect/kafka-to-aws-batch.md
- kafka-to-aws-certificate-manager: connect/kafka-to-aws-certificate-manager.md
- kafka-to-aws-cloudformation: connect/kafka-to-aws-cloudformation.md
- kafka-to-aws-cloudfront: connect/kafka-to-aws-cloudfront.md
- kafka-to-aws-cloudtrail: connect/kafka-to-aws-cloudtrail.md
- kafka-to-aws-cloudwatch: connect/kafka-to-aws-cloudwatch.md
- kafka-to-aws-codebuild: connect/kafka-to-aws-codebuild.md
- kafka-to-aws-codecommit: connect/kafka-to-aws-codecommit.md
- kafka-to-aws-codedeploy: connect/kafka-to-aws-codedeploy.md
- kafka-to-aws-codepipeline: connect/kafka-to-aws-codepipeline.md
- kafka-to-aws-codestar: connect/kafka-to-aws-codestar.md
- kafka-to-aws-cognito: connect/kafka-to-aws-cognito.md
- kafka-to-aws-config: connect/kafka-to-aws-config.md
- kafka-to-aws-data-pipeline: connect/kafka-to-aws-data-pipeline.md
- kafka-to-aws-database-migration-service: connect/kafka-to-aws-database-migration-service.md
- kafka-to-aws-direct-connect: connect/kafka-to-aws-direct-connect.md
- kafka-to-aws-directory-service: connect/kafka-to-aws-directory-service.md
- kafka-to-aws-dynamodb: connect/kafka-to-aws-dynamodb.md
- kafka-to-aws-ec2: connect/kafka-to-aws-ec2.md
- kafka-to-aws-elastic-beanstalk: connect/kafka-to-aws-elastic-beanstalk.md
- kafka-to-aws-elastic-load-balancing: connect/kafka-to-aws-elastic-load-balancing.md
- kafka-to-aws-elemental-mediaconvert: connect/kafka-to-aws-elemental-mediaconvert.md
- kafka-to-aws-elemental-medialive: connect/kafka-to-aws-elemental-medialive.md
- kafka-to-aws-elemental-mediapackage: connect/kafka-to-aws-elemental-mediapackage.md
- kafka-to-aws-elemental-mediastore: connect/kafka-to-aws-elemental-mediastore.md
- kafka-to-aws-elemental-mediatailor: connect/kafka-to-aws-elemental-mediatailor.md
- kafka-to-aws-eventbridge: connect/kafka-to-aws-eventbridge.md
- kafka-to-aws-fargate: connect/kafka-to-aws-fargate.md
- kafka-to-aws-firewall-manager: connect/kafka-to-aws-firewall-manager.md
- kafka-to-aws-glue: connect/kafka-to-aws-glue.md
- kafka-to-aws-iam: connect/kafka-to-aws-iam.md
- kafka-to-aws-iot-core: connect/kafka-to-aws-iot-core.md
- kafka-to-aws-kinesis: connect/kafka-to-aws-kinesis.md
- kafka-to-aws-lambda: connect/kafka-to-aws-lambda.md
- kafka-to-aws-lightsail: connect/kafka-to-aws-lightsail.md
- kafka-to-aws-macie: connect/kafka-to-aws-macie.md
- kafka-to-aws-managed-blockchain: connect/kafka-to-aws-managed-blockchain.md
- kafka-to-aws-marketplace: connect/kafka-to-aws-marketplace.md
- kafka-to-aws-migration-hub: connect/kafka-to-aws-migration-hub.md
- kafka-to-aws-mobile-hub: connect/kafka-to-aws-mobile-hub.md
- kafka-to-aws-opsworks: connect/kafka-to-aws-opsworks.md
- kafka-to-aws-organizations: connect/kafka-to-aws-organizations.md
- kafka-to-aws-outposts: connect/kafka-to-aws-outposts.md
- kafka-to-aws-personal-health-dashboard: connect/kafka-to-aws-personal-health-dashboard.md
- kafka-to-aws-pinpoint: connect/kafka-to-aws-pinpoint.md
- kafka-to-aws-polly: connect/kafka-to-aws-polly.md
- kafka-to-aws-privatelink: connect/kafka-to-aws-privatelink.md
- kafka-to-aws-rds: connect/kafka-to-aws-rds.md
- kafka-to-aws-redshift: connect/kafka-to-aws-redshift.md
- kafka-to-aws-rekognition: connect/kafka-to-aws-rekognition.md
- kafka-to-aws-resource-access-manager: connect/kafka-to-aws-resource-access-manager.md
- kafka-to-aws-robomaker: connect/kafka-to-aws-robomaker.md
- kafka-to-aws-route-53: connect/kafka-to-aws-route-53.md
- kafka-to-aws-s3: connect/kafka-to-aws-s3.md
- kafka-to-aws-sagemaker: connect/kafka-to-aws-sagemaker.md
- kafka-to-aws-secrets-manager: connect/kafka-to-aws-secrets-manager.md
- kafka-to-aws-security-hub: connect/kafka-to-aws-security-hub.md
- kafka-to-aws-server-migration-service: connect/kafka-to-aws-server-migration-service.md
- kafka-to-aws-service-catalog: connect/kafka-to-aws-service-catalog.md
- kafka-to-aws-shield: connect/kafka-to-aws-shield.md
- kafka-to-aws-snowball: connect/kafka-to-aws-snowball.md
- kafka-to-aws-step-functions: connect/kafka-to-aws-step-functions.md
- kafka-to-aws-storage-gateway: connect/kafka-to-aws-storage-gateway.md
- kafka-to-aws-systems-manager: connect/kafka-to-aws-systems-manager.md
- kafka-to-aws-timestream: connect/kafka-to-aws-timestream.md
- kafka-to-aws-transfer-family: connect/kafka-to-aws-transfer-family.md
- kafka-to-aws-transit-gateway: connect/kafka-to-aws-transit-gateway.md
- kafka-to-aws-trusted-advisor: connect/kafka-to-aws-trusted-advisor.md
- kafka-to-aws-vpc: connect/kafka-to-aws-vpc.md
- kafka-to-aws-waf: connect/kafka-to-aws-waf.md
- kafka-to-aws-well-architected-tool: connect/kafka-to-aws-well-architected-tool.md
- kafka-to-aws-x-ray: connect/kafka-to-aws-x-ray.md
- kafka-to-azure-synapse: connect/kafka-to-azure-synapse.md
- kafka-to-bigquery: connect/kafka-to-bigquery.md
- kafka-to-bitbucket: connect/kafka-to-bitbucket.md
- kafka-to-bokeh: connect/kafka-to-bokeh.md
- kafka-to-circleci: connect/kafka-to-circleci.md
- kafka-to-clickhouse: connect/kafka-to-clickhouse.md
- kafka-to-cloudflare: connect/kafka-to-cloudflare.md
- kafka-to-couchbase: connect/kafka-to-couchbase.md
- kafka-to-dagster: connect/kafka-to-dagster.md
- kafka-to-databricks: connect/kafka-to-databricks.md
- kafka-to-datadog: connect/kafka-to-datadog.md
- kafka-to-django: connect/kafka-to-django.md
- kafka-to-domo: connect/kafka-to-domo.md
- kafka-to-dropbox: connect/kafka-to-dropbox.md
- kafka-to-elasticsearch: connect/kafka-to-elasticsearch.md
- kafka-to-exasol: connect/kafka-to-exasol.md
- kafka-to-faunadb: connect/kafka-to-faunadb.md
- kafka-to-firebase: connect/kafka-to-firebase.md
- kafka-to-fivetran: connect/kafka-to-fivetran.md
- kafka-to-flask: connect/kafka-to-flask.md
- kafka-to-git: connect/kafka-to-git.md
- kafka-to-google-cloud-platform: connect/kafka-to-google-cloud-platform.md
- kafka-to-google-drive: connect/kafka-to-google-drive.md
- kafka-to-grafana: connect/kafka-to-grafana.md
- kafka-to-greenplum: connect/kafka-to-greenplum.md
- kafka-to-h2o-ai: connect/kafka-to-h2o-ai.md
- kafka-to-hasura: connect/kafka-to-hasura.md
- kafka-to-heroku: connect/kafka-to-heroku.md
- kafka-to-hugo: connect/kafka-to-hugo.md
- kafka-to-ibm-db2: connect/kafka-to-ibm-db2.md
- kafka-to-informatica: connect/kafka-to-informatica.md
- kafka-to-insightly: connect/kafka-to-insightly.md
- kafka-to-jenkins: connect/kafka-to-jenkins.md
- kafka-to-jira: connect/kafka-to-jira.md
- kafka-to-jupyter: connect/kafka-to-jupyter.md
- kafka-to-kibana: connect/kafka-to-kibana.md
- kafka-to-knime: connect/kafka-to-knime.md
- kafka-to-kubernetes: connect/kafka-to-kubernetes.md
- kafka-to-linkedin: connect/kafka-to-linkedin.md
- kafka-to-looker: connect/kafka-to-looker.md
- kafka-to-lookml: connect/kafka-to-lookml.md
- kafka-to-luigi: connect/kafka-to-luigi.md
- kafka-to-mailchimp: connect/kafka-to-mailchimp.md
- kafka-to-mariadb: connect/kafka-to-mariadb.md
- kafka-to-matplotlib: connect/kafka-to-matplotlib.md
- kafka-to-medium: connect/kafka-to-medium.md
- kafka-to-meltano: connect/kafka-to-meltano.md
- kafka-to-memcached: connect/kafka-to-memcached.md
- kafka-to-microsoft-azure: connect/kafka-to-microsoft-azure.md
- kafka-to-microsoft-onedrive: connect/kafka-to-microsoft-onedrive.md
- kafka-to-microsoft-teams: connect/kafka-to-microsoft-teams.md
- kafka-to-mongodb: connect/kafka-to-mongodb.md
- kafka-to-mysql: connect/kafka-to-mysql.md
- kafka-to-netezza: connect/kafka-to-netezza.md
- kafka-to-netlify: connect/kafka-to-netlify.md
- kafka-to-notion: connect/kafka-to-notion.md
- kafka-to-numpy: connect/kafka-to-numpy.md
- kafka-to-opencart: connect/kafka-to-opencart.md
- kafka-to-oracle: connect/kafka-to-oracle.md
- kafka-to-pandas: connect/kafka-to-pandas.md
- kafka-to-perl: connect/kafka-to-perl.md
- kafka-to-plotly: connect/kafka-to-plotly.md
- kafka-to-postgresql: connect/kafka-to-postgresql.md
- kafka-to-power-bi: connect/kafka-to-power-bi.md
- kafka-to-prefect: connect/kafka-to-prefect.md
- kafka-to-presto: connect/kafka-to-presto.md
- kafka-to-pytorch: connect/kafka-to-pytorch.md
- kafka-to-qlik: connect/kafka-to-qlik.md
- kafka-to-rapidminer: connect/kafka-to-rapidminer.md
- kafka-to-redis-cloud: connect/kafka-to-redis-cloud.md
- kafka-to-redis-enterprise: connect/kafka-to-redis-enterprise.md
- kafka-to-redis: connect/kafka-to-redis.md
- kafka-to-redisai: connect/kafka-to-redisai.md
- kafka-to-redisbloom: connect/kafka-to-redisbloom.md
- kafka-to-redisgears: connect/kafka-to-redisgears.md
- kafka-to-redisgraph: connect/kafka-to-redisgraph.md
- kafka-to-redisinsight: connect/kafka-to-redisinsight.md
- kafka-to-redisjson: connect/kafka-to-redisjson.md
- kafka-to-redshift: connect/kafka-to-redshift.md
- kafka-to-ringcentral: connect/kafka-to-ringcentral.md
- kafka-to-rust: connect/kafka-to-rust.md
- kafka-to-salesforce: connect/kafka-to-salesforce.md
- kafka-to-sas: connect/kafka-to-sas.md
- kafka-to-scikit-learn: connect/kafka-to-scikit-learn.md
- kafka-to-seaborn: connect/kafka-to-seaborn.md
- kafka-to-segment: connect/kafka-to-segment.md
- kafka-to-sendgrid: connect/kafka-to-sendgrid.md
- kafka-to-shopify: connect/kafka-to-shopify.md
- kafka-to-slack: connect/kafka-to-slack.md
- kafka-to-snowflake: connect/kafka-to-snowflake.md
- kafka-to-spss: connect/kafka-to-spss.md
- kafka-to-sqlite: connect/kafka-to-sqlite.md
- kafka-to-supabase: connect/kafka-to-supabase.md
- kafka-to-tableau: connect/kafka-to-tableau.md
- kafka-to-talend: connect/kafka-to-talend.md
- kafka-to-tensorflow: connect/kafka-to-tensorflow.md
- kafka-to-terraform: connect/kafka-to-terraform.md
- kafka-to-trino: connect/kafka-to-trino.md
- kafka-to-twilio: connect/kafka-to-twilio.md
- kafka-to-vercel: connect/kafka-to-vercel.md
- kafka-to-vertica: connect/kafka-to-vertica.md
- kafka-to-vultr: connect/kafka-to-vultr.md
- kafka-to-wasabi: connect/kafka-to-wasabi.md
- kafka-to-webex: connect/kafka-to-webex.md
- kafka-to-webflow: connect/kafka-to-webflow.md
- kafka-to-weebly: connect/kafka-to-weebly.md
- kafka-to-woocommerce: connect/kafka-to-woocommerce.md
- kafka-to-wordpress: connect/kafka-to-wordpress.md
- kafka-to-wrike: connect/kafka-to-wrike.md
- kafka-to-xml-commons: connect/kafka-to-xml-commons.md
- kafka-to-xml-graphics: connect/kafka-to-xml-graphics.md
- kafka-to-xml-security: connect/kafka-to-xml-security.md
- kafka-to-xmlbeans: connect/kafka-to-xmlbeans.md
- kafka-to-zoho: connect/kafka-to-zoho.md
- kafka-to-zoom: connect/kafka-to-zoom.md
- 'Tutorials':
- 'Overview': 'tutorials/overview.md'
- 'Event detection and alerting featuring InfluxDB and PagerDuty':
- 'Overview': 'tutorials/influxdb-alerting/overview.md'
- '1. Write the Python client': 'tutorials/influxdb-alerting/python-client.md'
- '2. Add an external source': 'tutorials/influxdb-alerting/external-source.md'
- '3. Add InfluxDB destination': 'tutorials/influxdb-alerting/influxdb-destination.md'
- '4. Add threshold detection': 'tutorials/influxdb-alerting/threshold-detection.md'
- '5. Add PagerDuty alerting': 'tutorials/influxdb-alerting/add-alerting.md'
- '6. Summary': 'tutorials/influxdb-alerting/summary.md'
- 'Migrating InfluxDB v2 to v3':
- 'Overview': 'tutorials/influxdb-migration/overview.md'
- '1. Install InfluxDB v2': 'tutorials/influxdb-migration/influxdb-v2-install.md'
- '2. Create the project': 'tutorials/influxdb-migration/create-project.md'
- '3. Add InfluxDB v2 source': 'tutorials/influxdb-migration/influxdb-source.md'
- '4. Add InfluxDB v3 destination': 'tutorials/influxdb-migration/influxdb-destination.md'
- '5. Summary': 'tutorials/influxdb-migration/summary.md'
- 'Vector Store Embeddings': 'tutorials/ingest-embeddings/continuously_ingest_documents_into_a_vector_store_using_apache_kafka.md'
- 'Predictive maintenance':
- 'Overview': 'tutorials/predictive-maintenance/overview.md'
- '1. Get the project': 'tutorials/predictive-maintenance/get-project.md'
- '2. Data generator': 'tutorials/predictive-maintenance/data-generator.md'
- '3. Downsampling': 'tutorials/predictive-maintenance/downsampling.md'
- '4. Forecast': 'tutorials/predictive-maintenance/forecast-service.md'
- '5. Alerts': 'tutorials/predictive-maintenance/alert-service.md'
- '6. InfluxDB - raw data': 'tutorials/predictive-maintenance/influxdb-raw-data.md'
- '7. InfluxDB - alerts': 'tutorials/predictive-maintenance/influxdb-alerts.md'
# - '8. Printers dashboard': 'tutorials/predictive-maintenance/printers-dashboard.md'
# - '8. Lab: Add phone alerts': 'tutorials/predictive-maintenance/phone-alerts.md'
- '8. Summary': 'tutorials/predictive-maintenance/summary.md'
# - 'Clickstream analysis':
# - 'Overview': 'tutorials/clickstream/overview.md'
# - '1. Get the project': 'tutorials/clickstream/get-project.md'
# - '2. Clickstream producer': 'tutorials/clickstream/clickstream-producer.md'
# - '3. Data ingestion': 'tutorials/clickstream/data-ingestion.md'
# - '4. Data enrichment': 'tutorials/clickstream/data-enrichment.md'
# - '5. Data aggregation': 'tutorials/clickstream/data-aggregation.md'
# - '6. Event detection': 'tutorials/clickstream/event-detection.md'
# - '7. Webshop frontend': 'tutorials/clickstream/webshop-frontend.md'
# - '8. Real-time dashboard': 'tutorials/clickstream/realtime-dashboard.md'
# - '9. Lab: change offer': 'tutorials/clickstream/change-offer.md'
# - '10. Summary': 'tutorials/clickstream/summary.md'
# - 'Computer vision':
# - 'Overview': 'tutorials/computer-vision/overview.md'
# - '1. Get the project': tutorials/computer-vision/get-project.md
# - '2. TfL camera feed': tutorials/computer-vision/tfl-camera-feed.md
# - '3. Frame grabber': tutorials/computer-vision/tfl-frame-grabber.md
# - '4. Object detection': tutorials/computer-vision/object-detection.md
# - '5. Web UI': tutorials/computer-vision/web-ui.md
# - '6. Other services': tutorials/computer-vision/other-services.md
# - '7. Add service': tutorials/computer-vision/add-service.md
# - '8. Summary': tutorials/computer-vision/summary.md
# - 'Chat sentiment analysis':
# - 'Overview': 'tutorials/sentiment-analysis/overview.md'
# - '1. Get the project': tutorials/sentiment-analysis/get-project.md
# - '2. Try the UI': 'tutorials/sentiment-analysis/try-the-ui.md'
# - '3. UI service': 'tutorials/sentiment-analysis/ui-service.md'
# - '4. Sentiment analysis service': 'tutorials/sentiment-analysis/sentiment-analysis-service.md'
# - '5. Twitch service': 'tutorials/sentiment-analysis/twitch-service.md'
# - '6. Customize the UI': 'tutorials/sentiment-analysis/customize-the-ui.md'
# - '7. Summary': 'tutorials/sentiment-analysis/summary.md'
# - 'Real-time ML predictions':
# - 'Overview': 'tutorials/data-science/overview.md'
# - '1. Bicycle data': 'tutorials/data-science/1-bikedata.md'
# - '2. Weather data': 'tutorials/data-science/2-weatherdata.md'
# - '3. Data views': 'tutorials/data-science/3-data.md'
# - '4. Get training data': 'tutorials/data-science/4-train.md'
# - '5. Run the model': 'tutorials/data-science/5-run.md'
# - '6. Conclusion': 'tutorials/data-science/6-conclusion.md'
# - 'Real-time ML pipelines':
# - 'Overview': 'tutorials/train-and-deploy-ml/overview.md'
# - 'Create your data': 'tutorials/train-and-deploy-ml/create-data.md'
# - 'Import data into Jupyter': 'tutorials/train-and-deploy-ml/import-data.md'
# - 'Train your ML model': 'tutorials/train-and-deploy-ml/train-ml.md'
# - 'Deploy your ML model': 'tutorials/train-and-deploy-ml/deploy-ml.md'
# - 'Conclusion': 'tutorials/train-and-deploy-ml/conclusion.md'
# - 'Currency Alerting': 'tutorials/currency-alerting/currency-alerting.md'
#- 'MATLAB and Simulink': 'tutorials/matlab/matlab-and-simulink.md'
# These tutorials are commented out due to lack of updates / testing - warning has been added to overview
#- 'RSS Processing': 'tutorials/rss-tutorial/rss-processing-pipeline.md'
#- 'Data Stream Processing': 'tutorials/data-stream-processing/data-stream-processing.md'
#- 'Slack Alerting': 'tutorials/slack-alerting/slack-alerting.md'
# Pulling this one as apparently the app is no longer available in Google Store
#- 'Real-time event detection':
# - 'Overview': 'tutorials/event-detection/overview.md'
# - '1. Data acquisition': 'tutorials/event-detection/data-acquisition.md'
# - '2. Event detection': 'tutorials/event-detection/crash-detection.md'
# - '3. Demo UI': 'tutorials/event-detection/crash-detection-ui.md'
# - '4. Conclusion': 'tutorials/event-detection/conclusion.md'
- Blog Index:
- blog/index.md
# Exclude build scripts from v2.0+
exclude_docs: |
quix-streams/v2-0-latest/build/*
# Use custom hook to create redirects for 0.5 docs
hooks:
- hooks/redirect_0_5_urls.py
plugins:
- blog:
blog_toc: true
- multirepo:
cleanup: false
- include-markdown
- search:
separator: '[\s\-\.]'
- exclude-search:
exclude:
- connect/*
- social:
cards_layout_dir: layouts
cards_layout: quix
- glightbox
- redirects:
redirect_maps:
'index.md': 'get-started/welcome.md'
'contribute.md': 'kb/contribute.md'
'platform/changes.md': 'get-started/welcome.md'
'platform/ingest-data.md': 'develop/overview.md'
'platform/quickstart.md': 'quix-cloud/quickstart.md'
'platform/what-is-quix.md': 'kb/what-is-quix.md'
'platform/glossary.md': 'kb/glossary.md'
'platform/quixtour/overview.md': 'quix-cloud/quixtour/overview.md'
'platform/tutorials/index.md': 'tutorials/overview.md'
'platform/tutorials/computer-vision/index.md': 'tutorials/computer-vision/overview.md'
'platform/tutorials/computer-vision/get-project.md': 'tutorials/computer-vision/get-project.md'
'platform/tutorials/computer-vision/tfl-camera-feed.md': 'tutorials/computer-vision/tfl-camera-feed.md'
'platform/tutorials/computer-vision/tfl-frame-grabber.md': 'tutorials/computer-vision/tfl-frame-grabber.md'
'platform/tutorials/computer-vision/object-detection.md': 'tutorials/computer-vision/object-detection.md'
'platform/tutorials/computer-vision/web-ui.md': 'tutorials/computer-vision/web-ui.md'
'platform/tutorials/computer-vision/other-services.md': 'tutorials/computer-vision/other-services.md'
'platform/tutorials/computer-vision/add-service.md': 'tutorials/computer-vision/add-service.md'
'platform/tutorials/computer-vision/summary.md': 'tutorials/computer-vision/summary.md'
'platform/tutorials/currency-alerting/currency-alerting.md': 'tutorials/currency-alerting/currency-alerting.md'
'platform/tutorials/data-science/index.md': 'tutorials/data-science/overview.md'
'platform/tutorials/data-stream-processing/data-stream-processing.md': 'tutorials/data-stream-processing/data-stream-processing.md'
'platform/tutorials/event-detection/index.md': 'tutorials/event-detection/overview.md'
'platform/tutorials/matlab/matlab-and-simulink.md': 'tutorials/matlab/matlab-and-simulink.md'
'platform/tutorials/nocode-sentiment/nocode-sentiment-analysis.md': 'tutorials/sentiment-analysis/overview.md'
'platform/tutorials/rss-tutorial/rss-processing-pipeline.md': 'tutorials/rss-tutorial/rss-processing-pipeline.md'
'platform/tutorials/sentiment-analysis/index.md': 'tutorials/sentiment-analysis/overview.md'
'platform/tutorials/sentiment-analysis/get-project.md': 'tutorials/sentiment-analysis/get-project.md'
'platform/tutorials/sentiment-analysis/try-the-ui.md': 'tutorials/sentiment-analysis/try-the-ui.md'
'platform/tutorials/sentiment-analysis/sentiment-analysis-service.md': 'tutorials/sentiment-analysis/sentiment-analysis-service.md'
'platform/tutorials/sentiment-analysis/twitch-service.md': 'tutorials/sentiment-analysis/twitch-service.md'
'platform/tutorials/sentiment-analysis/customize-the-ui.md': 'tutorials/sentiment-analysis/customize-the-ui.md'
'platform/tutorials/sentiment-analysis/summary.md': 'tutorials/sentiment-analysis/summary.md'
'platform/tutorials/slack-alerting/slack-alerting.md': 'tutorials/slack-alerting/slack-alerting.md'
'platform/tutorials/train-and-deploy-ml/index.md': 'tutorials/train-and-deploy-ml/overview.md'
'apis/streaming-writer-api/index.md': 'apis/streaming-writer-api/overview.md'
'apis/streaming-reader-api/index.md': 'apis/streaming-reader-api/overview.md'
'apis/portal-api/index.md': 'apis/portal-api/overview.md'
'apis/query-api/index.md': 'apis/query-api/overview.md'
'platform/connectors/index.md': 'connectors/index.md'
'connectors/index.md': 'quix-connectors/templates/index.md'
'connectors/confluentkafkasource-source.md': 'quix-connectors/templates/confluentkafkasource-source.md'
'connectors/environmentsource-source.md': 'quix-connectors/templates/environmentsource-source.md'
'connectors/influxdb20source-source.md': 'quix-connectors/templates/influxdb20source-source.md'
'connectors/influxdb30source-source.md': 'quix-connectors/templates/influxdb30source-source.md'
'connectors/kafkaconnectsource-source.md': 'quix-connectors/templates/kafkaconnectsource-source.md'
'connectors/mqttsource-source.md': 'quix-connectors/templates/mqttsource-source.md'
'connectors/postgrescdcsource-source.md': 'quix-connectors/templates/postgrescdcsource-source.md'
'connectors/redissource-source.md': 'quix-connectors/templates/redissource-source.md'
'connectors/sqlchangedatacapturesource-source.md': 'quix-connectors/templates/sqlchangedatacapturesource-source.md'
'connectors/segmentsource-source.md': 'quix-connectors/templates/segmentsource-source.md'
'connectors/snowplowsource-source.md': 'quix-connectors/templates/snowplowsource-source.md'
'connectors/awss3icebergsink-destination.md': 'quix-connectors/templates/awss3icebergsink-destination.md'
'connectors/bigquerysink-destination.md': 'quix-connectors/templates/bigquerysink-destination.md'
'connectors/confluentkafkasink-destination.md': 'quix-connectors/templates/confluentkafkasink-destination.md'
'connectors/influxdb30sink-destination.md': 'quix-connectors/templates/influxdb30sink-destination.md'
'connectors/kafkaconnectsink-destination.md': 'quix-connectors/templates/kafkaconnectsink-destination.md'
'connectors/mqttsink-destination.md': 'quix-connectors/templates/mqttsink-destination.md'
'connectors/redissink-destination.md': 'quix-connectors/templates/redissink-destination.md'
'connectors/slacksink-destination.md': 'quix-connectors/templates/slacksink-destination.md'
'connectors/websocketdestination-destination.md': 'quix-connectors/templates/websocketdestination-destination.md'
'platform/how-to/personal-access-token-pat.md': 'develop/authentication/personal-access-token.md'
'platform/how-to/replay.md': 'manage/replay.md'
'platform/how-to/create-project.md': 'create/create-project.md'
'client-library-intro.md': 'quix-streams/introduction.md'
'quix-streams/client-library-intro.md': 'quix-streams/introduction.md'
'quix-streams-intro.md': 'quix-streams/introduction.md'
'quix-streams/quix-streams-intro.md': 'quix-streams/introduction.md'
'integrations/influxdb/overview.md': 'integrations/databases/influxdb/overview.md'
'integrations/influxdb/quickstart.md': 'integrations/databases/influxdb/quickstart.md'
'integrations/influxdb/telegraf.md': 'integrations/databases/influxdb/telegraf.md'
'integrations/influxdb/replacing-flux.md': 'integrations/databases/influxdb/replacing-flux.md'
'platform/how-to/use-sdk-token.md': 'develop/authentication/streaming-token.md'
'get-started/quixtour/ingest-push.md': 'quix-cloud/quixtour/external-source.md'
'get-started/quickstart.md': 'quix-cloud/quickstart.md'
'get-started/quixtour/overview.md': 'quix-cloud/quixtour/overview.md'
'get-started/quixtour/external-source.md': 'quix-cloud/quixtour/external-source.md'
'get-started/quixtour/process-threshold.md': 'quix-cloud/quixtour/process-threshold.md'
'get-started/quixtour/serve-sms.md': 'quix-cloud/quixtour/serve-sms.md'
'get-started/what-is-quix.md': 'kb/what-is-quix.md'
'get-started/why-stream-processing.md': 'kb/why-stream-processing.md'
'get-started/what-is-kafka.md': 'kb/what-is-kafka.md'
'get-started/glossary.md': 'kb/glossary.md'
'get-started/contribute.md': 'kb/contribute.md'
'get-started/build-cli.md' : 'cli/cli-quickstart.md'
'get-started/cli-quickstart.md' : 'cli/cli-quickstart.md'
'cli/cli-build-pipeline.md' : 'cli/cli-quickstart.md'
'get-started/install.md': 'get-started/quix-start.md'
'cli/cli-quickstart.md' : 'quix-cli/cli-quickstart.md'
'cli/overview.md' : 'quix-cli/overview.md'
'cli/cli-reference.md' : 'quix-cli/overview.md'
'platform/security/security.md': 'quix-cloud/security.md'
quix-streams/connectors/sources/file-source.md: quix-streams/connectors/sources/local-file-source.md
'quix-connectors/quix-streams/sources/coming-soon/AzureBlobStorage-source.md': 'quix-streams/connectors/sources/microsoft-azure-file-source.md'
'quix-connectors/quix-streams/sinks/coming-soon/AzureBlobStorage-sink.md': 'quix-streams/connectors/sinks/microsoft-azure-file-sink.md'
theme:
name: 'material'
custom_dir: overrides
# features:
# TODO
#custom_dir: 'theme'
favicon: 'assets/favicon.ico'
logo: 'assets/Quix-Docs-Negative-RGB.png'
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue grey
accent: blue
toggle:
icon: material/weather-night
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
accent: light blue
toggle:
icon: material/weather-sunny
name: Switch to light mode
features:
- content.code.copy
- navigation.instant # Instant loading pages.
- navigation.sections # Render top sections as groups.
- navigation.top # Adds a "Back to top" that is shown when scrolling up.
- navigation.tracking # Updates the url with highlighted section anchor.
- navigation.indexes # Documents can be directly attached to sections
- search.highlight # Search will highlight the searched word(s) on the page.*
- search.share # Adds an option to share a search query link.*
- search.suggest # Search will suggest the likeliest completion for a word.*
- content.tabs.link
- content.code.annotate # code annotations
- content.action.view # view page source
icon:
logo: 'material/library'
repo: 'material/github'
extra_css:
- stylesheets/extra.css
extra_javascript:
- javascripts/quix.js
- javascripts/feedback.js
- javascripts/runllm-widget.js
extra:
social:
- icon: 'fontawesome/brands/github'
link: 'https://github.com/quixio/quix-docs'
- icon: 'fontawesome/brands/slack'
link: 'https://quix.io/community'
- icon: 'fontawesome/brands/twitter'
link: 'https://twitter.com/quix_io'
- icon: 'fontawesome/brands/youtube'
link: 'https://www.youtube.com/channel/UCrijXvbQg67m9-le28c7rPA'
analytics:
provider: google-tag-manager
property: GTM-55L66N3
posthog:
host: https://eu.posthog.com
key: phc_UyQcafs2J7OUQEwJrmejeb0vCIdA9i9vYz66suPshix
hotjar:
id: 2437577
consent:
title: Cookie consent
description: >-
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.
cookies:
analytics:
name: Google Analytics
checked: true
posthog: Posthog
#alternate:
markdown_extensions:
- attr_list
- md_in_html
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- admonition
- footnotes
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.details:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format