Skip to content

Allow custom names for User-Defined Actions #7958

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

Merged
merged 1 commit into from
May 6, 2025

Conversation

melihmutlu
Copy link
Member

@melihmutlu melihmutlu commented Apr 14, 2025

This commit allows custom names for Used-Defined Actions.

add_job() and alter_job() accept an additional "job_name" argument to modify the name of User-Defined Action. If "job_name" is not specified, it is names as default.

Closes #6991

@melihmutlu melihmutlu self-assigned this Apr 14, 2025
@CLAassistant
Copy link

CLAassistant commented Apr 14, 2025

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@melihmutlu melihmutlu force-pushed the allow_custom_uda_name branch from c049edd to 9470fe2 Compare April 14, 2025 14:00
@RobAtticus
Copy link
Member

Nice, so this would close #6991 then?

@fabriziomello fabriziomello added jobs Background Worker The background worker subsystem, including the scheduler labels Apr 14, 2025
@melihmutlu melihmutlu force-pushed the allow_custom_uda_name branch 9 times, most recently from 4cd8f17 to a9002db Compare April 15, 2025 14:59
Copy link
Member

@mkindahl mkindahl left a comment

Choose a reason for hiding this comment

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

Patch looks good, but I do not think it is necessary to add the job id if the user provides a job name.

It forces the user to think about this when reading job information using scripts or automation and also limits the usability for the user if they want to provide other information or information in different format as part of the job name.

Copy link

codecov bot commented Apr 16, 2025

Codecov Report

Attention: Patch coverage is 88.23529% with 2 lines in your changes missing coverage. Please review.

Project coverage is 82.13%. Comparing base (59f50f2) to head (58496b1).
Report is 1009 commits behind head on main.

Files with missing lines Patch % Lines
src/bgw/job.c 83.33% 0 Missing and 1 partial ⚠️
tsl/src/bgw_policy/job_api.c 90.90% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7958      +/-   ##
==========================================
+ Coverage   80.06%   82.13%   +2.07%     
==========================================
  Files         190      253      +63     
  Lines       37181    47231   +10050     
  Branches     9450    11902    +2452     
==========================================
+ Hits        29770    38795    +9025     
- Misses       2997     3726     +729     
- Partials     4414     4710     +296     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@melihmutlu melihmutlu force-pushed the allow_custom_uda_name branch from a13d930 to 5cfbba4 Compare April 16, 2025 10:56
@philkra philkra added this to the v2.20.0 milestone Apr 16, 2025
@melihmutlu melihmutlu force-pushed the allow_custom_uda_name branch 2 times, most recently from 64cceae to 747ab7f Compare April 16, 2025 11:30
@svenklemm
Copy link
Member

Shouldn't the datatype in the API be text since name is for sql identifier which this is not.

@melihmutlu
Copy link
Member Author

Shouldn't the datatype in the API be text since name is for sql identifier which this is not.

application_name is name, and job names go into application_name. That's why I decided to go with name instead of text.

Another reason was thatname has a limit of 63 bytes, so it would help to have names with reasonable lengths. But now I realize that a format like "<job_name> [<job_id>]" can easily exceed that limit. Even without appending the job ID, users could provide long job names that get truncated to 63 bytes, potentially resulting in different jobs ending up with the same name.

Maybe we should have a limit on the length of job name, possibly a bit shorter than 63, to be safe. Any thoughts?

@melihmutlu melihmutlu force-pushed the allow_custom_uda_name branch 3 times, most recently from 91d7787 to 6c33371 Compare April 21, 2025 13:50
@melihmutlu melihmutlu force-pushed the allow_custom_uda_name branch 3 times, most recently from fb66024 to 423fad7 Compare April 22, 2025 07:39
@melihmutlu melihmutlu force-pushed the allow_custom_uda_name branch 3 times, most recently from 659b009 to abcd731 Compare April 29, 2025 15:55
@melihmutlu melihmutlu force-pushed the allow_custom_uda_name branch 3 times, most recently from f73c309 to b000625 Compare April 30, 2025 14:19
@melihmutlu melihmutlu force-pushed the allow_custom_uda_name branch from b000625 to ff477e4 Compare May 5, 2025 07:54
@philkra philkra requested a review from fabriziomello May 5, 2025 11:38
@melihmutlu melihmutlu force-pushed the allow_custom_uda_name branch from ff477e4 to 8480132 Compare May 5, 2025 21:23
@melihmutlu melihmutlu enabled auto-merge (squash) May 6, 2025 08:31
@melihmutlu melihmutlu disabled auto-merge May 6, 2025 08:31
This commit allows custom names for Used-Defined Actions.

