Skip to content

Commit 022dfb9

Browse files
committed
Updated arguments on documentation
1 parent 619879e commit 022dfb9

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Add the following to your pom.xml:
2424
<dependency>
2525
<groupId>com.datasqrl</groupId>
2626
<artifactId>flink-jar-runner</artifactId>
27-
<version>1.0.0</version>
27+
<version>0.0.3</version>
2828
</dependency>
2929
```
3030

@@ -42,17 +42,17 @@ The tool can be executed via the command line with the following arguments:
4242

4343
| Argument | Description |
4444
----------- |--------------------------------------------|
45-
|--sql-schema| Path to the SQL schema file |
46-
|--compiled-plan| Path to the compiled plan JSON file |
47-
|--system-jars| Directory containing additional JAR files |
48-
|--local-mode| tbd |
45+
|--sqlfile| SQL file to execute |
46+
|--planfile| Compiled plan JSON file |
47+
|--config-dir| Directory containing configuration YAML file |
48+
|--udfpath| Path to UDFs |
4949

5050
Example usage:
5151
```bash
5252
java -jar flink-jar-runner.jar \
53-
--sql-schema /path/to/schema.sql \
54-
--compiled-plan /path/to/compiledplan.json \
55-
--system-jars /path/to/jars
53+
--sqlfile /path/to/schema.sql \
54+
--planfile /path/to/compiledplan.json \
55+
--udfpath /path/to/jars
5656
```
5757

5858
### Environment Variable Substitution
@@ -97,7 +97,7 @@ spec:
9797
cpu: 1
9898
job:
9999
jarURI: http://raw.github.com/datasqrl/releases/1.0.0/flink-jar-runner.jar
100-
args: ["--sql-schema", "/opt/flink/usrlib/sql-scripts/schema.sql", "--compiled-plan", "/opt/flink/usrlib/sql-scripts/compiledplan.json", "--system-jars", "/opt/flink/usrlib/jars"]
100+
args: ["--sqlfile", "/opt/flink/usrlib/sql-scripts/schema.sql", "--planfile", "/opt/flink/usrlib/sql-scripts/compiledplan.json", "--udfpath", "/opt/flink/usrlib/jars"]
101101
parallelism: 1
102102
upgradeMode: stateless
103103
```
@@ -113,10 +113,9 @@ Running Flink jar-runner locally:
113113

114114
```bash
115115
java -jar flink-jar-runner.jar \
116-
--sql-schema /path/to/schema.sql \
117-
--compiled-plan /path/to/compiledplan.json \
118-
--system-jars /path/to/jars \
119-
--local-mode
116+
--sqlfile /path/to/schema.sql \
117+
--planfile /path/to/compiledplan.json \
118+
--udfpath /path/to/jars
120119
```
121120

122121
---
@@ -129,13 +128,13 @@ You can download the JAR directly from Maven Central or Docker Hub:
129128
<dependency>
130129
<groupId>com.datasqrl</groupId>
131130
<artifactId>flink-jar-runner</artifactId>
132-
<version>1.0.0</version>
131+
<version>0.0.3</version>
133132
</dependency>
134133
```
135134
- Docker:
136135

137136
```bash
138-
docker pull datasqrl/flink-jar-runner:latest
137+
docker pull datasqrl/flink-jar-runner:0.0.3-sqrlv0.5.10
139138
```
140139

141140
## Contributing
@@ -145,4 +144,4 @@ Contributions are welcome! Feel free to open an issue or submit a [pull request]
145144
This project is licensed under the Apache 2 License. See the [LICENSE](https://github.com/DataSQRL/flink-jar-runner/blob/main/LICENSE) file for details.
146145

147146
## Contact
148-
For any questions or support, please open an [issue](https://github.com/DataSQRL/flink-jar-runner/issues) in the GitHub repository.
147+
For any questions or support, please open an [issue](https://github.com/DataSQRL/flink-jar-runner/issues) in the GitHub repository.

0 commit comments

Comments
 (0)