Allow custom names for User-Defined Actions

melihmutlu · melihmutlu · commit a9002db66cee · 2025-04-15T17:59:24.000+03:00
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.
diff --git a/.unreleased/pr_7958 b/.unreleased/pr_7958
@@ -0,0 +1 @@
+Implements: #7958 Allow custom names for User-Defined Actions
diff --git a/sql/job_api.sql b/sql/job_api.sql
@@ -10,7 +10,8 @@ CREATE OR REPLACE FUNCTION @extschema@.add_job(
   scheduled BOOL DEFAULT true,
   check_config REGPROC DEFAULT NULL,
   fixed_schedule BOOL DEFAULT TRUE,
-  timezone TEXT DEFAULT NULL
+  timezone TEXT DEFAULT NULL,
+  job_name name DEFAULT NULL
 ) RETURNS INTEGER AS '@MODULE_PATHNAME@', 'ts_job_add' LANGUAGE C VOLATILE;
 
 CREATE OR REPLACE FUNCTION @extschema@.delete_job(job_id INTEGER) RETURNS VOID AS '@MODULE_PATHNAME@', 'ts_job_delete' LANGUAGE C VOLATILE STRICT;
@@ -30,10 +31,11 @@ CREATE OR REPLACE FUNCTION @extschema@.alter_job(
     check_config REGPROC = NULL,
     fixed_schedule BOOL = NULL,
     initial_start TIMESTAMPTZ = NULL,
-    timezone TEXT DEFAULT NULL
+    timezone TEXT DEFAULT NULL,
+    job_name name DEFAULT NULL
 )
 RETURNS TABLE (job_id INTEGER, schedule_interval INTERVAL, max_runtime INTERVAL, max_retries INTEGER, retry_period INTERVAL, scheduled BOOL, config JSONB,
-next_start TIMESTAMPTZ, check_config TEXT, fixed_schedule BOOL, initial_start TIMESTAMPTZ, timezone TEXT)
+next_start TIMESTAMPTZ, check_config TEXT, fixed_schedule BOOL, initial_start TIMESTAMPTZ, timezone TEXT, job_name name)
 AS '@MODULE_PATHNAME@', 'ts_job_alter'
 LANGUAGE C VOLATILE;
 
diff --git a/sql/updates/latest-dev.sql b/sql/updates/latest-dev.sql
@@ -34,3 +34,65 @@ LANGUAGE C VOLATILE;
 
 UPDATE _timescaledb_catalog.hypertable SET chunk_sizing_func_schema = '_timescaledb_functions' WHERE chunk_sizing_func_schema = '_timescaledb_internal' AND chunk_sizing_func_name = 'calculate_chunk_interval';
 
