|
1 | 1 | # Flink-SQL-Helper |
| 2 | +一款帮助你更高效、专注开发FlinkSQL的插件。支持FlinkSQL(v1.20.0)的语法校验提示、代码高亮、关键字补全、重命名、查找全部引用、代码格式化等。 |
2 | 3 |
|
3 | | -Help you efficiently and focus on FlinkSQL development. support Flink SQL error grammar check, syntax highlighting, complete keywords, rename, find all references and code format, including user-defined functions. |
| 4 | +> 用户QQ群:913711491 |
4 | 5 |
|
5 | | -> I suggest that you develop and debug on vscode based on the information (https://code.visualstudio.com/docs/java/java-debugging) to obtain a better experience. |
| 6 | +> 如果你喜欢在IDEA中进行FlinkSQL的开发。我建议你使用[IDEA版的Flink SQL Helper](https://plugins.jetbrains.com/plugin/25912-flink-sql-helper),它支持了所有语句,在VsCode插件的基础上,它的报错信息也更加清晰。 |
| 7 | +> 如果你喜欢在VsCode上开发,那么配合[VS Code官网里的Java环境配置](https://code.visualstudio.com/docs/java/java-debugging)也会很棒。 |
6 | 8 |
|
7 | | -## 1.Features |
| 9 | +版本之间的差异见下面的介绍`VSCode plugin VS IDEA plugin`。 |
8 | 10 |
|
9 | | -### 1.1 Grammar Check |
| 11 | +--- |
10 | 12 |
|
11 | | -Grammar check when you save edit (suggest you turn off automatic saving). |
| 13 | +Help you efficiently and focus on FlinkSQL development. support FlinkSQL(v1.20.0) error grammar check, syntax highlighting, complete keywords, rename, find all references and code format. |
| 14 | + |
| 15 | +> If you like develop Flink SQL in IDEA, you can use IDEA version of the plugin——[Flink SQL Helper](https://plugins.jetbrains.com/plugin/25912-flink-sql-helper), Its grammar error message is more powerful and supports all statement. |
| 16 | +Or you like develop Flink SQL in VsCode. i suggest that you develop and debug on vscode based on [the information](https://code.visualstudio.com/docs/java/java-debugging) to obtain a better experience. |
| 17 | + |
| 18 | +VSCode plugin VS IDEA plugin: |
| 19 | +  |
| 20 | + |
| 21 | + |
| 22 | +## 1.功能介绍(Features) |
| 23 | + |
| 24 | +### 1.1 语法检测(Grammar Check) |
| 25 | + |
| 26 | +语法检测将会在你保存时进行检测(强烈建议你关闭自动保存)。这个功能需要在配置中手动开启(默认不开启): |
| 27 | + |
| 28 | +Grammar check when you save edit (suggest you turn off automatic saving).the feature needs enabled in the configuration(not enabled by default): |
| 29 | + |
| 30 | +1.  |
| 31 | +2.  |
| 32 | + |
| 33 | +运行例子: |
12 | 34 |
|
13 | 35 | example: |
14 | 36 |
|
15 | 37 | -  |
16 | 38 | -  |
17 | | --  |
18 | 39 |
|
19 | | -if you dont like the feature, you can setting config to turn off and show you how to change config: |
20 | | -1.  |
21 | | -2.  |
22 | 40 |
|
23 | 41 |
|
24 | | -### 1.2 Refactorings |
| 42 | +### 1.2 重构(Refactorings) |
25 | 43 |
|
26 | 44 |  |
27 | 45 |
|
28 | | -### 1.3 Code Completion Proposals |
| 46 | +### 1.3 代码补全(Code Completion Proposals) |
29 | 47 |
|
30 | 48 |  |
31 | 49 |
|
32 | | -### 1.4 Snippets |
| 50 | +### 1.4 快捷代码(Snippets) |
33 | 51 |
|
34 | | -snippets keywords: |
| 52 | +可触发关键字(snippets keywords): |
35 | 53 |
|
36 | 54 | - create |
37 | 55 | - select |
@@ -59,28 +77,31 @@ snippets keywords: |
59 | 77 |
|
60 | 78 |  |
61 | 79 |
|
62 | | -### 1.5 Find All References |
| 80 | +### 1.5 查找所有的引用(Find All References) |
63 | 81 |
|
64 | 82 |  |
65 | 83 |
|
66 | | -### 1.5 Show References |
| 84 | +### 1.5 查找引用(Show References) |
67 | 85 |
|
68 | 86 |  |
69 | 87 |
|
70 | | -### 1.7 Code Format |
| 88 | +### 1.7 代码格式化(Code Format) |
71 | 89 |
|
72 | 90 |  |
73 | 91 |
|
74 | | -## 2. User Guide |
| 92 | +## 2. 用户手册(User Guide) |
| 93 | +如果你想让插件在你的FlinkSQL文件中生效,你的扩展名需要是`.fql`。 |
75 | 94 |
|
76 | | -Enable the extension on your file, either name the file with a extension: |
| 95 | +或者通过按F1,输入`Change Language Mode`,然后选择FlinkSQL。 |
77 | 96 |
|
78 | | -- SQL |
79 | | -- FQL |
| 97 | + |
| 98 | +Enable the extension on your Flink SQL file, either name the file with a extension `.fql` . |
80 | 99 |
|
81 | 100 | Or press F1, type 'Change Language Mode', and then choose FlinkSQL. |
82 | 101 |
|
83 | | -### 2.1 Color theme recommend |
| 102 | +### 2.1 配色建议(Color theme recommend) |
| 103 | + |
| 104 | +按F1, 选择`Preference: Color Theme`,然后复制下面的配色进去。 |
84 | 105 |
|
85 | 106 | Press F1, choose `Preference: Open User Setting(JSON)` then paste: |
86 | 107 |
|
@@ -219,4 +240,7 @@ Press F1, choose `Preference: Open User Setting(JSON)` then paste: |
219 | 240 | } |
220 | 241 | ~~~ |
221 | 242 |
|
| 243 | +我们提供了很多个选项,可以让开发者更好的定制自己的主题。如果你对主题有更多需求,可以查看 `syntaxes/flink.tmLanguage.json` 来了解关键字和配色映射。 |
| 244 | + |
| 245 | + |
222 | 246 | We provide so many options to allow developers to better customize their favorite themes. if you want to deep in, please see the `syntaxes/flink.tmLanguage.json` to understand keyword and color theme mapping. |
0 commit comments