Skip to content

Commit 4ba3350

Browse files
davetroianodavetroiano
authored
Flink SQL clone instructions (#7) (#66)
* fix: add repo clone instructions to Flink tutorials * fix: improve header font in Flink SQL run instructions
1 parent 4df8a09 commit 4ba3350

File tree

17 files changed

+461
-241
lines changed

17 files changed

+461
-241
lines changed

‎aggregating-count/flinksql/README.md‎

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,21 @@ against Flink and Kafka running in Docker, or with Confluent Cloud.
3838
<details>
3939
<summary>Flink Table API-based test</summary>
4040

41-
#### Prerequisites
41+
### Prerequisites
4242

4343
* Java 17, e.g., follow the OpenJDK installation instructions [here](https://openjdk.org/install/) if you don't have Java.
4444
* Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
4545

46-
#### Run the test
46+
### Run the test
4747

48-
Run the following command to execute [FlinkSqlAggregatingCountTest#testCountAggregation](src/test/java/io/confluent/developer/FlinkSqlAggregatingCountTest.java):
48+
Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
49+
50+
```shell
51+
git clone [email protected]:confluentinc/tutorials.git
52+
cd tutorials
53+
```
54+
55+
Run the following command to execute [FlinkSqlAggregatingCountTest#testCountAggregation](src/test/java/io/confluent/developer/FlinkSqlAggregatingCountTest.java):
4956

5057
```plaintext
5158
./gradlew clean :aggregating-count:flinksql:test
@@ -58,14 +65,21 @@ Run the following command to execute [FlinkSqlAggregatingCountTest#testCountAggr
5865
<details>
5966
<summary>Flink SQL Client CLI</summary>
6067

61-
#### Prerequisites
68+
### Prerequisites
6269

6370
* Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
6471
* [Docker Compose](https://docs.docker.com/compose/install/). Ensure that the command `docker compose version` succeeds.
6572

66-
#### Run the commands
73+
### Run the commands
74+
75+
Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
76+
77+
```shell
78+
git clone [email protected]:confluentinc/tutorials.git
79+
cd tutorials
80+
```
6781

68-
First, start Flink and Kafka:
82+
Start Flink and Kafka:
6983

7084
```shell
7185
docker compose -f ./docker/docker-compose-flinksql.yml up -d
@@ -123,11 +137,11 @@ Run the following command to execute [FlinkSqlAggregatingCountTest#testCountAggr
123137

124138
```plaintext
125139
title tickets_sold
126-
---------------- -----------
127-
Aliens 1
128-
Die Hard 3
129-
The Big Lebowski 2
130-
The Godfather 4
140+
---------------- ------------
141+
Aliens 1
142+
Die Hard 3
143+
The Big Lebowski 2
144+
The Godfather 4
131145
```
132146

133147
When you are finished, clean up the containers used for this tutorial by running:
@@ -141,12 +155,12 @@ Run the following command to execute [FlinkSqlAggregatingCountTest#testCountAggr
141155
<details>
142156
<summary>Confluent Cloud</summary>
143157

144-
#### Prerequisites
158+
### Prerequisites
145159

146160
* A [Confluent Cloud](https://confluent.cloud/signup) account
147161
* A Flink compute pool created in Confluent Cloud. Follow [this](https://docs.confluent.io/cloud/current/flink/get-started/quick-start-cloud-console.html) quick start to create one.
148162

149-
#### Run the commands
163+
### Run the commands
150164

151165
In the Confluent Cloud Console, navigate to your environment and then click the `Open SQL Workspace` button for the compute
152166
pool that you have created.

‎aggregating-minmax/flinksql/README.md‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,21 @@ against Flink and Kafka running in Docker, or with Confluent Cloud.
4141
<details>
4242
<summary>Flink Table API-based test</summary>
4343

44-
#### Prerequisites
44+
### Prerequisites
4545

4646
* Java 17, e.g., follow the OpenJDK installation instructions [here](https://openjdk.org/install/) if you don't have Java.
4747
* Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
4848

49-
#### Run the test
49+
### Run the test
5050

51-
Run the following command to execute [FlinkSqlAggregatingMinMaxTest#testMinMax](src/test/java/io/confluent/developer/FlinkSqlAggregatingMinMaxTest.java):
51+
Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
52+
53+
```shell
54+
git clone [email protected]:confluentinc/tutorials.git
55+
cd tutorials
56+
```
57+
58+
Run the following command to execute [FlinkSqlAggregatingMinMaxTest#testMinMax](src/test/java/io/confluent/developer/FlinkSqlAggregatingMinMaxTest.java):
5259

5360
```plaintext
5461
./gradlew clean :aggregating-minmax:flinksql:test
@@ -61,14 +68,21 @@ Run the following command to execute [FlinkSqlAggregatingMinMaxTest#testMinMax](
6168
<details>
6269
<summary>Flink SQL Client CLI</summary>
6370

64-
#### Prerequisites
71+
### Prerequisites
6572

6673
* Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
6774
* [Docker Compose](https://docs.docker.com/compose/install/). Ensure that the command `docker compose version` succeeds.
6875

69-
#### Run the commands
76+
### Run the commands
77+
78+
Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
79+
80+
```shell
81+
git clone [email protected]:confluentinc/tutorials.git
82+
cd tutorials
83+
```
7084

71-
First, start Flink and Kafka:
85+
Start Flink and Kafka:
7286

7387
```shell
7488
docker compose -f ./docker/docker-compose-flinksql.yml up -d
@@ -146,12 +160,12 @@ Run the following command to execute [FlinkSqlAggregatingMinMaxTest#testMinMax](
146160
<details>
147161
<summary>Confluent Cloud</summary>
148162

149-
#### Prerequisites
163+
### Prerequisites
150164

151165
* A [Confluent Cloud](https://confluent.cloud/signup) account
152166
* A Flink compute pool created in Confluent Cloud. Follow [this](https://docs.confluent.io/cloud/current/flink/get-started/quick-start-cloud-console.html) quick start to create one.
153167

154-
#### Run the commands
168+
### Run the commands
155169

156170
In the Confluent Cloud Console, navigate to your environment and then click the `Open SQL Workspace` button for the compute
157171
pool that you have created.

‎cumulating-windows/flinksql/README.md‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,21 @@ against Flink and Kafka running in Docker, or with Confluent Cloud.
5454
<details>
5555
<summary>Flink Table API-based test</summary>
5656

57-
#### Prerequisites
57+
### Prerequisites
5858

5959
* Java 17, e.g., follow the OpenJDK installation instructions [here](https://openjdk.org/install/) if you don't have Java.
6060
* Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
6161

62-
#### Run the test
62+
### Run the test
6363

64-
Run the following command to execute [FlinkSqlCumulatingWindowTest#testCumulatingWindows](src/test/java/io/confluent/developer/FlinkSqlCumulatingWindowTest.java):
64+
Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
65+
66+
```shell
67+
git clone [email protected]:confluentinc/tutorials.git
68+
cd tutorials
69+
```
70+
71+
Run the following command to execute [FlinkSqlCumulatingWindowTest#testCumulatingWindows](src/test/java/io/confluent/developer/FlinkSqlCumulatingWindowTest.java):
6572

6673
```plaintext
6774
./gradlew clean :cunulating-windows:flinksql:test
@@ -74,14 +81,21 @@ Run the following command to execute [FlinkSqlCumulatingWindowTest#testCumulatin
7481
<details>
7582
<summary>Flink SQL Client CLI</summary>
7683

77-
#### Prerequisites
84+
### Prerequisites
7885

7986
* Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
8087
* [Docker Compose](https://docs.docker.com/compose/install/). Ensure that the command `docker compose version` succeeds.
8188

82-
#### Run the commands
89+
### Run the commands
90+
91+
Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
92+
93+
```shell
94+
git clone [email protected]:confluentinc/tutorials.git
95+
cd tutorials
96+
```
8397

84-
First, start Flink and Kafka:
98+
Start Flink and Kafka:
8599

86100
```shell
87101
docker compose -f ./docker/docker-compose-flinksql.yml up -d
@@ -161,12 +175,12 @@ Run the following command to execute [FlinkSqlCumulatingWindowTest#testCumulatin
161175
<details>
162176
<summary>Confluent Cloud</summary>
163177

164-
#### Prerequisites
178+
### Prerequisites
165179

166180
* A [Confluent Cloud](https://confluent.cloud/signup) account
167181
* A Flink compute pool created in Confluent Cloud. Follow [this](https://docs.confluent.io/cloud/current/flink/get-started/quick-start-cloud-console.html) quick start to create one.
168182

169-
#### Run the commands
183+
### Run the commands
170184

171185
In the Confluent Cloud Console, navigate to your environment and then click the `Open SQL Workspace` button for the compute
172186
pool that you have created.

‎deduplication-windowed/flinksql/README.md‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,21 @@ against Flink and Kafka running in Docker, or with Confluent Cloud.
5050
<details>
5151
<summary>Flink Table API-based test</summary>
5252

53-
#### Prerequisites
53+
### Prerequisites
5454

5555
* Java 11, e.g., follow the OpenJDK installation instructions [here](https://openjdk.org/install/) if you don't have Java.
5656
* Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
5757

58-
#### Run the test
58+
### Run the test
5959

60-
Run the following command to execute [FlinkSqlFindingDistinctTest#testFindDistinct](src/test/java/io/confluent/developer/FlinkSqlFindingDistinctTest.java):
60+
Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
61+
62+
```shell
63+
git clone [email protected]:confluentinc/tutorials.git
64+
cd tutorials
65+
```
66+
67+
Run the following command to execute [FlinkSqlFindingDistinctTest#testFindDistinct](src/test/java/io/confluent/developer/FlinkSqlFindingDistinctTest.java):
6168

6269
```plaintext
6370
./gradlew clean :deduplication-windowed:flinksql:test
@@ -70,14 +77,21 @@ Run the following command to execute [FlinkSqlFindingDistinctTest#testFindDistin
7077
<details>
7178
<summary>Flink SQL Client CLI</summary>
7279

73-
#### Prerequisites
80+
### Prerequisites
7481

7582
* Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
7683
* [Docker Compose](https://docs.docker.com/compose/install/). Ensure that the command `docker compose version` succeeds.
7784

78-
#### Run the commands
85+
### Run the commands
86+
87+
Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
88+
89+
```shell
90+
git clone [email protected]:confluentinc/tutorials.git
91+
cd tutorials
92+
```
7993

80-
First, start Flink and Kafka:
94+
Start Flink and Kafka:
8195

8296
```shell
8397
docker compose -f ./docker/docker-compose-flinksql.yml up -d
@@ -154,12 +168,12 @@ Run the following command to execute [FlinkSqlFindingDistinctTest#testFindDistin
154168
<details>
155169
<summary>Confluent Cloud</summary>
156170

157-
#### Prerequisites
171+
### Prerequisites
158172

159173
* A [Confluent Cloud](https://confluent.cloud/signup) account
160174
* A Flink compute pool created in Confluent Cloud. Follow [this](https://docs.confluent.io/cloud/current/flink/get-started/quick-start-cloud-console.html) quick start to create one.
161175

162-
#### Run the commands
176+
### Run the commands
163177

164178
In the Confluent Cloud Console, navigate to your environment and then click the `Open SQL Workspace` button for the compute
165179
pool that you have created.

‎deduplication/flinksql/README.md‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,21 @@ against Flink and Kafka running in Docker, or with Confluent Cloud.
4646
<details>
4747
<summary>Flink Table API-based test</summary>
4848

49-
#### Prerequisites
49+
### Prerequisites
5050

5151
* Java 17, e.g., follow the OpenJDK installation instructions [here](https://openjdk.org/install/) if you don't have Java.
5252
* Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
5353

54-
#### Run the test
54+
### Run the test
5555

56-
Run the following command to execute [FlinkSqlFindingDistinctTest#testFindDistinct](src/test/java/io/confluent/developer/FlinkSqlFindingDistinctTest.java):
56+
Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
57+
58+
```shell
59+
git clone [email protected]:confluentinc/tutorials.git
60+
cd tutorials
61+
```
62+
63+
Run the following command to execute [FlinkSqlFindingDistinctTest#testFindDistinct](src/test/java/io/confluent/developer/FlinkSqlFindingDistinctTest.java):
5764

5865
```plaintext
5966
./gradlew clean :deduplication:flinksql:test
@@ -66,14 +73,21 @@ Run the following command to execute [FlinkSqlFindingDistinctTest#testFindDistin
6673
<details>
6774
<summary>Flink SQL Client CLI</summary>
6875

69-
#### Prerequisites
76+
### Prerequisites
7077

7178
* Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
7279
* [Docker Compose](https://docs.docker.com/compose/install/). Ensure that the command `docker compose version` succeeds.
7380

74-
#### Run the commands
81+
### Run the commands
82+
83+
Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
84+
85+
```shell
86+
git clone [email protected]:confluentinc/tutorials.git
87+
cd tutorials
88+
```
7589

76-
First, start Flink and Kafka:
90+
Start Flink and Kafka:
7791

7892
```shell
7993
docker compose -f ./docker/docker-compose-flinksql.yml up -d
@@ -145,12 +159,12 @@ Run the following command to execute [FlinkSqlFindingDistinctTest#testFindDistin
145159
<details>
146160
<summary>Confluent Cloud</summary>
147161

148-
#### Prerequisites
162+
### Prerequisites
149163

150164
* A [Confluent Cloud](https://confluent.cloud/signup) account
151165
* A Flink compute pool created in Confluent Cloud. Follow [this](https://docs.confluent.io/cloud/current/flink/get-started/quick-start-cloud-console.html) quick start to create one.
152166

153-
#### Run the commands
167+
### Run the commands
154168

155169
In the Confluent Cloud Console, navigate to your environment and then click the `Open SQL Workspace` button for the compute
156170
pool that you have created.

0 commit comments

Comments
 (0)