+DROP FUNCTION IF EXISTS @extschema@.add_job(
+  proc REGPROC,
+  schedule_interval INTERVAL,
+  config JSONB,
+  initial_start TIMESTAMPTZ,
+  scheduled BOOL,
+  check_config REGPROC,
+  fixed_schedule BOOL,
+  timezone TEXT
+);
+
+CREATE FUNCTION @extschema@.add_job(
+  proc REGPROC,
+  schedule_interval INTERVAL,
+  config JSONB DEFAULT NULL,
+  initial_start TIMESTAMPTZ DEFAULT NULL,
+  scheduled BOOL DEFAULT true,
+  check_config REGPROC DEFAULT NULL,
+  fixed_schedule BOOL DEFAULT TRUE,
+  timezone TEXT DEFAULT NULL,
+  job_name name DEFAULT NULL
+)
+RETURNS INTEGER
+AS '@MODULE_PATHNAME@', 'ts_update_placeholder'
+LANGUAGE C VOLATILE;
+
+DROP FUNCTION IF EXISTS @extschema@.alter_job(
+    job_id INTEGER,
+    schedule_interval INTERVAL,
+    max_runtime INTERVAL,
+    max_retries INTEGER,
+    retry_period INTERVAL,
+    scheduled BOOL,
+    config JSONB,
+    next_start TIMESTAMPTZ,
+    if_exists BOOL,
+    check_config REGPROC,
+    fixed_schedule BOOL,
+    initial_start TIMESTAMPTZ,
+    timezone TEXT
+);
+
+CREATE FUNCTION @extschema@.alter_job(
+    job_id INTEGER,
+    schedule_interval INTERVAL = NULL,
+    max_runtime INTERVAL = NULL,
+    max_retries INTEGER = NULL,
+    retry_period INTERVAL = NULL,
+    scheduled BOOL = NULL,
+    config JSONB = NULL,
+    next_start TIMESTAMPTZ = NULL,
+    if_exists BOOL = FALSE,
+    check_config REGPROC = NULL,
+    fixed_schedule BOOL = NULL,
+    initial_start TIMESTAMPTZ = NULL,
+    timezone TEXT DEFAULT NULL,
+    job_name name DEFAULT NULL
+)
+RETURNS TABLE (job_id INTEGER, schedule_interval INTERVAL, max_runtime INTERVAL, max_retries INTEGER, retry_period INTERVAL, scheduled BOOL, config JSONB,
+next_start TIMESTAMPTZ, check_config TEXT, fixed_schedule BOOL, initial_start TIMESTAMPTZ, timezone TEXT, job_name name)
+AS '@MODULE_PATHNAME@', 'ts_update_placeholder'
+LANGUAGE C VOLATILE;
diff --git a/sql/updates/reverse-dev.sql b/sql/updates/reverse-dev.sql
@@ -31,3 +31,66 @@ CREATE FUNCTION @extschema@.add_continuous_aggregate_policy(
 RETURNS INTEGER
 AS '@MODULE_PATHNAME@', 'ts_update_placeholder'
 LANGUAGE C VOLATILE;
+
+DROP FUNCTION IF EXISTS @extschema@.add_job(
+  proc REGPROC,
+  schedule_interval INTERVAL,
+  config JSONB,
+  initial_start TIMESTAMPTZ,
+  scheduled BOOL,
+  check_config REGPROC,
+  fixed_schedule BOOL,
+  timezone TEXT,
+  job_name name
+);
+
+CREATE FUNCTION @extschema@.add_job(
+  proc REGPROC,
+  schedule_interval INTERVAL,
+  config JSONB DEFAULT NULL,
+  initial_start TIMESTAMPTZ DEFAULT NULL,
+  scheduled BOOL DEFAULT true,
+  check_config REGPROC DEFAULT NULL,
+  fixed_schedule BOOL DEFAULT TRUE,
+  timezone TEXT DEFAULT NULL
+)
+RETURNS INTEGER
+AS '@MODULE_PATHNAME@', 'ts_update_placeholder'
+LANGUAGE C VOLATILE;
+
+DROP FUNCTION IF EXISTS @extschema@.alter_job(
+    job_id INTEGER,
+    schedule_interval INTERVAL,
+    max_runtime INTERVAL,
+    max_retries INTEGER,
+    retry_period INTERVAL,
+    scheduled BOOL,
+    config JSONB,
+    next_start TIMESTAMPTZ,
+    if_exists BOOL,
+    check_config REGPROC,
+    fixed_schedule BOOL,
+    initial_start TIMESTAMPTZ,
+    timezone TEXT,
+    job_name name
+);
+
+CREATE FUNCTION @extschema@.alter_job(
+    job_id INTEGER,
+    schedule_interval INTERVAL = NULL,
+    max_runtime INTERVAL = NULL,
+    max_retries INTEGER = NULL,
+    retry_period INTERVAL = NULL,
+    scheduled BOOL = NULL,
+    config JSONB = NULL,
+    next_start TIMESTAMPTZ = NULL,
+    if_exists BOOL = FALSE,
+    check_config REGPROC = NULL,
+    fixed_schedule BOOL = NULL,
+    initial_start TIMESTAMPTZ = NULL,
+    timezone TEXT DEFAULT NULL
+)
+RETURNS TABLE (job_id INTEGER, schedule_interval INTERVAL, max_runtime INTERVAL, max_retries INTEGER, retry_period INTERVAL, scheduled BOOL, config JSONB,
+next_start TIMESTAMPTZ, check_config TEXT, fixed_schedule BOOL, initial_start TIMESTAMPTZ, timezone TEXT)
+AS '@MODULE_PATHNAME@', 'ts_update_placeholder'
+LANGUAGE C VOLATILE;
diff --git a/src/bgw/job.c b/src/bgw/job.c
@@ -786,6 +786,10 @@ bgw_job_tuple_update_by_id(TupleInfo *ti, void *const data)
 	bool isnull[Natts_bgw_job] = { 0 };
 	bool doReplace[Natts_bgw_job] = { 0 };
 
+	values[AttrNumberGetAttrOffset(Anum_bgw_job_application_name)] =
+		NameGetDatum(&updated_job->fd.application_name);
+	doReplace[AttrNumberGetAttrOffset(Anum_bgw_job_application_name)] = true;
+
 	Datum old_schedule_interval =
 		slot_getattr(ti->slot, Anum_bgw_job_schedule_interval, &isnull[0]);
 	Assert(!isnull[0]);
diff --git a/tsl/src/bgw_policy/job_api.c b/tsl/src/bgw_policy/job_api.c
@@ -70,6 +70,7 @@ validate_check_signature(Oid check)
  * 5 check_config REGPROC DEFAULT NULL
  * 6 fixed_schedule BOOL DEFAULT TRUE
  * 7 timezone TEXT DEFAULT NULL
+ * 8 job_name name DEFAULT NULL
  * ) RETURNS INTEGER
  */
 Datum
