[Core] New jinja model.batch context

[QMalcolm]

Link to the page(s) on docs.getdbt.com requiring updates

• https://docs.getdbt.com/reference/dbt-jinja-functions
• https://docs.getdbt.com/reference/dbt-jinja-functions/model

Tell us more about this update

We've added a new batch object to the already existing model dbt-jinja-functions. I'm not sure exactly how this should be documented, as it a new thing on an already existing "dbt-jinja-function" and not a new "dbt-jinja-function" itself (depending on how you think about it).

batch properties

The batch qualities available are:

• id (i.e. model.batch.id)
  • This is the "unique" id for the batch within the context of the microbatch model
• event_time_start (i.e. model.batch.event_time_start)
  • This is the start time of the batch's event time filter (inclusive)
• event_time_end (i.e. model.batch.event_time_end)
  • This is the end time of the batch's event_time_filter (exclusive)

things to call out

1. model.batch is only ever populated in the context of a microbatch model batch execution
   a. that is, outside of batch execution model.batch = None and the sub properties are unaccsible
2. Given (1a) it is recommended to guard any accessing of the underlying properties

Example of (2)

{% if model.batch %}
  {{ log(model.batch.id) }}
{% endif %}

Reviewers/Stakeholders/SMEs

• @jtcohen6
• @QMalcolm
• @MichelleArk

Related GitHub issues

No response

Additional information

No response