1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
.. Automatically generated by code2rst.py
Edit src/backup.c not this file!
.. currentmodule:: apsw
.. _backup:
Backup
******
A backup object encapsulates copying one database to another. You
call :meth:`Connection.backup` on the destination database to get the
Backup object. Call :meth:`~Backup.step` to copy some pages
repeatedly dealing with errors as appropriate. Finally
:meth:`~Backup.finish` cleans up committing or rolling back and
releasing locks.
See the :ref:`example <example_backup>`.
Important details
=================
The database is copied page by page. This means that there is not a
round trip via SQL. All pages are copied including free ones.
The destination database is locked during the copy. You will get a
:exc:`ThreadingViolationError` if you attempt to use it.
The source database can change during the backup. SQLite will
come back and copy those changes too until the backup is complete.
Backup class
============
.. class:: Backup
You create a backup instance by calling :meth:`Connection.backup`.
.. method:: Backup.__enter__() -> Backup
You can use the backup object as a `context manager
<https://docs.python.org/3/reference/datamodel.html#with-statement-context-managers>`_
as defined in :pep:`0343`. The :meth:`~Backup.__exit__` method ensures that backup
is :meth:`finished <Backup.finish>`.
.. method:: Backup.__exit__(etype: Optional[type[BaseException]], evalue: Optional[BaseException], etraceback: Optional[types.TracebackType]) -> Optional[bool]
Implements context manager in conjunction with :meth:`~Backup.__enter__` ensuring
that the copy is :meth:`finished <Backup.finish>`.
.. method:: Backup.close(force: bool = False) -> None
Does the same thing as :meth:`~Backup.finish`. This extra api is
provided to give the same api as other APSW objects and files.
It is safe to call this method multiple times.
:param force: If true then any exceptions are ignored.
.. attribute:: Backup.done
:type: bool
A boolean that is True if the copy completed in the last call to :meth:`~Backup.step`.
.. index:: sqlite3_backup_finish
.. method:: Backup.finish() -> None
Completes the copy process. If all pages have been copied then the
transaction is committed on the destination database, otherwise it
is rolled back. This method must be called for your backup to take
effect. The backup object will always be finished even if there is
an exception. It is safe to call this method multiple times.
Calls: `sqlite3_backup_finish <https://sqlite.org/c3ref/backup_finish.html#sqlite3backupfinish>`__
.. index:: sqlite3_backup_pagecount
.. attribute:: Backup.page_count
:type: int
Read only. How many pages were in the source database after the last
step. If you haven't called :meth:`~Backup.step` or the backup
object has been :meth:`finished <Backup.finish>` then zero is
returned.
Calls: `sqlite3_backup_pagecount <https://sqlite.org/c3ref/backup_finish.html#sqlite3backuppagecount>`__
.. index:: sqlite3_backup_remaining
.. attribute:: Backup.remaining
:type: int
Read only. How many pages were remaining to be copied after the last
step. If you haven't called :meth:`~Backup.step` or the backup
object has been :meth:`finished <Backup.finish>` then zero is
returned.
Calls: `sqlite3_backup_remaining <https://sqlite.org/c3ref/backup_finish.html#sqlite3backupremaining>`__
.. index:: sqlite3_backup_step
.. method:: Backup.step(npages: int = -1) -> bool
Copies *npages* pages from the source to destination database. The source database is locked during the copy so
using smaller values allows other access to the source database. The destination database is always locked until the
backup object is :meth:`finished <Backup.finish>`.
:param npages: How many pages to copy. If the parameter is omitted
or negative then all remaining pages are copied.
This method may throw a :exc:`BusyError` or :exc:`LockedError` if
unable to lock the source database. You can catch those and try
again.
:returns: True if this copied the last remaining outstanding pages, else False. This is the same value as :attr:`~Backup.done`
Calls: `sqlite3_backup_step <https://sqlite.org/c3ref/backup_finish.html#sqlite3backupstep>`__
|
