← Back to branch summary

~hardware-certification/zope3/certify-staging-2.5

« back to all changes in this revision

Viewing changes to src/ZODB/scripts/README.txt

  • Committer: Marc Tardif
  • Date: 2008-04-26 19:03:34 UTC
  • Revision ID: cr3@lime-20080426190334-u16xo4llz56vliqf
Initial import.

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/ZODB/scripts/README.txt
 
1
This directory contains a collection of utilities for managing ZODB
 
2
databases.  Some are more useful than others.  If you install ZODB
 
3
using distutils ("python setup.py install"), a few of these will be installed.
 
4
 
 
5
Unless otherwise noted, these scripts are invoked with the name of the
 
6
Data.fs file as their only argument.  Example: checkbtrees.py data.fs.
 
7
 
 
8
 
 
9
analyze.py -- a transaction analyzer for FileStorage
 
10
 
 
11
Reports on the data in a FileStorage.  The report is organized by
 
12
class.  It shows total data, as well as separate reports for current
 
13
and historical revisions of objects.
 
14
 
 
15
 
 
16
checkbtrees.py -- checks BTrees in a FileStorage for corruption
 
17
 
 
18
Attempts to find all the BTrees contained in a Data.fs, calls their
 
19
_check() methods, and runs them through BTrees.check.check().
 
20
 
 
21
 
 
22
fsdump.py -- summarize FileStorage contents, one line per revision
 
23
 
 
24
Prints a report of FileStorage contents, with one line for each
 
25
transaction and one line for each data record in that transaction.
 
26
Includes time stamps, file positions, and class names.
 
27
 
 
28
 
 
29
fsoids.py -- trace all uses of specified oids in a FileStorage
 
30
 
 
31
For heavy debugging.
 
32
A set of oids is specified by text file listing and/or command line.
 
33
A report is generated showing all uses of these oids in the database:
 
34
all new-revision creation/modifications, all references from all
 
35
revisions of other objects, and all creation undos.
 
36
 
 
37
 
 
38
fstest.py -- simple consistency checker for FileStorage
 
39
 
 
40
usage: fstest.py [-v] data.fs
 
41
 
 
42
The fstest tool will scan all the data in a FileStorage and report an
 
43
error if it finds any corrupt transaction data.  The tool will print a
 
44
message when the first error is detected an exit.
 
45
 
 
46
The tool accepts one or more -v arguments.  If a single -v is used, it
 
47
will print a line of text for each transaction record it encounters.
 
48
If two -v arguments are used, it will also print a line of text for
 
49
each object.  The objects for a transaction will be printed before the
 
50
transaction itself.
 
51
 
 
52
Note: It does not check the consistency of the object pickles.  It is
 
53
possible for the damage to occur only in the part of the file that
 
54
stores object pickles.  Those errors will go undetected.
 
55
 
 
56
 
 
57
space.py -- report space used by objects in a FileStorage
 
58
 
 
59
usage: space.py [-v] data.fs
 
60
 
 
61
This ignores revisions and versions.
 
62
 
 
63
 
 
64
netspace.py -- hackish attempt to report on size of objects
 
65
 
 
66
usage: netspace.py [-P | -v] data.fs
 
67
 
 
68
-P: do a pack first
 
69
-v: print info for all objects, even if a traversal path isn't found
 
70
 
 
71
Traverses objects from the database root and attempts to calculate
 
72
size of object, including all reachable subobjects.
 
73
 
 
74
 
 
75
parsezeolog.py -- parse BLATHER logs from ZEO server
 
76
 
 
77
This script may be obsolete.  It has not been tested against the
 
78
current log output of the ZEO server.
 
79
 
 
80
Reports on the time and size of transactions committed by a ZEO
 
81
server, by inspecting log messages at BLATHER level.
 
82
 
 
83
 
 
84
repozo.py -- incremental backup utility for FileStorage
 
85
 
 
86
Run the script with the -h option to see usage details.
 
87
 
 
88
 
 
89
timeout.py -- script to test transaction timeout
 
90
 
 
91
usage: timeout.py address delay [storage-name]
 
92
 
 
93
This script connects to a storage, begins a transaction, calls store()
 
94
and tpc_vote(), and then sleeps forever.  This should trigger the
 
95
transaction timeout feature of the server.
 
96
 
 
97
zodbload.py -- exercise ZODB under a heavy synthesized Zope-like load
 
98
 
 
99
See the module docstring for details.  Note that this script requires
 
100
Zope.  New in ZODB3 3.1.4.
 
101
 
 
102
 
 
103
fsrefs.py -- check FileStorage for dangling references
 
104
 
 
105
 
 
106
fstail.py -- display the most recent transactions in a FileStorage
 
107
 
 
108
usage:  fstail.py [-n nxtn] data.fs
 
109
 
 
110
The most recent ntxn transactions are displayed, to stdout.
 
111
Optional argument -n specifies ntxn, and defaults to 10.
 
112
 
 
113
 
 
114
migrate.py -- do a storage migration and gather statistics
 
115
 
 
116
See the module docstring for details.