Add timescaledb_information.jobs view

This patch adds a convenience view to list all configured jobs.
timescale · Sep 22, 2020 · 51b156c · 51b156c
1 parent 519863f
commit 51b156c
Show file tree

Hide file tree

Showing 6 changed files with 117 additions and 81 deletions.
diff --git a/sql/views.sql b/sql/views.sql
@@ -69,6 +69,27 @@ CREATE OR REPLACE VIEW timescaledb_information.policy_stats as
     INNER JOIN _timescaledb_internal.bgw_job_stat js on j.id = js.job_id
   ORDER BY ht.schema_name, ht.table_name;
 
+-- view for background worker jobs
+CREATE OR REPLACE VIEW timescaledb_information.jobs AS
+SELECT j.id AS job_id,
+  j.application_name,
+  j.schedule_interval,
+  j.max_runtime,
+  j.max_retries,
+  j.retry_period,
+  j.proc_schema,
+  j.proc_name,
+  j.owner,
+  j.scheduled,
+  j.config,
+  js.next_start,
+  ht.schema_name AS hypertable_schema,
+  ht.table_name AS hypertable_name
+FROM _timescaledb_config.bgw_job j
+  LEFT JOIN _timescaledb_catalog.hypertable ht ON ht.id = j.hypertable_id
+  LEFT JOIN _timescaledb_internal.bgw_job_stat js ON js.job_id = j.id
+ORDER BY j.id;
+
 -- views for continuous aggregate queries ---
 CREATE OR REPLACE VIEW timescaledb_information.continuous_aggregates as
   SELECT format('%1$I.%2$I', cagg.user_view_schema, cagg.user_view_name)::regclass as view_name,

diff --git a/test/expected/pg_dump.out b/test/expected/pg_dump.out
@@ -540,6 +540,7 @@ WHERE   refclassid = 'pg_catalog.pg_extension'::pg_catalog.regclass AND
  timescaledb_information.chunks
  timescaledb_information.data_node
  timescaledb_information.continuous_aggregates
+ timescaledb_information.jobs
  timescaledb_information.policy_stats
  timescaledb_information.license
  timescaledb_information.hypertables
@@ -549,7 +550,7 @@ WHERE   refclassid = 'pg_catalog.pg_extension'::pg_catalog.regclass AND
  _timescaledb_internal.bgw_policy_chunk_stats
  _timescaledb_internal.bgw_job_stat
  _timescaledb_catalog.tablespace_id_seq
-(14 rows)
+(15 rows)
 
 -- Make sure we can't run our restoring functions as a normal perm user as that would disable functionality for the whole db
 \c :TEST_DBNAME :ROLE_DEFAULT_PERM_USER

