Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

target-firebase

target-firebase is a Singer target for Firebase.

Build with the Meltano Target SDK.

Installation

Install from PyPI:

uv tool install target-firebase

Install from GitHub:

uv tool install git+https://github.com/ORG_NAME/target-firebase.git@main

Configuration

Accepted Config Options

Setting Required Default Description
credential_file False None The path to the Google Cloud Firestore credential file. If none is provided, Google Application Default Credentials are used.
credential False None The Google Cloud Firestore credential object. If none is provided, Google Application Default Credentials are used.
credential.type True service_account The type of credential.
credential.client_email True None The service account's email.
credential.token_uri False https://oauth2.googleapis.com/token The OAuth 2.0 Token URI.
credential.project_id True None Project ID associated with the service account credential.
credential.universe_domain False None The universe domain. The default universe domain is googleapis.com. For default value self signed jwt is used for token refresh.
credential.trust_boundary False None String representation of trust boundary meta.
firebase_app False [DEFAULT] The name of the Firebase app to use.
database_id False None The database ID of the Google Cloud Firestore database to be used. Defaults to the default Firestore database ID if not specified or an empty string.
add_record_metadata False None Whether to add metadata fields to records.
load_method False TargetLoadMethods.APPEND_ONLY The method to use when loading data into the destination. append-only will always write all input records whether that records already exists or not. upsert will update existing records and insert new records. overwrite will delete all existing records and insert all input records.
batch_size_rows False None Maximum number of rows in each batch.
validate_records False True Whether to validate the schema of the incoming streams.
stream_maps False None Config object for stream maps capability. For more information check out Stream Maps.
stream_maps.else False None Currently, only setting this to __NULL__ is supported. This will remove all other streams.
stream_map_config False None User-defined config values to be used within map expressions.
faker_config False None Config for the Faker instance variable fake used within map expressions. Only applicable if the plugin specifies faker as an additional dependency (through the singer-sdk faker extra or directly).
faker_config.seed False None Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator
faker_config.locale False None One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization
flattening_enabled False None 'True' to enable schema flattening and automatically expand nested properties.
flattening_max_depth False None The max depth to flatten schemas.

A full list of supported settings and capabilities for this target is available by running:

target-firebase --about

Configure using environment variables

This Singer target will automatically import any environment variables within the working directory's .env if the --config=ENV is provided, such that config values will be considered if a matching environment variable is set either in the terminal context or in the .env file.

Usage

You can easily run target-firebase by itself or in a pipeline using Meltano.

Executing the Target Directly

target-firebase --version
target-firebase --help
# Test using the "Smoke Test" tap:
tap-smoke-test | target-firebase --config /path/to/target-firebase-config.json

Developer Resources

Follow these instructions to contribute to this project.

Initialize your Development Environment

curl -LsSf https://astral.sh/uv/install.sh | sh  # or see https://docs.astral.sh/uv/getting-started/installation/
uv sync

Create and Run Tests

Create tests within the tests subfolder and then run:

uv run pytest

You can also test the target-firebase CLI interface directly using uv run:

uv run target-firebase --help

Testing with Meltano

Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.

Use Meltano to run an EL pipeline:

# Test invocation:
uvx meltano invoke tap-firebase --version

# OR run a test `elt` pipeline:
uvx meltano run tap-firebase target-jsonl

SDK Dev Guide

See the dev guide for more instructions on how to use the Meltano Singer SDK to develop your own Singer taps and targets.

Metadata

Release files for target-firebase 0.0.1a6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for target-firebase 0.0.1a6
File Size Uploaded
target_firebase-0.0.1a6.tar.gz 116.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for target-firebase 0.0.1a6
File Interpreter ABI Platform
target_firebase-0.0.1a6-py3-none-any.whl Python 3 none any Details

Total release size: 126.4 kB

Release files / target_firebase-0.0.1a6.tar.gz

Download URL target_firebase-0.0.1a6.tar.gz
Size 116.1 kB
Tags Source
SHA-256 checksum
How to use checksums
de9215ab7a89d0262ae1dc23bb5780bf16ce19ba48a0475f95e91574d9a7d8e1
BLAKE2b-256 checksum
How to use checksums
12d06c36d6affa0e1f91f23dab1b75e63f13dabee56858208008ecd834e493a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 25, 2025.

Transparency log

Release files / target_firebase-0.0.1a6-py3-none-any.whl

Download URL target_firebase-0.0.1a6-py3-none-any.whl
Size 10.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
599288ff5d665af8b446a54bae6e318c46f349fc2118c707707296bf7911715a
BLAKE2b-256 checksum
How to use checksums
9763f49331c3a437fe679594cbdc6a076d07006b11a57ec432592b19be8f0b61
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 25, 2025.

Transparency log
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page