From e53fdc92096a996fe2a957b0007b1d4e0b5e6d08 Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Wed, 30 Aug 2023 12:54:17 -0500 Subject: [PATCH] Add doc section for functions; julian() and julian_to() functions --- doc/src/functions.m4 | 38 +++++++++++++++++++++++ doc/src/functions/julian.m4 | 56 ++++++++++++++++++++++++++++++++++ doc/src/functions/julian_to.m4 | 49 +++++++++++++++++++++++++++++ doc/src/index.m4 | 1 + 4 files changed, 144 insertions(+) create mode 100644 doc/src/functions.m4 create mode 100644 doc/src/functions/julian.m4 create mode 100644 doc/src/functions/julian_to.m4 diff --git a/doc/src/functions.m4 b/doc/src/functions.m4 new file mode 100644 index 0000000..335ec3f --- /dev/null +++ b/doc/src/functions.m4 @@ -0,0 +1,38 @@ +.. Copyright (C) 2023 The Meme Factory, Inc. www.karlpinc.com + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +.. M4 setup +include(constants.m4) +include(macros.m4) +sdb_rst_quotes(`on') +sdb_generated_rst() + + +.. _sql_functions: + +SQL Functions +============= + +The functions documented here may be useful when writing SQL. + +The database contains a large number of functions but only those +documented below are expected to be used directly by the database +users. + +.. toctree:: + :maxdepth: 1 + + functions/julian.rst + functions/julian_to.rst diff --git a/doc/src/functions/julian.m4 b/doc/src/functions/julian.m4 new file mode 100644 index 0000000..caafadd --- /dev/null +++ b/doc/src/functions/julian.m4 @@ -0,0 +1,56 @@ +.. Copyright (C) 2023 The Meme Factory, Inc. www.karlpinc.com + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +.. M4 setup +include(constants.m4) +include(macros.m4) +sdb_rst_quotes(`on') +sdb_generated_rst() + + +.. _function_julian: + +julian() +-------- + +Synopsis +```````` + +:: + + julian(date DATE) INT + julian(date TIMESTAMP) INT + +Input +````` + +date +'''' + +A ``DATE`` or a ``TIMESTAMP``. + +Description +``````````` + +.. |julian_summary| replace:: + Convert a date or a timestamp to a julian date. + +|julian_summary| Supply this function with a ``DATE`` (or a +``TIMESTAMP``) and it returns the integer that represents the given +date as the number of days since a particular reference date. This +number is known as the Julian date representation of the given +date. (Day number 2,361,222 is September 14, 1752.) Legal values for +the date are between September 14, 1752 and December 31, 9999, +inclusive. diff --git a/doc/src/functions/julian_to.m4 b/doc/src/functions/julian_to.m4 new file mode 100644 index 0000000..ade3e68 --- /dev/null +++ b/doc/src/functions/julian_to.m4 @@ -0,0 +1,49 @@ +.. Copyright (C) 2023 The Meme Factory, Inc. www.karlpinc.com + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +.. M4 setup +include(constants.m4) +include(macros.m4) +sdb_rst_quotes(`on') +sdb_generated_rst() + + +.. _function_julian_to: + +julian_to() +----------- + +Synopsis +```````` + +:: + + julian_to(julian INT) DATE + +Input +````` + +julian +'''''' + +An integer representing a julian date. + +Description +``````````` + +.. |julian_to_summary| replace:: + Converts a julian date value to a regular date value. + +|julian_to_summary| This function reverses the :ref:`julian` function. diff --git a/doc/src/index.m4 b/doc/src/index.m4 index 7bec5da..b119771 100644 --- a/doc/src/index.m4 +++ b/doc/src/index.m4 @@ -34,6 +34,7 @@ Technical Documentation er_diagrams.rst code_tables.rst tables.rst + functions.rst appendices.rst .. Add these back later.... -- 2.34.1