Templates
Using and creating pipeline templates
Templates are pre-configured pipeline settings that you can use as starting points when creating new pipelines. They save time and ensure consistency across your organization.
System Templates
Fireconduit includes two built-in system templates:
Official Firebase Extension
Compatible with the official Firebase BigQuery Extension schema. This template uses 7 columns:
| Column | Source | Description |
|---|---|---|
timestamp | Backfill Time | When the backfill ran |
event_id | Generated UUID | Unique identifier for the row |
document_name | Document Path | Full Firestore document path |
document_id | Document ID | The document’s ID |
operation | Constant | Always “BACKFILL” |
data | Document Data (JSON) | Full document as JSON string |
old_data | Null | Not used for backfills |
Use this template when:
- You already use the Firebase BigQuery Extension for real-time sync
- You want to backfill historical data into the same table format
- You need compatibility with existing BigQuery queries
Simple
A minimal template with 4 essential columns:
| Column | Source | Description |
|---|---|---|
id | Generated UUID | Unique row identifier |
document_id | Document ID | The Firestore document ID |
data | Document Data (JSON) | Full document as JSON string |
timestamp | Backfill Time | When the backfill ran |
Use this template when:
- You want a simple, minimal schema
- You don’t need Firebase Extension compatibility
- You’ll process the JSON data in BigQuery queries
Using Templates
When Creating a Pipeline
- Navigate to Pipelines and click New Pipeline
- In the Schema step, you’ll see template options
- Select a template to pre-populate the schema columns
- Modify the schema as needed for your use case
From the Templates Page
- Navigate to Templates in the dashboard
- Browse system and organization templates
- Click Use This Template on your chosen template
- Complete the pipeline wizard with pre-filled settings
Organization Templates
In addition to system templates, you can create custom templates for your organization.
Creating a Template
Organization templates are created from existing pipelines:
- Create and configure a pipeline with your desired settings
- Navigate to the pipeline’s detail page
- Click Save as Template
- Give the template a name and description
Your template will include:
- Schema column configuration
- Trigger type settings
- Dataflow worker configuration
Managing Templates
Organization templates appear in the Templates page alongside system templates. You can:
- View template details and settings
- Use templates when creating new pipelines
- Delete templates you no longer need
Template Best Practices
Name templates clearly: Use descriptive names that indicate the template’s purpose, like “Analytics Events Schema” or “User Profile Export”.
Document in descriptions: Explain when and why to use each template. Future team members will thank you.
Standardize across projects: If you have multiple Firebase projects, use the same templates to keep BigQuery schemas consistent.
Review periodically: As your needs evolve, update or retire templates that are no longer relevant.
Template vs. Custom Schema
You’re not limited to template schemas. When creating a pipeline, you can:
- Start from a template: Select a template and use it as-is
- Modify a template: Start from a template and add, remove, or change columns
- Build from scratch: Skip templates and define your own schema
Templates are starting points—feel free to customize them to match your exact requirements.