add_job() and alter_job() accept an additional "job_name" argument to
modify the name of User-Defined Action. If "job_name" is not specified,
it is names as default.
@melihmutlu melihmutlu force-pushed the allow_custom_uda_name branch from 8480132 to 58496b1 Compare May 6, 2025 08:32
@melihmutlu melihmutlu enabled auto-merge (squash) May 6, 2025 08:32
@melihmutlu melihmutlu merged commit 2785bea into timescale:main May 6, 2025
43 checks passed
@melihmutlu melihmutlu deleted the allow_custom_uda_name branch May 6, 2025 11:50
This was referenced May 7, 2025
philkra added a commit that referenced this pull request May 15, 2025
## 2.20.0 (2025-05-15)

This release contains performance improvements and bug fixes since the
2.19.3 release. We recommend that you upgrade at the next available
opportunity.

**Highlighted features in TimescaleDB v2.20.0**
* The columnstore now leverages *bloom filters* to deliver up to 6x
faster point queries on columns with high cardinality values, such as
UUIDs.
* Major *improvements to the columnstores' backfill process* enable
`UPSERTS` with strict constraints to execute up to 10x faster.
* *SkipScan is now supported in the columnstore*, including for DISTINCT
queries. This enhancement leads to dramatic query performance
improvements of 2000x to 2500x, especially for selective queries.
* SIMD vectorization for the bool data type is now enabled by default.
This change results in a 30–45% increase in performance for analytical
queries with bool clauses on the columnstore.
* *Continuous aggregates* now include experimental support for *window
functions and non-immutable functions*, extending the analytics use
cases they can solve.
* Several quality-of-life improvements have been introduced: job names
for continuous aggregates are now more descriptive, you can assign
custom names to them, and it is now possible to add unique constraints
along with `ADD COLUMN` operations in the columnstore.
* Improved management and optimization of chunks with the ability to
split large uncompressed chunks at a specified point in time using the
`split_chunk` function. This new function complements the existing
`merge_chunk` function that can be used to merge two small chunks into
one larger chunk.
* Enhancements to the default behavior of the columnstore now provide
better *automatic assessments* of `segment by` and `order by` columns,
reducing the need for manual configuration and simplifying initial
setup.

**PostgreSQL 14 support removal announcement**

Following the deprecation announcement for PostgreSQL 14 in TimescaleDB
v2.19.0, PostgreSQL 14 is no longer supported in TimescaleDB v2.20.0.
The currently supported PostgreSQL major versions are 15, 16, and 17.

