docs(db): fix comments on database functions

Fixes the comments on functions wt_add_seconds, wt_add_seconds_to_now,
wt_sub_seconds, and wt_sub_seconds_from_now which were the tragic
victims of a copypasta error.
This commit is contained in:
Michael Gaffney committed 2022-10-26 06:34:36 -04:00
1 parent b86430c2af
commit 3241c9a411
3 files changed
+19

No files matched your search

@@ -1,5 +1,9 @@
begin;
-- The 'comment on function' statements below are not for the functions in the
-- file. They incorrectly override the comments for functions declared in
-- 7/01_functions.up.sql. Fixes are contained in 57/01_fix_comments.up.sql.
create function wt_sub_seconds(sec integer, ts timestamp with time zone) returns timestamp with time zone
as $$
select ts - sec * '1 second'::interval;
@@ -0,0 +1,12 @@
begin;
-- Restores the correct comments originally defined in 7/01_functions.up.sql
-- but incorrectly overridden in 12/01_timestamp_sub_funcs.up.sql.
comment on function wt_add_seconds is 'wt_add_seconds returns ts + sec.';
comment on function wt_add_seconds_to_now is 'wt_add_seconds_to_now returns current_timestamp + sec.';
-- Sets comments for functions defined in 12/01_timestamp_sub_funcs.up.sql.
comment on function wt_sub_seconds is 'wt_sub_seconds returns ts - sec.';
comment on function wt_sub_seconds_from_now is 'wt_sub_seconds_from_now returns current_timestamp - sec.';
commit;
@@ -1,5 +1,8 @@
begin;
-- Comments for the functions below were incorrectly overridden in
-- 12/01_timestamp_sub_funcs.up.sql but fixed in 57/01_fix_comments.up.sql.
create function wt_add_seconds(sec integer, ts timestamp with time zone) returns timestamp with time zone
as $$
select ts + sec * '1 second'::interval;