docs: add jobs overwrite flag #4646
Open
+3
−2
Conversation
This file contains hidden or 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
Signed-off-by: Javier Aliaga <[email protected]>
javier-aliaga
changed the title
msfussell
reviewed
May 7, 2025
There was a problem hiding this comment.
@javier-aliaga - Commented. A few things
-
Please put the code issue into the docs issue. I have added it in this case (Don't overwrite jobs using same name dapr#8402)
-
Let's use this PR to update docs overview here https://docs.dapr.io/developing-applications/building-blocks/jobs/jobs-overview/
- Under Features we really should say that the primary feature here is to create, get and delete jobs. This can be one paragraph, but in that paragraph you should mention that an existing job cannot be overwritten unless specific indicated. Write something and I will review this
- The first sentence here is now wrong I presume https://docs.dapr.io/developing-applications/building-blocks/jobs/jobs-overview/ under "Schedule jobs across multiple replicas" - where is says "When you create a job, it replaces any existing job with the same name." Should now say "When you create a job, it does not replace an existing job with the same name, unless you explicitly set the 'overwrite' flag"
- Remove the "waiting on code" label once this code is merged.
| @@ -19,8 +19,7 @@ All jobs are registered with a case-sensitive job name. These names are intended | |||
| interfacing with the Dapr runtime. The name is used as an identifier when creating and modifying the job as well as | |||
| to indicate which job a triggered invocation is associated with. | |||
|
|
|||
| Only one job can be associated with a name at any given time. Any attempt to create a new job using the same name | |||
| as an existing job will result in an overwrite of this existing job. | |||
| Only one job can be associated with a name at any given time. By default, any attempt to create a new job using the same name as an existing job will result in an error. However, if the `overwrite` flag is set to `true`, the new job will overwrite the existing job with the same name. | |||
There was a problem hiding this comment.
Suggested change
| Only one job can be associated with a name at any given time. By default, any attempt to create a new job using the same name as an existing job will result in an error. However, if the `overwrite` flag is set to `true`, the new job will overwrite the existing job with the same name. | |
| Only one job can be associated with a name at any given time. By default, any attempt to create a new job using the same name as an existing job results in an error. However, if the `overwrite` flag is set to `true`, the new job overwrites the existing job with the same name. |
| @@ -37,6 +37,7 @@ Parameter | Description | |||
| `dueTime` | An optional time at which the job should be active, or the "one shot" time, if other scheduling type fields are not provided. Accepts a "point in time" string in the format of RFC3339, Go duration string (calculated from creation time), or non-repeating ISO8601. | |||
| `repeats` | An optional number of times in which the job should be triggered. If not set, the job runs indefinitely or until expiration. | |||
| `ttl` | An optional time to live or expiration of the job. Accepts a "point in time" string in the format of RFC3339, Go duration string (calculated from job creation time), or non-repeating ISO8601. | |||
| `overwrite` | A boolean value to specify it the job can overwrite an existing one. Default value is `false` | |||
There was a problem hiding this comment.
Suggested change
| `overwrite` | A boolean value to specify it the job can overwrite an existing one. Default value is `false` | |
| `overwrite` | A boolean value to specify if the job can overwrite an existing one with the same name. Default value is `false` |
msfussell
added
the
waiting-on-code-pr
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Thank you for helping make the Dapr documentation better!
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
Issue reference
dapr/dapr#8402