-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Revert commits which broke the docs (#501)
* Revert "Make doc links point to GH repo (#496)" This reverts commit 0371a08. * Revert "DOCS-127 - Add KSQL doc to CP (#472)" This reverts commit c488125.
- Loading branch information
Showing
30 changed files
with
1,680 additions
and
3,664 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,32 @@ | ||
# KSQL Documentation | ||
|
||
The KSQL documentation is available on the Confluent Platform documentation site at [docs.confluent.io](https://docs.confluent.io/current/ksql/docs/index.html). | ||
| Overview |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo#clickstream-analysis) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | | ||
|---|----|-----|----|----|----|----|----| | ||
|
||
> *Important: This release is a **developer preview** and is free and open-source from Confluent under the Apache 2.0 license. Do not run KSQL against a production cluster.* | ||
# Overview | ||
KSQL is an open source streaming SQL engine that implements continuous, interactive queries against Apache Kafka™. It allows you to query, read, write, and process data in Apache Kafka in real-time, at scale using SQL commands. KSQL interacts directly with the [Kafka Streams API](https://kafka.apache.org/documentation/streams/), removing the requirement of building a Java app. | ||
|
||
### Use cases | ||
Common KSQL use cases are: | ||
|
||
- Fraud detection - identify and act on out of the ordinary data to provide real-time awareness. | ||
- Personalization - create real-time experiences and insight for end users driven by data. | ||
- Notifications - build custom alerts and messages based on real-time data. | ||
- Real-time Analytics - power real-time dashboards to understand what’s happening as it does. | ||
- Sensor data and IoT - understand and deliver sensor data how and where it needs to be. | ||
- Customer 360 - provide a clear, real-time understanding of your customers across every interaction. | ||
|
||
KSQL lowers the barriers for using real-time data in your applications. It is powered by a scalable streaming platform without the learning curve or additional management complexity of other stream processing solutions. | ||
|
||
## Modes of operation | ||
|
||
You can use KSQL in standalone, client-server, application, and embedded modes. See [Concepts](/docs/concepts.md#concepts) for more information. | ||
|
||
## Getting Started | ||
|
||
* Beginners: Try the [interactive quick start](/docs/quickstart#quick-start). The quick start configures a single instance in a lightweight Docker container or in a Kafka cluster. It demonstrates a simple workflow using KSQL to write streaming queries against data in Kafka. | ||
* Advanced users: Try the [end-to-end Clickstream Analysis demo](/ksql-clickstream-demo#clickstream-analysis). | ||
|
||
# Contributing | ||
|
||
This documentation is built using [Sphinx](http://sphinx-doc.org). For information on how to contribute, see the [contributing guidelines](contributing.md). |
Oops, something went wrong.