Merge branch 'wip-MDL-56776-master' of git://github.com/marinaglancy/moodle
[moodle.git] / backup / upgrade.txt
blob88a9c8856918ecd6a873d0250c50cc235f172402
1 This files describes API changes in /backup/*,
2 information provided here is intended especially for developers.
4 === 3.1 ===
6 * New close() method added to loggers so they can close any open resource. Previously
7   any backup and restore operation using the file logger may be leaving unclosed files.
8 * New destroy() method added to loggers, normally called from backup and restore controllers
9   own destroy() method to ensure that all references in the chained loggers are deleted
10   and any open resource within them is closed properly.
12 === 3.0 ===
14 * The backup_auto_keep setting, in automated backups configuration, is now
15   renamed to backup_auto_max_kept as part of a rationalise of naming (see MDL-50602)
17 === 2.6 ===
19 * The backup_controller_dbops::create_temptable_from_real_table()
20   method is not available anymore. Temp tables must be created
21   inline always.
23 * Using the info field from backup_ids_temp or backup_files_temp
24   must now go via backup_controller_dbops::decode_backup_temp_info() and
25   backup_controller_dbops::encode_backup_temp_info(). The implementation
26   of the encoding has changed.  These new functions encapsulate any future
27   changes to the encoding.
29 === 2.5 ===
31 * New optional param $sortby in backup set_source_table() allows to
32     specify the ORDER BY clause to be used. Previously it was required
33     to use the set_source_sql() more complex alternative in places
34     requiring ordering.
35 * The old 1.9 files backuplib.php, lib.php and restorelib.php and the bb directory,
36     (all under /backup) have been deleted and no code should rely on them anymore.
38 === 2.4 ===
40 * Since 2.3.1+ the backup file name schema has changed. The ID of the course will always be part of
41     the filename regardless of the setting 'backup_shortname'. See MDL-33812.
43 === 2.3 ===
45 * Since 2.3.1+ the backup file name schema has changed. The ID of the course will always be part of
46     the filename regardless of the setting 'backup_shortname'. See MDL-33812.
48 === 2.2 ===
50 * Since 2.2.4+ the backup file name schema has changed. The ID of the course will always be part of
51     the filename regardless of the setting 'backup_shortname'. See MDL-33812.