@@ -99,6 +100,7 @@ job_add(PG_FUNCTION_ARGS)
 	/* verify it's a valid timezone */
 	if (timezone != NULL)
 		valid_timezone = ts_bgw_job_validate_timezone(PG_GETARG_DATUM(7));
+	char *job_name_str = PG_ARGISNULL(8) ? NULL : NameStr(*PG_GETARG_NAME(8));
 
 	TS_PREVENT_FUNC_IF_READ_ONLY();
 
@@ -161,7 +163,10 @@ job_add(PG_FUNCTION_ARGS)
 	ts_bgw_job_validate_job_owner(owner);
 
 	/* Next, insert a new job into jobs table */
-	namestrcpy(&application_name, "User-Defined Action");
+	if (job_name_str)
+		namestrcpy(&application_name, job_name_str);
+	else
+		namestrcpy(&application_name, "User-Defined Action");
 	namestrcpy(&proc_schema, get_namespace_name(get_func_namespace(proc)));
 	namestrcpy(&proc_name, func_name);
 
@@ -283,6 +288,7 @@ job_run(PG_FUNCTION_ARGS)
  * 10   fixed_schedule BOOL = NULL,
  * 11   initial_start TIMESTAMPTZ = NULL
  * 12   timezone TEXT = NULL
+ * 13	job_name name = NULL
  * ) RETURNS TABLE (
  *      job_id INTEGER,
  *      schedule_interval INTERVAL,
@@ -296,6 +302,7 @@ job_run(PG_FUNCTION_ARGS)
  *      fixed_schedule BOOL
  *      initial_start TIMESTAMPTZ
  *      timezone TEXT
+ * 	 	job_name name
  * )
  */
 Datum
@@ -436,6 +443,13 @@ job_alter(PG_FUNCTION_ARGS)
 		job->fd.initial_start = initial_start;
 	}
 
+	if (!PG_ARGISNULL(13))
+	{
+		char app_name[NAMEDATALEN];
+		snprintf(app_name, NAMEDATALEN, "%s [%d]", NameStr(*PG_GETARG_NAME(13)), job_id);
+		namestrcpy(&job->fd.application_name, app_name);
+	}
+
 	if (valid_timezone != NULL)
 		job->fd.timezone = cstring_to_text(valid_timezone);
 	else
@@ -525,6 +539,8 @@ job_alter(PG_FUNCTION_ARGS)
 	else
 		nulls[11] = true;
 
+	values[12] = NameGetDatum(&job->fd.application_name);
+
 	tuple = heap_form_tuple(tupdesc, values, nulls);
 	return HeapTupleGetDatum(tuple);
 }
