Merge branch '6.2.x'

confluentinc · Mar 3, 2021 · 7007729 · 7007729
2 parents 65d0df1 + f5dc7cc
commit 7007729
Show file tree

Hide file tree

Showing 26 changed files with 223 additions and 11 deletions.
diff --git a/docs/concepts/functions.md b/docs/concepts/functions.md
@@ -1,6 +1,9 @@
 ---
 layout: page
-title: ksqlDB - User-defined functions
+title: User-defined functions 
+tagline: Create custom ksqlDB functions 
+description: ksqlDB lets you add new functions using Java hooks
+keywords: function, user-defined function, aggregation, table  
 ---
 
 # User-defined functions

diff --git a/docs/concepts/queries.md b/docs/concepts/queries.md
@@ -1,3 +1,11 @@
+---
+layout: page
+title: Queries
+tagline: Query streaming data
+description: Learn how to query streaming data in ksqlDB
+keywords: query, persistent, push, pull
+---
+
 There are three kinds of queries in ksqlDB: persistent, push, and pull.
 Each gives you different ways to work with rows of events.
 

diff --git a/docs/concepts/streams.md b/docs/concepts/streams.md
@@ -1,5 +1,20 @@
-A stream is a partitioned, immutable, append-only collection that represents a series of historical facts. For example, the rows of a stream could model a sequence of financial transactions, like "Alice sent $100 to Bob", followed by "Charlie sent $50 to Bob".
+---
+layout: page
+title: Streams 
+tagline: The stream concept in ksqlDB
+description: Summary of the stream concept in ksqlDB
+keywords: stream, partition, key
+---
 
-Once a row is inserted into a stream, it can never change. New rows can be appended at the end of the stream, but existing rows can never be updated or deleted.
+A stream is a partitioned, immutable, append-only collection that represents a
+series of historical facts. For example, the rows of a stream could model a
+sequence of financial transactions, like "Alice sent $100 to Bob", followed by
+"Charlie sent $50 to Bob".
 
-Each row is stored in a particular partition. Every row, implicitly or explicitly, has a key that represents its identity. All rows with the same key reside in the same partition.
+Once a row is inserted into a stream, it can never change. New rows can be
+appended at the end of the stream, but existing rows can never be updated or
+deleted.
+
+Each row is stored in a particular partition. Every row, implicitly or
+explicitly, has a key that represents its identity. All rows with the same key
+reside in the same partition.
diff --git a/docs/concepts/tables.md b/docs/concepts/tables.md
@@ -1,3 +1,18 @@
-A table is a mutable, partitioned collection that models change over time. In contrast with a stream, which represents a historical sequence of events, a table represents what is true as of "now". For example, you might use a table to model the locations where someone has lived as a stream: first Miami, then New York, then London, and so forth.
+---
+layout: page
+title: Tables 
+tagline: The table concept in ksqlDB
+description: Summary of the table concept in ksqlDB
+keywords: table, partition, key
+---
 
-Tables work by leveraging the keys of each row. If a sequence of rows shares a key, the last row for a given key represents the most up-to-date information for that key's identity. A background process periodically runs and deletes all but the newest rows for each key.
+A table is a mutable, partitioned collection that models change over time. In
+contrast with a stream, which represents a historical sequence of events, a
+table represents what is true as of "now". For example, you might use a table
+to model the locations where someone has lived as a stream: first Miami, then
+New York, then London, and so forth.
+
+Tables work by leveraging the keys of each row. If a sequence of rows shares a
+key, the last row for a given key represents the most up-to-date information
+for that key's identity. A background process periodically runs and deletes all
+but the newest rows for each key.
diff --git a/docs/developer-guide/ksqldb-reference/define.md b/docs/developer-guide/ksqldb-reference/define.md
@@ -1,3 +1,11 @@
+---
+layout: page
+title: DEFINE 
+tagline: ksqlDB DEFINE statement
+description: Syntax for the DEFINE statement in ksqlDB
+keywords: variable, substitution, define
+---
+
 # DEFINE
 
 ## Synopsis