diff --git a/tsl/test/expected/bgw_custom.out b/tsl/test/expected/bgw_custom.out
@@ -56,6 +56,17 @@ SELECT add_job('custom_func_definer', '1h', config:='{"type":"function"}'::jsonb
     1004
 (1 row)
 
+SELECT * FROM timescaledb_information.jobs ORDER BY 1;
+ job_id |    application_name    | schedule_interval |   max_runtime   | max_retries | retry_period |      proc_schema      |      proc_name      |       owner       | scheduled |        config         | next_start | hypertable_schema | hypertable_name 
+--------+------------------------+-------------------+-----------------+-------------+--------------+-----------------------+---------------------+-------------------+-----------+-----------------------+------------+-------------------+-----------------
+      1 | Telemetry Reporter [1] | @ 24 hours        | @ 1 min 40 secs |          -1 | @ 1 hour     | _timescaledb_internal | policy_telemetry    | super_user        | t         |                       |            |                   | 
+   1000 | Custom Job [1000]      | @ 1 hour          | @ 0             |          -1 | @ 5 mins     | public                | custom_func         | default_perm_user | t         | {"type": "function"}  |            |                   | 
+   1001 | Custom Job [1001]      | @ 1 hour          | @ 0             |          -1 | @ 5 mins     | public                | custom_proc         | default_perm_user | t         | {"type": "procedure"} |            |                   | 
+   1002 | Custom Job [1002]      | @ 1 hour          | @ 0             |          -1 | @ 5 mins     | public                | custom_proc2        | default_perm_user | t         | {"type": "procedure"} |            |                   | 
+   1003 | Custom Job [1003]      | @ 1 hour          | @ 0             |          -1 | @ 5 mins     | public                | custom_func         | default_perm_user | t         | {"type": "function"}  |            |                   | 
+   1004 | Custom Job [1004]      | @ 1 hour          | @ 0             |          -1 | @ 5 mins     | public                | custom_func_definer | default_perm_user | t         | {"type": "function"}  |            |                   | 
+(6 rows)
+
 CALL run_job(1000);
 CALL run_job(1001);
 CALL run_job(1002);
@@ -103,10 +114,11 @@ SELECT delete_job(1004);
 (1 row)
 
 -- check jobs got removed
-SELECT * FROM _timescaledb_config.bgw_job WHERE id >= 1000;
- id | application_name | schedule_interval | max_runtime | max_retries | retry_period | proc_schema | proc_name | owner | scheduled | hypertable_id | config 
-----+------------------+-------------------+-------------+-------------+--------------+-------------+-----------+-------+-----------+---------------+--------
-(0 rows)
+SELECT count(*) FROM timescaledb_information.jobs WHERE job_id >= 1000;
+ count 
+-------
+     0
+(1 row)
 
 \c :TEST_DBNAME :ROLE_SUPERUSER
 -- test altering job with NULL config
@@ -116,10 +128,10 @@ SELECT job_id FROM alter_job(1,scheduled:=false);
       1
 (1 row)
 
-SELECT * FROM _timescaledb_config.bgw_job WHERE id = 1;
- id |    application_name    | schedule_interval |   max_runtime   | max_retries | retry_period |      proc_schema      |    proc_name     |   owner    | scheduled | hypertable_id | config 
-----+------------------------+-------------------+-----------------+-------------+--------------+-----------------------+------------------+------------+-----------+---------------+--------
-  1 | Telemetry Reporter [1] | @ 24 hours        | @ 1 min 40 secs |          -1 | @ 1 hour     | _timescaledb_internal | policy_telemetry | super_user | f         |               | 
+SELECT * FROM timescaledb_information.jobs WHERE job_id = 1;
+ job_id |    application_name    | schedule_interval |   max_runtime   | max_retries | retry_period |      proc_schema      |    proc_name     |   owner    | scheduled | config | next_start | hypertable_schema | hypertable_name 
+--------+------------------------+-------------------+-----------------+-------------+--------------+-----------------------+------------------+------------+-----------+--------+------------+-------------------+-----------------
+      1 | Telemetry Reporter [1] | @ 24 hours        | @ 1 min 40 secs |          -1 | @ 1 hour     | _timescaledb_internal | policy_telemetry | super_user | f         |        |            |                   | 
 (1 row)
 
 -- test updating job settings
@@ -129,10 +141,10 @@ SELECT job_id FROM alter_job(1,config:='{"test":"test"}');
       1
 (1 row)
 
-SELECT * FROM _timescaledb_config.bgw_job WHERE id = 1;
- id |    application_name    | schedule_interval |   max_runtime   | max_retries | retry_period |      proc_schema      |    proc_name     |   owner    | scheduled | hypertable_id |      config      
-----+------------------------+-------------------+-----------------+-------------+--------------+-----------------------+------------------+------------+-----------+---------------+------------------
-  1 | Telemetry Reporter [1] | @ 24 hours        | @ 1 min 40 secs |          -1 | @ 1 hour     | _timescaledb_internal | policy_telemetry | super_user | f         |               | {"test": "test"}
+SELECT * FROM timescaledb_information.jobs WHERE job_id = 1;
+ job_id |    application_name    | schedule_interval |   max_runtime   | max_retries | retry_period |      proc_schema      |    proc_name     |   owner    | scheduled |      config      | next_start | hypertable_schema | hypertable_name 
+--------+------------------------+-------------------+-----------------+-------------+--------------+-----------------------+------------------+------------+-----------+------------------+------------+-------------------+-----------------
+      1 | Telemetry Reporter [1] | @ 24 hours        | @ 1 min 40 secs |          -1 | @ 1 hour     | _timescaledb_internal | policy_telemetry | super_user | f         | {"test": "test"} |            |                   | 
 (1 row)
 
 SELECT job_id FROM alter_job(1,scheduled:=true);
@@ -141,10 +153,10 @@ SELECT job_id FROM alter_job(1,scheduled:=true);
       1
 (1 row)
 
-SELECT * FROM _timescaledb_config.bgw_job WHERE id = 1;
- id |    application_name    | schedule_interval |   max_runtime   | max_retries | retry_period |      proc_schema      |    proc_name     |   owner    | scheduled | hypertable_id |      config      
-----+------------------------+-------------------+-----------------+-------------+--------------+-----------------------+------------------+------------+-----------+---------------+------------------
-  1 | Telemetry Reporter [1] | @ 24 hours        | @ 1 min 40 secs |          -1 | @ 1 hour     | _timescaledb_internal | policy_telemetry | super_user | t         |               | {"test": "test"}
+SELECT * FROM timescaledb_information.jobs WHERE job_id = 1;
+ job_id |    application_name    | schedule_interval |   max_runtime   | max_retries | retry_period |      proc_schema      |    proc_name     |   owner    | scheduled |      config      | next_start | hypertable_schema | hypertable_name 
+--------+------------------------+-------------------+-----------------+-------------+--------------+-----------------------+------------------+------------+-----------+------------------+------------+-------------------+-----------------
+      1 | Telemetry Reporter [1] | @ 24 hours        | @ 1 min 40 secs |          -1 | @ 1 hour     | _timescaledb_internal | policy_telemetry | super_user | t         | {"test": "test"} |            |                   | 
 (1 row)
 
 SELECT job_id FROM alter_job(1,scheduled:=false);
@@ -153,9 +165,9 @@ SELECT job_id FROM alter_job(1,scheduled:=false);
       1
 (1 row)
 
-SELECT * FROM _timescaledb_config.bgw_job WHERE id = 1;
- id |    application_name    | schedule_interval |   max_runtime   | max_retries | retry_period |      proc_schema      |    proc_name     |   owner    | scheduled | hypertable_id |      config      
-----+------------------------+-------------------+-----------------+-------------+--------------+-----------------------+------------------+------------+-----------+---------------+------------------
-  1 | Telemetry Reporter [1] | @ 24 hours        | @ 1 min 40 secs |          -1 | @ 1 hour     | _timescaledb_internal | policy_telemetry | super_user | f         |               | {"test": "test"}
+SELECT * FROM timescaledb_information.jobs WHERE job_id = 1;
+ job_id |    application_name    | schedule_interval |   max_runtime   | max_retries | retry_period |      proc_schema      |    proc_name     |   owner    | scheduled |      config      | next_start | hypertable_schema | hypertable_name 
+--------+------------------------+-------------------+-----------------+-------------+--------------+-----------------------+------------------+------------+-----------+------------------+------------+-------------------+-----------------
+      1 | Telemetry Reporter [1] | @ 24 hours        | @ 1 min 40 secs |          -1 | @ 1 hour     | _timescaledb_internal | policy_telemetry | super_user | f         | {"test": "test"} |            |                   | 
 (1 row)