You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/FTPSource-batchsource.md
+25-9
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,5 @@
1
1
# FTP Batch Source
2
2
3
-
4
3
Description
5
4
-----------
6
5
Batch source for an FTP or SFTP source. Prefix of the path ('ftp://...' or 'sftp://...') determines the source server
@@ -16,8 +15,17 @@ Properties
16
15
----------
17
16
**Reference Name:** Name used to uniquely identify this source for lineage, annotating metadata, etc.
18
17
19
-
**Path:** Path to file(s) to be read. The path uses filename expansion (globbing) to read files.
20
-
Path is expected to be of the form prefix://username:password@hostname:port/path
18
+
**Server Type:** Whether to read from an FTP or SFTP server
19
+
20
+
**Host:** Host to read from.
21
+
22
+
**Port:** Optional port to read from. If no port is given, it will default to 21 for FTP and 22 for SFTP.
23
+
24
+
**Path:** Path to the file or directory to read from. For example: /path/to/directory.
25
+
26
+
**User:** User name to use for authentication.
27
+
28
+
**Password:** Password to use for authentication.
21
29
22
30
**Format:** Format of the data to read.
23
31
The format must be one of 'blob', 'csv', 'delimited', 'json', 'text', 'tsv', or the
@@ -38,20 +46,28 @@ JSON - is not supported. You must manually provide the output schema.
38
46
39
47
**Delimiter:** Delimiter to use when the format is 'delimited'. This will be ignored for other formats.
40
48
41
-
**Use First Row as Header:** Whether to use the first line of each file as the column headers. Supported formats are 'text', 'csv', 'tsv', and 'delimited'.
49
+
**Use First Row as Header:** Whether to use the first line of each file as the column headers. Supported formats are '
50
+
text', 'csv', 'tsv', and 'delimited'.
42
51
43
52
**Enable Quoted Values** Whether to treat content between quotes as a value. This value will only be used if the format
44
-
is 'csv', 'tsv' or 'delimited'. For example, if this is set to true, a line that looks like `1, "a, b, c"` will output two fields.
45
-
The first field will have `1` as its value and the second will have `a, b, c` as its value. The quote characters will be trimmed.
53
+
is 'csv', 'tsv' or 'delimited'. For example, if this is set to true, a line that looks like `1, "a, b, c"` will output
54
+
two fields.
55
+
The first field will have `1` as its value and the second will have `a, b, c` as its value. The quote characters will be
56
+
trimmed.
46
57
The newline delimiter cannot be within quotes.
47
58
48
-
It also assumes the quotes are well enclosed. The left quote will match the first following quote right before the delimiter. If there is an
59
+
It also assumes the quotes are well enclosed. The left quote will match the first following quote right before the
60
+
delimiter. If there is an
49
61
unenclosed quote, an error will occur.
50
62
51
-
**Regex Path Filter:** Regex to filter out files in the path. It accepts regular expression which is applied to the complete
63
+
**Enable Multiline Support** Enable the support for a single field, enclosed in quotes, to span over multiple lines.
64
+
This value will only be used if the format is 'csv', 'tsv' or 'delimited'. The default value is false.
65
+
66
+
**Regex Path Filter:** Regex to filter out files in the path. It accepts regular expression which is applied to the
67
+
complete
52
68
path and returns the list of files that match the specified pattern.
53
69
54
70
**Allow Empty Input:** Identify if path needs to be ignored or not, for case when directory or file does not
55
71
exists. If set to true it will treat the not present folder as 0 input and log a warning. Default is false.
56
72
57
-
**File System Properties:** Additional properties to use with the InputFormat when reading the data.
73
+
**File System Properties:** Additional properties to use with the InputFormat when reading the data.
0 commit comments