**Features**
* [#7638](#7638) Bloom
filter sparse indexes for compressed columns. Can be disabled with the
GUC `timescaledb.enable_sparse_index_bloom`
* [#7756](#7756) Add
warning for poor compression ratio
* [#7762](#7762) Speed up
the queries that use minmax sparse indexes on compressed tables by
changing the index TOAST storage type to `MAIN`. This applies to newly
compressed chunks
* [#7785](#7785) Do
`DELETE` instead of `TRUNCATE` when locks aren't acquired
* [#7852](#7852) Allow
creating foreign key constraints on compressed tables
* [#7854](#7854) Remove
support for PG14
* [#7864](#7854) Allow
adding CHECK constraints to compressed chunks
* [#7868](#7868) Allow
adding columns with `CHECK` constraints to compressed chunks
* [#7874](#7874) Support
for SkipScan for distinct aggregates over the same column
* [#7877](#7877) Remove
blocker for unique constraints with `ADD COLUMN`
* [#7878](#7878) Don't
block non-immutable functions in continuous aggregates
* [#7880](#7880) Add
experimental support for window functions in continuous aggregates
* [#7899](#7899) Vectorized
decompression and filtering for boolean columns
* [#7915](#7915) New option
`refresh_newest_first` to continuous aggregate refresh policy API
* [#7917](#7917) Remove
`_timescaledb_functions.create_chunk_table` function
* [#7929](#7929) Add
`CREATE TABLE ... WITH` API for creating hypertables
* [#7946](#7946) Add
support for splitting a chunk
* [#7958](#7958) Allow
custom names for jobs
* [#7972](#7972) Add
vectorized filtering for constraint checking while backfilling into
compressed chunks
* [#7976](#7976) Include
continuous aggregate name in jobs informational view
* [#7977](#7977) Replace
references to compression with columnstore
* [#7981](#7981) Add
columnstore as alias for `enable_columnstore `in `ALTER TABLE`
* [#7983](#7983) Support
for SkipScan over compressed data
* [#7991](#7991) Improves
default `segmentby` options
* [#7992](#7992) Add API
into hypertable invalidation log
* [#8000](#8000) Add
primary dimension info to information schema
* [#8005](#8005) Support
`ALTER TABLE SET (timescaledb.chunk_time_interval='1 day')`
* [#8012](#8012) Add event
triggers support on chunk creation
* [#8014](#8014) Enable
bool compression by default by setting
`timescaledb.enable_bool_compression=true`. Note: for downgrading to
`2.18` or earlier version, use [this downgrade
script](https://github.com/timescale/timescaledb-extras/blob/master/utils/2.19.0-downgrade_new_compression_algorithms.sql)
* [#8018](#8018) Add
spin-lock during recompression on unique constraints
* [#8026](#8026) Allow
`WHERE` conditions that use nonvolatile functions to be pushed down to
the compressed scan level. For example, conditions like `time > now()`,
where `time` is a columnstore `orderby` column, will evaluate `now()`
and use the sparse index on `time` to filter out the entire compressed
batches that cannot contain matching rows.
* [#8027](#8027) Add
materialization invalidations API
* [#8047](#8027) Support
SkipScan for `SELECT DISTINCT` with multiple distincts when all but one
distinct is pinned
* [#8115](#8115) Add batch
size limiting during compression

**Bugfixes**
* [#7862](#7862) Release
cache pin when checking for `NOT NULL`
* [#7909](#7909) Update
compression stats when merging chunks
* [#7928](#7928) Don't
create a hypertable for implicitly published tables
* [#7982](#7982) Fix crash
in batch sort merge over eligible expressions
* [#8008](#8008) Fix
compression policy error message that shows number of successes
* [#8031](#8031) Fix
reporting of deleted tuples for direct batch delete
* [#8033](#8033) Skip
default `segmentby` if `orderby` is explicitly set
* [#8061](#8061) Ensure
settings for a compressed relation are found
* [#7515](#7515) Add
missing lock to Constraint-aware append
* [#8067](#8067) Make sure
hypercore TAM parent is vacuumed
* [#8074](#8074) Fix memory
leak in row compressor flush
* [#8099](#8099) Block
chunk merging on multi-dimensional hypertables
* [#8106](#8106) Fix
segfault when adding unique compression indexes to compressed chunks
* [#8127](#8127) Read
bit-packed version of booleans

**GUCs**
* `timescaledb.enable_sparse_index_bloom`: Enable creation of the bloom1
sparse index on compressed chunks; Default: `ON`
* `timescaledb.compress_truncate_behaviour`: Defines how truncate
behaves at the end of compression; Default: `truncate_only`
* `timescaledb.enable_compression_ratio_warnings`: Enable warnings for
poor compression ratio; Default: `ON`
* `timescaledb.enable_event_triggers`: Enable event triggers for chunks
creation; Default: `OFF`
* `timescaledb.enable_cagg_window_functions`: Enable window functions in
continuous aggregates; Default: `OFF`

**Thanks**
* @arajkumar for reporting that implicitly published tables were still
able to create hypertables
* @thotokraa for reporting an issue with unique expression indexes on
compressed chunks

---------

Signed-off-by: Philip Krauss <[email protected]>
Signed-off-by: Ramon Guiu <[email protected]>
Co-authored-by: Anastasiia Tovpeko <[email protected]>
Co-authored-by: Ramon Guiu <[email protected]>
@akuzm akuzm added the released-2.20.0 Released in 2.20.0 label May 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Background Worker The background worker subsystem, including the scheduler jobs released-2.20.0 Released in 2.20.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Enhancement]: Allow specifying application_name for custom jobs
8 participants