docs: add comment docs

vesoft-inc · Jan 11, 2024 · 6bee114 · 6bee114
1 parent b907fe9
commit 6bee114
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -336,11 +336,13 @@ csv:
   delimiter: ","
   withHeader: false
   lazyQuotes: false
+  comment: ""
 ```
 
 * `delimiter`: **Optional**. Specifies the delimiter for the CSV files. The default value is `","`. And only a 1-character string delimiter is supported.
 * `withHeader`: **Optional**. Specifies whether to ignore the first record in csv file. The default value is `false`.
 * `lazyQuotes`: **Optional**. If lazyQuotes is true, a quote may appear in an unquoted field and a non-doubled quote may appear in a quoted field.
+* `comment`: **Optional**. Specifies the comment character. Lines beginning with the Comment character without preceding whitespace are ignored.
 
 #### tags
 

diff --git a/docs/configuration-reference.md b/docs/configuration-reference.md
@@ -82,6 +82,7 @@
 | sources[].csv.delimiter                     | Specifies the delimiter for the CSV files.                                                           | ","              |
 | sources[].csv.withHeader                    | Specifies whether to ignore the first record in csv file.                                            | false            |
 | sources[].csv.lazyQuotes                    | Specifies lazy quotes of csv file.                                                                   | false            |
+| sources[].csv.comment                       | Specifies the comment character.                                                                     | -                |
 | sources[].tags                              | Describes the schema definition for tags.                                                            | -                |
 | sources[].tags[].name                       | The tag name.                                                                                        | -                |
 | sources[].tags[].mode                       | The mode for processing data, one of `INSERT`, `UPDATE` or `DELETE`.                                 | -                |