This repository contains Mozilla Data Team's:
- Derived ETL jobs that do not require a custom container
- User-defined functions (UDFs)
- Airflow DAGs for scheduled bigquery-etl queries
- Tools for query & UDF deployment, management and scheduling
For more information, see https://mozilla.github.io/bigquery-etl/
Apple Silicon (M1) user suggestion
Enable Rosetta mode for your terminal BEFORE installing below tools using your terminal. It'll save you a lot of headaches.
- Homebrew (not required, but useful for Mac) - Follow the instructions here to install homebrew on your Mac.
- Python 3.8+ - (see this guide for instructions if you're on a mac and haven't installed anything other than the default system Python).
- Java JDK 11+ - (required for some functionality, e.g. AdoptOpenJDK) with
$JAVA_HOME
set. - Maven - (needed for downloading jar dependencies). Available via your package manager in most Linux distributions and from homebrew on mac, or you can install yourself by downloading a binary and following maven's install instructions.
- For Mozilla Employees or Contributors (not in Data Engineering) - Set up GCP command line tools, as described on docs.telemetry.mozilla.org. Note that some functionality (e.g. writing UDFs or backfilling queries) may not be allowed.
- For Data Engineering - In addition to setting up the command line tools, you will want to log in to
shared-prod
if making changes to production systems. Rungcloud auth login --update-adc --project=moz-fx-data-shared-prod
(if you have not run it previously).
- Clone the repository
git clone [email protected]:mozilla/bigquery-etl.git
cd bigquery-etl
- Install the
bqetl
command line tool
./bqetl bootstrap
- Install standard pre-commit hooks
venv/bin/pre-commit install
- Optionally, download java dependencies
mvn dependency:copy-dependencies
venv/bin/pip-sync requirements.txt java-requirements.txt
Finally, if you are using Visual Studio Code, you may also wish to use our recommended defaults:
cp .vscode/settings.json.default .vscode/settings.json
And you should now be set up to start working in the repo! The easiest way to do this is for many tasks is to use bqetl
. You may also want to read up on common workflows.