Skip to content

Commit 9e67748

Browse files
akashverma0786Akash Verma
andauthored
MINOR: Add SFTP connector md and beta tag (#25950)
Co-authored-by: Akash Verma <akashverma@Akashs-MacBook-Pro-2.local>
1 parent 699f583 commit 9e67748

File tree

2 files changed

+85
-0
lines changed

2 files changed

+85
-0
lines changed
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# SFTP
2+
3+
In this section, we provide guides and references to use the SFTP connector.
4+
5+
## Requirements
6+
7+
To extract metadata from an SFTP server, the user needs to have read access to the directories and files to be catalogued.
8+
9+
You can find further information on the SFTP connector in the <a href="https://docs.open-metadata.org/connectors/drive/sftp" target="_blank">docs</a>.
10+
11+
## Connection Details
12+
13+
$$section
14+
### Host $(id="host")
15+
SFTP server hostname or IP address (e.g., `sftp.example.com` or `192.168.1.100`).
16+
$$
17+
18+
$$section
19+
### Port $(id="port")
20+
SFTP server port number. Defaults to `22`.
21+
$$
22+
23+
$$section
24+
### Authentication Type $(id="authType")
25+
Authentication method to connect to the SFTP server. Choose between:
26+
- **Username/Password**: Authenticate using a username and password.
27+
- **Private Key**: Authenticate using an SSH private key in PEM format. Supports RSA, Ed25519, ECDSA, and DSS keys.
28+
$$
29+
30+
$$section
31+
### Username $(id="username")
32+
SFTP username used for authentication.
33+
$$
34+
35+
$$section
36+
### Password $(id="password")
37+
Password for username/password authentication.
38+
$$
39+
40+
$$section
41+
### Private Key $(id="privateKey")
42+
SSH private key content in PEM format for key-based authentication. Supports RSA, Ed25519, ECDSA, and DSS keys.
43+
$$
44+
45+
$$section
46+
### Private Key Passphrase $(id="privateKeyPassphrase")
47+
Passphrase to decrypt the private key, if the key is encrypted. Leave blank if the key has no passphrase.
48+
$$
49+
50+
$$section
51+
### Root Directories $(id="rootDirectories")
52+
List of root directories to scan for files and subdirectories. Defaults to `/` (the user's home directory). Multiple directories can be specified to scope the ingestion to specific paths on the server.
53+
$$
54+
55+
$$section
56+
### Connection Options $(id="connectionOptions")
57+
Additional connection options to build the URL that can be sent to the service during the connection.
58+
$$
59+
60+
$$section
61+
### Connection Arguments $(id="connectionArguments")
62+
Additional connection arguments such as security or protocol configs that can be sent to the service during connection.
63+
$$
64+
65+
$$section
66+
### Directory Filter Pattern $(id="directoryFilterPattern")
67+
Regex to only include/exclude directories that match the pattern.
68+
$$
69+
70+
$$section
71+
### File Filter Pattern $(id="fileFilterPattern")
72+
Regex to only include/exclude files that match the pattern.
73+
$$
74+
75+
$$section
76+
### Structured Data Files Only $(id="structuredDataFilesOnly")
77+
When enabled, only catalog structured data files (CSV, TSV) that can have schema extracted. Non-structured files like images, PDFs, and videos will be skipped. Defaults to `false`.
78+
$$
79+
80+
$$section
81+
### Extract Sample Data $(id="extractSampleData")
82+
When enabled, extract sample data from structured files (CSV, TSV). Disabled by default to avoid performance overhead.
83+
$$

openmetadata-ui/src/main/resources/ui/src/constants/Services.constant.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -461,6 +461,8 @@ export const BETA_SERVICES = [
461461
DatabaseServiceType.MicrosoftFabric,
462462
PipelineServiceType.MicrosoftFabricPipeline,
463463
DatabaseServiceType.BurstIQ,
464+
DatabaseServiceType.StarRocks,
465+
DriveServiceType.SFTP,
464466
];
465467

466468
export const TEST_CONNECTION_INITIAL_MESSAGE =

0 commit comments

Comments
 (0)