mirror of
https://github.com/bringout/oca-technical.git
synced 2026-04-18 10:12:05 +02:00
Initial commit: OCA Technical packages (595 packages)
This commit is contained in:
Ernad Husremovic
commit
2cc02aac6e
24950 changed files with 2318079 additions and 0 deletions
|
|
@ -0,0 +1,121 @@
|
|||
===============
|
||||
Postgres vacuum
|
||||
===============
|
||||
|
||||
..
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! source digest: sha256:5d2939b9cb7920d62259b3053fcbd55d53424a63311afd81fed3735215f8dfac
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
|
||||
.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
|
||||
:target: https://odoo-community.org/page/development-status
|
||||
:alt: Alpha
|
||||
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
|
||||
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
|
||||
:alt: License: AGPL-3
|
||||
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
|
||||
:target: https://github.com/OCA/server-tools/tree/16.0/postgres_vacuum
|
||||
:alt: OCA/server-tools
|
||||
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
||||
:target: https://translation.odoo-community.org/projects/server-tools-16-0/server-tools-16-0-postgres_vacuum
|
||||
:alt: Translate me on Weblate
|
||||
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
|
||||
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=16.0
|
||||
:alt: Try me on Runboat
|
||||
|
||||
|badge1| |badge2| |badge3| |badge4| |badge5|
|
||||
|
||||
This module adds a cronjob that vacuums or analyses postgres tables.
|
||||
|
||||
As postgres' autovacuum is not recommended for busy databases, it can be
|
||||
a better choice to schedule this process manually.
|
||||
|
||||
.. IMPORTANT::
|
||||
This is an alpha version, the data model and design can change at any time without warning.
|
||||
Only for development or testing purpose, do not use in production.
|
||||
`More details on development status <https://odoo-community.org/page/development-status>`_
|
||||
|
||||
**Table of contents**
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
To configure this module, you need to:
|
||||
|
||||
1. Go to Settings/Technical/Automation/Scheduled Actions
|
||||
2. Select actions *Vacuum Postgresql Tables* and *Analyze Postgresql
|
||||
Tables*
|
||||
3. Adapt the schedule to run at a time when your Odoo installation is
|
||||
least busy, take care that the analyze and vacuum cronjobs won't run
|
||||
simultaneously
|
||||
4. Adapt the parameters to match your setting, but the defaults should
|
||||
be fine for most users
|
||||
5. Note that the vacuum cronjob is inactive by default, because this is
|
||||
a potentially very heavy operation
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
To use this module, you need to:
|
||||
|
||||
1. Go to Settings/Technical/Automation/Scheduled Actions
|
||||
2. Select action *Vacuum Postgresql Tables*
|
||||
3. Click the *Run Manually* button
|
||||
|
||||
Known issues / Roadmap
|
||||
======================
|
||||
|
||||
- it would be nice if the cronjob could detect some odoo-specific
|
||||
measure of "busyness" and only run if it is below some threshold
|
||||
- add some statistics in the model views about number of dead rows, last
|
||||
vacuum timestamp etc from
|
||||
https://www.postgresql.org/docs/current/monitoring-stats.html#MONITORING-PG-STAT-ALL-TABLES-VIEW
|
||||
|
||||
Bug Tracker
|
||||
===========
|
||||
|
||||
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
|
||||
In case of trouble, please check there if your issue has already been reported.
|
||||
If you spotted it first, help us to smash it by providing a detailed and welcomed
|
||||
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20postgres_vacuum%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
||||
|
||||
Do not contact contributors directly about support or help with technical issues.
|
||||
|
||||
Credits
|
||||
=======
|
||||
|
||||
Authors
|
||||
-------
|
||||
|
||||
* Hunki Enterprises BV
|
||||
* Therp BV
|
||||
|
||||
Contributors
|
||||
------------
|
||||
|
||||
- Kevin Kamaa <kkahumba@therp.nl> (https://therp.nl)
|
||||
- Holger Brunn <mail@hunki-enterprises.com>
|
||||
(https://hunki-enterprises.com)
|
||||
|
||||
Maintainers
|
||||
-----------
|
||||
|
||||
This module is maintained by the OCA.
|
||||
|
||||
.. image:: https://odoo-community.org/logo.png
|
||||
:alt: Odoo Community Association
|
||||
:target: https://odoo-community.org
|
||||
|
||||
OCA, or the Odoo Community Association, is a nonprofit organization whose
|
||||
mission is to support the collaborative development of Odoo features and
|
||||
promote its widespread use.
|
||||
|
||||
This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/16.0/postgres_vacuum>`_ project on GitHub.
|
||||
|
||||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||
|
|
@ -0,0 +1 @@
|
|||
from . import models
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# Copyright 2025 Therp BV
|
||||
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0)
|
||||
|
||||
{
|
||||
"name": "Postgres vacuum",
|
||||
"summary": "Vacuum or analyze Odoo's database tables",
|
||||
"version": "16.0.1.0.0",
|
||||
"development_status": "Alpha",
|
||||
"category": "Extra Tools",
|
||||
"website": "https://github.com/OCA/server-tools",
|
||||
"author": "Hunki Enterprises BV, Odoo Community Association (OCA), Therp BV",
|
||||
"maintainers": [],
|
||||
"license": "AGPL-3",
|
||||
"depends": [
|
||||
"base",
|
||||
],
|
||||
"data": [
|
||||
"data/ir_cron.xml",
|
||||
],
|
||||
}
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!-- Copyright 2025 Therp BV
|
||||
License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0) -->
|
||||
<data noupdate="True">
|
||||
<record id="cronjob_analyze" model="ir.cron">
|
||||
<field name="name">Analyze Postgresql Tables</field>
|
||||
<field name="interval_number">1</field>
|
||||
<field name="interval_type">weeks</field>
|
||||
<field name="numbercall">-1</field>
|
||||
<field name="model_id" ref="base.model_ir_cron" />
|
||||
<field name="state">code</field>
|
||||
<field
|
||||
name="code"
|
||||
>model._postgres_vacuum(max_minutes=120, full_vacuum=False)</field>
|
||||
</record>
|
||||
<record id="cronjob_vacuum" model="ir.cron">
|
||||
<field name="name">Vacuum Postgresql Tables</field>
|
||||
<field name="active" eval="False" />
|
||||
<field name="interval_number">1</field>
|
||||
<field name="interval_type">months</field>
|
||||
<field name="numbercall">-1</field>
|
||||
<field name="model_id" ref="base.model_ir_cron" />
|
||||
<field name="state">code</field>
|
||||
<field
|
||||
name="code"
|
||||
>model._postgres_vacuum(max_minutes=120, full_vacuum=True)</field>
|
||||
</record>
|
||||
</data>
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
# Translation of Odoo Server.
|
||||
# This file contains the translation of the following modules:
|
||||
# * postgres_vacuum
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 16.0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"Last-Translator: \n"
|
||||
"Language-Team: \n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: \n"
|
||||
"Plural-Forms: \n"
|
||||
|
||||
#. module: postgres_vacuum
|
||||
#: model:ir.actions.server,name:postgres_vacuum.cronjob_analyze_ir_actions_server
|
||||
#: model:ir.cron,cron_name:postgres_vacuum.cronjob_analyze
|
||||
msgid "Analyze Postgresql Tables"
|
||||
msgstr "Analyze Postgresql Tables"
|
||||
|
||||
#. module: postgres_vacuum
|
||||
#: model:ir.model,name:postgres_vacuum.model_ir_cron
|
||||
msgid "Scheduled Actions"
|
||||
msgstr "Vremenski plan akcija"
|
||||
|
||||
#. module: postgres_vacuum
|
||||
#: model:ir.model.fields,field_description:postgres_vacuum.field_ir_cron__smart_search
|
||||
msgid "Smart Search"
|
||||
msgstr "Pametna pretraga"
|
||||
|
||||
#. module: postgres_vacuum
|
||||
#: model:ir.actions.server,name:postgres_vacuum.cronjob_vacuum_ir_actions_server
|
||||
#: model:ir.cron,cron_name:postgres_vacuum.cronjob_vacuum
|
||||
msgid "Vacuum Postgresql Tables"
|
||||
msgstr "Vacuum Postgresql Tables"
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
# Translation of Odoo Server.
|
||||
# This file contains the translation of the following modules:
|
||||
# * postgres_vacuum
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 16.0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"PO-Revision-Date: 2025-05-28 11:25+0000\n"
|
||||
"Last-Translator: mymage <stefano.consolaro@mymage.it>\n"
|
||||
"Language-Team: none\n"
|
||||
"Language: it\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: \n"
|
||||
"Plural-Forms: nplurals=2; plural=n != 1;\n"
|
||||
"X-Generator: Weblate 5.10.4\n"
|
||||
|
||||
#. module: postgres_vacuum
|
||||
#: model:ir.actions.server,name:postgres_vacuum.cronjob_analyze_ir_actions_server
|
||||
#: model:ir.cron,cron_name:postgres_vacuum.cronjob_analyze
|
||||
msgid "Analyze Postgresql Tables"
|
||||
msgstr "Analizza tabelle Postgresql"
|
||||
|
||||
#. module: postgres_vacuum
|
||||
#: model:ir.model,name:postgres_vacuum.model_ir_cron
|
||||
msgid "Scheduled Actions"
|
||||
msgstr "Azioni pianificate"
|
||||
|
||||
#. module: postgres_vacuum
|
||||
#: model:ir.model.fields,field_description:postgres_vacuum.field_ir_cron__smart_search
|
||||
msgid "Smart Search"
|
||||
msgstr "Ricerca intelligente"
|
||||
|
||||
#. module: postgres_vacuum
|
||||
#: model:ir.actions.server,name:postgres_vacuum.cronjob_vacuum_ir_actions_server
|
||||
#: model:ir.cron,cron_name:postgres_vacuum.cronjob_vacuum
|
||||
msgid "Vacuum Postgresql Tables"
|
||||
msgstr "Svuota tabelle Postgresql"
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
# Translation of Odoo Server.
|
||||
# This file contains the translation of the following modules:
|
||||
# * postgres_vacuum
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 16.0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"Last-Translator: \n"
|
||||
"Language-Team: \n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: \n"
|
||||
"Plural-Forms: \n"
|
||||
|
||||
#. module: postgres_vacuum
|
||||
#: model:ir.actions.server,name:postgres_vacuum.cronjob_analyze_ir_actions_server
|
||||
#: model:ir.cron,cron_name:postgres_vacuum.cronjob_analyze
|
||||
msgid "Analyze Postgresql Tables"
|
||||
msgstr ""
|
||||
|
||||
#. module: postgres_vacuum
|
||||
#: model:ir.model,name:postgres_vacuum.model_ir_cron
|
||||
msgid "Scheduled Actions"
|
||||
msgstr ""
|
||||
|
||||
#. module: postgres_vacuum
|
||||
#: model:ir.model.fields,field_description:postgres_vacuum.field_ir_cron__smart_search
|
||||
msgid "Smart Search"
|
||||
msgstr ""
|
||||
|
||||
#. module: postgres_vacuum
|
||||
#: model:ir.actions.server,name:postgres_vacuum.cronjob_vacuum_ir_actions_server
|
||||
#: model:ir.cron,cron_name:postgres_vacuum.cronjob_vacuum
|
||||
msgid "Vacuum Postgresql Tables"
|
||||
msgstr ""
|
||||
|
|
@ -0,0 +1 @@
|
|||
from . import ir_cron
|
||||
|
|
@ -0,0 +1,67 @@
|
|||
# Copyright 2025 Therp BV
|
||||
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0)
|
||||
|
||||
import logging
|
||||
from datetime import datetime, timedelta
|
||||
|
||||
from psycopg2.extensions import ISOLATION_LEVEL_AUTOCOMMIT
|
||||
|
||||
from odoo import models
|
||||
from odoo.sql_db import db_connect
|
||||
|
||||
|
||||
class IrCron(models.Model):
|
||||
_inherit = "ir.cron"
|
||||
|
||||
def _postgres_vacuum(self, max_minutes, full_vacuum):
|
||||
"""
|
||||
Vacuum or analyze tables, don't continue after max_minutes have elapsed
|
||||
|
||||
Do either a VACUUM FULL (full_vacuum=True) or ANALYZE
|
||||
"""
|
||||
|
||||
_logger = logging.getLogger("odoo.addons.postgres_vacuum")
|
||||
|
||||
query = "ANALYZE (SKIP_LOCKED)"
|
||||
if full_vacuum:
|
||||
query = "VACUUM (FULL, SKIP_LOCKED)"
|
||||
|
||||
current_time = datetime.now()
|
||||
exit_time_window = current_time + timedelta(minutes=max_minutes)
|
||||
|
||||
order_by_clause = "last_analyze"
|
||||
if full_vacuum:
|
||||
order_by_clause = "last_vacuum"
|
||||
|
||||
connection = db_connect(self.env.cr.dbname)
|
||||
|
||||
with connection.cursor() as cr:
|
||||
cr._cnx.set_isolation_level(ISOLATION_LEVEL_AUTOCOMMIT)
|
||||
# pylint: disable=sql-injection
|
||||
cr.execute(f"SET statement_timeout = '{int(max_minutes)}min'")
|
||||
|
||||
# pylint: disable=sql-injection
|
||||
cr.execute(
|
||||
f"""
|
||||
SELECT relname
|
||||
FROM pg_stat_user_tables
|
||||
ORDER BY {order_by_clause} ASC NULLS FIRST
|
||||
"""
|
||||
)
|
||||
for (table,) in cr.fetchall():
|
||||
action = "vacuum" if full_vacuum else "analyze"
|
||||
|
||||
if datetime.now() >= exit_time_window:
|
||||
_logger.info(
|
||||
"{max_minutes} minutes elapsed, not continuing to {action}"
|
||||
)
|
||||
return
|
||||
|
||||
_logger.debug(f"{action} of table {table}")
|
||||
try:
|
||||
# pylint: disable=sql-injection
|
||||
cr.execute(f'{query} "{table}"')
|
||||
except Exception:
|
||||
_logger.exception(f"{action} of table {table} failed")
|
||||
else:
|
||||
_logger.debug(f"{action} of table {table} done")
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
To configure this module, you need to:
|
||||
|
||||
1. Go to Settings/Technical/Automation/Scheduled Actions
|
||||
2. Select actions *Vacuum Postgresql Tables* and *Analyze Postgresql Tables*
|
||||
3. Adapt the schedule to run at a time when your Odoo installation is least busy, take care that the analyze and vacuum cronjobs won't run simultaneously
|
||||
4. Adapt the parameters to match your setting, but the defaults should be fine for most users
|
||||
5. Note that the vacuum cronjob is inactive by default, because this is a potentially very heavy operation
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
- Kevin Kamaa \<kkahumba@therp.nl> (https://therp.nl)
|
||||
- Holger Brunn \<mail@hunki-enterprises.com> (https://hunki-enterprises.com)
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
This module adds a cronjob that vacuums or analyses postgres tables.
|
||||
|
||||
As postgres' autovacuum is not recommended for busy databases, it can be a better choice to schedule this process manually.
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
- it would be nice if the cronjob could detect some odoo-specific measure of "busyness" and only run if it is below some threshold
|
||||
- add some statistics in the model views about number of dead rows, last vacuum timestamp etc from https://www.postgresql.org/docs/current/monitoring-stats.html#MONITORING-PG-STAT-ALL-TABLES-VIEW
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
To use this module, you need to:
|
||||
|
||||
1. Go to Settings/Technical/Automation/Scheduled Actions
|
||||
2. Select action *Vacuum Postgresql Tables*
|
||||
3. Click the *Run Manually* button
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 9.2 KiB |
|
|
@ -0,0 +1,472 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
|
||||
<title>Postgres vacuum</title>
|
||||
<style type="text/css">
|
||||
|
||||
/*
|
||||
:Author: David Goodger (goodger@python.org)
|
||||
:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
|
||||
:Copyright: This stylesheet has been placed in the public domain.
|
||||
|
||||
Default cascading style sheet for the HTML output of Docutils.
|
||||
Despite the name, some widely supported CSS2 features are used.
|
||||
|
||||
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
|
||||
customize this style sheet.
|
||||
*/
|
||||
|
||||
/* used to remove borders from tables and images */
|
||||
.borderless, table.borderless td, table.borderless th {
|
||||
border: 0 }
|
||||
|
||||
table.borderless td, table.borderless th {
|
||||
/* Override padding for "table.docutils td" with "! important".
|
||||
The right padding separates the table cells. */
|
||||
padding: 0 0.5em 0 0 ! important }
|
||||
|
||||
.first {
|
||||
/* Override more specific margin styles with "! important". */
|
||||
margin-top: 0 ! important }
|
||||
|
||||
.last, .with-subtitle {
|
||||
margin-bottom: 0 ! important }
|
||||
|
||||
.hidden {
|
||||
display: none }
|
||||
|
||||
.subscript {
|
||||
vertical-align: sub;
|
||||
font-size: smaller }
|
||||
|
||||
.superscript {
|
||||
vertical-align: super;
|
||||
font-size: smaller }
|
||||
|
||||
a.toc-backref {
|
||||
text-decoration: none ;
|
||||
color: black }
|
||||
|
||||
blockquote.epigraph {
|
||||
margin: 2em 5em ; }
|
||||
|
||||
dl.docutils dd {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
/* Uncomment (and remove this text!) to get bold-faced definition list terms
|
||||
dl.docutils dt {
|
||||
font-weight: bold }
|
||||
*/
|
||||
|
||||
div.abstract {
|
||||
margin: 2em 5em }
|
||||
|
||||
div.abstract p.topic-title {
|
||||
font-weight: bold ;
|
||||
text-align: center }
|
||||
|
||||
div.admonition, div.attention, div.caution, div.danger, div.error,
|
||||
div.hint, div.important, div.note, div.tip, div.warning {
|
||||
margin: 2em ;
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.admonition p.admonition-title, div.hint p.admonition-title,
|
||||
div.important p.admonition-title, div.note p.admonition-title,
|
||||
div.tip p.admonition-title {
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
div.attention p.admonition-title, div.caution p.admonition-title,
|
||||
div.danger p.admonition-title, div.error p.admonition-title,
|
||||
div.warning p.admonition-title, .code .error {
|
||||
color: red ;
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
/* Uncomment (and remove this text!) to get reduced vertical space in
|
||||
compound paragraphs.
|
||||
div.compound .compound-first, div.compound .compound-middle {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
div.compound .compound-last, div.compound .compound-middle {
|
||||
margin-top: 0.5em }
|
||||
*/
|
||||
|
||||
div.dedication {
|
||||
margin: 2em 5em ;
|
||||
text-align: center ;
|
||||
font-style: italic }
|
||||
|
||||
div.dedication p.topic-title {
|
||||
font-weight: bold ;
|
||||
font-style: normal }
|
||||
|
||||
div.figure {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
div.footer, div.header {
|
||||
clear: both;
|
||||
font-size: smaller }
|
||||
|
||||
div.line-block {
|
||||
display: block ;
|
||||
margin-top: 1em ;
|
||||
margin-bottom: 1em }
|
||||
|
||||
div.line-block div.line-block {
|
||||
margin-top: 0 ;
|
||||
margin-bottom: 0 ;
|
||||
margin-left: 1.5em }
|
||||
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em ;
|
||||
border: medium outset ;
|
||||
padding: 1em ;
|
||||
background-color: #ffffee ;
|
||||
width: 40% ;
|
||||
float: right ;
|
||||
clear: right }
|
||||
|
||||
div.sidebar p.rubric {
|
||||
font-family: sans-serif ;
|
||||
font-size: medium }
|
||||
|
||||
div.system-messages {
|
||||
margin: 5em }
|
||||
|
||||
div.system-messages h1 {
|
||||
color: red }
|
||||
|
||||
div.system-message {
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.system-message p.system-message-title {
|
||||
color: red ;
|
||||
font-weight: bold }
|
||||
|
||||
div.topic {
|
||||
margin: 2em }
|
||||
|
||||
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
|
||||
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
|
||||
margin-top: 0.4em }
|
||||
|
||||
h1.title {
|
||||
text-align: center }
|
||||
|
||||
h2.subtitle {
|
||||
text-align: center }
|
||||
|
||||
hr.docutils {
|
||||
width: 75% }
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left, table.align-left {
|
||||
clear: left ;
|
||||
float: left ;
|
||||
margin-right: 1em }
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right, table.align-right {
|
||||
clear: right ;
|
||||
float: right ;
|
||||
margin-left: 1em }
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-center {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left }
|
||||
|
||||
.align-center {
|
||||
clear: both ;
|
||||
text-align: center }
|
||||
|
||||
.align-right {
|
||||
text-align: right }
|
||||
|
||||
/* reset inner alignment in figures */
|
||||
div.align-right {
|
||||
text-align: inherit }
|
||||
|
||||
/* div.align-center * { */
|
||||
/* text-align: left } */
|
||||
|
||||
.align-top {
|
||||
vertical-align: top }
|
||||
|
||||
.align-middle {
|
||||
vertical-align: middle }
|
||||
|
||||
.align-bottom {
|
||||
vertical-align: bottom }
|
||||
|
||||
ol.simple, ul.simple {
|
||||
margin-bottom: 1em }
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal }
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha }
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha }
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman }
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman }
|
||||
|
||||
p.attribution {
|
||||
text-align: right ;
|
||||
margin-left: 50% }
|
||||
|
||||
p.caption {
|
||||
font-style: italic }
|
||||
|
||||
p.credits {
|
||||
font-style: italic ;
|
||||
font-size: smaller }
|
||||
|
||||
p.label {
|
||||
white-space: nowrap }
|
||||
|
||||
p.rubric {
|
||||
font-weight: bold ;
|
||||
font-size: larger ;
|
||||
color: maroon ;
|
||||
text-align: center }
|
||||
|
||||
p.sidebar-title {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold ;
|
||||
font-size: larger }
|
||||
|
||||
p.sidebar-subtitle {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
p.topic-title {
|
||||
font-weight: bold }
|
||||
|
||||
pre.address {
|
||||
margin-bottom: 0 ;
|
||||
margin-top: 0 ;
|
||||
font: inherit }
|
||||
|
||||
pre.literal-block, pre.doctest-block, pre.math, pre.code {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
pre.code .ln { color: gray; } /* line numbers */
|
||||
pre.code, code { background-color: #eeeeee }
|
||||
pre.code .comment, code .comment { color: #5C6576 }
|
||||
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
|
||||
pre.code .literal.string, code .literal.string { color: #0C5404 }
|
||||
pre.code .name.builtin, code .name.builtin { color: #352B84 }
|
||||
pre.code .deleted, code .deleted { background-color: #DEB0A1}
|
||||
pre.code .inserted, code .inserted { background-color: #A3D289}
|
||||
|
||||
span.classifier {
|
||||
font-family: sans-serif ;
|
||||
font-style: oblique }
|
||||
|
||||
span.classifier-delimiter {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
span.interpreted {
|
||||
font-family: sans-serif }
|
||||
|
||||
span.option {
|
||||
white-space: nowrap }
|
||||
|
||||
span.pre {
|
||||
white-space: pre }
|
||||
|
||||
span.problematic, pre.problematic {
|
||||
color: red }
|
||||
|
||||
span.section-subtitle {
|
||||
/* font-size relative to parent (h1..h6 element) */
|
||||
font-size: 80% }
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docinfo {
|
||||
margin: 2em 4em }
|
||||
|
||||
table.docutils {
|
||||
margin-top: 0.5em ;
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
table.footnote {
|
||||
border-left: solid 1px black;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docutils td, table.docutils th,
|
||||
table.docinfo td, table.docinfo th {
|
||||
padding-left: 0.5em ;
|
||||
padding-right: 0.5em ;
|
||||
vertical-align: top }
|
||||
|
||||
table.docutils th.field-name, table.docinfo th.docinfo-name {
|
||||
font-weight: bold ;
|
||||
text-align: left ;
|
||||
white-space: nowrap ;
|
||||
padding-left: 0 }
|
||||
|
||||
/* "booktabs" style (no vertical lines) */
|
||||
table.docutils.booktabs {
|
||||
border: 0px;
|
||||
border-top: 2px solid;
|
||||
border-bottom: 2px solid;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.docutils.booktabs * {
|
||||
border: 0px;
|
||||
}
|
||||
table.docutils.booktabs th {
|
||||
border-bottom: thin solid;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
|
||||
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
|
||||
font-size: 100% }
|
||||
|
||||
ul.auto-toc {
|
||||
list-style-type: none }
|
||||
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="postgres-vacuum">
|
||||
<h1 class="title">Postgres vacuum</h1>
|
||||
|
||||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! source digest: sha256:5d2939b9cb7920d62259b3053fcbd55d53424a63311afd81fed3735215f8dfac
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Alpha" src="https://img.shields.io/badge/maturity-Alpha-red.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-tools/tree/16.0/postgres_vacuum"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-tools-16-0/server-tools-16-0-postgres_vacuum"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
|
||||
<p>This module adds a cronjob that vacuums or analyses postgres tables.</p>
|
||||
<p>As postgres’ autovacuum is not recommended for busy databases, it can be
|
||||
a better choice to schedule this process manually.</p>
|
||||
<div class="admonition important">
|
||||
<p class="first admonition-title">Important</p>
|
||||
<p class="last">This is an alpha version, the data model and design can change at any time without warning.
|
||||
Only for development or testing purpose, do not use in production.
|
||||
<a class="reference external" href="https://odoo-community.org/page/development-status">More details on development status</a></p>
|
||||
</div>
|
||||
<p><strong>Table of contents</strong></p>
|
||||
<div class="contents local topic" id="contents">
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="#configuration" id="toc-entry-1">Configuration</a></li>
|
||||
<li><a class="reference internal" href="#usage" id="toc-entry-2">Usage</a></li>
|
||||
<li><a class="reference internal" href="#known-issues-roadmap" id="toc-entry-3">Known issues / Roadmap</a></li>
|
||||
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-4">Bug Tracker</a></li>
|
||||
<li><a class="reference internal" href="#credits" id="toc-entry-5">Credits</a><ul>
|
||||
<li><a class="reference internal" href="#authors" id="toc-entry-6">Authors</a></li>
|
||||
<li><a class="reference internal" href="#contributors" id="toc-entry-7">Contributors</a></li>
|
||||
<li><a class="reference internal" href="#maintainers" id="toc-entry-8">Maintainers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="configuration">
|
||||
<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
|
||||
<p>To configure this module, you need to:</p>
|
||||
<ol class="arabic simple">
|
||||
<li>Go to Settings/Technical/Automation/Scheduled Actions</li>
|
||||
<li>Select actions <em>Vacuum Postgresql Tables</em> and <em>Analyze Postgresql
|
||||
Tables</em></li>
|
||||
<li>Adapt the schedule to run at a time when your Odoo installation is
|
||||
least busy, take care that the analyze and vacuum cronjobs won’t run
|
||||
simultaneously</li>
|
||||
<li>Adapt the parameters to match your setting, but the defaults should
|
||||
be fine for most users</li>
|
||||
<li>Note that the vacuum cronjob is inactive by default, because this is
|
||||
a potentially very heavy operation</li>
|
||||
</ol>
|
||||
</div>
|
||||
<div class="section" id="usage">
|
||||
<h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
|
||||
<p>To use this module, you need to:</p>
|
||||
<ol class="arabic simple">
|
||||
<li>Go to Settings/Technical/Automation/Scheduled Actions</li>
|
||||
<li>Select action <em>Vacuum Postgresql Tables</em></li>
|
||||
<li>Click the <em>Run Manually</em> button</li>
|
||||
</ol>
|
||||
</div>
|
||||
<div class="section" id="known-issues-roadmap">
|
||||
<h1><a class="toc-backref" href="#toc-entry-3">Known issues / Roadmap</a></h1>
|
||||
<ul class="simple">
|
||||
<li>it would be nice if the cronjob could detect some odoo-specific
|
||||
measure of “busyness” and only run if it is below some threshold</li>
|
||||
<li>add some statistics in the model views about number of dead rows, last
|
||||
vacuum timestamp etc from
|
||||
<a class="reference external" href="https://www.postgresql.org/docs/current/monitoring-stats.html#MONITORING-PG-STAT-ALL-TABLES-VIEW">https://www.postgresql.org/docs/current/monitoring-stats.html#MONITORING-PG-STAT-ALL-TABLES-VIEW</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="bug-tracker">
|
||||
<h1><a class="toc-backref" href="#toc-entry-4">Bug Tracker</a></h1>
|
||||
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
|
||||
In case of trouble, please check there if your issue has already been reported.
|
||||
If you spotted it first, help us to smash it by providing a detailed and welcomed
|
||||
<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20postgres_vacuum%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
|
||||
<p>Do not contact contributors directly about support or help with technical issues.</p>
|
||||
</div>
|
||||
<div class="section" id="credits">
|
||||
<h1><a class="toc-backref" href="#toc-entry-5">Credits</a></h1>
|
||||
<div class="section" id="authors">
|
||||
<h2><a class="toc-backref" href="#toc-entry-6">Authors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Hunki Enterprises BV</li>
|
||||
<li>Therp BV</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="contributors">
|
||||
<h2><a class="toc-backref" href="#toc-entry-7">Contributors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Kevin Kamaa <<a class="reference external" href="mailto:kkahumba@therp.nl">kkahumba@therp.nl</a>> (<a class="reference external" href="https://therp.nl">https://therp.nl</a>)</li>
|
||||
<li>Holger Brunn <<a class="reference external" href="mailto:mail@hunki-enterprises.com">mail@hunki-enterprises.com</a>>
|
||||
(<a class="reference external" href="https://hunki-enterprises.com">https://hunki-enterprises.com</a>)</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="maintainers">
|
||||
<h2><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h2>
|
||||
<p>This module is maintained by the OCA.</p>
|
||||
<a class="reference external image-reference" href="https://odoo-community.org">
|
||||
<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
|
||||
</a>
|
||||
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
|
||||
mission is to support the collaborative development of Odoo features and
|
||||
promote its widespread use.</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/16.0/postgres_vacuum">OCA/server-tools</a> project on GitHub.</p>
|
||||
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1 @@
|
|||
from . import test_postgres_vacuum
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# Copyright 2025 Therp BV
|
||||
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0)
|
||||
|
||||
from odoo.tests.common import TransactionCase
|
||||
|
||||
|
||||
class TestPostgresVacuum(TransactionCase):
|
||||
def test_vacuum(self):
|
||||
with self.assertLogs("odoo.addons.postgres_vacuum", "DEBUG") as logs:
|
||||
self.env["ir.cron"]._postgres_vacuum(max_minutes=100, full_vacuum=True)
|
||||
|
||||
self.assertTrue(
|
||||
any("vacuum of table res_partner" in log for log in logs.output)
|
||||
)
|
||||
|
||||
def test_analyze(self):
|
||||
with self.assertLogs("odoo.addons.postgres_vacuum", "DEBUG") as logs:
|
||||
self.env["ir.cron"]._postgres_vacuum(max_minutes=100, full_vacuum=False)
|
||||
|
||||
self.assertTrue(
|
||||
any("analyze of table res_partner" in log for log in logs.output)
|
||||
)
|
||||
Loading…
Add table
Add a link
Reference in a new issue