@@ -23,6 +31,10 @@ All variable values must be enclosed into single-quotes. Single-quotes are remov
 
 There is no type declaration for a value.
 
+Use the [SHOW VARIABLES](/developer-guide/ksqldb-reference/show-variables) statement to see all variable definitions.
+
+Use the [UNDEFINE](/developer-guide/ksqldb-reference/undefine) statement to clear a variable definitions.
+
 ## Example
 
 ```sql

diff --git a/docs/developer-guide/ksqldb-reference/show-variables.md b/docs/developer-guide/ksqldb-reference/show-variables.md
@@ -1,9 +1,17 @@
+---
+layout: page
+title: SHOW VARIABLES 
+tagline: ksqlDB SHOW VARIABLES statement
+description: Syntax for the SHOW VARIABLES statement in ksqlDB
+keywords: variable, substitution, define
+---
+
 # SHOW VARIABLES
 
 ## Synopsis
 
 ```sql
-DEFINE VARIABLES;
+SHOW VARIABLES;
 ```
 
 ## Description

diff --git a/docs/developer-guide/ksqldb-reference/undefine.md b/docs/developer-guide/ksqldb-reference/undefine.md
@@ -1,3 +1,11 @@
+---
+layout: page
+title: UNDEFINE 
+tagline: ksqlDB UNDEFINE statement
+description: Syntax for the UNDEFINE statement in ksqlDB
+keywords: variable, substitution, define, undefine
+---
+
 # UNDEFINE
 
 ## Synopsis

diff --git a/docs/how-to-guides/control-the-case-of-identifiers.md b/docs/how-to-guides/control-the-case-of-identifiers.md
@@ -1,3 +1,11 @@
+---
+layout: page
+title: How to control the case of identifiers 
+tagline: Casing for ksqlDB stream name and column names
+description: Use backticks to control the casing of ksqlDB stream name and column names
+keywords: case, identifier
+---
+
 # How to control the case of identifiers
 
 ## Context

diff --git a/docs/how-to-guides/convert-changelog-to-table.md b/docs/how-to-guides/convert-changelog-to-table.md
@@ -1,3 +1,11 @@
+---
+layout: page
+title: How to convert a changelog to a table 
+tagline: Materialize a changelog stream into a table by using ksqlDB
+description: Use ksqlDB to create a view of a changelog that reflects only the last change for each key
+keywords: changelog, table, materialize
+---
+
 # How to convert a changelog to a table
 
 ## Context

diff --git a/docs/how-to-guides/create-a-user-defined-function.md b/docs/how-to-guides/create-a-user-defined-function.md
@@ -1,3 +1,11 @@
+---
+layout: page
+title: How to create a user-defined function 
+tagline: Create a custom ksqlDB function
+description: Extend ksqlDB to apply custom logic in your queries
+keywords: function, scalar, tabular, aggregation
+---
+
 # How to create a user-defined function
 
 ## Context

diff --git a/docs/how-to-guides/index.md b/docs/how-to-guides/index.md
@@ -1,3 +1,11 @@
+---
+layout: page
+title: How-to Guides 
+tagline: Frequently used ksqlDB patterns 
+description: Quick lessons that help you work with common ksqlDB functionality. 
+keywords: pattern, satructured data, changelog, connector, query, function, identifier, timestamp, variable
+---
+
 Follow compact lessons that help you work with common ksqlDB functionality.
 
 <div class="cards">

diff --git a/docs/how-to-guides/query-structured-data.md b/docs/how-to-guides/query-structured-data.md
@@ -1,3 +1,11 @@
+---
+layout: page
+title: How to query structured data 
+tagline: Query structs, maps, and arrays by using ksqlDB
+description: Read the inner contents of structs, maps, and arrays in ksqlDB queries 
+keywords: query, structured data, struct, array, map
+---
+
 # How to query structured data
 
 ## Context

diff --git a/docs/how-to-guides/substitute-variables.md b/docs/how-to-guides/substitute-variables.md
@@ -3,6 +3,7 @@ layout: page
 title: ksqlDB Variable Substitution
 tagline: Use variables in SQL statements
 description: Learn how to use variables in SQL statements
+keywords: variable, substitution, define
 ---
 
 ## Context

diff --git a/docs/how-to-guides/test-an-app.md b/docs/how-to-guides/test-an-app.md
@@ -3,6 +3,7 @@ layout: page
 title: ksqlDB Testing Tool
 tagline: Test your SQL statements in ksqlDB
 description: Test your SQL statements in ksqlDB without the need for a full Kafka cluster
+keywords: testing, qa, quality assurance, test runner
 ---
 
 # How to test an application

diff --git a/docs/how-to-guides/update-a-running-persistent-query.md b/docs/how-to-guides/update-a-running-persistent-query.md
@@ -1,3 +1,11 @@
+---
+layout: page
+title: How to update a running persistent query
+tagline: Upgrade a ksqlDB query
+description: Change a running ksqlDB query and start processing rows where the old version left off
+keywords: persistent query, upgrade
+---
+
 # How to update a running persistent query
 
 ## Context

diff --git a/docs/how-to-guides/use-a-custom-timestamp-column.md b/docs/how-to-guides/use-a-custom-timestamp-column.md
@@ -1,3 +1,11 @@
+---
+layout: page
+title: How to use a custom timestamp column
+tagline: Tell ksqlDB where to find the timestamp attribute within events
+description: Use the timestamp attribute within events to do time-related processing with ksqlDB
+keywords: timestamp, event time
+---
+
 # How to use a custom timestamp column
 
 ## Context

diff --git a/docs/how-to-guides/use-connector-management.md b/docs/how-to-guides/use-connector-management.md
@@ -1,3 +1,11 @@
+---
+layout: page
+title: How to use connector management
+tagline: Use connectors to get external data for ksqlDB apps
+description: Use SQL syntax to create connectors in your ksqlDB application 
+keywords: connector
+---
+
 # How to use connector management
 
 ## Context

diff --git a/docs/operate-and-deploy/logging.md b/docs/operate-and-deploy/logging.md
@@ -1,3 +1,11 @@
+---
+layout: page
+title: Logging
+tagline: Log debug output from ksqlDB
+description: Get DEBUG and INFO output from ksqlDB Server
+keywords: log, logging, appender
+---
+
 # Logging
 
 To get `DEBUG` or `INFO` output from ksqlDB Server, configure a {{ site.ak }}

diff --git a/docs/operate-and-deploy/monitoring.md b/docs/operate-and-deploy/monitoring.md
@@ -1,3 +1,11 @@
+---
+layout: page
+title: Monitoring
+tagline: Monitor ksqlDB
+description: Enable metrics monitoring on ksqlDB Server 
+keywords: metrics, monitor, jmx
+---
+
 # Monitoring
 
 ## Context

diff --git a/docs/operate-and-deploy/schema-registry-integration.md b/docs/operate-and-deploy/schema-registry-integration.md
@@ -1,3 +1,10 @@
+---
+layout: page
+title: Schema Inference
+tagline: ksqlDB and Confluent Schema Registry integration
+description: ksqlDB integrates with Confluent Schema Registry to read and write schemas as needed 
+keywords: serialization, schema, schema registry, json, avro, delimited
+---
 ## Schema Inference
 
 For supported [serialization formats](/reference/serialization),

diff --git a/docs/reference/metrics.md b/docs/reference/metrics.md
@@ -1,6 +1,13 @@
+---
+layout: page
+title: Metrics
+tagline: JMX metrics for monitoring ksqlDB
+description: ksqlDB has many JMX metrics to monitor what its servers are doing 
+keywords: metrics, jmx, monitor
+---
 # Metrics
 
-ksqlDB emits a variety of JMX metrics to help you understand
+ksqlDB emits a variety of JMX metrics to help you understand and
 [monitor](../operate-and-deploy/monitoring.md) what its servers are
 doing. This reference describes each metric and grouping.
 

diff --git a/docs/reference/sql/time.md b/docs/reference/sql/time.md
@@ -1,3 +1,11 @@
+---
+layout: page
+title: Time units and formats
+tagline: Valid time units and formats in ksqlDB
+description: Use built-in formats for time-based operations, like windowing, in ksqlDB
+keywords: time, datetime, timestamp, format, window
+---
+
 ### Time units
 
 The following list shows valid time units for the `SIZE`, `ADVANCE BY`,

diff --git a/docs/reference/user-defined-functions.md b/docs/reference/user-defined-functions.md
@@ -1,8 +1,23 @@
-[User-defined functions](/concepts/functions) let you extend ksqlDB's suite of built-in functions using Java hooks. This section is a reference for how they work. Use [the how-to guide](/how-to-guides/create-a-user-defined-function) to learn how to use them.
+---
+layout: page
+title: User-defined functions (UDFs) 
+tagline: Custom ksqlDB functions
+description: Extend ksqlDB's suite of built-in functions using Java hooks
+keywords: function, aggregation, table 
+---
+
+[User-defined functions](/concepts/functions) enable you to extend ksqlDB's
+suite of built-in functions using Java hooks. This section is a reference for
+how they work. Use [the how-to guide](/how-to-guides/create-a-user-defined-function)
+to learn how to use them.
 
 ## Data type mapping
 
-Because SQL has a type system that is independent from Java’s, user-defined functions (UDFs) need to use specific Java types so that ksqlDB can manage the correspondence from SQL to Java. Below is the mapping to use for all UDF parameters and return types. Use boxed types when you want to tolerate null values.
+Because SQL has a type system that is independent from Java’s, user-defined
+functions (UDFs) need to use specific Java types so that ksqlDB can manage
+the correspondence from SQL to Java. Below is the mapping to use for all UDF
+parameters and return types. Use boxed types when you want to tolerate null
+values.
 
 | SQL Type  | Java Type                             |
 |-----------|---------------------------------------|
@@ -12,7 +27,7 @@ Because SQL has a type system that is independent from Java’s, user-defined fu
 | `DOUBLE`  | `double`, `java.lang.Double`          |
 | `DECIMAL` | `java.math.BigDecimal`                |
 | `VARCHAR` | `java.lang.String`                    |
-|`TIMESTAMP`| `java.sql.Timestamp`                |
+|`TIMESTAMP`| `java.sql.Timestamp`                  |
 | `ARRAY`   | `java.util.List`                      |
 | `MAP`     | `java.util.Map`                       |
 | `STRUCT`  | `org.apache.kafka.connect.data.Struct`|

diff --git a/docs/tutorials/etl.md b/docs/tutorials/etl.md
@@ -1,3 +1,11 @@
+---
+layout: page
+title: Streaming ETL pipeline 
+tagline: Learn how to create a streaming ETL pipeline by using ksqlDB
+description: Use ksqlDB to create a streaming ETL pipeline that ingests and joins events together to create a cohesive view of orders that shipped
+keywords: etl, streaming data pipeline, join
+---
+
 # Streaming ETL pipeline
 
 ## What is it?

diff --git a/docs/tutorials/event-driven-microservice.md b/docs/tutorials/event-driven-microservice.md
@@ -1,3 +1,11 @@
+---
+layout: page
+title: Event-driven microservice 
+tagline: Learn how to create an event-driven microservice by using ksqlDB
+description: Use ksqlDB to create an event-driven microservice that identifies suspicious activity and notifies customers
+keywords: microservice
+---
+
 # Event-driven microservice
 
 ## What is it?

diff --git a/docs/tutorials/materialized.md b/docs/tutorials/materialized.md
@@ -1,3 +1,11 @@
+---
+layout: page
+title: Materialized cache 
+tagline: Learn how to create and query a set of materialized views by using ksqlDB
+description: Use ksqlDB to create and query a set of materialized views about phone calls made to the call center
+keywords: materialized view, cache, changelog
+---
+
 # Materialized cache
 
 ## What is it?