diff --git a/tsl/test/expected/bgw_custom.out b/tsl/test/expected/bgw_custom.out
@@ -68,7 +68,7 @@ SELECT add_job('custom_func', '1h', config:='{"type":"function"}'::jsonb, initia
     1003
 (1 row)
 
-SELECT add_job('custom_func_definer', '1h', config:='{"type":"function"}'::jsonb, initial_start => :'time_zero'::TIMESTAMPTZ);
+SELECT add_job('custom_func_definer', '1h', config:='{"type":"function"}'::jsonb, initial_start => :'time_zero'::TIMESTAMPTZ, job_name := 'custom_job_name');
  add_job 
 ---------
     1004
@@ -82,7 +82,7 @@ SELECT * FROM timescaledb_information.jobs WHERE job_id >= 1000 ORDER BY 1;
    1001 | User-Defined Action [1001] | @ 1 hour          | @ 0         |          -1 | @ 5 mins     | public      | custom_proc         | default_perm_user | t         | t              | {"type": "procedure"} | Fri Dec 31 16:00:00 1999 PST | Fri Dec 31 16:00:00 1999 PST |                   |                 |              | 
    1002 | User-Defined Action [1002] | @ 1 hour          | @ 0         |          -1 | @ 5 mins     | public      | custom_proc2        | default_perm_user | t         | t              | {"type": "procedure"} | Fri Dec 31 16:00:00 1999 PST | Fri Dec 31 16:00:00 1999 PST |                   |                 |              | 
    1003 | User-Defined Action [1003] | @ 1 hour          | @ 0         |          -1 | @ 5 mins     | public      | custom_func         | default_perm_user | t         | t              | {"type": "function"}  | Fri Dec 31 16:00:00 1999 PST | Fri Dec 31 16:00:00 1999 PST |                   |                 |              | 
-   1004 | User-Defined Action [1004] | @ 1 hour          | @ 0         |          -1 | @ 5 mins     | public      | custom_func_definer | default_perm_user | t         | t              | {"type": "function"}  | Fri Dec 31 16:00:00 1999 PST | Fri Dec 31 16:00:00 1999 PST |                   |                 |              | 
+   1004 | custom_job_name [1004]     | @ 1 hour          | @ 0         |          -1 | @ 5 mins     | public      | custom_func_definer | default_perm_user | t         | t              | {"type": "function"}  | Fri Dec 31 16:00:00 1999 PST | Fri Dec 31 16:00:00 1999 PST |                   |                 |              | 
 (5 rows)
 
 SELECT count(*) FROM _timescaledb_config.bgw_job WHERE config->>'type' IN ('procedure', 'function');
@@ -187,6 +187,18 @@ SELECT job_id FROM alter_job(1000,scheduled:=false);
    1000
 (1 row)
 
+-- test updating the job name
+SELECT job_id, job_name FROM alter_job(1000,job_name:='custom_name_2');
+ job_id |       job_name
+--------+----------------------
+   1000 | custom_name_2 [1000]
+(1 row)
+SELECT application_name FROM timescaledb_information.jobs WHERE job_id = 1000;
+   application_name
+----------------------
+ custom_name_2 [1000]
+(1 row)
+
 SELECT scheduled, config FROM timescaledb_information.jobs WHERE job_id = 1000;
  scheduled |        config        
 -----------+----------------------
diff --git a/tsl/test/shared/expected/extension.out b/tsl/test/shared/expected/extension.out
@@ -215,10 +215,10 @@ ORDER BY pronamespace::regnamespace::text COLLATE "C", p.oid::regprocedure::text
  add_continuous_aggregate_policy(regclass,"any","any",interval,boolean,timestamp with time zone,text,boolean,integer,integer,boolean)
  add_dimension(regclass,_timescaledb_internal.dimension_info,boolean)
  add_dimension(regclass,name,integer,anyelement,regproc,boolean)
- add_job(regproc,interval,jsonb,timestamp with time zone,boolean,regproc,boolean,text)
+ add_job(regproc,interval,jsonb,timestamp with time zone,boolean,regproc,boolean,text,name)
  add_reorder_policy(regclass,name,boolean,timestamp with time zone,text)
  add_retention_policy(regclass,"any",boolean,interval,timestamp with time zone,text,interval)
- alter_job(integer,interval,interval,integer,interval,boolean,jsonb,timestamp with time zone,boolean,regproc,boolean,timestamp with time zone,text)
+ alter_job(integer,interval,interval,integer,interval,boolean,jsonb,timestamp with time zone,boolean,regproc,boolean,timestamp with time zone,text,name)
  approximate_row_count(regclass)
  attach_tablespace(name,regclass,boolean)
  by_hash(name,integer,regproc)
diff --git a/tsl/test/sql/bgw_custom.sql b/tsl/test/sql/bgw_custom.sql
@@ -51,7 +51,7 @@ SELECT add_job('custom_proc','1h', config:='{"type":"procedure"}'::jsonb, initia
 SELECT add_job('custom_proc2','1h', config:= '{"type":"procedure"}'::jsonb, initial_start => :'time_zero'::TIMESTAMPTZ);
 
 SELECT add_job('custom_func', '1h', config:='{"type":"function"}'::jsonb, initial_start => :'time_zero'::TIMESTAMPTZ);
-SELECT add_job('custom_func_definer', '1h', config:='{"type":"function"}'::jsonb, initial_start => :'time_zero'::TIMESTAMPTZ);
+SELECT add_job('custom_func_definer', '1h', config:='{"type":"function"}'::jsonb, initial_start => :'time_zero'::TIMESTAMPTZ, job_name := 'custom_job_name');
 
 -- exclude internal jobs
 SELECT * FROM timescaledb_information.jobs WHERE job_id >= 1000 ORDER BY 1;
@@ -110,6 +110,10 @@ SELECT scheduled, config FROM timescaledb_information.jobs WHERE job_id = 1000;
 SELECT job_id FROM alter_job(1000,scheduled:=false);
 SELECT scheduled, config FROM timescaledb_information.jobs WHERE job_id = 1000;
 
+-- test updating the job name
+SELECT job_id, job_name FROM alter_job(1000,job_name:=='custom_name_2');
+SELECT application_name FROM timescaledb_information.jobs WHERE job_id = 1000;
+
 -- Done with job 1000 now, so remove it.
 SELECT delete_job(1000);
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Implements: #7958 Allow custom names for User-Defined Actions`