Database Auto-Backup (auto_backup) - Odoo Module Metadata

TIP: You can type at any time to perform a new search.

Repository: OCA/server-tools · module folder · Try on Runboat
Module version: 1.0.1
Category: Tools
Folder size: 0.9 MB
License: AGPL-3
Application: No
Auto-installable: No
Website: https://github.com/OCA/server-tools
Last tracking update: 2026-08-07 09:06:26
Authors: Odoo Community Association (OCA), Agile Business Group, LasLabs, Yenthe Van Ginneken, AdaptiveCity, Grupo ESOC Ingenieria de Servicios
Maintainers: Odoo Community Association (OCA), Agile Business Group, LasLabs, Yenthe Van Ginneken, AdaptiveCity, Grupo ESOC Ingenieria de Servicios
Committers: OCA-git-bot, oca-ci, Bhavesh Heliconia

Odoo dependencies

odoo/odoo:

Python dependencies

cryptography, paramiko<4.0.0, pysftp

System dependencies

None

Required by

None

Description

A tool for all your back-ups, internal and external!

XML ID	Model	Type	Status
`view_backup_conf_form`	db.backup	form	New
`view_backup_conf_list`	db.backup	list	New
`view_backup_conf_search`	db.backup	search	New

No HTTP endpoints found for this module.

New fields (10)

backup_format Selection
default='zip' help='Choose the format for this backup.' args: [('zip', 'zip (includes filestore)'), ('dump', 'pg_dump custom format (without filestore)')]
days_to_keep Integer
default=0 help='Backups older than this will be deleted automatically. Set 0 to disable autodeletion.' required=True
folder Char
default=<expr> help='Absolute path for storing the backups' required=True
method Selection
default='local' help='Choose the storage method for this backup.' args: [('local', 'Local disk'), ('sftp', 'Remote SFTP server')]
name Char
compute='_compute_name' help='Summary of this backup process' store=True
sftp_host Char
help='The host name or IP address from your remote server. For example 192.168.0.1' args: 'SFTP Server'
sftp_password Char
help='The password for the SFTP connection. If you specify a private key file, then this is the password to decrypt it.' args: 'SFTP Password'
sftp_port Integer
default=22 help='The port on the FTP server that accepts SSH/SFTP calls.' args: 'SFTP Port'
sftp_private_key Char
help='Path to the private key file. Only the Odoo user should have read permissions for that file.' args: 'Private key location'
sftp_user Char
help='The username where the SFTP connection should be made with. This is the user on the external server.' args: 'Username in the SFTP Server'

Public methods (8)

action_backup(self)
Run selected backups.
action_backup_all(self)
@api.model

Run all scheduled backups.
action_sftp_test_connection(self)
Check if the SFTP settings are correct.
backup_log(self)
@contextmanager

Log a backup result.
cleanup(self)
Clean up old backups.
cleanup_log(self)
@contextmanager

Log a possible cleanup failure.
filename(when, ext='zip')
@staticmethod

Generate a file name for a backup. :param datetime.datetime when: Use this datetime instead of :meth:`datetime.datetime.now`. :param str ext: Extension of the file. Default: dump.zip
sftp_connection(self)
Return a new SFTP connection with found parameters.

Loading…

db.backup New model Model 10 fields 8 methods DbBackup · inherits mail.thread · Database Backup