jedcunningham commented on code in PR #23099:
URL: https://github.com/apache/airflow/pull/23099#discussion_r853481174
##########
docs/apache-airflow/concepts/timetable.rst:
##########
@@ -48,3 +48,51 @@ the schedule. Some examples are:
As such, Airflow allows for custom timetables to be written in plugins and
used by
DAGs. An example demonstrating a custom timetable can be found in the
:doc:`/howto/timetable` how-to guide.
+
+Built In Timetables
+-------------------
+Airflow comes with several common timetables built in to cover the most common
use cases. Additional timetables
+may be available in provider packages.
+
+CronDataIntervalTimetable
+-------------------------
Review Comment:
```suggestion
^^^^^^^^^^^^^^^^^^^^^^^^^
```
##########
docs/apache-airflow/concepts/timetable.rst:
##########
@@ -48,3 +48,51 @@ the schedule. Some examples are:
As such, Airflow allows for custom timetables to be written in plugins and
used by
DAGs. An example demonstrating a custom timetable can be found in the
:doc:`/howto/timetable` how-to guide.
+
+Built In Timetables
+-------------------
Review Comment:
```suggestion
-------------------
```
##########
docs/apache-airflow/concepts/timetable.rst:
##########
@@ -48,3 +48,51 @@ the schedule. Some examples are:
As such, Airflow allows for custom timetables to be written in plugins and
used by
DAGs. An example demonstrating a custom timetable can be found in the
:doc:`/howto/timetable` how-to guide.
+
+Built In Timetables
+-------------------
+Airflow comes with several common timetables built in to cover the most common
use cases. Additional timetables
+may be available in provider packages.
+
+CronDataIntervalTimetable
+-------------------------
+Set timing based on a cron schedule. Can be selected by providing a string
that is a valid
Review Comment:
```suggestion
Set schedule based on a cron expression. Can be selected by providing a
string that is a valid
```
I think this sounds better?
##########
docs/apache-airflow/concepts/timetable.rst:
##########
@@ -48,3 +48,51 @@ the schedule. Some examples are:
As such, Airflow allows for custom timetables to be written in plugins and
used by
DAGs. An example demonstrating a custom timetable can be found in the
:doc:`/howto/timetable` how-to guide.
+
+Built In Timetables
+-------------------
+Airflow comes with several common timetables built in to cover the most common
use cases. Additional timetables
+may be available in provider packages.
+
+CronDataIntervalTimetable
+-------------------------
+Set timing based on a cron schedule. Can be selected by providing a string
that is a valid
+ cron expression to the schedule_interval parameter of a DAG as described in
the :doc:`/concepts/dags` documentation.
+
+.. code-block:: python
+ @dag(
+ schedule_interval="0 1 * * 3" # At 01:00 on Wednesday.
+ ...
+ )
+
+DeltaDataIntervalTimetable
+--------------------------
Review Comment:
```suggestion
^^^^^^^^^^^^^^^^^^^^^^^^^^
```
##########
docs/apache-airflow/concepts/timetable.rst:
##########
@@ -48,3 +48,51 @@ the schedule. Some examples are:
As such, Airflow allows for custom timetables to be written in plugins and
used by
DAGs. An example demonstrating a custom timetable can be found in the
:doc:`/howto/timetable` how-to guide.
+
+Built In Timetables
+-------------------
+Airflow comes with several common timetables built in to cover the most common
use cases. Additional timetables
+may be available in provider packages.
+
+CronDataIntervalTimetable
+-------------------------
+Set timing based on a cron schedule. Can be selected by providing a string
that is a valid
+ cron expression to the schedule_interval parameter of a DAG as described in
the :doc:`/concepts/dags` documentation.
+
+.. code-block:: python
+ @dag(
+ schedule_interval="0 1 * * 3" # At 01:00 on Wednesday.
+ ...
+ )
+
+DeltaDataIntervalTimetable
+--------------------------
+Schedules data intervals with a time delta. Can be selected by providing a
+ ``datetime.timedelta`` or ``dateutil.relativedelta.relativedelta`` to the
schedule_interval parameter of a DAG.
+
+.. code-block:: python
+ @dag(
+ schedule_interval=datetime.timedelta(minutes=30) # At 01:00 on
Wednesday.
+ ...
+ )
+
+EventsTimetable
+---------------
+Simply pass a list of datetimes for the DAG to run after. Useful for timing
based on sporting
Review Comment:
```suggestion
Simply pass a list of ``datetimes`` for the DAG to run after. Useful for
timing based on sporting
```
##########
docs/apache-airflow/concepts/timetable.rst:
##########
@@ -48,3 +48,51 @@ the schedule. Some examples are:
As such, Airflow allows for custom timetables to be written in plugins and
used by
DAGs. An example demonstrating a custom timetable can be found in the
:doc:`/howto/timetable` how-to guide.
+
+Built In Timetables
+-------------------
+Airflow comes with several common timetables built in to cover the most common
use cases. Additional timetables
+may be available in provider packages.
+
+CronDataIntervalTimetable
+-------------------------
+Set timing based on a cron schedule. Can be selected by providing a string
that is a valid
+ cron expression to the schedule_interval parameter of a DAG as described in
the :doc:`/concepts/dags` documentation.
Review Comment:
```suggestion
cron expression to the ``schedule_interval`` parameter of a DAG as
described in the :doc:`/concepts/dags` documentation.
```
##########
docs/apache-airflow/concepts/timetable.rst:
##########
@@ -48,3 +48,51 @@ the schedule. Some examples are:
As such, Airflow allows for custom timetables to be written in plugins and
used by
DAGs. An example demonstrating a custom timetable can be found in the
:doc:`/howto/timetable` how-to guide.
+
+Built In Timetables
+-------------------
+Airflow comes with several common timetables built in to cover the most common
use cases. Additional timetables
+may be available in provider packages.
+
+CronDataIntervalTimetable
+-------------------------
+Set timing based on a cron schedule. Can be selected by providing a string
that is a valid
+ cron expression to the schedule_interval parameter of a DAG as described in
the :doc:`/concepts/dags` documentation.
+
+.. code-block:: python
+ @dag(
+ schedule_interval="0 1 * * 3" # At 01:00 on Wednesday.
+ ...
+ )
+
+DeltaDataIntervalTimetable
+--------------------------
+Schedules data intervals with a time delta. Can be selected by providing a
+ ``datetime.timedelta`` or ``dateutil.relativedelta.relativedelta`` to the
schedule_interval parameter of a DAG.
+
+.. code-block:: python
+ @dag(
+ schedule_interval=datetime.timedelta(minutes=30) # At 01:00 on
Wednesday.
+ ...
+ )
+
+EventsTimetable
+---------------
Review Comment:
```suggestion
^^^^^^^^^^^^^^^
```
##########
docs/apache-airflow/concepts/timetable.rst:
##########
@@ -48,3 +48,51 @@ the schedule. Some examples are:
As such, Airflow allows for custom timetables to be written in plugins and
used by
DAGs. An example demonstrating a custom timetable can be found in the
:doc:`/howto/timetable` how-to guide.
+
+Built In Timetables
+-------------------
+Airflow comes with several common timetables built in to cover the most common
use cases. Additional timetables
+may be available in provider packages.
+
+CronDataIntervalTimetable
+-------------------------
+Set timing based on a cron schedule. Can be selected by providing a string
that is a valid
+ cron expression to the schedule_interval parameter of a DAG as described in
the :doc:`/concepts/dags` documentation.
+
+.. code-block:: python
+ @dag(
+ schedule_interval="0 1 * * 3" # At 01:00 on Wednesday.
+ ...
+ )
+
+DeltaDataIntervalTimetable
+--------------------------
+Schedules data intervals with a time delta. Can be selected by providing a
+ ``datetime.timedelta`` or ``dateutil.relativedelta.relativedelta`` to the
schedule_interval parameter of a DAG.
+
+.. code-block:: python
+ @dag(
+ schedule_interval=datetime.timedelta(minutes=30) # At 01:00 on
Wednesday.
Review Comment:
```suggestion
schedule_interval=datetime.timedelta(minutes=30)
```
##########
docs/apache-airflow/concepts/timetable.rst:
##########
@@ -48,3 +48,51 @@ the schedule. Some examples are:
As such, Airflow allows for custom timetables to be written in plugins and
used by
DAGs. An example demonstrating a custom timetable can be found in the
:doc:`/howto/timetable` how-to guide.
+
+Built In Timetables
+-------------------
+Airflow comes with several common timetables built in to cover the most common
use cases. Additional timetables
+may be available in provider packages.
+
+CronDataIntervalTimetable
+-------------------------
+Set timing based on a cron schedule. Can be selected by providing a string
that is a valid
+ cron expression to the schedule_interval parameter of a DAG as described in
the :doc:`/concepts/dags` documentation.
+
+.. code-block:: python
+ @dag(
+ schedule_interval="0 1 * * 3" # At 01:00 on Wednesday.
+ ...
+ )
+
+DeltaDataIntervalTimetable
+--------------------------
+Schedules data intervals with a time delta. Can be selected by providing a
+ ``datetime.timedelta`` or ``dateutil.relativedelta.relativedelta`` to the
schedule_interval parameter of a DAG.
Review Comment:
```suggestion
``datetime.timedelta`` or ``dateutil.relativedelta.relativedelta`` to the
``schedule_interval`` parameter of a DAG.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
