Local CSV
:::danger
Use this destination on a local workstation. It won’t work on Kubernetes.
:::
Overview
Data is written to a directory on the local filesystem of the host running Airbyte. By default, it is written to /tmp/airbyte_local. To change this location, modify the LOCAL_ROOT environment variable for Airbyte.
:::caution
Ensure Docker Desktop can access /tmp. On MacOS, it must also access /private because /tmp links to /private. Otherwise, it won’t work. Allow access through “File sharing” in Settings -> Resources -> File sharing -> add the one or two above folder, then select the “Apply & restart” button.
:::
Sync overview
Output schema
Each stream is written to its own file. Each file contains 3 columns:
_airbyte_ab_id: a UUID assigned by Airbyte to each processed event._airbyte_emitted_at: a timestamp showing when the event was pulled from the data source._airbyte_data: a JSON blob containing the event data.
Performance considerations
Your filesystem’s write speed limits this integration’s performance.
Supported sync modes
| Sync mode | Supported? |
|---|---|
| Full Refresh - Overwrite | Yes |
| Full Refresh - Append | Yes |
| Full Refresh - Overwrite + Deduped | No |
| Incremental Sync - Append | Yes |
| Incremental Sync - Append + Deduped | No |
Get started
The destination_path always starts with /local, whether you specify it or not. Any directory nesting within local maps to the local mount.
By default, the LOCAL_ROOT env variable in the .env file is set to /tmp/airbyte_local.
Docker mounts the local mount at LOCAL_ROOT. This means /local is replaced with /tmp/airbyte_local by default.
Example
- If
destination_pathis set to/local/cars/models, - and the local mount uses the
/tmp/airbyte_localdefault, - then all data is written to the
/tmp/airbyte_local/cars/modelsdirectory.
Access replicated data files
If your Airbyte instance runs on this computer, open file:///tmp/airbyte_local in your browser to view replicated data locally. If that fails, or Airbyte runs on a remote server, follow these steps to access the replicated files:
- Access the scheduler container using
docker exec -it airbyte-server bash - Go to the default local mount using
cd /tmp/airbyte_local - Go to the replicated file directory you specified when creating the destination, using
cd /{destination_path} - List files containing the replicated data using
ls - Run
cat {filename}to display data from a specific file
To copy the output file to your host machine’s current working directory, use this command:
docker cp airbyte-server:/tmp/airbyte_local/{destination_path}/{filename}.csv .
Note: If Airbyte runs on Windows with Docker backed by WSL2, follow similar steps or see link for an alternative approach.
Namespace support
This destination doesn’t support namespaces.
Changelog
Expand to review
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 1.0.2 | 2025-03-21 | 55906 | Upgrade to airbyte/java-connector-base:2.0.1 for M4 compatibility. |
| 1.0.1 | 2024-12-18 | 49864 | Use a base image: airbyte/java-connector-base:1.0.0 |
| 1.0.0 | 2022-12-20 | 17998 | Breaking changes: non backwards compatible. Adds delimiter dropdown. |
| 0.2.10 | 2022-06-20 | 13932 | Merging published connector changes |
| 0.2.9 | 2022-02-14 | 10256 | Add ExitOnOutOfMemoryError to java connectors and bump versions |
| 0.2.8 | 2021-07-21 | 3555 | Checkpointing: Partial Success in BufferedStreamConsumer (Destination) |
| 0.2.7 | 2021-06-09 | 3973 | add AIRBYTE_ENTRYPOINT for kubernetes support |
| 0.2.6 | 2021-05-25 | 3290 | Checkpointing: Worker use destination (instead of source) for state |
| 0.2.5 | 2021-05-10 | 3327 | don’t split lines on LSEP unicode characters when reading lines in destinations |
| 0.2.4 | 2021-05-10 | 3289 | bump all destination versions to support outputting messages |
| 0.2.3 | 2021-03-31 | 2668 | Add SupportedDestinationSyncModes to destination specs objects |
| 0.2.2 | 2021-03-19 | 2460 | Destinations supports destination sync mode |
| 0.2.0 | 2021-03-09 | 2238 | Upgrade all connectors (0.2.0) so protocol allows future / unknown properties |
| 0.1.8 | 2021-01-29 | 1882 | Local File Destinations UX change with destination paths |
| 0.1.7 | 2021-01-20 | 1737 | Rename destination tables |
| 0.1.6 | 2021-01-19 | 1708 | Add metadata prefix to destination internal columns |
| 0.1.5 | 2020-12-12 | 1294 | Incremental CSV destination |
| 0.1.4 | 2020-11-30 | 1038 | Change jdbc sources to discover more than standard schemas |
| 0.1.3 | 2020-11-20 | 1021 | Incremental Docs and Data Model Update |
| 0.1.2 | 2020-11-18 | 998 | Adding incremental to the data model |
| 0.1.1 | 2020-11-10 | 895 | bump versions: all destinations and source exchange rate |
| 0.1.0 | 2020-10-21 | 676 | Integrations Reorganization: Connectors |