Gmail
Gmail is Google's email service. With Weld, you can sync your mailbox — profile, labels, threads, and messages — into your data warehouse for reporting and analysis. Weld also supports Reverse ETL to send your model data as an email attachment from your connected Gmail account.
| Feature name | Supported | |
|---|---|---|
| Column Hashing | True | Field level |
| Blocking | True | Field level |
| Incremental | True | |
| Custom data | False | |
| History | False | |
| ReSync | True | Table level |
| Templates | False |
Data Schema
Setup Guide - ELT
Prerequisites
Access to the Gmail account you want to sync data from.
Step 1 - Begin Configuration
- In the connector setup form, enter the destination schema name of your choice.
- Click Authorize to allow Weld to access your Gmail account using OAuth. You will be redirected to your Google account.
Step 2 - Grant access to Weld
Click Grant Access to allow Weld read-only access to your Gmail account. When authorization is complete, you will be redirected back to the Weld connections overview.
Step 3 - Data To Sync
Select the tables you wish to include in the sync:
- Profile — your mailbox's email address and message/thread counters.
- Label — all labels in your mailbox, including system and custom labels.
- Thread — all email threads in your mailbox.
- Message — all messages in your mailbox, including labels, classification labels, and the full MIME payload (parts and headers).
You can view the schema, remove columns, or hash sensitive information.
Step 4 - Configure Sync
- Select how often you would like the data to sync.
- Choose a start date to limit how far back the initial sync goes.
- Provide a unique destination table name.
Weld will take over from here and commence syncing data from your Gmail account.
Setup Guide - Reverse ETL
Gmail reverse ETL allows you to sync data on a schedule from your Weld App automatically into your Gmail account, sending it as an email attachment.
Every sync generates a single file containing the full result of your model and sends it as an attachment from your connected Gmail account. There is no concept of inserting, updating, or upserting individual rows — each run is a fresh Mirror of your data.
Pre-requisites
- You first must set up a connection to Gmail via OAuth.
- You must publish your SQL model containing the data that you want to send.
Step 1 - Begin Configuration
- Click on the Reverse ETL button in the side bar and click + New on the top right.
- Select the Gmail connector from the drop down menu or else click + Add new connection to authorize the connector.
Step 2 - Destination Settings
- Recipient email address(es): Enter the email address(es) that should receive the file attachment.
- File type: Choose the format of the generated file —
CSV,Parquet,NDJSON, orJSON array. - Compression: Optionally compress the file with
Gzip. Not available forParquet, since it is already internally compressed.
Step 3 - Model
- Choose the SQL model that contains the data you would like to send.
- Map the model columns to the file columns. Every column will be included as is, the column name and type will be preserved to the extent the file format allows.
Step 4 - Sync Operation
Gmail only supports Mirror: every sync sends a new email with a fresh file attachment containing all of the data from your model.
There is a size limit on email attachments. If your model is too large to attach, reduce the amount of data or filter the model before sending.