Add scheduler source and info on () type (#50)

nstack · Jun 13, 2017 · ba227af · ba227af
1 parent 2ceda1b
commit ba227af
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/reference/supported_integrations.rst b/reference/supported_integrations.rst
@@ -10,6 +10,21 @@ NStack is built to integrate with existing infrastructure, event, and data-sourc
 Sources
 ^^^^^^^
 
+
+Schedule
+--------
+
+::
+
+ Sources.schedule<()> {
+   cron = "* * * * * *"
+ }
+
+NStack's Schedule source allows you to run a workflow in intervals over a time period. It takes a single argument of a *crontab*, which specifies the interval to use. 
+Note that NStack's scheduler expects six fields: minute, hour, day of month, month, day(s) of week, year. As the scheduler emits events, it is of type Unit, which is represented by ``()``
+
+
+
 Postgres
 -------
 

diff --git a/reference/supported_types.rst b/reference/supported_types.rst
@@ -31,4 +31,6 @@ More complex types can be built out of primitive ones:
 ``Void`` is a special type that is used to define custom sources and sinks,
 see :ref:`supported-integrations`.
 
+``()`` represents Unit, which signifies an event which contains no data. 
+
 A user can define their own type in the :ref:`workflow_language`.