1
0
mirror of synced 2025-12-21 02:51:29 -05:00
Files
airbyte/docs/integrations/destinations/sqlite.md

5.7 KiB

Sqlite

:::danger

This destination is meant to be used on a local workstation and won't work on Kubernetes

:::

Overview

This destination writes data to a file on the local filesystem on the host running Airbyte. By default, data is written to /tmp/airbyte_local. To change this location, modify the LOCAL_ROOT environment variable for Airbyte.

:::caution

Please make sure that Docker Desktop has access to /tmp (and /private on a MacOS, as /tmp has a symlink that points to /private. It will not work otherwise). You allow it with "File sharing" in Settings -> Resources -> File sharing -> add the one or two above folder and hit the "Apply & restart" button.

:::

Sync Overview

Output schema

Each stream will be output into its own table _airbyte_raw_{stream_name}. Each table will contain 3 columns:

  • _airbyte_ab_id: a uuid assigned by Airbyte to each event that is processed.
  • _airbyte_emitted_at: a timestamp representing when the event was pulled from the data source.
  • _airbyte_data: a json blob representing with the event data.

Features

Feature Supported
Full Refresh Sync Yes
Incremental - Append Sync Yes
Incremental - Append + Deduped No
Namespaces No

Performance considerations

This integration will be constrained by the speed at which your filesystem accepts writes.

Getting Started

The destination_path will always start with /local whether it is specified by the user or not. Any directory nesting within local will be mapped onto the local mount.

By default, the LOCAL_ROOT env variable in the .env file is set /tmp/airbyte_local.

The local mount is mounted by Docker onto LOCAL_ROOT. This means the /local is substituted by /tmp/airbyte_local by default.

Example:

  • If destination_path is set to /local/sqlite.db
  • the local mount is using the /tmp/airbyte_local default
  • then all data will be written to /tmp/airbyte_local/sqlite.db.

Access Replicated Data Files

If your Airbyte instance is running on the same computer that you are navigating with, you can open your browser and enter file:///tmp/airbyte_local to look at the replicated data locally. If the first approach fails or if your Airbyte instance is running on a remote server, follow the following steps to access the replicated files:

  1. Access the scheduler container using docker exec -it airbyte-server bash
  2. Navigate to the default local mount using cd /tmp/airbyte_local
  3. Navigate to the replicated file directory you specified when you created the destination, using cd /{destination_path}
  4. Execute sqlite3 {filename} to access the data in a particular database file.

You can also copy the output file to your host machine, the following command will copy the file to the current working directory you are using:

docker cp airbyte-server:/tmp/airbyte_local/{destination_path} .

Note: If you are running Airbyte on Windows with Docker backed by WSL2, you have to use similar step as above or refer to this link for an alternative approach.

Changelog

Expand to review
Version Date Pull Request Subject
0.2.9 2025-05-10 59805 Update dependencies
0.2.8 2025-05-03 59348 Update dependencies
0.2.7 2025-04-26 58682 Update dependencies
0.2.6 2025-04-19 58261 Update dependencies
0.2.5 2025-04-12 57615 Update dependencies
0.2.4 2025-04-05 57113 Update dependencies
0.2.3 2025-03-29 56577 Update dependencies
0.2.2 2025-03-22 56104 Update dependencies
0.2.1 2025-03-08 43815 Update dependencies
0.2.0 2025-03-01 54897 Update to Airbyte CDK 6 and Python 3.11
0.1.9 2024-08-22 44530 Update test dependencies
0.1.8 2024-07-09 41098 Update dependencies
0.1.7 2024-07-06 40944 Update dependencies
0.1.6 2024-06-27 40215 Replaced deprecated AirbyteLogger with logging.Logger
0.1.5 2024-06-25 40323 Update dependencies
0.1.4 2024-06-22 40070 Update dependencies
0.1.3 2024-06-04 38975 [autopull] Upgrade base image to v1.2.1
0.1.2 2024-05-22 38539 [autopull] base image + poetry + up_to_date
0.1.1 2024-05-21 38539 [autopull] base image + poetry + up_to_date
0.1.0 2022-07-25 15018 New SQLite destination