-
Notifications
You must be signed in to change notification settings - Fork 264
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
dungnmaster
wants to merge
3
commits into
staging
Choose a base branch
from
job_docs_update
base: staging
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
|
||
.. 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; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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; |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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()
andconnection.stop_jobs()
in the documentation.