Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added CREATE JOB and DROP JOB to evadb docs #1349

Open
wants to merge 3 commits into
base: staging
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,11 @@ parts:
- file: source/reference/evaql/create_function
- file: source/reference/evaql/create_index
- file: source/reference/evaql/create_table
- file: source/reference/evaql/create_job
- file: source/reference/evaql/drop_database
- file: source/reference/evaql/drop_function
- file: source/reference/evaql/drop_table
- file: source/reference/evaql/drop_job
- file: source/reference/evaql/insert_table
- file: source/reference/evaql/delete_table
- file: source/reference/evaql/rename
Expand Down
41 changes: 41 additions & 0 deletions docs/source/reference/evaql/create_job.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
CREATE JOB
===============

.. _create-job:

The CREATE JOB statement allows us to create recurring or one-time jobs in EvaDB. These jobs can be associated with multiple queries,
all of which will be executed sequentially every time the created job is triggered according to the assigned schedule.


Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We shall add connection.start_jobs() and connection.stop_jobs() in the documentation.

.. code-block:: text

CREATE JOB [IF NOT EXISTS] <job_name> AS
{
<job_queries>...
}
[START <start_time>]
[END <end_time>]
[EVERY <repeat_period> <repeat_unit>]

* There can be multiple queries defined per job.
* The START parameter denotes the first trigger time of the job. The default value is the job creation time.
* The END parameter denotes the last trigger time of the job. The job becomes inactive after this time. If no end value is provided, a recurring job never ends.
* The EVERY parameter can be used to specify the repeat frequency of the jobs. The repeat period is expected to be a positive integer, and accepted values for the repeat unit are "minute", "minutes", "min", "hour", "hours", "day", "days", "week", "weeks", "month", "months".


Examples
~~~~~~~~

.. code:: text

CREATE JOB forecasting_job AS
{
CREATE OR REPLACE FUNCTION HomeSalesForecast FROM
( SELECT * FROM postgres_data.home_sales )
TYPE Forecasting
PREDICT 'price';
SELECT HomeSalesForecast(10);
}
START '2023-04-01 01:10:00'
END '2023-05-01'
EVERY 1 week;
9 changes: 9 additions & 0 deletions docs/source/reference/evaql/drop_job.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
DROP JOB
=============

.. _drop-job:

.. code:: mysql

DROP JOB forecasting_job;
DROP JOB IF EXISTS forecasting_job;