From fb82a310b10475743fbcb40ee8a67d75e51fe86a Mon Sep 17 00:00:00 2001 From: Joel Hamill Date: Fri, 25 Aug 2017 11:34:46 -0700 Subject: [PATCH 01/16] Doc feedback rollup --- README.md | 14 +-- docs/README.md | 2 +- docs/concepts.md | 16 +-- docs/demo.md | 4 +- docs/examples.md | 4 +- docs/faq.md | 30 ++++- docs/quickstart/README.md | 9 +- docs/quickstart/quickstart-docker.md | 2 +- docs/quickstart/quickstart-non-docker.md | 2 +- docs/roadmap.md | 2 +- docs/syntax-reference.md | 116 ++++++++++++++++-- ksql-clickstream-demo/README.md | 4 +- ksql-clickstream-demo/docker-clickstream.md | 68 +++++----- .../non-docker-clickstream.md | 12 +- 14 files changed, 202 insertions(+), 83 deletions(-) diff --git a/README.md b/README.md index 6d4fcd2286ec..1e2bec4bd1ee 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,14 @@ -# ![KSQL rocket](ksq-lrocket.png) KSQL - Streaming SQL for Apache Kafka +# ![KSQL rocket](ksq-lrocket.png) KSQL - Open Source Streaming SQL for Apache Kafka > *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.* KSQL lowers the entry bar to the world of stream processing by providing you with a simple and completely interactive SQL interface with which you can process your data in Kafka most easily. No longer do you need to write code in a programming language such as Java or Python! KSQL is open-source (Apache 2.0 licensed), distributed, scalable, reliable, and real-time. It supports a wide range of powerful stream processing operations including aggregations, joins, windowing, sessionization, and much more. -- [Quick Start](#quick-start) -- [Documentation](#documentation) -- [Join the Community](#join-the-community) -- [Contributing](#contributing) -- [License](#license) - # Quick Start -If you are ready to see the power of KSQL, try the [KSQL Quick Start](/docs/quickstart#quick-start)! -It demonstrates a simple workflow using KSQL to write streaming queries against data in Kafka. +If you are ready to see the power of KSQL, try out these: + +- [KSQL Quick Start](/docs/quickstart#quick-start), which demonstrates a simple workflow using KSQL to write streaming queries against data in Kafka. +- [Clickstream Analysis Demo](/ksql-examples/examples/clickstream-analysis#clickstream-analysis), which shows how to build an application that performs real-time user analytics. # Documentation You can [find the KSQL documentation here](/docs/). diff --git a/docs/README.md b/docs/README.md index ae5d1e314792..4099c662e7ea 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # KSQL Documentation -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | [Demo](/ksql-clickstream-demo/) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [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.* diff --git a/docs/concepts.md b/docs/concepts.md index cb3858c44159..1fced5c46092 100644 --- a/docs/concepts.md +++ b/docs/concepts.md @@ -1,6 +1,6 @@ # Concepts -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | Concepts | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | [Demo](/ksql-clickstream-demo/) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | Concepts | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| @@ -47,13 +47,13 @@ Here's an overview of running KSQL in standalone mode: - Use with default settings: ```bash - .bin/ksql-cli local + ./bin/ksql-cli local ``` - Use with custom settings: ```bash - .bin/ksql-cli local --properties-file foo/bar/ksql.properties + ./bin/ksql-cli local --properties-file foo/bar/ksql.properties ``` ## Client-server mode @@ -67,18 +67,18 @@ Here's an overview of running KSQL in client-server mode: - Use with default settings: ```bash - .bin/ksql-server-start + ./bin/ksql-server-start ``` - Use with custom settings: ```bash - .bin/ksql-server-start --properties-file foo.properties + ./bin/ksql-server-start --properties-file foo.properties ``` - Start any number of CLIs, specifying a server address as `remote` endpoint ```bash - .bin/ksql-cli remote http://server:8090 + ./bin/ksql-cli remote http://server:8090 ``` - All engines share the work, for example, instances of the same KSQL apps. You can scale up or down without restarting. @@ -94,12 +94,12 @@ Here's an overview of running KSQL in application mode: - Start an engine instance and pass a file of KSQL statements to run, for example: ```bash - .bin/ksql-node --query-file=foo/bar.sql + ./bin/ksql-node --query-file=foo/bar.sql ``` or ```bash - .bin/ksql-node --properties-file ksql.properties --query-file=foo/bar.sql + ./bin/ksql-node --properties-file ksql.properties --query-file=foo/bar.sql ``` - This mode is ideal for streaming-ETL application deployment, for example, you can version-control your queries as code. - All engines share the work, for example, instances of the same KSQL app. You can scale up or down without restarting. diff --git a/docs/demo.md b/docs/demo.md index 6405848caa07..ae0b162fbf8b 100644 --- a/docs/demo.md +++ b/docs/demo.md @@ -1,12 +1,12 @@ # Demo -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | Demo | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |Demo | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| ## Clickstream Analysis -This demo shows how to build an application that performs real-time analytics of users about which pages a website visitor visits and in what order. +This demo shows how to build an application that performs real-time user analytics about which pages they visit and in what order. - [Get started now!](/ksql-examples/examples/clickstream-analysis#clickstream-analysis) diff --git a/docs/examples.md b/docs/examples.md index 9ce4629676a4..712499b3141d 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -1,6 +1,6 @@ # Examples -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) | Examples | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | [Demo](/ksql-clickstream-demo/) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | Examples | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| @@ -189,7 +189,7 @@ GROUP BY regionid; ``` The following queries show how to access array items and map values in KSQL. The 'interest' -column in the user table is an array of string with size two that represents the first and second +column in the user table is an array of string that represents the interest of each user. The contactinfo column is a string to string map that represents the following contact information for each user: phone, city, state and zipcode. The following query will create a new stream from pageview_enriched that includes the first interrest of each diff --git a/docs/faq.md b/docs/faq.md index b48ea4065e0a..77100cbcf811 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,6 +1,6 @@ # Frequently Asked Questions -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) | [Examples](/docs/examples.md#examples) | FAQ | [Roadmap](/docs/roadmap.md#roadmap) | [Demo](/ksql-clickstream-demo/) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | FAQ | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| @@ -49,3 +49,31 @@ _Support for Apache Avro is expected soon._ **Is KSQL fully compliant to ANSI SQL?** KSQL is a dialect inspired by ANSI SQL. It has some differences because it is geared at processing streaming data. For example, ANSI SQL has no notion of “windowing” for use cases such as performing aggregations on data grouped into 5-minute windows, which is a commonly required functionality in the streaming world. + +**How do I shutdown a KSQL environment?** + +- To stop DataGen tasks that were started with the `-daemon` flag. + + ``` + % jps | grep DataGen + 25379 DataGen + % kill 25379 + ``` + +- Exit KSQL. + + ``` + ksql> exit + ``` + +- Stop confluent platform. + + ``` + % confluent stop + ``` + +- To remove all data, topics and streams by shutting down all processes. + + ``` + % confluent destroy + ``` diff --git a/docs/quickstart/README.md b/docs/quickstart/README.md index 6e7f4d07df0a..83f9501c795c 100644 --- a/docs/quickstart/README.md +++ b/docs/quickstart/README.md @@ -1,6 +1,6 @@ # Quick Start -| [Overview](/docs/) | Quick Start | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | [Demo](/ksql-clickstream-demo/) | +| [Overview](/docs/) | Quick Start | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| Welcome to the quick start for KSQL! @@ -18,6 +18,8 @@ The goal of this quick start is to demonstrate a simple workflow using KSQL to w Because KSQL queries data in a Kafka cluster, you will need to bring up a Kafka cluster, including ZooKeeper and a Kafka broker. Do not run KSQL against a production Kafka cluster while KSQL is in developer preview. +**Important:** The + 1. Bring up a Kafka cluster and start KSQL. * [Follow these instructions if you are using Docker](/docs/quickstart/quickstart-docker.md#docker-setup-for-ksql) (we recommend Docker for simplicity) @@ -213,7 +215,7 @@ This KSQL quick start shows examples querying data from Kafka topics called `pag 1. From the output of `SHOW QUERIES;` identify a query ID you would like to terminate. For example, if you wish to terminate query ID `2`: ```bash - ksql> terminate 2; + ksql> TERMINATE 2; ``` 2. To exit from KSQL, type 'exit'. @@ -237,3 +239,6 @@ If you are running the Confluent Platform, you can stop it with this command. ``` confluent stop ``` + +## Next steps +Try the end-to-end [Clickstream Analysis demo](/ksql-examples/examples/clickstream-analysis#clickstream-analysis), which shows how to build an application that performs real-time user analytics. diff --git a/docs/quickstart/quickstart-docker.md b/docs/quickstart/quickstart-docker.md index 20ccf1067b76..9d195687d0b5 100644 --- a/docs/quickstart/quickstart-docker.md +++ b/docs/quickstart/quickstart-docker.md @@ -1,6 +1,6 @@ # Docker Setup for KSQL -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | [Demo](/ksql-clickstream-demo/) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| This part of the quick start will guide you through the steps to setup a Kafka cluster and start KSQL for Docker environments. After you complete these steps, you can start using KSQL to query the Kafka cluster. diff --git a/docs/quickstart/quickstart-non-docker.md b/docs/quickstart/quickstart-non-docker.md index 356f3570d8c0..c4483ccf67fd 100644 --- a/docs/quickstart/quickstart-non-docker.md +++ b/docs/quickstart/quickstart-non-docker.md @@ -1,6 +1,6 @@ # Non-Docker Setup for KSQL -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | [Demo](/ksql-clickstream-demo/) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| This part of the quick start will guide you through the steps to setup a Kafka cluster and start KSQL for non-Docker environments. After you complete these steps, you can return to the [main Quick Start](/docs/quickstart#quick-start) and use KSQL to query the Kafka cluster. diff --git a/docs/roadmap.md b/docs/roadmap.md index a130c6cf975b..40048f340443 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -1,6 +1,6 @@ # Roadmap -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | Roadmap | [Demo](/ksql-clickstream-demo/) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | Roadmap | |---|----|-----|----|----|----|----|----| Coming soon. \ No newline at end of file diff --git a/docs/syntax-reference.md b/docs/syntax-reference.md index c5ddd60fb15d..213d8b233c3a 100644 --- a/docs/syntax-reference.md +++ b/docs/syntax-reference.md @@ -1,6 +1,6 @@ # Syntax Reference -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | Syntax Reference | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | [Demo](/ksql-clickstream-demo/) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | Syntax Reference | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| @@ -64,15 +64,27 @@ KSQL statements should be terminated with a semicolon (`;`). If desired, in the ### DESCRIBE + +**Synopsis** + ``` DESCRIBE (stream_name|table_name); ``` + +**Description** + List the columns in a stream or table along with their data type and other attributes. ### CREATE STREAM + +**Synopsis** + ``` CREATE STREAM stream_name ( { column_name data_type} [, ...] ) WITH ( property_name = expression [, ...] ); ``` + +**Description** + Create a new stream with the specified columns and properties. The supported column data types are BOOELAN, INTEGER, BIGINT, DOUBLE, VARCHAR (STRING), ARRAY (JSON only) and MAP (JSON only). @@ -94,10 +106,14 @@ Example: ### CREATE TABLE +**Synopsis** + ``` CREATE TABLE table_name ( { column_name data_type} [, ...] ) WITH ( property_name = expression [, ...] ); ``` +**Description** + Create a new KSQL table with the specified columns and properties. The supported column data types are BOOELAN, INTEGER, BIGINT, DOUBLE, VARCHAR (STRING), ARRAY (JSON only) and MAP (JSON only). In addition to the defined columns in the statement, KSQL adds two implicit columns to every table, ROWKEY and ROWTIME, which represent the corresponding Kafka message key and message timestamp. @@ -117,7 +133,7 @@ Example: ### CREATE STREAM AS SELECT -Create a new KSQL stream along with the corresponding Kafka topic and stream the result of the SELECT query into the topic. +**Synopsis** ```sql CREATE STREAM `stream_name` @@ -125,9 +141,13 @@ CREATE STREAM `stream_name` AS SELECT `select_expr` [, ...] FROM `from_item` [, ...] [ WHERE `condition` ] -[PARTITION BY `column_name`] +[PARTITION BY `column_name`]; ``` +**Description** + +Create a new KSQL stream along with the corresponding Kafka topic and stream the result of the SELECT query into the topic. + You can use the WITH section to set the properties for the result KSQL stream. The properties that can be set are: @@ -145,8 +165,7 @@ You can use the WITH section to set the properties for the result KSQL stream. T ### CREATE TABLE AS SELECT -Create a new KSQL table along with the corresponding Kafka topic and stream the result of the -SELECT query as a changelog into the topic. +**Synopsis** ``` CREATE TABLE `stream_name` @@ -156,8 +175,12 @@ FROM `from_item` [, ...] [ WINDOW `window_expression` ] [ WHERE `condition` ] [ GROUP BY `grouping expression` ] -[ HAVING `having_expression` ] +[ HAVING `having_expression` ]; ``` +**Description** + +Create a new KSQL table along with the corresponding Kafka topic and stream the result of the +SELECT query as a changelog into the topic. The WITH section can be used to set the properties for the result KSQL topic. The properties that can be set are as the following: @@ -170,21 +193,35 @@ The WITH section can be used to set the properties for the result KSQL topic. Th * REPLICATIONS: The replication factor for the sink stream. -### DROP STREAM +### DROP STREAM + +**Synopsis** + +``` +DROP STREAM "stream_name"; +``` + +**Description** Drops an existing stream. -### DROP TABLE +### DROP TABLE + +**Synopsis** + +``` +DROP TABLE "table_name"; +``` + +**Description** Drops an existing table. ### SELECT -Selects rows from a KSQL stream or table. The result of this statement will not be persisted in a - Kafka topic and will only be printed out in the console. To stop the continuous query in the CLI - press Ctrl+C. +**Synopsis** ``` SELECT `select_expr` [, ...] @@ -192,9 +229,15 @@ FROM `from_item` [, ...] [ WINDOW `window_expression` ] [ WHERE `condition` ] [ GROUP BY `grouping expression` ] -[ HAVING `having_expression` ] +[ HAVING `having_expression` ]; ``` +**Description** + +Selects rows from a KSQL stream or table. The result of this statement will not be persisted in a + Kafka topic and will only be printed out in the console. To stop the continuous query in the CLI + press `Ctrl+C`. + In the above statements `from_item` is one of the following: - `table_name [ [ AS ] alias]` @@ -232,6 +275,13 @@ The WINDOW clause is used to define a window for aggregate queries. KSQL support ``` #### CAST + +**Synopsis** + +``` +CAST ([(length)] expression AS data_type); +``` + You can cast an expression type in KSQL using CAST. Here is an example of converting a BIGINT into a VARCHAR type: @@ -241,25 +291,65 @@ SELECT pageid, CONCAT(CAST(count(*) AS VARCHAR), '__HI') from enrichedpv window ### SHOW | LIST TOPICS +**Synopsis** + +``` +SHOW | LIST TOPICS; +``` + +**Description** + The list of available topics in Kafka cluster. ### SHOW | LIST STREAMS +**Synopsis** + +``` +SHOW | LIST STREAMS; +``` + +**Description** + List the streams in KSQL. ### SHOW | LIST TABLES +**Synopsis** + +``` +SHOW | LIST TABLES; +``` + +**Description** + List the tables in KSQL. ### SHOW QUERIES +**Synopsis** + +``` +SHOW QUERIES; +``` + +**Description** + List the queries in KSQL. -### TERMINATE [QUERY] `query-id` +### TERMINATE + +**Synopsis** + +``` +TERMINATE query_id; +``` + +**Description** End a query. Queries will run continuously as KSQL applications until they are explicitly terminated. diff --git a/ksql-clickstream-demo/README.md b/ksql-clickstream-demo/README.md index 1229341f6244..9588bcf472c8 100644 --- a/ksql-clickstream-demo/README.md +++ b/ksql-clickstream-demo/README.md @@ -1,10 +1,10 @@ # Clickstream Analysis -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | Demo | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | Demo | |---|----|-----|----|----|----|----|----| ### Introduction -Clickstream analysis is the process of collecting, analyzing and reporting aggregate data about which pages a website visitor visits -- and in what order. The path the visitor takes though a website is called the clickstream. +Clickstream analysis is the process of collecting, analyzing, and reporting aggregate data about which pages a website visitor visits -- and in what order. The path the visitor takes though a website is called the clickstream. This application focuses on building real-time analytics of users to determine: * General website analytics, such as hit count & visitors diff --git a/ksql-clickstream-demo/docker-clickstream.md b/ksql-clickstream-demo/docker-clickstream.md index e9547500b2f6..6c4c69bec41d 100644 --- a/ksql-clickstream-demo/docker-clickstream.md +++ b/ksql-clickstream-demo/docker-clickstream.md @@ -1,6 +1,6 @@ # Clickstream Analysis using Docker -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | [Demo](/ksql-clickstream-demo/) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| These steps will guide you through how to setup your environment and run the clickstream analysis demo from a Docker container. For instructions without using Docker, see [this documentation](/ksql-clickstream-demo/non-docker-clickstream.md). @@ -69,6 +69,8 @@ These steps will guide you through how to setup your environment and run the cli 1. From your terminal, create the clickStream data using the ksql-datagen utility. This stream will run continuously until you terminate. + **Tip:** Because of shell redirection, this command does not print a newline and so it might look like it's still in the foreground. The process is running as a daemon, so just press return again to see the shell prompt. + ```bash $ ksql-datagen -daemon quickstart=clickstream format=json topic=clickstream maxInterval=100 iterations=500000 ``` @@ -81,8 +83,6 @@ These steps will guide you through how to setup your environment and run the cli 1. From your terminal, create the status codes using the ksql-datagen utility. This stream runs once to populate the table. - **Tip:** Because of shell redirection, the previous command does not print a newline and so it might look like it's still in the foreground. The process is running as a daemon, so just press return again to see the shell prompt. - ```bash $ ksql-datagen quickstart=clickstream_codes format=json topic=clickstream_codes maxInterval=20 iterations=100 ``` @@ -114,39 +114,39 @@ These steps will guide you through how to setup your environment and run the cli 1. Launch the KSQL CLI in local mode. + 1. Start the KSQL server. -1. Start the KSQL server. - - ```bash - $ ksql-server-start /etc/ksql/ksqlserver.properties > /tmp/ksql-logs/ksql-server.log 2>&1 & - ``` - -1. Start the CLI on port 8080. - - ```bash - $ ksql-cli remote http://localhost:8080 - ``` - - You should now be in the KSQL CLI. + ```bash + $ ksql-server-start /etc/ksql/ksqlserver.properties > /tmp/ksql-logs/ksql-server.log 2>&1 & + ``` - ```bash - ====================================== - = _ __ _____ ____ _ = - = | |/ // ____|/ __ \| | = - = | ' /| (___ | | | | | = - = | < \___ \| | | | | = - = | . \ ____) | |__| | |____ = - = |_|\_\_____/ \___\_\______| = - = = - = Streaming SQL Engine for Kafka = - Copyright 2017 Confluent Inc. + 1. Start the CLI on port 8080. - CLI v0.1, Server v0.1 located at http://localhost:9098 + ```bash + $ ksql-cli remote http://localhost:8080 + ``` - Having trouble? Type 'help' (case-insensitive) for a rundown of how things work! + You should now be in the KSQL CLI. - ksql> - ``` + ```bash + ====================================== + = _ __ _____ ____ _ = + = | |/ // ____|/ __ \| | = + = | ' /| (___ | | | | | = + = | < \___ \| | | | | = + = | . \ ____) | |__| | |____ = + = |_|\_\_____/ \___\_\______| = + = = + = Streaming SQL Engine for Kafka = + Copyright 2017 Confluent Inc. + + CLI v0.1, Server v0.1 located at http://localhost:9098 + + Having trouble? Type 'help' (case-insensitive) for a rundown of how things work! + + ksql> + ``` + 1. From the the KSQL CLI, load the `clickstream.sql` schema file that will run the demo app. **Important:** Before running this step, you must have already run ksql-datagen utility to create the clickstream data, status codes, and set of users. @@ -218,7 +218,7 @@ These steps will guide you through how to setup your environment and run the cli **View clickstream data** ```bash - ksql> select * from CLICKSTREAM LIMIT 5; + ksql> SELECT * FROM CLICKSTREAM LIMIT 5; ``` Your output should resemble: @@ -236,7 +236,7 @@ These steps will guide you through how to setup your environment and run the cli **View the events per minute** ```bash - ksql> select * from EVENTS_PER_MIN_TS LIMIT 5; + ksql> SELECT * FROM EVENTS_PER_MIN_TS LIMIT 5; ``` Your output should resemble: @@ -254,7 +254,7 @@ These steps will guide you through how to setup your environment and run the cli **View pages per minute** ```bash - ksql> select * from PAGES_PER_MIN LIMIT 5; + ksql> SELECT * FROM PAGES_PER_MIN LIMIT 5; ``` Your output should resemble: diff --git a/ksql-clickstream-demo/non-docker-clickstream.md b/ksql-clickstream-demo/non-docker-clickstream.md index 3742156b1f64..fca5ca6fb50d 100644 --- a/ksql-clickstream-demo/non-docker-clickstream.md +++ b/ksql-clickstream-demo/non-docker-clickstream.md @@ -1,5 +1,5 @@ # Clickstream Analysis -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | [Demo](/ksql-clickstream-demo/) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| These steps will guide you through how to setup your environment and run the clickstream analysis demo. For instructions using Docker, see [this documentation](/ksql-clickstream-demo/docker-clickstream.md). @@ -60,6 +60,8 @@ These steps will guide you through how to setup your environment and run the cli 1. From your terminal, create the clickStream data using the ksql-datagen utility. This stream will run continuously until you terminate. + **Tip:** Because of shell redirection, this command does not print a newline and so it might look like it's still in the foreground. The process is running as a daemon, so just press return again to see the shell prompt. + ```bash $ /bin/ksql-datagen -daemon quickstart=clickstream format=json topic=clickstream maxInterval=100 iterations=500000 ``` @@ -72,8 +74,6 @@ These steps will guide you through how to setup your environment and run the cli 1. From your terminal, create the status codes using the ksql-datagen utility. This stream runs once to populate the table. - **Tip:** Because of shell redirection, the previous command does not print a newline and so it mightlook like it's still in the foreground. The process is running as a daemon, so just press return again to see the shell prompt. - ```bash $ /bin/ksql-datagen quickstart=clickstream_codes format=json topic=clickstream_codes maxInterval=20 iterations=100 ``` @@ -202,7 +202,7 @@ These steps will guide you through how to setup your environment and run the cli **View clickstream data** ```bash - ksql> select * from CLICKSTREAM LIMIT 5; + ksql> SELECT * FROM CLICKSTREAM LIMIT 5; ``` Your output should resemble: @@ -220,7 +220,7 @@ These steps will guide you through how to setup your environment and run the cli **View the events per minute** ```bash - ksql> select * from EVENTS_PER_MIN_TS LIMIT 5; + ksql> SELECT * FROM EVENTS_PER_MIN_TS LIMIT 5; ``` Your output should resemble: @@ -238,7 +238,7 @@ These steps will guide you through how to setup your environment and run the cli **View pages per minute** ```bash - ksql> select * from PAGES_PER_MIN LIMIT 5; + ksql> SELECT * FROM PAGES_PER_MIN LIMIT 5; ``` Your output should resemble: From 9baa75a0d13fecbed67597efac964310167c4274 Mon Sep 17 00:00:00 2001 From: Joel Hamill Date: Fri, 25 Aug 2017 11:36:18 -0700 Subject: [PATCH 02/16] Backed off title change per Lu --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1e2bec4bd1ee..07651f51064e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# ![KSQL rocket](ksq-lrocket.png) KSQL - Open Source Streaming SQL for Apache Kafka +# ![KSQL rocket](ksq-lrocket.png) KSQL - Streaming SQL for Apache Kafka > *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.* From 93bc1cded44bd54ca58698abec68a1654dca646d Mon Sep 17 00:00:00 2001 From: Joel Hamill Date: Fri, 25 Aug 2017 11:37:43 -0700 Subject: [PATCH 03/16] More --- README.md | 2 ++ docs/quickstart/README.md | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 07651f51064e..e5061140c34b 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ KSQL lowers the entry bar to the world of stream processing by providing you with a simple and completely interactive SQL interface with which you can process your data in Kafka most easily. No longer do you need to write code in a programming language such as Java or Python! KSQL is open-source (Apache 2.0 licensed), distributed, scalable, reliable, and real-time. It supports a wide range of powerful stream processing operations including aggregations, joins, windowing, sessionization, and much more. + + # Quick Start If you are ready to see the power of KSQL, try out these: diff --git a/docs/quickstart/README.md b/docs/quickstart/README.md index 83f9501c795c..659915da9010 100644 --- a/docs/quickstart/README.md +++ b/docs/quickstart/README.md @@ -18,7 +18,7 @@ The goal of this quick start is to demonstrate a simple workflow using KSQL to w Because KSQL queries data in a Kafka cluster, you will need to bring up a Kafka cluster, including ZooKeeper and a Kafka broker. Do not run KSQL against a production Kafka cluster while KSQL is in developer preview. -**Important:** The + 1. Bring up a Kafka cluster and start KSQL. From a9431c07c4a8876ae54b150d497ac3b16d5e7ba6 Mon Sep 17 00:00:00 2001 From: Joel Hamill Date: Fri, 25 Aug 2017 11:40:36 -0700 Subject: [PATCH 04/16] Anchor --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e5061140c34b..a267589d6a60 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ If you are ready to see the power of KSQL, try out these: - [Clickstream Analysis Demo](/ksql-examples/examples/clickstream-analysis#clickstream-analysis), which shows how to build an application that performs real-time user analytics. # Documentation -You can [find the KSQL documentation here](/docs/). +You can [find the KSQL documentation here](/docs#ksql-documentation). # Join the Community Whether you need help, want to contribute, or are just looking for the latest news, you can find out how to [connect with your fellow Confluent community members here](https://www.confluent.io/contact-us-thank-you/). From 9f873d37d22f2261b30496640dcb28b1b55d638d Mon Sep 17 00:00:00 2001 From: Joel Hamill Date: Fri, 25 Aug 2017 11:42:14 -0700 Subject: [PATCH 05/16] Anchor --- ksql-clickstream-demo/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ksql-clickstream-demo/README.md b/ksql-clickstream-demo/README.md index 9588bcf472c8..8ea0fabe055a 100644 --- a/ksql-clickstream-demo/README.md +++ b/ksql-clickstream-demo/README.md @@ -1,6 +1,6 @@ # Clickstream Analysis -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | Demo | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| ### Introduction From 7de6fa83551816f7bfb9fbfcfcf150fe25f8cc0d Mon Sep 17 00:00:00 2001 From: Joel Hamill Date: Fri, 25 Aug 2017 11:43:04 -0700 Subject: [PATCH 06/16] link fix --- ksql-clickstream-demo/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ksql-clickstream-demo/README.md b/ksql-clickstream-demo/README.md index 8ea0fabe055a..8e0d74b8d6e5 100644 --- a/ksql-clickstream-demo/README.md +++ b/ksql-clickstream-demo/README.md @@ -1,6 +1,6 @@ # Clickstream Analysis -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) | Demo | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| ### Introduction From f1de8dc97a327d01974e52b095ed743e5296ca98 Mon Sep 17 00:00:00 2001 From: Joel Hamill Date: Fri, 25 Aug 2017 11:45:07 -0700 Subject: [PATCH 07/16] link fix --- docs/README.md | 2 +- docs/concepts.md | 2 +- docs/examples.md | 2 +- docs/faq.md | 2 +- docs/quickstart/README.md | 2 +- docs/quickstart/quickstart-docker.md | 2 +- docs/quickstart/quickstart-non-docker.md | 2 +- docs/roadmap.md | 2 +- ksql-clickstream-demo/docker-clickstream.md | 2 +- ksql-clickstream-demo/non-docker-clickstream.md | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/README.md b/docs/README.md index 4099c662e7ea..d0d02ae033a4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # KSQL Documentation -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#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.* diff --git a/docs/concepts.md b/docs/concepts.md index 1fced5c46092..12acebff0922 100644 --- a/docs/concepts.md +++ b/docs/concepts.md @@ -1,6 +1,6 @@ # Concepts -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | Concepts | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | Concepts | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| diff --git a/docs/examples.md b/docs/examples.md index 712499b3141d..4a2d2fc1ecac 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -1,6 +1,6 @@ # Examples -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | Examples | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | Examples | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| diff --git a/docs/faq.md b/docs/faq.md index 77100cbcf811..3213aba5dfc7 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,6 +1,6 @@ # Frequently Asked Questions -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | FAQ | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | [Examples](/docs/examples.md#examples) | FAQ | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| diff --git a/docs/quickstart/README.md b/docs/quickstart/README.md index 659915da9010..0a65977626a6 100644 --- a/docs/quickstart/README.md +++ b/docs/quickstart/README.md @@ -1,6 +1,6 @@ # Quick Start -| [Overview](/docs/) | Quick Start | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) | Quick Start | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| Welcome to the quick start for KSQL! diff --git a/docs/quickstart/quickstart-docker.md b/docs/quickstart/quickstart-docker.md index 9d195687d0b5..cf6ff4b39fd4 100644 --- a/docs/quickstart/quickstart-docker.md +++ b/docs/quickstart/quickstart-docker.md @@ -1,6 +1,6 @@ # Docker Setup for KSQL -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| This part of the quick start will guide you through the steps to setup a Kafka cluster and start KSQL for Docker environments. After you complete these steps, you can start using KSQL to query the Kafka cluster. diff --git a/docs/quickstart/quickstart-non-docker.md b/docs/quickstart/quickstart-non-docker.md index c4483ccf67fd..7c45d6d8f18f 100644 --- a/docs/quickstart/quickstart-non-docker.md +++ b/docs/quickstart/quickstart-non-docker.md @@ -1,6 +1,6 @@ # Non-Docker Setup for KSQL -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| This part of the quick start will guide you through the steps to setup a Kafka cluster and start KSQL for non-Docker environments. After you complete these steps, you can return to the [main Quick Start](/docs/quickstart#quick-start) and use KSQL to query the Kafka cluster. diff --git a/docs/roadmap.md b/docs/roadmap.md index 40048f340443..5c4909304eb4 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -1,6 +1,6 @@ # Roadmap -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | Roadmap | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | Roadmap | |---|----|-----|----|----|----|----|----| Coming soon. \ No newline at end of file diff --git a/ksql-clickstream-demo/docker-clickstream.md b/ksql-clickstream-demo/docker-clickstream.md index 6c4c69bec41d..e092a847dcb3 100644 --- a/ksql-clickstream-demo/docker-clickstream.md +++ b/ksql-clickstream-demo/docker-clickstream.md @@ -1,6 +1,6 @@ # Clickstream Analysis using Docker -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| These steps will guide you through how to setup your environment and run the clickstream analysis demo from a Docker container. For instructions without using Docker, see [this documentation](/ksql-clickstream-demo/non-docker-clickstream.md). diff --git a/ksql-clickstream-demo/non-docker-clickstream.md b/ksql-clickstream-demo/non-docker-clickstream.md index fca5ca6fb50d..bd9fdaf613b6 100644 --- a/ksql-clickstream-demo/non-docker-clickstream.md +++ b/ksql-clickstream-demo/non-docker-clickstream.md @@ -1,5 +1,5 @@ # Clickstream Analysis -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| These steps will guide you through how to setup your environment and run the clickstream analysis demo. For instructions using Docker, see [this documentation](/ksql-clickstream-demo/docker-clickstream.md). From 40986f3673f9e68967818b9c78d1dd06c00db11b Mon Sep 17 00:00:00 2001 From: Joel Hamill Date: Fri, 25 Aug 2017 11:49:24 -0700 Subject: [PATCH 08/16] More --- docs/README.md | 2 +- docs/concepts.md | 2 +- docs/examples.md | 2 +- docs/faq.md | 2 +- docs/quickstart/README.md | 6 +++--- docs/quickstart/quickstart-docker.md | 2 +- docs/quickstart/quickstart-non-docker.md | 2 +- docs/roadmap.md | 2 +- docs/syntax-reference.md | 2 +- ksql-clickstream-demo/docker-clickstream.md | 2 +- ksql-clickstream-demo/non-docker-clickstream.md | 2 +- 11 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/README.md b/docs/README.md index d0d02ae033a4..4099c662e7ea 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # KSQL Documentation -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [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.* diff --git a/docs/concepts.md b/docs/concepts.md index 12acebff0922..1fced5c46092 100644 --- a/docs/concepts.md +++ b/docs/concepts.md @@ -1,6 +1,6 @@ # Concepts -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | Concepts | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | Concepts | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| diff --git a/docs/examples.md b/docs/examples.md index 4a2d2fc1ecac..712499b3141d 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -1,6 +1,6 @@ # Examples -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | Examples | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | Examples | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| diff --git a/docs/faq.md b/docs/faq.md index 3213aba5dfc7..77100cbcf811 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,6 +1,6 @@ # Frequently Asked Questions -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | [Examples](/docs/examples.md#examples) | FAQ | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | FAQ | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| diff --git a/docs/quickstart/README.md b/docs/quickstart/README.md index 0a65977626a6..3f7d6fdd1886 100644 --- a/docs/quickstart/README.md +++ b/docs/quickstart/README.md @@ -1,12 +1,14 @@ # Quick Start -| [Overview](/docs/) | Quick Start | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) | Quick Start | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| Welcome to the quick start for KSQL! The goal of this quick start is to demonstrate a simple workflow using KSQL to write streaming queries against data in Kafka. +By default KSQL reads the topics for streams and tables from the latest offset. + **Table of Contents** - [Setup](#setup) @@ -18,8 +20,6 @@ The goal of this quick start is to demonstrate a simple workflow using KSQL to w Because KSQL queries data in a Kafka cluster, you will need to bring up a Kafka cluster, including ZooKeeper and a Kafka broker. Do not run KSQL against a production Kafka cluster while KSQL is in developer preview. - - 1. Bring up a Kafka cluster and start KSQL. * [Follow these instructions if you are using Docker](/docs/quickstart/quickstart-docker.md#docker-setup-for-ksql) (we recommend Docker for simplicity) diff --git a/docs/quickstart/quickstart-docker.md b/docs/quickstart/quickstart-docker.md index cf6ff4b39fd4..9d195687d0b5 100644 --- a/docs/quickstart/quickstart-docker.md +++ b/docs/quickstart/quickstart-docker.md @@ -1,6 +1,6 @@ # Docker Setup for KSQL -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| This part of the quick start will guide you through the steps to setup a Kafka cluster and start KSQL for Docker environments. After you complete these steps, you can start using KSQL to query the Kafka cluster. diff --git a/docs/quickstart/quickstart-non-docker.md b/docs/quickstart/quickstart-non-docker.md index 7c45d6d8f18f..c4483ccf67fd 100644 --- a/docs/quickstart/quickstart-non-docker.md +++ b/docs/quickstart/quickstart-non-docker.md @@ -1,6 +1,6 @@ # Non-Docker Setup for KSQL -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| This part of the quick start will guide you through the steps to setup a Kafka cluster and start KSQL for non-Docker environments. After you complete these steps, you can return to the [main Quick Start](/docs/quickstart#quick-start) and use KSQL to query the Kafka cluster. diff --git a/docs/roadmap.md b/docs/roadmap.md index 5c4909304eb4..40048f340443 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -1,6 +1,6 @@ # Roadmap -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | Roadmap | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | Roadmap | |---|----|-----|----|----|----|----|----| Coming soon. \ No newline at end of file diff --git a/docs/syntax-reference.md b/docs/syntax-reference.md index 213d8b233c3a..c8851e2f7de0 100644 --- a/docs/syntax-reference.md +++ b/docs/syntax-reference.md @@ -1,6 +1,6 @@ # Syntax Reference -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | Syntax Reference | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | Syntax Reference | [Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| diff --git a/ksql-clickstream-demo/docker-clickstream.md b/ksql-clickstream-demo/docker-clickstream.md index e092a847dcb3..6c4c69bec41d 100644 --- a/ksql-clickstream-demo/docker-clickstream.md +++ b/ksql-clickstream-demo/docker-clickstream.md @@ -1,6 +1,6 @@ # Clickstream Analysis using Docker -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| These steps will guide you through how to setup your environment and run the clickstream analysis demo from a Docker container. For instructions without using Docker, see [this documentation](/ksql-clickstream-demo/non-docker-clickstream.md). diff --git a/ksql-clickstream-demo/non-docker-clickstream.md b/ksql-clickstream-demo/non-docker-clickstream.md index bd9fdaf613b6..fca5ca6fb50d 100644 --- a/ksql-clickstream-demo/non-docker-clickstream.md +++ b/ksql-clickstream-demo/non-docker-clickstream.md @@ -1,5 +1,5 @@ # Clickstream Analysis -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/README.md#clickstream-analysis) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| These steps will guide you through how to setup your environment and run the clickstream analysis demo. For instructions using Docker, see [this documentation](/ksql-clickstream-demo/docker-clickstream.md). From aefd06d7d8e3827d7500df740455305d591b8913 Mon Sep 17 00:00:00 2001 From: Joel Hamill Date: Fri, 25 Aug 2017 13:10:47 -0700 Subject: [PATCH 09/16] Add default info --- docs/quickstart/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/quickstart/README.md b/docs/quickstart/README.md index 3f7d6fdd1886..e6b803849950 100644 --- a/docs/quickstart/README.md +++ b/docs/quickstart/README.md @@ -7,8 +7,6 @@ Welcome to the quick start for KSQL! The goal of this quick start is to demonstrate a simple workflow using KSQL to write streaming queries against data in Kafka. -By default KSQL reads the topics for streams and tables from the latest offset. - **Table of Contents** - [Setup](#setup) @@ -118,6 +116,8 @@ This KSQL quick start shows examples querying data from Kafka topics called `pag ## Write Queries +**Note:** By default KSQL reads the topics for streams and tables from the latest offset. + 1. Use `SELECT` to create a query that returns data from a STREAM. To stop viewing the data, press ``. You may optionally include the `LIMIT` keyword to limit the number of rows returned in the query result. Note that exact data output may vary because of the randomness of the data generation. ```bash From 31a0c2bc810034d336c3169be1679cebe7d969cf Mon Sep 17 00:00:00 2001 From: Joel Hamill Date: Fri, 25 Aug 2017 13:11:44 -0700 Subject: [PATCH 10/16] Add default info --- docs/examples.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/examples.md b/docs/examples.md index 712499b3141d..06d94423ed8f 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -1,6 +1,6 @@ # Examples -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | Examples | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[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 | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| From 9b722fc2778f4dec678abe261a4d88c1a21a30e6 Mon Sep 17 00:00:00 2001 From: Joel Hamill Date: Fri, 25 Aug 2017 13:12:51 -0700 Subject: [PATCH 11/16] Demo link --- docs/README.md | 2 +- docs/concepts.md | 2 +- docs/faq.md | 2 +- docs/quickstart/README.md | 2 +- docs/quickstart/quickstart-docker.md | 2 +- docs/quickstart/quickstart-non-docker.md | 2 +- docs/roadmap.md | 2 +- docs/syntax-reference.md | 2 +- ksql-clickstream-demo/docker-clickstream.md | 2 +- ksql-clickstream-demo/non-docker-clickstream.md | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/README.md b/docs/README.md index 4099c662e7ea..b5ce4c5670b0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # KSQL Documentation -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[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.* diff --git a/docs/concepts.md b/docs/concepts.md index 1fced5c46092..adda0cdd6ce9 100644 --- a/docs/concepts.md +++ b/docs/concepts.md @@ -1,6 +1,6 @@ # Concepts -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | Concepts | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | 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) | |---|----|-----|----|----|----|----|----| diff --git a/docs/faq.md b/docs/faq.md index 77100cbcf811..6f72cc8f5e93 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,6 +1,6 @@ # Frequently Asked Questions -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | FAQ | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[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 | [Roadmap](/docs/roadmap.md#roadmap) | |---|----|-----|----|----|----|----|----| diff --git a/docs/quickstart/README.md b/docs/quickstart/README.md index e6b803849950..3cc362a08f37 100644 --- a/docs/quickstart/README.md +++ b/docs/quickstart/README.md @@ -1,6 +1,6 @@ # Quick Start -| [Overview](/docs/) | Quick Start | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) | 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) | |---|----|-----|----|----|----|----|----| Welcome to the quick start for KSQL! diff --git a/docs/quickstart/quickstart-docker.md b/docs/quickstart/quickstart-docker.md index 9d195687d0b5..dbbccb1723a9 100644 --- a/docs/quickstart/quickstart-docker.md +++ b/docs/quickstart/quickstart-docker.md @@ -1,6 +1,6 @@ # Docker Setup for KSQL -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[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) | |---|----|-----|----|----|----|----|----| This part of the quick start will guide you through the steps to setup a Kafka cluster and start KSQL for Docker environments. After you complete these steps, you can start using KSQL to query the Kafka cluster. diff --git a/docs/quickstart/quickstart-non-docker.md b/docs/quickstart/quickstart-non-docker.md index c4483ccf67fd..905ea635563b 100644 --- a/docs/quickstart/quickstart-non-docker.md +++ b/docs/quickstart/quickstart-non-docker.md @@ -1,6 +1,6 @@ # Non-Docker Setup for KSQL -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[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) | |---|----|-----|----|----|----|----|----| This part of the quick start will guide you through the steps to setup a Kafka cluster and start KSQL for non-Docker environments. After you complete these steps, you can return to the [main Quick Start](/docs/quickstart#quick-start) and use KSQL to query the Kafka cluster. diff --git a/docs/roadmap.md b/docs/roadmap.md index 40048f340443..e2fb01ab469c 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -1,6 +1,6 @@ # Roadmap -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | Roadmap | +| [Overview](/docs/) |[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 | |---|----|-----|----|----|----|----|----| Coming soon. \ No newline at end of file diff --git a/docs/syntax-reference.md b/docs/syntax-reference.md index c8851e2f7de0..eb10489d3338 100644 --- a/docs/syntax-reference.md +++ b/docs/syntax-reference.md @@ -1,6 +1,6 @@ # Syntax Reference -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | Syntax Reference | [Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | 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) | |---|----|-----|----|----|----|----|----| diff --git a/ksql-clickstream-demo/docker-clickstream.md b/ksql-clickstream-demo/docker-clickstream.md index 6c4c69bec41d..5821b3eab547 100644 --- a/ksql-clickstream-demo/docker-clickstream.md +++ b/ksql-clickstream-demo/docker-clickstream.md @@ -1,6 +1,6 @@ # Clickstream Analysis using Docker -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[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) | |---|----|-----|----|----|----|----|----| These steps will guide you through how to setup your environment and run the clickstream analysis demo from a Docker container. For instructions without using Docker, see [this documentation](/ksql-clickstream-demo/non-docker-clickstream.md). diff --git a/ksql-clickstream-demo/non-docker-clickstream.md b/ksql-clickstream-demo/non-docker-clickstream.md index fca5ca6fb50d..63eb958ec126 100644 --- a/ksql-clickstream-demo/non-docker-clickstream.md +++ b/ksql-clickstream-demo/non-docker-clickstream.md @@ -1,5 +1,5 @@ # Clickstream Analysis -| [Overview](/docs/) |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo/) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +| [Overview](/docs/) |[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) | |---|----|-----|----|----|----|----|----| These steps will guide you through how to setup your environment and run the clickstream analysis demo. For instructions using Docker, see [this documentation](/ksql-clickstream-demo/docker-clickstream.md). From 013e0b6264583f89d3d9c0adfe9bdabcd68f7f71 Mon Sep 17 00:00:00 2001 From: Joel Hamill Date: Fri, 25 Aug 2017 13:14:16 -0700 Subject: [PATCH 12/16] Demo link --- ksql-clickstream-demo/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ksql-clickstream-demo/README.md b/ksql-clickstream-demo/README.md index 8e0d74b8d6e5..5e43884a02c3 100644 --- a/ksql-clickstream-demo/README.md +++ b/ksql-clickstream-demo/README.md @@ -16,5 +16,5 @@ This application focuses on building real-time analytics of users to determine: The application makes use of standard streaming functions (i.e. min, max, etc), as well as enrichment using child tables, table-stream joins and different types of windowing functionality. -- [Follow these instructions if you are using Docker](/ksql-clickstream-demo/docker-clickstream.md) -- [Follow these instructions if you are not using Docker](/ksql-clickstream-demo/non-docker-clickstream.md) \ No newline at end of file +- [Follow these instructions if you are using Docker](/ksql-clickstream-demo/docker-clickstream.md#clickstream-analysis-using-docker) +- [Follow these instructions if you are not using Docker](/ksql-clickstream-demo/non-docker-clickstream.md#clickstream-analysis) \ No newline at end of file From 430031909059051aa93a747ce0a8ca364ac6e40e Mon Sep 17 00:00:00 2001 From: Joel Hamill Date: Fri, 25 Aug 2017 13:33:00 -0700 Subject: [PATCH 13/16] link fix --- README.md | 2 +- docs/syntax-reference.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a267589d6a60..f276cc8060d3 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ KSQL lowers the entry bar to the world of stream processing by providing you wit If you are ready to see the power of KSQL, try out these: - [KSQL Quick Start](/docs/quickstart#quick-start), which demonstrates a simple workflow using KSQL to write streaming queries against data in Kafka. -- [Clickstream Analysis Demo](/ksql-examples/examples/clickstream-analysis#clickstream-analysis), which shows how to build an application that performs real-time user analytics. +- [Clickstream Analysis Demo](/ksql-clickstream-demo#clickstream-analysis), which shows how to build an application that performs real-time user analytics. # Documentation You can [find the KSQL documentation here](/docs#ksql-documentation). diff --git a/docs/syntax-reference.md b/docs/syntax-reference.md index c1770381c588..ec940cd9a546 100644 --- a/docs/syntax-reference.md +++ b/docs/syntax-reference.md @@ -218,7 +218,7 @@ The WITH section can be used to set the properties for the result KSQL topic. Th **Synopsis** ``` -DROP STREAM "stream_name"; +DROP STREAM stream_name; ``` **Description** @@ -231,7 +231,7 @@ Drops an existing stream. **Synopsis** ``` -DROP TABLE "table_name"; +DROP TABLE table_name; ``` **Description** From 256f536e72f72518e38bd94e2ecf777f66672fe9 Mon Sep 17 00:00:00 2001 From: Joel Hamill Date: Fri, 25 Aug 2017 13:45:08 -0700 Subject: [PATCH 14/16] Fix syntax formatting --- docs/syntax-reference.md | 42 ++++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/syntax-reference.md b/docs/syntax-reference.md index ec940cd9a546..f22a8ffd4c42 100644 --- a/docs/syntax-reference.md +++ b/docs/syntax-reference.md @@ -156,12 +156,12 @@ Example: **Synopsis** ```sql -CREATE STREAM `stream_name` -[WITH ( `property_name = expression` [, ...] )] -AS SELECT `select_expr` [, ...] -FROM `from_item` [, ...] -[ WHERE `condition` ] -[PARTITION BY `column_name`]; +CREATE STREAM stream_name +[WITH ( property_name = expression [, ...] )] +AS SELECT select_expr [, ...] +FROM from_item [, ...] +[ WHERE condition ] +[PARTITION BY column_name]; ``` **Description** @@ -188,14 +188,14 @@ You can use the WITH section to set the properties for the result KSQL stream. T **Synopsis** ``` -CREATE TABLE `stream_name` -[WITH ( `property_name = expression` [, ...] )] -AS SELECT `select_expr` [, ...] -FROM `from_item` [, ...] -[ WINDOW `window_expression` ] -[ WHERE `condition` ] -[ GROUP BY `grouping expression` ] -[ HAVING `having_expression` ]; +CREATE TABLE stream_name +[WITH ( property_name = expression [, ...] )] +AS SELECT select_expr [, ...] +FROM from_item [, ...] +[ WINDOW window_expression ] +[ WHERE condition ] +[ GROUP BY grouping expression ] +[ HAVING having_expression ]; ``` **Description** @@ -244,12 +244,12 @@ Drops an existing table. **Synopsis** ``` -SELECT `select_expr` [, ...] -FROM `from_item` [, ...] -[ WINDOW `window_expression` ] -[ WHERE `condition` ] -[ GROUP BY `grouping expression` ] -[ HAVING `having_expression` ]; +SELECT select_expr [, ...] +FROM from_item [, ...] +[ WINDOW window_expression ] +[ WHERE condition ] +[ GROUP BY grouping expression ] +[ HAVING having_expression ]; ``` **Description** @@ -258,7 +258,7 @@ Selects rows from a KSQL stream or table. The result of this statement will not Kafka topic and will only be printed out in the console. To stop the continuous query in the CLI press `Ctrl+C`. -In the above statements `from_item` is one of the following: +In the above statements from_item is one of the following: - `table_name [ [ AS ] alias]` From 7ca414c72a322c43582ecc14a2d6d4458749eee9 Mon Sep 17 00:00:00 2001 From: Joel Hamill Date: Fri, 25 Aug 2017 13:47:22 -0700 Subject: [PATCH 15/16] fix cast syntax --- docs/syntax-reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/syntax-reference.md b/docs/syntax-reference.md index f22a8ffd4c42..b7c38897f897 100644 --- a/docs/syntax-reference.md +++ b/docs/syntax-reference.md @@ -299,7 +299,7 @@ The WINDOW clause is used to define a window for aggregate queries. KSQL support **Synopsis** ``` -CAST ([(length)] expression AS data_type); +CAST (expression AS data_type); ``` You can cast an expression type in KSQL using CAST. Here is an example of converting a BIGINT From 0fd14cd2673c3f6a7635406be5d07265cb1a7632 Mon Sep 17 00:00:00 2001 From: Joel Hamill Date: Fri, 25 Aug 2017 14:41:36 -0700 Subject: [PATCH 16/16] Fix examples table --- docs/examples.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/examples.md b/docs/examples.md index 8c876bc6651f..adb35e464217 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -1,6 +1,7 @@ # Examples | [Overview](/docs/) |[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 | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) | +|---|----|-----|----|----|----|----|----| **Table of Contents**