Skip to content
Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@
| `max_retries` | INTEGER | - | ✖ | The number of times the job is retried if it fails. |
| `retry_period` |INTERVAL| - | ✖ | The amount of time the scheduler waits between retries of the job on failure. |
| `scheduled` |BOOLEAN| `true` | ✖ | Set to `false` to exclude this job from being run as a background job. |
| `config` |JSONB| - | ✖| {C.JOB_CAP}-specific configuration, passed to the function when it runs. For the {C.COLUMNSTORE} policy this includes: <ul><li>`maxchunks_to_compress`: integer, defaults to `0` (no limit). The maximum number of {C.CHUNK}s to add to the {C.COLUMNSTORE} during a policy run.</li><li>`compress_after`: see [`add_columnstore_policy`](/reference/timescaledb/hypercore/add_columnstore_policy#arguments).</li><li>`compress_created_before`: see [`add_columnstore_policy`](/reference/timescaledb/hypercore/add_columnstore_policy#arguments).</li></ul> For the {C.CAGG} refresh policy this includes <ul><li>`compress_after_refresh`: boolean, defaults to `false`. When `true`, {C.TIMESCALE_DB} converts the {C.CAGG} {C.CHUNK}s in the refresh window to the {C.COLUMNSTORE} at the end of each scheduled refresh. Since 2.27.0.</li></ul> |
| `config` |JSONB| - | ✖| {C.JOB_CAP}-specific configuration, passed to the function when it runs. For the {C.COLUMNSTORE} policy this includes: <ul><li>`maxchunks_to_compress`: integer, defaults to `0` (no limit). The maximum number of {C.CHUNK}s to add to the {C.COLUMNSTORE} during a policy run.</li><li>`compress_after`: see [`add_columnstore_policy`](/reference/timescaledb/hypercore/add_columnstore_policy#arguments).</li><li>`compress_created_before`: see [`add_columnstore_policy`](/reference/timescaledb/hypercore/add_columnstore_policy#arguments).</li><li>`recompress_unordered`: boolean, defaults to `true`. Whether the policy recompresses fully compressed {C.CHUNK}s whose batches are out of order, which rewrites the whole {C.CHUNK}. Set to `false` to leave them to the cheaper [compaction policy](/reference/timescaledb/hypercore/add_compaction_policy). Since 2.29.0.</li></ul> For the {C.CAGG} refresh policy this includes <ul><li>`compress_after_refresh`: boolean, defaults to `false`. When `true`, {C.TIMESCALE_DB} converts the {C.CAGG} {C.CHUNK}s in the refresh window to the {C.COLUMNSTORE} at the end of each scheduled refresh. Since 2.27.0.</li></ul> |

Check warning on line 152 in src/content/docs/reference/timescaledb/jobs-automation/alter_job.mdx

View workflow job for this annotation

GitHub Actions / Vale

Vale: Google.Acronyms

Spell out 'CHUNK', if it's unfamiliar to the audience.

Check warning on line 152 in src/content/docs/reference/timescaledb/jobs-automation/alter_job.mdx

View workflow job for this annotation

GitHub Actions / Vale

Vale: Google.Acronyms

Spell out 'CAGG', if it's unfamiliar to the audience.

Check warning on line 152 in src/content/docs/reference/timescaledb/jobs-automation/alter_job.mdx

View workflow job for this annotation

GitHub Actions / Vale

Vale: Google.Acronyms

Spell out 'CAGG', if it's unfamiliar to the audience.

Check warning on line 152 in src/content/docs/reference/timescaledb/jobs-automation/alter_job.mdx

View workflow job for this annotation

GitHub Actions / Vale

Vale: Google.Acronyms

Spell out 'CHUNK', if it's unfamiliar to the audience.

Check warning on line 152 in src/content/docs/reference/timescaledb/jobs-automation/alter_job.mdx

View workflow job for this annotation

GitHub Actions / Vale

Vale: Google.Acronyms

Spell out 'CHUNK', if it's unfamiliar to the audience.

Check warning on line 152 in src/content/docs/reference/timescaledb/jobs-automation/alter_job.mdx

View workflow job for this annotation

GitHub Actions / Vale

Vale: Google.Acronyms

Spell out 'CHUNK', if it's unfamiliar to the audience.

Check warning on line 152 in src/content/docs/reference/timescaledb/jobs-automation/alter_job.mdx

View workflow job for this annotation

GitHub Actions / Vale

Vale: Google.Acronyms

Spell out 'JSONB', if it's unfamiliar to the audience.
| `config_merge` |JSONB| - | ✖| Since 2.29.0. Merge these keys into the {C.JOB}'s existing `config` instead of replacing it. The keys you pass take precedence, and the keys you leave out are unchanged. Cannot be combined with `config`. |
| `next_start` |TIMESTAMPTZ| - | ✖ | The next time at which to run the job. The job can be paused by setting this value to `infinity`, and restarted with a value of `now()`. |
| `if_exists` |BOOLEAN| `false` | ✖ | Set to `true` to issue a notice instead of an error if the job does not exist. |
Expand Down
Loading