Skip to content

Commit

Permalink
[chore] Update KLIP readme (#9820)
Browse files Browse the repository at this point in the history
  • Loading branch information
mjsax authored Mar 8, 2023
1 parent b616839 commit d900cbd
Show file tree
Hide file tree
Showing 34 changed files with 133 additions and 139 deletions.
132 changes: 66 additions & 66 deletions design-proposals/README.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP 13 - Introduce KSQL command to print connect worker properties to the console

**Author**: alex-dukhno |
**Release Target**: N/A |
**Status**: _In Discussion_ |
**Release Target**: 0.8.0; 5.5.0 |
**Status**: _Merged_ |
**Discussion**: _link to the design discussion PR_

**tl;dr:** The best tools are ones that greatly support users workflow. As of today users couldn't
Expand Down
6 changes: 3 additions & 3 deletions design-proposals/klip-14-rowtime-as-pseudocolumn.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP 14 - ROWTIME as Pseudocolumn

**Author**: @big-andy-coates |
**Release Target**: TBD |
**Status**: Merged |
**Release Target**: 0.9.0; 6.0.0 |
**Status**: _Merged_ |
**Discussion**: https://github.com/confluentinc/ksql/pull/4026

**tl;dr:**
Expand Down Expand Up @@ -175,4 +175,4 @@ None.

### ROWTIME as a system function

Rejected as it won't work in joins, where the `ROWTIME` needs to be scoped to a specific source within the join.
Rejected as it won't work in joins, where the `ROWTIME` needs to be scoped to a specific source within the join.
2 changes: 1 addition & 1 deletion design-proposals/klip-2-produce-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Author**: agavra |
**Release Target**: 5.3 |
**Status**: Approved |
**Status**: _Merged_ |
**Discussion**: [#2693](https://github.com/confluentinc/ksql/pull/2693)

**tl;dr:** *Improve the interactivity of the development story by enabling CLI users to directly
Expand Down
4 changes: 2 additions & 2 deletions design-proposals/klip-23-primary-keys-for-tables.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP 23 - Use PRIMARY KEYs for tables

**Author**: @big-andy-coates |
**Release Target**: 0.9 |
**Status**: Merged |
**Release Target**: 0.9; 0.6.0 |
**Status**: _Merged_ |
**Discussion**: [Github PR](https://github.com/confluentinc/ksql/pull/5008)

**tl;dr:** In ksqlDB, Tables and Streams currently use the `KEY` keyword to identify columns that
Expand Down
4 changes: 2 additions & 2 deletions design-proposals/klip-24-key-column-semantics-in-queries.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP 24 - KEY column semantics in queries

**Author**: @big-andy-coates |
**Release Target**: 0.10.0 |
**Status**: In Discussion |
**Release Target**: 0.10.0; 6.0.0 |
**Status**: _Merged_ |
**Discussion**: [Github PR](https://github.com/confluentinc/ksql/pull/5115)

**tl;dr:** Persistent queries do not allow the key column in the projection as key columns are
Expand Down
4 changes: 2 additions & 2 deletions design-proposals/klip-25-removal-of-with-key-syntax.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP 25 - Removal of WITH(KEY) syntax

**Author**: @big-andy-coates |
**Release Target**: TBD |
**Status**: Accepted |
**Release Target**: 0.10.0; 6.0.0 |
**Status**: _Merged_ |
**Discussion**: [Github PR](https://github.com/confluentinc/ksql/pull/5117)

**tl;dr:** The `WITH(KEY)` syntax is the cause of much confusion and errors as it requires users to
Expand Down
4 changes: 2 additions & 2 deletions design-proposals/klip-26-java-client-interfaces.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP 26 - Java client interfaces

**Author**: Victoria Xia (@vcrfxia) |
**Release Target**: ksqlDB 0.10.0 |
**Status**: _In development_ |
**Release Target**: 0.10.0; 6.0.0 |
**Status**: _Merged_ |
**Discussion**: [GitHub PR](https://github.com/confluentinc/ksql/pull/5236)

**tl;dr:** _[KLIP 15](./klip-15-new-api-and-client.md) already made the case for why it makes sense
Expand Down
4 changes: 2 additions & 2 deletions design-proposals/klip-28-create-or-replace.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP 28 - Introduce CREATE OR REPLACE

**Author**: agavra |
**Release Target**: 0.11 |
**Status**: _Approved_ |
**Release Target**: 0.12.0; 6.1.0 |
**Status**: _Merged_ |
**Discussion**: _https://github.com/confluentinc/ksql/pull/5611_

**tl;dr:** _CREATE OR REPLACE is a mechanism geared toward enabling in-place ksqlDB query evolution._
Expand Down
6 changes: 3 additions & 3 deletions design-proposals/klip-29-explicit-keys.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP-29: Explicit Keys

**Author**: @big-andy-coates |
**Release Target**: 0.10.0 |
**Status**: Merged |
**Release Target**: 0.10.0; 6.0.0 |
**Status**: _Merged_ |
**Discussion**: [Github PR](https://github.com/confluentinc/ksql/pull/5530)

**tl;dr:** Up until now ksqlDB has added an implicit `ROWKEY STRING (PRIMARY) KEY` to a `CREATE TABLE`
Expand Down Expand Up @@ -159,4 +159,4 @@ use-case.

## Security Implications

None.
None.
4 changes: 2 additions & 2 deletions design-proposals/klip-30-lambda-functions.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP-30 - Lambda Expressions

**Authors**: derekjn, blueedgenick |
**Release Target**: N/A |
**Status**: _In Discussion_ |
**Release Target**: 0.17.0; 6.2.0 |
**Status**: _Merged_ |
**Discussion**: [#5661](https://github.com/confluentinc/ksql/pull/5661)

**tl;dr**: The introduction of lambda functions would bridge the gap somewhat between builtins and UDFs.
Expand Down
4 changes: 2 additions & 2 deletions design-proposals/klip-31-metastore-backups.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP 31 - Metastore Backups

**Author**: Sergio Peña (@spena) |
**Release Target**: 0.11 |
**Status**: Merged |
**Release Target**: 0.11.0; 6.0.0 |
**Status**: _Merged_ |
**Discussion**: https://github.com/confluentinc/ksql/pull/5741

**tl;dr:** _KSQL should keep a local backup of the metastore (or command_topic) to allow users recover from an accidental
Expand Down
4 changes: 2 additions & 2 deletions design-proposals/klip-33-key-format.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP 33 - Key format

**Author**: @big-andy-coates |
**Release Target**: 0.13 |
**Status**: Approved |
**Release Target**: 0.13.0; 6.1.0 |
**Status**: _Merged_ |
**Discussion**: https://github.com/confluentinc/ksql/pull/6017

**tl;dr:** ksqlDB currently only supports keys compatible with the `KAFKA` format. This limits the
Expand Down
6 changes: 3 additions & 3 deletions design-proposals/klip-36-grace-stream-stream-joins.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# KLIP 36 - GRACE period for stream-stream joins

**Author**: agavra |
**Release Target**: 0.14 |
**Status**: In Discussion |
**Discussion**: TBD
**Release Target**: 0.23.1; 7.1.0 |
**Status**: _Merged_ |
**Discussion**: https://github.com/confluentinc/ksql/pull/6175

**tl;dr:** _Support controlling the GRACE period for a stream-stream join to improve disk space
utilization for small windows_
Expand Down
2 changes: 1 addition & 1 deletion design-proposals/klip-38-variable-substitution.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# KLIP 38 - Variable Substitution

**Author**: Sergio Peña (@spena) |
**Release Target**: 0.14 |
**Release Target**: 0.14.0; 6.1.0 |
**Status**: _Merged_ |
**Discussion**: https://github.com/confluentinc/ksql/pull/6259

Expand Down
2 changes: 1 addition & 1 deletion design-proposals/klip-4-custom-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Author**: agavra |
**Release Target**: 5.4 |
**Status**: Approved |
**Status**: _Merged_ |
**Discussion**: https://github.com/confluentinc/ksql/pull/2894

**tl;dr:** *Introduce a feature that makes custom types easier to work with in KSQL by aliasing
Expand Down
6 changes: 3 additions & 3 deletions design-proposals/klip-42-schema-migrations-tool.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP 42 - Schema Migrations Tool

**Author**: Sergio Peña (@spena) |
**Release Target**: 0.18 |
**Status**: _Design Approved_ |
**Release Target**: 0.17.0; 6.2.0 |
**Status**: _Merged_ |
**Discussion**: https://github.com/confluentinc/ksql/pull/6721

**tl;dr:** _New tool to provide ksqlDB users for easy and automated schema migrations for their
Expand Down Expand Up @@ -541,4 +541,4 @@ No compatibility implications.
## Security Implications
This tool requires same security configurations as any other ksqlDB client, such as user authentication and SSL
communication with the ksqlDB server.
communication with the ksqlDB server.
4 changes: 2 additions & 2 deletions design-proposals/klip-43-timestamp-data-type-support.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP-43: TIMESTAMP Data Type Support

**Author**: @jzaralim |
**Release Target**: 0.16 |
**Status**: In development |
**Release Target**: 0.17,0; 6.1.0 |
**Status**: _Merged_ |
**Discussion**: https://github.com/confluentinc/ksql/pull/6649

**tl;dr:** _Add support for TIMESTAMP column types in ksqlDB. This will allow users to easily migrate
Expand Down
6 changes: 3 additions & 3 deletions design-proposals/klip-46-date-and-time-data-type-support.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP 46 - DATE and TIME Data Type Support

**Author**: Zara Lim (@jzaralim) |
**Release Target**: 0.20 |
**Status**: _In Discussion_ |
**Release Target**: 0.20.0; 7.0.0 |
**Status**: _Merged_ |
**Discussion**: https://github.com/confluentinc/ksql/pull/7417

**tl;dr:** _Add support for DATE and TIME types. This will give users a more complete set of types
Expand Down Expand Up @@ -282,4 +282,4 @@ recognize the TIMESTAMP type, and the server will enter a DEGRADED state.

## Security Implications

None
None
4 changes: 2 additions & 2 deletions design-proposals/klip-49-add-source-stream-table-semantic.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP 49 - Add Source Stream/Table Semantic

**Author**: Boyang Chen (@boyang) |
**Release Target**: TBD |
**Status**: _In Discussion_ |
**Release Target**: 0.22.0; 7.1.0 |
**Status**: _Merged_ |
**Discussion**: https://github.com/confluentinc/ksql/pull/7474

**tl;dr:** _Add support for source stream/table. This will give users a read-only view of data that
Expand Down
3 changes: 0 additions & 3 deletions design-proposals/klip-5-internal-schemas-for-KSQL-engine.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
# KLIP-5: Internal Schemas for KSQL Engine

**Author**: hjafarpour |

**Release Target**: 5.4 |

**Status**: In Discussion |

**Discussion**:

**tl;dr:** *Introduce the internal schemas for KSQL engine to decouple the internal identifier names from the
Expand Down
4 changes: 2 additions & 2 deletions design-proposals/klip-50-partition-and-offset-in-ksqldb.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP 50 - Partition and Offset in ksqlDB

**Author**: Victoria Xia (@vcrfxia) |
**Release Target**: 0.23.0 |
**Status**: _In Discussion_ |
**Release Target**: 0.23.1; 7.1.0 |
**Status**: _Merged_ |
**Discussion**: https://github.com/confluentinc/ksql/pull/7505

**tl;dr:** _To aid in development and debugging of ksqlDB applications, ksqlDB should
Expand Down
4 changes: 2 additions & 2 deletions design-proposals/klip-52-bytes-data-type-support.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP 52 - BYTES Data Type Support

**Author**: Zara Lim (@jzaralim) |
**Release Target**: 0.21 |
**Status**: _In Discussion_ |
**Release Target**: 0.21.0; 7.0.0 |
**Status**: _Merged_ |
**Discussion**: https://github.com/confluentinc/ksql/pull/7764

**tl;dr:** _Add support for the BYTES data type. This will allow users to work with BLOBs of data that don't fit into any other data type._
Expand Down
6 changes: 3 additions & 3 deletions design-proposals/klip-53-pull-queries-on-streams.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP 53 - Pull Queries on Streams

**Author**: John Roesler (@vvcephei) |
**Release Target**: 0.22 |
**Status**: _In Discussion_ |
**Release Target**: 0.23.1; 7.1.0 |
**Status**: _Merged_ |
**Discussion**: _link to the design discussion PR_

**tl;dr:** People should be able to issue pull (ad-hoc, self-terminating) queries on streams,
Expand Down Expand Up @@ -93,4 +93,4 @@ As this is only removing a restriction, no compatibility problems are anticipate
## Security Implications

This is only adding a more convenient way to issue queries on data that is already
queriable, therefore the existing access control mechanisms are sufficient.
queriable, therefore the existing access control mechanisms are sufficient.
4 changes: 2 additions & 2 deletions design-proposals/klip-54-optimized-range-pull-queries.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP 54 - Optimized Range Pull Queries

**Author**: Patrick Stuedi (@pstuedi) |
**Release Target**: 0.22 |
**Status**: _In Discussion_ |
**Release Target**: 0.22.0; 7.1.0 |
**Status**: _Merged_ |
**Discussion**: https://github.com/confluentinc/ksql/pull/7993

**tl;dr:** For range pull queries on tables, use the range interface provided by the state store for retrieving records instead of doing a table scan.
Expand Down
2 changes: 1 addition & 1 deletion design-proposals/klip-56-schema-id-in-create-statements.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# KLIP 56 - Schema ID in Create Statements

**Author**: Hao Li (@lihaosky) |
**Release Target**: 0.24 |
**Release Target**: 0.24.0; 7.2.0 |
**Status**: _Merged_ |
**Discussion**: [Issue](https://github.com/confluentinc/ksql/issues/3634), [GitHub PR1](https://github.com/confluentinc/ksql/pull/8177)

Expand Down
2 changes: 1 addition & 1 deletion design-proposals/klip-57-kafka-headers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# KLIP 57 - Reading Kafka headers in ksqlDB
**Author**: Zara Lim (@jzaralim) |
**Release Target**: 0.24 |
**Release Target**: 0.24.0; 7.2.0 |
**Status**: _Merged_ |
**Discussion**: https://github.com/confluentinc/ksql/pull/8293

Expand Down
4 changes: 2 additions & 2 deletions design-proposals/klip-58-limit-clause-for-pull-queries.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP 58 - LIMIT clause for Pull Queries

**Author**: Chittaranjan Prasad (@cprasad1) |
**Release Target**: 0.24.0 |
**Status**: _In Discussion_ |
**Release Target**: 0.24.0; 7.2.0 |
**Status**: _Merged_ |
**Discussion**: https://github.com/confluentinc/ksql/pull/8298

**tl;dr:** Users of pull queries don't have any way of restricting the number of rows returned by a pull query. The
Expand Down
4 changes: 2 additions & 2 deletions design-proposals/klip-59-json-functions.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP-59 - JSON functions

**Authors**: Aleksandr Sorokoumov (@gerrrr), Colin Hicks (@colinhicks)
**Release Target**: TBD
**Status**: _Approved_ |
**Release Target**: 0.24.0; 7.2.0 |
**Status**: _Merged_ |
**Discussion**: [GitHub PR](https://github.com/confluentinc/ksql/pull/8550)

## Motivation and background
Expand Down
9 changes: 3 additions & 6 deletions design-proposals/klip-6-execution-plans.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
# Query Execution Plans

Author: Rohan Desai (rodesai)

Release target: 5.4

Status: Accepted

Author: Rohan Desai (rodesai) |
Release target: 5.4 |
Status: _Merged_ |
Discussion:

## Motivation and background
Expand Down
8 changes: 4 additions & 4 deletions design-proposals/klip-63-pause-resume-persistent-queries.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# KLIP-63: PAUSE and RESUME for persistent queries

**Author**: Jim Hughes (jnh5y) |
**Release Target**: Unknown |
**Status**: In Discussion |
**Discussion**:
**Author**: Jim Hughes (jnh5y) |
**Release Target**: 0.28.0; 7.3.0 |
**Status**: _Merged_ |
**Discussion**: https://github.com/confluentinc/ksql/pull/9095

**tl;dr:** Adds the ability to pause the processing of a persistent query.

Expand Down
2 changes: 1 addition & 1 deletion design-proposals/klip-7-connect-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Author**: agavra |
**Release Target**: 5.4 |
**Status**: Approved |
**Status**: _Merged_ |
**Discussion**: link

**tl;dr:** _provide first-class integration with Kafka connect for KSQL data ingress and egress_
Expand Down
2 changes: 1 addition & 1 deletion design-proposals/klip-8-queryable-state-stores.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Author**: derekjn |
**Release Target**: 5.4+ |
**Status**: Approved |
**Status**: _Merged_ |
**Discussion**: [#3117](https://github.com/confluentinc/ksql/pull/3117), [#530](https://github.com/confluentinc/ksql/issues/530)

## Motivation and background
Expand Down
6 changes: 3 additions & 3 deletions design-proposals/klip-9-table-functions.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# KLIP 9 - Table functions

**Author**: Tim Fox (GitHub: purplefox)
**Release Target**: 5.4
**Status**: Approved
**Author**: Tim Fox (GitHub: purplefox) |
**Release Target**: 5.4 |
**Status**: _Merged_ |
**Discussion**: https://github.com/confluentinc/ksql/issues/527

## Motivation and background
Expand Down

0 comments on commit d900cbd

Please sign in to comment.