Prerequisites
- By default, SFTP uses keypair authentication for access. You will need a provided
public keyto configure your destination. It will look roughly like this:
Public key format
Create a user on the SFTP server
Login to the SFTP server and complete the steps below.
- Create group
sftpwriter:
Create group
- Create user
sftpwriter:
Create user
- Switch to the
sftpwriteruser:
Switch user
- Create the
.sshdirectory:
Create .ssh directory
- Set permissions:
Set directory permissions
- Navigate to the
.sshdirectory:
Navigate to .ssh
- Create the
authorized_keysfile:
Create authorized_keys file
- Set permissions:
Set file permissions
- Add the public key to the
authorized_keysfile. The key, including the “ssh-key” and comment, should be all on one line in the file, without linebreaks.
Add public key
Add your destination
Use the following details to complete the connection setup: host name, folder name, username, port and preferred delimiter character.
Write permissions at the SFTP root are requiredIn addition to write access within your configured
<folder>, this destination writes per-transfer manifest files under a _manifests/ directory created at the root of the SFTP home/path. Ensure the SFTP user can create and write to _manifests at that root (even if your data lands under a subfolder). Manifests allow downstream systems to detect when a transfer is complete. See the FAQ below for how these files are organized.Frequently asked questions
How will the data appear in my SFTP server?
How will the data appear in my SFTP server?
The data will be loaded with the configured file format (
Parquet, CSV, or JSON/JSONL) in a predictable folder structure that can be easily parsed by downstream systems.sftpwriter_home_folder
some_provided_folder
some_table_a
dt=2024-01-01
0_20240101181004.csv
1_20240101184002.csv
dt=2024-01-02
0_20240102180123.csv
dt=2024-01-03
0_20240103182145.csv
some_table_b
dt=2024-01-01
0_20240101186004.csv
dt=2024-01-02
0_20240102185123.csv
dt=2024-01-03
0_20240103187145.csv
How is the SFTP connection secured?
How is the SFTP connection secured?
Use SSH key-based authentication for a dedicated, least-privileged SFTP user. Restrict access to only the required directories (e.g., chroot), and allowlist the service’s static egress IP at your network perimeter.
What file formats are supported?
What file formats are supported?
Parquet (default/recommended), CSV, and JSON/JSONL.How do I know when a transfer completed?
How do I know when a transfer completed?
Each transfer writes a manifest JSON file per model under
_manifests/ at the root. Files follow the pattern: _manifests/<model_name>/dt=<transfer_date>/manifest_{transfer_id}.json. Use these manifests to trigger downstream processing.Why do I sometimes see duplicates?
Why do I sometimes see duplicates?
File-based destinations are append-oriented. The change-detection process uses a lookback window to prevent missed records, which can create duplicates across adjacent transfers. Downstream pipelines can deduplicate by primary key prioritizing rows in the most recent transfer window.
Can I provide my own public key? Where is the private key stored?
Can I provide my own public key? Where is the private key stored?
We do not support providing your own public key for security reasons. The private key is securely generated and stored in our system and is never shared externally.