Skip to main content

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.

Performance considerations​

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

Supported sync modes​

Sync modeSupported?
Full Refresh - OverwriteYes
Full Refresh - AppendYes
Full Refresh - Overwrite + DedupedNo
Incremental Sync - AppendYes
Incremental Sync - Append + DedupedNo

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.

Namespace support​

This destination does not support namespaces.

Reference​

Config fields reference

Field
Type
Property name
string
destination_path

Changelog​

Expand to review
VersionDatePull RequestSubject
0.2.92025-05-1059805Update dependencies
0.2.82025-05-0359348Update dependencies
0.2.72025-04-2658682Update dependencies
0.2.62025-04-1958261Update dependencies
0.2.52025-04-1257615Update dependencies
0.2.42025-04-0557113Update dependencies
0.2.32025-03-2956577Update dependencies
0.2.22025-03-2256104Update dependencies
0.2.12025-03-0843815Update dependencies
0.2.02025-03-0154897Update to Airbyte CDK 6 and Python 3.11
0.1.92024-08-2244530Update test dependencies
0.1.82024-07-0941098Update dependencies
0.1.72024-07-0640944Update dependencies
0.1.62024-06-2740215Replaced deprecated AirbyteLogger with logging.Logger
0.1.52024-06-2540323Update dependencies
0.1.42024-06-2240070Update dependencies
0.1.32024-06-0438975[autopull] Upgrade base image to v1.2.1
0.1.22024-05-2238539[autopull] base image + poetry + up_to_date
0.1.12024-05-2138539[autopull] base image + poetry + up_to_date
0.1.02022-07-2515018New SQLite destination