CINXE.COM

<!DOCTYPE html> <html class="writer-html5" lang="en" > <head> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Welcome to pg_timetable’s documentation! — pg_timetable documentation</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />  <script src="_static/jquery.js?v=5d32c60e"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="_static/documentation_options.js?v=5929fcd5"></script> <script src="_static/doctools.js?v=888ff710"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="1. Introduction" href="README.html" />  <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.org", "builder": "sphinx", "canonical_url": null, "docroot": "/docs/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-1", "language": "en", "page": "index", "programming_language": "go", "project": "pg-timetable", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_rtd_theme", "user_analytics_code": "", "version": "master"}</script>  <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script>  <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="pg-timetable" /><meta name="readthedocs-version-slug" content="master" /><meta name="readthedocs-resolver-filename" content="/" /><meta name="readthedocs-http-status" content="200" /></head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="#" class="icon icon-home"> pg_timetable </a> <div class="version"> master </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="README.html">1. Introduction</a></li> <li class="toctree-l1"><a class="reference internal" href="background.html">2. Project background</a></li> <li class="toctree-l1"><a class="reference internal" href="installation.html">3. Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="components.html">4. Components</a></li> <li class="toctree-l1"><a class="reference internal" href="basic_jobs.html">5. Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="samples.html">6. Samples</a></li> <li class="toctree-l1"><a class="reference internal" href="migration.html">7. Migration from others schedulers</a></li> <li class="toctree-l1"><a class="reference internal" href="api.html">8. REST API</a></li> <li class="toctree-l1"><a class="reference internal" href="database_schema.html">9. Database Schema</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="#">pg_timetable</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="#" class="icon icon-home" aria-label="Home"></a></li> <li class="breadcrumb-item active">Welcome to pg_timetable’s documentation!</li> <li class="wy-breadcrumbs-aside"> <a href="https://github.com/cybertec-postgresql/pg_timetable/blob/master/docs/index.rst" class="fa fa-github"> Edit on GitHub</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="welcome-to-pg-timetable-s-documentation"> <h1>Welcome to pg_timetable’s documentation!<a class="headerlink" href="#welcome-to-pg-timetable-s-documentation" title="Link to this heading"></a></h1> <div class="toctree-wrapper compound"> <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="README.html">1. Introduction</a><ul> <li class="toctree-l2"><a class="reference internal" href="README.html#main-features">1.1. Main features</a></li> <li class="toctree-l2"><a class="reference internal" href="README.html#quick-start">1.2. Quick Start</a></li> <li class="toctree-l2"><a class="reference internal" href="README.html#command-line-options">1.3. Command line options</a></li> <li class="toctree-l2"><a class="reference internal" href="README.html#contributing">1.4. Contributing</a></li> <li class="toctree-l2"><a class="reference internal" href="README.html#support">1.5. Support</a></li> <li class="toctree-l2"><a class="reference internal" href="README.html#authors">1.6. Authors</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="background.html">2. Project background</a><ul> <li class="toctree-l2"><a class="reference internal" href="background.html#project-feedback">2.1. Project feedback</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="installation.html">3. Installation</a><ul> <li class="toctree-l2"><a class="reference internal" href="installation.html#official-release-packages">3.1. Official release packages</a></li> <li class="toctree-l2"><a class="reference internal" href="installation.html#docker">3.2. Docker</a></li> <li class="toctree-l2"><a class="reference internal" href="installation.html#build-from-sources">3.3. Build from sources</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="components.html">4. Components</a><ul> <li class="toctree-l2"><a class="reference internal" href="components.html#command">4.1. Command</a></li> <li class="toctree-l2"><a class="reference internal" href="components.html#task">4.2. Task</a></li> <li class="toctree-l2"><a class="reference internal" href="components.html#chain">4.3. Chain</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="basic_jobs.html">5. Getting started</a><ul> <li class="toctree-l2"><a class="reference internal" href="basic_jobs.html#add-simple-job">5.1. Add simple job</a></li> <li class="toctree-l2"><a class="reference internal" href="basic_jobs.html#examples">5.2. Examples</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="samples.html">6. Samples</a><ul> <li class="toctree-l2"><a class="reference internal" href="samples.html#basic">6.1. Basic</a></li> <li class="toctree-l2"><a class="reference internal" href="samples.html#send-email">6.2. Send email</a></li> <li class="toctree-l2"><a class="reference internal" href="samples.html#download-transform-and-import">6.3. Download, Transform and Import</a></li> <li class="toctree-l2"><a class="reference internal" href="samples.html#run-tasks-in-autonomous-transaction">6.4. Run tasks in autonomous transaction</a></li> <li class="toctree-l2"><a class="reference internal" href="samples.html#shutdown-the-scheduler-and-terminate-the-session">6.5. Shutdown the scheduler and terminate the session</a></li> <li class="toctree-l2"><a class="reference internal" href="samples.html#access-previous-task-result-code-and-output-from-the-next-task">6.6. Access previous task result code and output from the next task</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="migration.html">7. Migration from others schedulers</a><ul> <li class="toctree-l2"><a class="reference internal" href="migration.html#migrate-jobs-from-pg-cron-to-pg-timetable">7.1. Migrate jobs from pg_cron to pg_timetable</a></li> <li class="toctree-l2"><a class="reference internal" href="migration.html#migrate-jobs-from-pgagent-to-pg-timetable">7.2. Migrate jobs from pgAgent to pg_timetable</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="api.html">8. REST API</a><ul> <li class="toctree-l2"><a class="reference internal" href="api.html#health-check-endpoints">8.1. Health check endpoints</a></li> <li class="toctree-l2"><a class="reference internal" href="api.html#chain-management-endpoints">8.2. Chain management endpoints</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="database_schema.html">9. Database Schema</a><ul> <li class="toctree-l2"><a class="reference internal" href="database_schema.html#main-tables-and-objects">9.1. Main tables and objects</a></li> <li class="toctree-l2"><a class="reference internal" href="database_schema.html#jobs-related-functions">9.2. Jobs related functions</a></li> <li class="toctree-l2"><a class="reference internal" href="database_schema.html#ron-related-functions">9.3. Сron related functions</a></li> <li class="toctree-l2"><a class="reference internal" href="database_schema.html#er-diagram">9.4. ER-Diagram</a></li> </ul> </li> </ul> </div> </section> <section id="indices-and-tables"> <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading"></a></h1> <ul class="simple"> <li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li> <li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li> <li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li> </ul> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="README.html" class="btn btn-neutral float-right" title="1. Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> <hr/> <div role="contentinfo"> <p>© Copyright 2023. <span class="commit">Revision <code>d1364029</code>. </span></p> </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>