OLD | NEW |
| (Empty) |
1 # Run this TCL script using "testfixture" in order get a report that shows | |
2 # how much disk space is used by a particular data to actually store data | |
3 # versus how much space is unused. | |
4 # | |
5 | |
6 if {[catch { | |
7 | |
8 # Argument $tname is the name of a table within the database opened by | |
9 # database handle [db]. Return true if it is a WITHOUT ROWID table, or | |
10 # false otherwise. | |
11 # | |
12 proc is_without_rowid {tname} { | |
13 set t [string map {' ''} $tname] | |
14 db eval "PRAGMA index_list = '$t'" o { | |
15 if {$o(origin) == "pk"} { | |
16 set n $o(name) | |
17 if {0==[db one { SELECT count(*) FROM sqlite_master WHERE name=$n }]} { | |
18 return 1 | |
19 } | |
20 } | |
21 } | |
22 return 0 | |
23 } | |
24 | |
25 # Get the name of the database to analyze | |
26 # | |
27 proc usage {} { | |
28 set argv0 [file rootname [file tail [info nameofexecutable]]] | |
29 puts stderr "Usage: $argv0 ?--pageinfo? ?--stats? database-filename" | |
30 puts stderr { | |
31 Analyze the SQLite3 database file specified by the "database-filename" | |
32 argument and output a report detailing size and storage efficiency | |
33 information for the database and its constituent tables and indexes. | |
34 | |
35 Options: | |
36 | |
37 --stats Output SQL text that creates a new database containing | |
38 statistics about the database that was analyzed | |
39 | |
40 --pageinfo Show how each page of the database-file is used | |
41 } | |
42 exit 1 | |
43 } | |
44 set file_to_analyze {} | |
45 set flags(-pageinfo) 0 | |
46 set flags(-stats) 0 | |
47 append argv {} | |
48 foreach arg $argv { | |
49 if {[regexp {^-+pageinfo$} $arg]} { | |
50 set flags(-pageinfo) 1 | |
51 } elseif {[regexp {^-+stats$} $arg]} { | |
52 set flags(-stats) 1 | |
53 } elseif {[regexp {^-} $arg]} { | |
54 puts stderr "Unknown option: $arg" | |
55 usage | |
56 } elseif {$file_to_analyze!=""} { | |
57 usage | |
58 } else { | |
59 set file_to_analyze $arg | |
60 } | |
61 } | |
62 if {$file_to_analyze==""} usage | |
63 set root_filename $file_to_analyze | |
64 regexp {^file:(//)?([^?]*)} $file_to_analyze all x1 root_filename | |
65 if {![file exists $root_filename]} { | |
66 puts stderr "No such file: $root_filename" | |
67 exit 1 | |
68 } | |
69 if {![file readable $root_filename]} { | |
70 puts stderr "File is not readable: $root_filename" | |
71 exit 1 | |
72 } | |
73 set true_file_size [file size $root_filename] | |
74 if {$true_file_size<512} { | |
75 puts stderr "Empty or malformed database: $root_filename" | |
76 exit 1 | |
77 } | |
78 | |
79 # Compute the total file size assuming test_multiplexor is being used. | |
80 # Assume that SQLITE_ENABLE_8_3_NAMES might be enabled | |
81 # | |
82 set extension [file extension $root_filename] | |
83 set pattern $root_filename | |
84 append pattern {[0-3][0-9][0-9]} | |
85 foreach f [glob -nocomplain $pattern] { | |
86 incr true_file_size [file size $f] | |
87 set extension {} | |
88 } | |
89 if {[string length $extension]>=2 && [string length $extension]<=4} { | |
90 set pattern [file rootname $root_filename] | |
91 append pattern {.[0-3][0-9][0-9]} | |
92 foreach f [glob -nocomplain $pattern] { | |
93 incr true_file_size [file size $f] | |
94 } | |
95 } | |
96 | |
97 # Open the database | |
98 # | |
99 if {[catch {sqlite3 db $file_to_analyze -uri 1} msg]} { | |
100 puts stderr "error trying to open $file_to_analyze: $msg" | |
101 exit 1 | |
102 } | |
103 | |
104 db eval {SELECT count(*) FROM sqlite_master} | |
105 set pageSize [expr {wide([db one {PRAGMA page_size}])}] | |
106 | |
107 if {$flags(-pageinfo)} { | |
108 db eval {CREATE VIRTUAL TABLE temp.stat USING dbstat} | |
109 db eval {SELECT name, path, pageno FROM temp.stat ORDER BY pageno} { | |
110 puts "$pageno $name $path" | |
111 } | |
112 exit 0 | |
113 } | |
114 if {$flags(-stats)} { | |
115 db eval {CREATE VIRTUAL TABLE temp.stat USING dbstat} | |
116 puts "BEGIN;" | |
117 puts "CREATE TABLE stats(" | |
118 puts " name STRING, /* Name of table or index */" | |
119 puts " path INTEGER, /* Path to page from root */" | |
120 puts " pageno INTEGER, /* Page number */" | |
121 puts " pagetype STRING, /* 'internal', 'leaf' or 'overflow' */" | |
122 puts " ncell INTEGER, /* Cells on page (0 for overflow) */" | |
123 puts " payload INTEGER, /* Bytes of payload on this page */" | |
124 puts " unused INTEGER, /* Bytes of unused space on this page */" | |
125 puts " mx_payload INTEGER, /* Largest payload size of all cells */" | |
126 puts " pgoffset INTEGER, /* Offset of page in file */" | |
127 puts " pgsize INTEGER /* Size of the page */" | |
128 puts ");" | |
129 db eval {SELECT quote(name) || ',' || | |
130 quote(path) || ',' || | |
131 quote(pageno) || ',' || | |
132 quote(pagetype) || ',' || | |
133 quote(ncell) || ',' || | |
134 quote(payload) || ',' || | |
135 quote(unused) || ',' || | |
136 quote(mx_payload) || ',' || | |
137 quote(pgoffset) || ',' || | |
138 quote(pgsize) AS x FROM stat} { | |
139 puts "INSERT INTO stats VALUES($x);" | |
140 } | |
141 puts "COMMIT;" | |
142 exit 0 | |
143 } | |
144 | |
145 # In-memory database for collecting statistics. This script loops through | |
146 # the tables and indices in the database being analyzed, adding a row for each | |
147 # to an in-memory database (for which the schema is shown below). It then | |
148 # queries the in-memory db to produce the space-analysis report. | |
149 # | |
150 sqlite3 mem :memory: | |
151 set tabledef {CREATE TABLE space_used( | |
152 name clob, -- Name of a table or index in the database file | |
153 tblname clob, -- Name of associated table | |
154 is_index boolean, -- TRUE if it is an index, false for a table | |
155 nentry int, -- Number of entries in the BTree | |
156 leaf_entries int, -- Number of leaf entries | |
157 depth int, -- Depth of the b-tree | |
158 payload int, -- Total amount of data stored in this table or index | |
159 ovfl_payload int, -- Total amount of data stored on overflow pages | |
160 ovfl_cnt int, -- Number of entries that use overflow | |
161 mx_payload int, -- Maximum payload size | |
162 int_pages int, -- Number of interior pages used | |
163 leaf_pages int, -- Number of leaf pages used | |
164 ovfl_pages int, -- Number of overflow pages used | |
165 int_unused int, -- Number of unused bytes on interior pages | |
166 leaf_unused int, -- Number of unused bytes on primary pages | |
167 ovfl_unused int, -- Number of unused bytes on overflow pages | |
168 gap_cnt int, -- Number of gaps in the page layout | |
169 compressed_size int -- Total bytes stored on disk | |
170 );} | |
171 mem eval $tabledef | |
172 | |
173 # Create a temporary "dbstat" virtual table. | |
174 # | |
175 db eval {CREATE VIRTUAL TABLE temp.stat USING dbstat} | |
176 db eval {CREATE TEMP TABLE dbstat AS SELECT * FROM temp.stat | |
177 ORDER BY name, path} | |
178 db eval {DROP TABLE temp.stat} | |
179 | |
180 set isCompressed 0 | |
181 set compressOverhead 0 | |
182 set depth 0 | |
183 set sql { SELECT name, tbl_name FROM sqlite_master WHERE rootpage>0 } | |
184 foreach {name tblname} [concat sqlite_master sqlite_master [db eval $sql]] { | |
185 | |
186 set is_index [expr {$name!=$tblname}] | |
187 set idx_btree [expr {$is_index || [is_without_rowid $name]}] | |
188 db eval { | |
189 SELECT | |
190 sum(ncell) AS nentry, | |
191 sum((pagetype=='leaf')*ncell) AS leaf_entries, | |
192 sum(payload) AS payload, | |
193 sum((pagetype=='overflow') * payload) AS ovfl_payload, | |
194 sum(path LIKE '%+000000') AS ovfl_cnt, | |
195 max(mx_payload) AS mx_payload, | |
196 sum(pagetype=='internal') AS int_pages, | |
197 sum(pagetype=='leaf') AS leaf_pages, | |
198 sum(pagetype=='overflow') AS ovfl_pages, | |
199 sum((pagetype=='internal') * unused) AS int_unused, | |
200 sum((pagetype=='leaf') * unused) AS leaf_unused, | |
201 sum((pagetype=='overflow') * unused) AS ovfl_unused, | |
202 sum(pgsize) AS compressed_size, | |
203 max((length(CASE WHEN path LIKE '%+%' THEN '' ELSE path END)+3)/4) | |
204 AS depth | |
205 FROM temp.dbstat WHERE name = $name | |
206 } break | |
207 | |
208 set total_pages [expr {$leaf_pages+$int_pages+$ovfl_pages}] | |
209 set storage [expr {$total_pages*$pageSize}] | |
210 if {!$isCompressed && $storage>$compressed_size} { | |
211 set isCompressed 1 | |
212 set compressOverhead 14 | |
213 } | |
214 | |
215 # Column 'gap_cnt' is set to the number of non-contiguous entries in the | |
216 # list of pages visited if the b-tree structure is traversed in a top-down | |
217 # fashion (each node visited before its child-tree is passed). Any overflow | |
218 # chains present are traversed from start to finish before any child-tree | |
219 # is. | |
220 # | |
221 set gap_cnt 0 | |
222 set prev 0 | |
223 db eval { | |
224 SELECT pageno, pagetype FROM temp.dbstat | |
225 WHERE name=$name | |
226 ORDER BY pageno | |
227 } { | |
228 if {$prev>0 && $pagetype=="leaf" && $pageno!=$prev+1} { | |
229 incr gap_cnt | |
230 } | |
231 set prev $pageno | |
232 } | |
233 mem eval { | |
234 INSERT INTO space_used VALUES( | |
235 $name, | |
236 $tblname, | |
237 $is_index, | |
238 $nentry, | |
239 $leaf_entries, | |
240 $depth, | |
241 $payload, | |
242 $ovfl_payload, | |
243 $ovfl_cnt, | |
244 $mx_payload, | |
245 $int_pages, | |
246 $leaf_pages, | |
247 $ovfl_pages, | |
248 $int_unused, | |
249 $leaf_unused, | |
250 $ovfl_unused, | |
251 $gap_cnt, | |
252 $compressed_size | |
253 ); | |
254 } | |
255 } | |
256 | |
257 proc integerify {real} { | |
258 if {[string is double -strict $real]} { | |
259 return [expr {wide($real)}] | |
260 } else { | |
261 return 0 | |
262 } | |
263 } | |
264 mem function int integerify | |
265 | |
266 # Quote a string for use in an SQL query. Examples: | |
267 # | |
268 # [quote {hello world}] == {'hello world'} | |
269 # [quote {hello world's}] == {'hello world''s'} | |
270 # | |
271 proc quote {txt} { | |
272 return [string map {' ''} $txt] | |
273 } | |
274 | |
275 # Output a title line | |
276 # | |
277 proc titleline {title} { | |
278 if {$title==""} { | |
279 puts [string repeat * 79] | |
280 } else { | |
281 set len [string length $title] | |
282 set stars [string repeat * [expr 79-$len-5]] | |
283 puts "*** $title $stars" | |
284 } | |
285 } | |
286 | |
287 # Generate a single line of output in the statistics section of the | |
288 # report. | |
289 # | |
290 proc statline {title value {extra {}}} { | |
291 set len [string length $title] | |
292 set dots [string repeat . [expr 50-$len]] | |
293 set len [string length $value] | |
294 set sp2 [string range { } $len end] | |
295 if {$extra ne ""} { | |
296 set extra " $extra" | |
297 } | |
298 puts "$title$dots $value$sp2$extra" | |
299 } | |
300 | |
301 # Generate a formatted percentage value for $num/$denom | |
302 # | |
303 proc percent {num denom {of {}}} { | |
304 if {$denom==0.0} {return ""} | |
305 set v [expr {$num*100.0/$denom}] | |
306 set of {} | |
307 if {$v==100.0 || $v<0.001 || ($v>1.0 && $v<99.0)} { | |
308 return [format {%5.1f%% %s} $v $of] | |
309 } elseif {$v<0.1 || $v>99.9} { | |
310 return [format {%7.3f%% %s} $v $of] | |
311 } else { | |
312 return [format {%6.2f%% %s} $v $of] | |
313 } | |
314 } | |
315 | |
316 proc divide {num denom} { | |
317 if {$denom==0} {return 0.0} | |
318 return [format %.2f [expr double($num)/double($denom)]] | |
319 } | |
320 | |
321 # Generate a subreport that covers some subset of the database. | |
322 # the $where clause determines which subset to analyze. | |
323 # | |
324 proc subreport {title where showFrag} { | |
325 global pageSize file_pgcnt compressOverhead | |
326 | |
327 # Query the in-memory database for the sum of various statistics | |
328 # for the subset of tables/indices identified by the WHERE clause in | |
329 # $where. Note that even if the WHERE clause matches no rows, the | |
330 # following query returns exactly one row (because it is an aggregate). | |
331 # | |
332 # The results of the query are stored directly by SQLite into local | |
333 # variables (i.e. $nentry, $nleaf etc.). | |
334 # | |
335 mem eval " | |
336 SELECT | |
337 int(sum(nentry)) AS nentry, | |
338 int(sum(leaf_entries)) AS nleaf, | |
339 int(sum(payload)) AS payload, | |
340 int(sum(ovfl_payload)) AS ovfl_payload, | |
341 max(mx_payload) AS mx_payload, | |
342 int(sum(ovfl_cnt)) as ovfl_cnt, | |
343 int(sum(leaf_pages)) AS leaf_pages, | |
344 int(sum(int_pages)) AS int_pages, | |
345 int(sum(ovfl_pages)) AS ovfl_pages, | |
346 int(sum(leaf_unused)) AS leaf_unused, | |
347 int(sum(int_unused)) AS int_unused, | |
348 int(sum(ovfl_unused)) AS ovfl_unused, | |
349 int(sum(gap_cnt)) AS gap_cnt, | |
350 int(sum(compressed_size)) AS compressed_size, | |
351 int(max(depth)) AS depth, | |
352 count(*) AS cnt | |
353 FROM space_used WHERE $where" {} {} | |
354 | |
355 # Output the sub-report title, nicely decorated with * characters. | |
356 # | |
357 puts "" | |
358 titleline $title | |
359 puts "" | |
360 | |
361 # Calculate statistics and store the results in TCL variables, as follows: | |
362 # | |
363 # total_pages: Database pages consumed. | |
364 # total_pages_percent: Pages consumed as a percentage of the file. | |
365 # storage: Bytes consumed. | |
366 # payload_percent: Payload bytes used as a percentage of $storage. | |
367 # total_unused: Unused bytes on pages. | |
368 # avg_payload: Average payload per btree entry. | |
369 # avg_fanout: Average fanout for internal pages. | |
370 # avg_unused: Average unused bytes per btree entry. | |
371 # ovfl_cnt_percent: Percentage of btree entries that use overflow pages. | |
372 # | |
373 set total_pages [expr {$leaf_pages+$int_pages+$ovfl_pages}] | |
374 set total_pages_percent [percent $total_pages $file_pgcnt] | |
375 set storage [expr {$total_pages*$pageSize}] | |
376 set payload_percent [percent $payload $storage {of storage consumed}] | |
377 set total_unused [expr {$ovfl_unused+$int_unused+$leaf_unused}] | |
378 set avg_payload [divide $payload $nleaf] | |
379 set avg_unused [divide $total_unused $nleaf] | |
380 if {$int_pages>0} { | |
381 # TODO: Is this formula correct? | |
382 set nTab [mem eval " | |
383 SELECT count(*) FROM ( | |
384 SELECT DISTINCT tblname FROM space_used WHERE $where AND is_index=0 | |
385 ) | |
386 "] | |
387 set avg_fanout [mem eval " | |
388 SELECT (sum(leaf_pages+int_pages)-$nTab)/sum(int_pages) FROM space_used | |
389 WHERE $where | |
390 "] | |
391 set avg_fanout [format %.2f $avg_fanout] | |
392 } | |
393 set ovfl_cnt_percent [percent $ovfl_cnt $nleaf {of all entries}] | |
394 | |
395 # Print out the sub-report statistics. | |
396 # | |
397 statline {Percentage of total database} $total_pages_percent | |
398 statline {Number of entries} $nleaf | |
399 statline {Bytes of storage consumed} $storage | |
400 if {$compressed_size!=$storage} { | |
401 set compressed_size [expr {$compressed_size+$compressOverhead*$total_pages}] | |
402 set pct [expr {$compressed_size*100.0/$storage}] | |
403 set pct [format {%5.1f%%} $pct] | |
404 statline {Bytes used after compression} $compressed_size $pct | |
405 } | |
406 statline {Bytes of payload} $payload $payload_percent | |
407 if {$cnt==1} {statline {B-tree depth} $depth} | |
408 statline {Average payload per entry} $avg_payload | |
409 statline {Average unused bytes per entry} $avg_unused | |
410 if {[info exists avg_fanout]} { | |
411 statline {Average fanout} $avg_fanout | |
412 } | |
413 if {$showFrag && $total_pages>1} { | |
414 set fragmentation [percent $gap_cnt [expr {$total_pages-1}]] | |
415 statline {Non-sequential pages} $gap_cnt $fragmentation | |
416 } | |
417 statline {Maximum payload per entry} $mx_payload | |
418 statline {Entries that use overflow} $ovfl_cnt $ovfl_cnt_percent | |
419 if {$int_pages>0} { | |
420 statline {Index pages used} $int_pages | |
421 } | |
422 statline {Primary pages used} $leaf_pages | |
423 statline {Overflow pages used} $ovfl_pages | |
424 statline {Total pages used} $total_pages | |
425 if {$int_unused>0} { | |
426 set int_unused_percent [ | |
427 percent $int_unused [expr {$int_pages*$pageSize}] {of index space}] | |
428 statline "Unused bytes on index pages" $int_unused $int_unused_percent | |
429 } | |
430 statline "Unused bytes on primary pages" $leaf_unused [ | |
431 percent $leaf_unused [expr {$leaf_pages*$pageSize}] {of primary space}] | |
432 statline "Unused bytes on overflow pages" $ovfl_unused [ | |
433 percent $ovfl_unused [expr {$ovfl_pages*$pageSize}] {of overflow space}] | |
434 statline "Unused bytes on all pages" $total_unused [ | |
435 percent $total_unused $storage {of all space}] | |
436 return 1 | |
437 } | |
438 | |
439 # Calculate the overhead in pages caused by auto-vacuum. | |
440 # | |
441 # This procedure calculates and returns the number of pages used by the | |
442 # auto-vacuum 'pointer-map'. If the database does not support auto-vacuum, | |
443 # then 0 is returned. The two arguments are the size of the database file in | |
444 # pages and the page size used by the database (in bytes). | |
445 proc autovacuum_overhead {filePages pageSize} { | |
446 | |
447 # Set $autovacuum to non-zero for databases that support auto-vacuum. | |
448 set autovacuum [db one {PRAGMA auto_vacuum}] | |
449 | |
450 # If the database is not an auto-vacuum database or the file consists | |
451 # of one page only then there is no overhead for auto-vacuum. Return zero. | |
452 if {0==$autovacuum || $filePages==1} { | |
453 return 0 | |
454 } | |
455 | |
456 # The number of entries on each pointer map page. The layout of the | |
457 # database file is one pointer-map page, followed by $ptrsPerPage other | |
458 # pages, followed by a pointer-map page etc. The first pointer-map page | |
459 # is the second page of the file overall. | |
460 set ptrsPerPage [expr double($pageSize/5)] | |
461 | |
462 # Return the number of pointer map pages in the database. | |
463 return [expr wide(ceil( ($filePages-1.0)/($ptrsPerPage+1.0) ))] | |
464 } | |
465 | |
466 | |
467 # Calculate the summary statistics for the database and store the results | |
468 # in TCL variables. They are output below. Variables are as follows: | |
469 # | |
470 # pageSize: Size of each page in bytes. | |
471 # file_bytes: File size in bytes. | |
472 # file_pgcnt: Number of pages in the file. | |
473 # file_pgcnt2: Number of pages in the file (calculated). | |
474 # av_pgcnt: Pages consumed by the auto-vacuum pointer-map. | |
475 # av_percent: Percentage of the file consumed by auto-vacuum pointer-map. | |
476 # inuse_pgcnt: Data pages in the file. | |
477 # inuse_percent: Percentage of pages used to store data. | |
478 # free_pgcnt: Free pages calculated as (<total pages> - <in-use pages>) | |
479 # free_pgcnt2: Free pages in the file according to the file header. | |
480 # free_percent: Percentage of file consumed by free pages (calculated). | |
481 # free_percent2: Percentage of file consumed by free pages (header). | |
482 # ntable: Number of tables in the db. | |
483 # nindex: Number of indices in the db. | |
484 # nautoindex: Number of indices created automatically. | |
485 # nmanindex: Number of indices created manually. | |
486 # user_payload: Number of bytes of payload in table btrees | |
487 # (not including sqlite_master) | |
488 # user_percent: $user_payload as a percentage of total file size. | |
489 | |
490 ### The following, setting $file_bytes based on the actual size of the file | |
491 ### on disk, causes this tool to choke on zipvfs databases. So set it based | |
492 ### on the return of [PRAGMA page_count] instead. | |
493 if 0 { | |
494 set file_bytes [file size $file_to_analyze] | |
495 set file_pgcnt [expr {$file_bytes/$pageSize}] | |
496 } | |
497 set file_pgcnt [db one {PRAGMA page_count}] | |
498 set file_bytes [expr {$file_pgcnt * $pageSize}] | |
499 | |
500 set av_pgcnt [autovacuum_overhead $file_pgcnt $pageSize] | |
501 set av_percent [percent $av_pgcnt $file_pgcnt] | |
502 | |
503 set sql {SELECT sum(leaf_pages+int_pages+ovfl_pages) FROM space_used} | |
504 set inuse_pgcnt [expr wide([mem eval $sql])] | |
505 set inuse_percent [percent $inuse_pgcnt $file_pgcnt] | |
506 | |
507 set free_pgcnt [expr {$file_pgcnt-$inuse_pgcnt-$av_pgcnt}] | |
508 set free_percent [percent $free_pgcnt $file_pgcnt] | |
509 set free_pgcnt2 [db one {PRAGMA freelist_count}] | |
510 set free_percent2 [percent $free_pgcnt2 $file_pgcnt] | |
511 | |
512 set file_pgcnt2 [expr {$inuse_pgcnt+$free_pgcnt2+$av_pgcnt}] | |
513 | |
514 set ntable [db eval {SELECT count(*)+1 FROM sqlite_master WHERE type='table'}] | |
515 set nindex [db eval {SELECT count(*) FROM sqlite_master WHERE type='index'}] | |
516 set sql {SELECT count(*) FROM sqlite_master WHERE name LIKE 'sqlite_autoindex%'} | |
517 set nautoindex [db eval $sql] | |
518 set nmanindex [expr {$nindex-$nautoindex}] | |
519 | |
520 # set total_payload [mem eval "SELECT sum(payload) FROM space_used"] | |
521 set user_payload [mem one {SELECT int(sum(payload)) FROM space_used | |
522 WHERE NOT is_index AND name NOT LIKE 'sqlite_master'}] | |
523 set user_percent [percent $user_payload $file_bytes] | |
524 | |
525 # Output the summary statistics calculated above. | |
526 # | |
527 puts "/** Disk-Space Utilization Report For $root_filename" | |
528 puts "" | |
529 statline {Page size in bytes} $pageSize | |
530 statline {Pages in the whole file (measured)} $file_pgcnt | |
531 statline {Pages in the whole file (calculated)} $file_pgcnt2 | |
532 statline {Pages that store data} $inuse_pgcnt $inuse_percent | |
533 statline {Pages on the freelist (per header)} $free_pgcnt2 $free_percent2 | |
534 statline {Pages on the freelist (calculated)} $free_pgcnt $free_percent | |
535 statline {Pages of auto-vacuum overhead} $av_pgcnt $av_percent | |
536 statline {Number of tables in the database} $ntable | |
537 statline {Number of indices} $nindex | |
538 statline {Number of defined indices} $nmanindex | |
539 statline {Number of implied indices} $nautoindex | |
540 if {$isCompressed} { | |
541 statline {Size of uncompressed content in bytes} $file_bytes | |
542 set efficiency [percent $true_file_size $file_bytes] | |
543 statline {Size of compressed file on disk} $true_file_size $efficiency | |
544 } else { | |
545 statline {Size of the file in bytes} $file_bytes | |
546 } | |
547 statline {Bytes of user payload stored} $user_payload $user_percent | |
548 | |
549 # Output table rankings | |
550 # | |
551 puts "" | |
552 titleline "Page counts for all tables with their indices" | |
553 puts "" | |
554 mem eval {SELECT tblname, count(*) AS cnt, | |
555 int(sum(int_pages+leaf_pages+ovfl_pages)) AS size | |
556 FROM space_used GROUP BY tblname ORDER BY size+0 DESC, tblname} {} { | |
557 statline [string toupper $tblname] $size [percent $size $file_pgcnt] | |
558 } | |
559 puts "" | |
560 titleline "Page counts for all tables and indices separately" | |
561 puts "" | |
562 mem eval { | |
563 SELECT | |
564 upper(name) AS nm, | |
565 int(int_pages+leaf_pages+ovfl_pages) AS size | |
566 FROM space_used | |
567 ORDER BY size+0 DESC, name} {} { | |
568 statline $nm $size [percent $size $file_pgcnt] | |
569 } | |
570 if {$isCompressed} { | |
571 puts "" | |
572 titleline "Bytes of disk space used after compression" | |
573 puts "" | |
574 set csum 0 | |
575 mem eval {SELECT tblname, | |
576 int(sum(compressed_size)) + | |
577 $compressOverhead*sum(int_pages+leaf_pages+ovfl_pages) | |
578 AS csize | |
579 FROM space_used GROUP BY tblname ORDER BY csize+0 DESC, tblname} {} { | |
580 incr csum $csize | |
581 statline [string toupper $tblname] $csize [percent $csize $true_file_size] | |
582 } | |
583 set overhead [expr {$true_file_size - $csum}] | |
584 if {$overhead>0} { | |
585 statline {Header and free space} $overhead [percent $overhead $true_file_siz
e] | |
586 } | |
587 } | |
588 | |
589 # Output subreports | |
590 # | |
591 if {$nindex>0} { | |
592 subreport {All tables and indices} 1 0 | |
593 } | |
594 subreport {All tables} {NOT is_index} 0 | |
595 if {$nindex>0} { | |
596 subreport {All indices} {is_index} 0 | |
597 } | |
598 foreach tbl [mem eval {SELECT DISTINCT tblname name FROM space_used | |
599 ORDER BY name}] { | |
600 set qn [quote $tbl] | |
601 set name [string toupper $tbl] | |
602 set n [mem eval {SELECT count(*) FROM space_used WHERE tblname=$tbl}] | |
603 if {$n>1} { | |
604 set idxlist [mem eval "SELECT name FROM space_used | |
605 WHERE tblname='$qn' AND is_index | |
606 ORDER BY 1"] | |
607 subreport "Table $name and all its indices" "tblname='$qn'" 0 | |
608 subreport "Table $name w/o any indices" "name='$qn'" 1 | |
609 if {[llength $idxlist]>1} { | |
610 subreport "Indices of table $name" "tblname='$qn' AND is_index" 0 | |
611 } | |
612 foreach idx $idxlist { | |
613 set qidx [quote $idx] | |
614 subreport "Index [string toupper $idx] of table $name" "name='$qidx'" 1 | |
615 } | |
616 } else { | |
617 subreport "Table $name" "name='$qn'" 1 | |
618 } | |
619 } | |
620 | |
621 # Output instructions on what the numbers above mean. | |
622 # | |
623 puts "" | |
624 titleline Definitions | |
625 puts { | |
626 Page size in bytes | |
627 | |
628 The number of bytes in a single page of the database file. | |
629 Usually 1024. | |
630 | |
631 Number of pages in the whole file | |
632 } | |
633 puts " The number of $pageSize-byte pages that go into forming the complete | |
634 database" | |
635 puts { | |
636 Pages that store data | |
637 | |
638 The number of pages that store data, either as primary B*Tree pages or | |
639 as overflow pages. The number at the right is the data pages divided by | |
640 the total number of pages in the file. | |
641 | |
642 Pages on the freelist | |
643 | |
644 The number of pages that are not currently in use but are reserved for | |
645 future use. The percentage at the right is the number of freelist pages | |
646 divided by the total number of pages in the file. | |
647 | |
648 Pages of auto-vacuum overhead | |
649 | |
650 The number of pages that store data used by the database to facilitate | |
651 auto-vacuum. This is zero for databases that do not support auto-vacuum. | |
652 | |
653 Number of tables in the database | |
654 | |
655 The number of tables in the database, including the SQLITE_MASTER table | |
656 used to store schema information. | |
657 | |
658 Number of indices | |
659 | |
660 The total number of indices in the database. | |
661 | |
662 Number of defined indices | |
663 | |
664 The number of indices created using an explicit CREATE INDEX statement. | |
665 | |
666 Number of implied indices | |
667 | |
668 The number of indices used to implement PRIMARY KEY or UNIQUE constraints | |
669 on tables. | |
670 | |
671 Size of the file in bytes | |
672 | |
673 The total amount of disk space used by the entire database files. | |
674 | |
675 Bytes of user payload stored | |
676 | |
677 The total number of bytes of user payload stored in the database. The | |
678 schema information in the SQLITE_MASTER table is not counted when | |
679 computing this number. The percentage at the right shows the payload | |
680 divided by the total file size. | |
681 | |
682 Percentage of total database | |
683 | |
684 The amount of the complete database file that is devoted to storing | |
685 information described by this category. | |
686 | |
687 Number of entries | |
688 | |
689 The total number of B-Tree key/value pairs stored under this category. | |
690 | |
691 Bytes of storage consumed | |
692 | |
693 The total amount of disk space required to store all B-Tree entries | |
694 under this category. The is the total number of pages used times | |
695 the pages size. | |
696 | |
697 Bytes of payload | |
698 | |
699 The amount of payload stored under this category. Payload is the data | |
700 part of table entries and the key part of index entries. The percentage | |
701 at the right is the bytes of payload divided by the bytes of storage | |
702 consumed. | |
703 | |
704 Average payload per entry | |
705 | |
706 The average amount of payload on each entry. This is just the bytes of | |
707 payload divided by the number of entries. | |
708 | |
709 Average unused bytes per entry | |
710 | |
711 The average amount of free space remaining on all pages under this | |
712 category on a per-entry basis. This is the number of unused bytes on | |
713 all pages divided by the number of entries. | |
714 | |
715 Non-sequential pages | |
716 | |
717 The number of pages in the table or index that are out of sequence. | |
718 Many filesystems are optimized for sequential file access so a small | |
719 number of non-sequential pages might result in faster queries, | |
720 especially for larger database files that do not fit in the disk cache. | |
721 Note that after running VACUUM, the root page of each table or index is | |
722 at the beginning of the database file and all other pages are in a | |
723 separate part of the database file, resulting in a single non- | |
724 sequential page. | |
725 | |
726 Maximum payload per entry | |
727 | |
728 The largest payload size of any entry. | |
729 | |
730 Entries that use overflow | |
731 | |
732 The number of entries that user one or more overflow pages. | |
733 | |
734 Total pages used | |
735 | |
736 This is the number of pages used to hold all information in the current | |
737 category. This is the sum of index, primary, and overflow pages. | |
738 | |
739 Index pages used | |
740 | |
741 This is the number of pages in a table B-tree that hold only key (rowid) | |
742 information and no data. | |
743 | |
744 Primary pages used | |
745 | |
746 This is the number of B-tree pages that hold both key and data. | |
747 | |
748 Overflow pages used | |
749 | |
750 The total number of overflow pages used for this category. | |
751 | |
752 Unused bytes on index pages | |
753 | |
754 The total number of bytes of unused space on all index pages. The | |
755 percentage at the right is the number of unused bytes divided by the | |
756 total number of bytes on index pages. | |
757 | |
758 Unused bytes on primary pages | |
759 | |
760 The total number of bytes of unused space on all primary pages. The | |
761 percentage at the right is the number of unused bytes divided by the | |
762 total number of bytes on primary pages. | |
763 | |
764 Unused bytes on overflow pages | |
765 | |
766 The total number of bytes of unused space on all overflow pages. The | |
767 percentage at the right is the number of unused bytes divided by the | |
768 total number of bytes on overflow pages. | |
769 | |
770 Unused bytes on all pages | |
771 | |
772 The total number of bytes of unused space on all primary and overflow | |
773 pages. The percentage at the right is the number of unused bytes | |
774 divided by the total number of bytes. | |
775 } | |
776 | |
777 # Output a dump of the in-memory database. This can be used for more | |
778 # complex offline analysis. | |
779 # | |
780 titleline {} | |
781 puts "The entire text of this report can be sourced into any SQL database" | |
782 puts "engine for further analysis. All of the text above is an SQL comment." | |
783 puts "The data used to generate this report follows:" | |
784 puts "*/" | |
785 puts "BEGIN;" | |
786 puts $tabledef | |
787 unset -nocomplain x | |
788 mem eval {SELECT * FROM space_used} x { | |
789 puts -nonewline "INSERT INTO space_used VALUES" | |
790 set sep ( | |
791 foreach col $x(*) { | |
792 set v $x($col) | |
793 if {$v=="" || ![string is double $v]} {set v '[quote $v]'} | |
794 puts -nonewline $sep$v | |
795 set sep , | |
796 } | |
797 puts ");" | |
798 } | |
799 puts "COMMIT;" | |
800 | |
801 } err]} { | |
802 puts "ERROR: $err" | |
803 puts $errorInfo | |
804 exit 1 | |
805 } | |
OLD | NEW |