Skip to content

Commit 0eadb4d

Browse files
hjafarpourhjafarpour
committed
Starting a clean ksql repo by removing all the previous commit history.
This will be the repo that will be made public.
0 parents  commit 0eadb4d

File tree

484 files changed

+51195
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

484 files changed

+51195
-0
lines changed

‎.gitignore

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Build products
2+
target/
3+
docs/_build/
4+
dist/
5+
6+
# IntelliJ data
7+
*.iml
8+
*.iws
9+
*.ipr
10+
.idea/
11+
12+
# Other
13+
.DS_Store
14+
.dumbjump
15+
*classes
16+
*~
17+
*#
18+
.#*
19+
.classpath
20+
/.metadata
21+
.project
22+
.settings
23+
.tern-port

‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

+130
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# KSQL - a Streaming SQL Engine for Apache Kafka™ from Confluent
2+
---
3+
4+
A DEVELOPER PREVIEW
5+
6+
---
7+
8+
KSQL is an open source streaming SQL engine that implements continuous, interactive queries against Apache Kafka™. It allows you to query, read, write, and process data in Apache Kafka in real-time, at scale using SQL commands.
9+
10+
KSQL does not require proficiency with a programming language such as Java or Go, and it does not require you to install and manage a separate processing cluster technology. As such, it opens up the world of stream processing to a broader set of users and applications than ever before.
11+
12+
This release is a DEVELOPER PREVIEW which is free and open-source from Confluent under the Apache 2.0 license.
13+
14+
---
15+
16+
# Hello, KSQL!
17+
---
18+
Here are some example queries to illustrate the look and feel of the KSQL syntax:
19+
20+
Filter an inbound stream of page views to only show errors
21+
22+
```sql
23+
SELECT STREAM request, ip, status
24+
WHERE status >= 400
25+
```
26+
27+
Create a new stream that contains the pageviews from female users only
28+
```sql
29+
CREATE STREAM pageviews_by_female_users AS
30+
SELECT users.userid AS userid, pageid, regionid, gender FROM pageviews
31+
LEFT JOIN users ON pageview.userid = users.userid
32+
WHERE gender = 'FEMALE';
33+
```
34+
35+
Continuously compute the number of pageviews for each page with 5-second tumbling windows
36+
```sql
37+
CREATE TABLE pageview_counts AS
38+
SELECT pageid, count(*) FROM pageviews
39+
WINDOW TUMBLING (size 5 second)
40+
GROUP BY pageid;
41+
```
42+
43+
# Let’s Play with KSQL
44+
---
45+
46+
* First-time users may want to try our [interactive quickstart](https://github.com/confluentinc/ksql).
47+
* If you want a more realistic end-to-end example, walk through our [KSQL demo](https://github.com/confluentinc/ksql).
48+
49+
To learn more about KSQL see our [documentation](https://github.com/confluentinc/ksql) including the [KSQL Syntax Guide](https://github.com/confluentinc/ksql).
50+
51+
# Need help?
52+
---
53+
If you need help or have questions, you have several options:
54+
* Ask a question in the #ksql channel in our public [Confluent Community Slack](https://confluent.typeform.com/to/GxTHUD). Account registration is free and self-service.
55+
* Create a [ticket](https://github.com/confluentinc/ksql) in our issue [tracker](https://github.com/confluentinc/ksql).
56+
* Join the [Confluent google group](https://groups.google.com/forum/#!forum/confluent-platform).
57+
58+
# How it works
59+
---
60+
KSQL consists of a client and a server component. The client is a command line interface (CLI) similar to the CLIs of MySQL or PostgreSQL. The server, of which you can run one or many instances, executes those queries for you.
61+
62+
You can use KSQL in stand-alone mode and/or in client-server mode.
63+
64+
In stand-alone mode, both the KSQL client and server components are co-located on the same machine, in the same JVM, and are started together which makes it convenient for local development and testing.
65+
66+
![alt text](https://user-images.githubusercontent.com/2977624/29090610-f4b11096-7c34-11e7-8a63-85c9ead22bc3.png)
67+
68+
In client-server mode, a pool of KSQL server(s) can be running on remote machines, VMs, or containers and the CLI connects to them over HTTP.
69+
70+
![alt text](https://user-images.githubusercontent.com/2977624/29090617-fab5e930-7c34-11e7-9eee-0554192854d5.png)
71+
72+
# Frequently Asked Questions
73+
---
74+
**What are the benefits of KSQL?**
75+
76+
KSQL allows you to query, read, write, and process data in Apache Kafka in real-time and at scale using intuitive SQL-like syntax. KSQL does not require proficiency with a programming language such as Java or Scala, and you don’t have to install a separate processing cluster technology.
77+
78+
**What are the technical requirements of KSQL?**
79+
80+
KSQL only requires
81+
1. a Java runtime environment
82+
2. access to an Apache Kafka cluster for reading and writing data in real-time. The cluster can be on-premises or in the cloud.
83+
84+
We recommend the use of [Confluent Platform](https://www.confluent.io/product/confluent-platform/) or [Confluent Cloud](https://www.confluent.io/confluent-cloud/) for running Apache Kafka.
85+
86+
**Is KSQL owned by the Apache Software Foundation?**
87+
88+
No, KSQL is owned and maintained by [Confluent Inc.](https://www.confluent.io/) as part of its free [Confluent Open Source](https://www.confluent.io/product/confluent-open-source/) product.
89+
90+
**How does KSQL compare to Apache Kafka’s Streams API?**
91+
92+
KSQL is complementary to the Kafka Streams API, and indeed executes queries through Streams applications. One of the key benefits of KSQL is that it does not require the user to develop any code in Java or Scala.
93+
This enables users to use a SQL-like interface alone to construct streaming ETL pipelines, as well as responding to a real-time, continuous business requests. For full-fledged stream processing applications Kafka Streams remains a more appropriate choice.
94+
As with many technologies each has its sweet-spot based on technical requirements, mission-criticality, and user skillset.
95+
96+
**Is KSQL ready for production?**
97+
98+
KSQL is a technical preview at this point in time. We do not yet recommend its use for production purposes.
99+
100+
**Can I use KSQL with my favorite data format (e.g. JSON, Avro)?**
101+
102+
KSQL currently supports formats:
103+
104+
* DELIMITED (e.g. CSV)
105+
* JSON
106+
107+
_Support for AVRO is expected soon._
108+
109+
**Is KSQL fully compliant to ANSI SQL?**
110+
111+
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.
112+
113+
# Contributing to KSQL
114+
---
115+
*This section contains information about how to contribute code and documentation, etc.*
116+
117+
To build KSQL locally:
118+
119+
```sh
120+
$ git clone https://github.com/confluentinc/ksql.git
121+
$ cd ksql
122+
$ mvn clean package
123+
```
124+
125+
# License
126+
---
127+
The project is licensed under the Apache License, version 2.0.
128+
129+
*Apache, Apache Kafka, Kafka, and associated open source project names are trademarks of the [Apache Software Foundation](https://www.apache.org/)*
130+

‎bin/ksql-cli

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#!/bin/bash
2+
# (Copyright) [2017 - 2017] Confluent, Inc.
3+
4+
#
5+
# Use shellcheck to lint this file
6+
#
7+
set -ue
8+
9+
base_dir=$( cd "$( dirname "${BASH_SOURCE[0]}" )/.." && pwd )
10+
: "${KSQL_CONFIG_DIR:="$base_dir/config"}"
11+
12+
: "${KSQL_LOG4J_OPTS:=""}"
13+
if [ -z "$KSQL_LOG4J_OPTS" ] && [ -e "$KSQL_CONFIG_DIR/log4j-silent.properties" ]; then
14+
export KSQL_LOG4J_OPTS="-Dlog4j.configuration=file:$KSQL_CONFIG_DIR/log4j-silent.properties"
15+
fi
16+
17+
exec "$base_dir"/bin/ksql-run-class io.confluent.ksql.Ksql "$@"

‎bin/ksql-cli-stop

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#!/bin/bash
2+
# (Copyright) [2017 - 2017] Confluent, Inc.
3+
4+
#
5+
# Use shellcheck to lint this file
6+
#
7+
8+
# This script is mainly useful if the user has run some non-interactive query via the CLI with the
9+
# -daemon flag passed in; it's less painful than manually grepping for the process and killing it
10+
# However, it comes with the downside that it kills every currently-running CLI session, interactive
11+
# or not, daemon or not, so:
12+
# TODO: Consider only killing non-interactive and/or daemon instances of the CLI
13+
CLIPIDS=$(jcmd | grep 'io\.confluent\.ksql\.Ksql' | awk '{print $1}')
14+
15+
if [ -z "$CLIPIDS" ]; then
16+
echo "No CLI session(s) to stop"
17+
exit 1
18+
fi
19+
20+
for PID in $CLIPIDS; do
21+
kill -s TERM "$PID"
22+
while kill -0 "$PID" >/dev/null 2>&1; do sleep 1; done
23+
done

0 commit comments

Comments
 (0)