File: table_visualizer_chapter.html

package info (click to toggle)
erlang-doc-html 1%3A12.b.3-dfsg-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 27,712 kB
  • ctags: 13,052
  • sloc: erlang: 505; ansic: 323; perl: 61; makefile: 57; sh: 23
file content (1046 lines) | stat: -rw-r--r-- 29,008 bytes parent folder | download
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This document was generated using DocBuilder-0.9.8.4 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>The Table Visualizer</title>
  <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
  <script type="text/javascript" src="../../../../doc/erlresolvelinks.js"></script>
  <style type="text/css">
<!--
    body          { font-family: Verdana, Arial, Helvetica, sans-serif }
    span.bold_code        { font-family: courier;font-weight: bold}
    span.code        { font-family: courier;font-weight: normal}

.note, .warning {
  border: solid black 1px;
  margin: 1em 3em;
}

.note .label {
  background: #30d42a;
  color: white;
  font-weight: bold;
  padding: 5px 10px;
}
.note .content {
  background: #eafeea;
  color: black;
  line-height: 120%;
  font-size: 90%;
  padding: 5px 10px;
}
.warning .label {
  background: #C00;
  color: white;
  font-weight: bold;
  padding: 5px 10px;
}
.warning .content {
  background: #FFF0F0;
  color: black;
  line-height: 120%;
  font-size: 90%;
  padding: 5px 10px;
}

    .example     { background-color:#eeeeff } 
    pre          { font-family: courier; font-weight: normal }
    .REFBODY     { margin-left: 13mm }
    .REFTYPES    { margin-left: 8mm }
-->
  </style>
</head>
<body bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#FF00FF" alink="#FF0000">
<center>
<a href="http://www.ericsson.com/technology/opensource/erlang"><img border="0" alt="[Ericsson AB]" src="min_head.gif"/></a>
</center><a name="1"><!-- Empty --></a>
<h2>1 The Table Visualizer</h2>

<p>The TV, TV, is a tool that enables the user to examine 
ETS and Mnesia tables on any (connected) node in the currently running Erlang
system. Once a certain table has been opened in the tool, the content may be
viewed in various levels of detail. The content may also be edited, as well as
sorted, using any element as key. It is also possible to search for a specified object or
element. The table may be polled anytime, either regularly, at specified
intervals, or manually. New and deleted objects, as well as those altered, are
marked with characteristic colours.
</p>
<p>Information about the table itself (permissions, storage type, and so on) may
also be obtained.

</p><a name="1.1"><!-- Empty --></a>
<h3>1.1 Terminology and Background</h3>

<p>To avoid confusion, we have to distinguish between the <strong>actual table</strong>, i.e.,
the data stored in ETS or Mnesia, and the <strong>image of the table</strong>, i.e., the
data shown in the TV. The <strong>image of the table</strong> is simply a copy
of the <strong>actual table</strong>, and can be manipulated in a number of ways, for example
sorted. It follows that these manipulations in no way affects the <strong>actual table</strong>!
</p>
<p>The expression <strong>poll the table</strong> is used for the operation of scanning through the
content of the actual table (in order to keep the image of the table consistent with the
actual table).
</p>
<p>The ETS and Mnesia modules provides the user with the ability to store vast quantities
of data in, the data organized as dynamic, unordered tables. The ETS
facility stores <strong>tuples</strong>, while Mnesia stores <strong>records</strong>.
Each tuple consists of one or more <strong>elements</strong>; each record consists of one or
more <strong>fields</strong>. It should be noted that, since records are implemented as tuples,
with the record name as the first element, the first field of a record becomes the second
element in the corresponding tuple!
<br />


In the following, all table objects are mainly referred to as tuples, regardless of the
table type.
</p>
<p>For further information about ETS and Mnesia, please see the manual pages and Mnesia User's Guide.
</p><a name="1.2"><!-- Empty --></a>
<h3>1.2 Starting the TV</h3>

<p>The TV tool is started by giving the command
</p>
<div class="example"><pre>
      tv:start().
    
</pre></div>

<p>The window that appears, is hereafter referred to as <strong>the TV main window</strong>. It consists of:
</p>
<ul>

<li>

a <strong>menubar</strong>.<br />


</li>


<li>

a <strong>grid</strong>, i.e., a multicolumnar array, where tables existing on
the current node is shown. Each square in the grid is called a <strong>cell</strong>.<br />


</li>


</ul>

<center>
<img alt="tv_start" src="tv_start.gif"/><br/>
<em>The TV Main Window at startup.</em>

</center>

<p>For each table, the following information is shown, in order:

</p>
<ul>

<li>

the <strong>table name</strong>. If the table is accessible through this name, as is the
case with Mnesia tables and named ETS tables, the table name is shown in
black, otherwise in medium grey.<br />


</li>


<li>

the <strong>table identifier</strong>, if there is one; since Mnesia tables are accessed
solely through the table name, this cell will in those cases be blank.<br />


</li>


<li>

the <strong>process identifier (PID) of the process owning the table</strong>.<br />


</li>


<li>

the <strong>name of the process owning the table</strong>, provided the process
is registered.<br />


</li>


<li>

the <strong>table size</strong>, i.e., the number of objects currently stored in
the table.<br />


</li>


</ul>
<a name="1.3"><!-- Empty --></a>
<h3>1.3 Changing View</h3>

<p>The TV will by default show currently existing ETS tables,
but the user may easily switch to a Mnesia table view, by choosing the
<strong>Mnesia Tables</strong> option in the <strong>View</strong> menu:

</p>
<center>
<img alt="tv_start_mnesia" src="tv_start_mnesia.gif"/><br/>
<em>The TV Main Window, showing Mnesia tables.</em>

</center>

<p>Normally, system tables (i.e., tables used by system applications) and unreadable
tables are not shown. The menu option <strong>System Tables</strong>, in the <strong>Options</strong>
menu, makes the system tables visible:

</p>
<center>
<img alt="tv_start_system" src="tv_start_system.gif"/><br/>
<em>The TV Main Window, showing readable user and system tables.</em>

</center>

<p>Still unreadable tables are hidden, but the menu option <strong>Unreadable Tables</strong>,
also in the <strong>Options</strong> menu, makes even those tables visible. It shall be noted
that rows containing unreadable tables are shaded, using a grey colour:

</p>
<center>
<img alt="tv_start_system_unreadable" src="tv_start_system_unreadable.gif"/><br/>
<em>The TV Main Window, showing both readable and unreadable user and system tables.</em>

</center>

<p>Once a table view has been opened, the user may choose how to view it: it may be sorted
by the table names, by the table identifiers, by the process identifiers of the owner
processes, or by the names of the owning processes. These sorting options are found in the
<strong>Options</strong> menu.

</p>
<center>
<img alt="tv_start_pid_sorted" src="tv_start_pid_sorted.gif"/><br/>
<em>The TV Main Window, tables sorted by owner PID.</em>

</center>
<a name="1.4"><!-- Empty --></a>
<h3>1.4 Changing the Current Node</h3>

<p>By default, the Table Vizualizer will show tables residing on the node
it was started from. However, the user may easily view tables on other nodes.
By choosing the <strong>Nodes</strong> option, in the <strong>File</strong> menu, a window showing
all connected nodes will appear. Clicking on any of the nodes in the list will cause
the main window to immediately show the tables residing on the specified node:

</p>
<center>
<img alt="tv_start_other_node" src="tv_start_other_node.gif"/><br/>
<em>The Connected Nodes window, and the TV Main Window, showing tables on the selected node.</em>

</center>
<a name="1.5"><!-- Empty --></a>
<h3>1.5 Opening a Table in the Table Browser</h3>

<p>Whenever a table shall be opened, the first step is to choose the corresponding
<strong>Table Name</strong> or <strong>Table ID</strong> cell. Secondly, the <strong>Open Table</strong>
menu item, in the <strong>File</strong> menu, has to be chosen. (Or, one may directly
double-click on a <strong>Table Name</strong> or <strong>Table Id</strong> cell.)
</p>
<p>If the table selected table is readable, a window will appear after a short delay. This new
window is hereafter denoted the <strong>Table Browser</strong> window. Should the table be
unreadable, the Table Information window will appear instead (see further description
below).

</p><a name="1.5.1"><!-- Empty --></a>
<h4>1.5.1 The Table Browser Window</h4>

<p>The Table Browser window consists of:
</p>
<ul>

<li>

a <strong>menubar</strong>.<br />


</li>


<li>

a <strong>toolbar</strong> with buttons providing shortcuts to the menubar options. If the
cursor rests on any button, a so-called toolbar tip, explaining the button,
will appear. <br />


(In the picture below, the cursor has lingered on the <strong>Open Table</strong>
button for a while.)<br />


</li>


<li>

a <strong>content and edit field</strong>, showing the content of a specified row or cell.
Through this field the row, or cell, may also be edited (see below for a detailed
description).<br />


</li>


<li>

a <strong>grid</strong>, i.e., a multicolumnar array, where the content of the
opened table will be shown. (As above, each square in the grid is called a cell.<br />


</li>


</ul>

<center>
<img alt="tv_table_browser" src="tv_table_browser.gif"/><br/>
<em>The Table Browser Window.</em>

</center>

<p>The successful appearance of the Table Browser window means that an image of
the selected table has been created in the TV. It is this image
that is shown in the Table Browser.

</p><a name="1.5.1.1"><!-- Empty --></a>
<h5>1.5.1.1 How Table Data Is Presented</h5>

<p>Each object in the table is presented on a row of its own in the grid.
Each element in the object is presented in a cell of its own. <br />


The colours on the <strong>vertical</strong> buttons to the left of the grid show the status
of the object on that very row: a bright red colour indicates that the object just
has been inserted (when the table is opened, all objects are regarded as being
just inserted), while a bright green colour indicates that the object has been
changed. The colour fades away, shade by shade, every time the actual table is polled,
until the normal background colour is encountered. <br />


When an object has been deleted, the colour of the corresponding
<strong>vertical button</strong> turns to black. The next time the table is polled, the
object will be removed from the grid.
</p>
<center>
<img alt="tv_table_browser_updated" src="tv_table_browser_updated.gif"/><br/>
<em>The Table Browser Window, with new, changed, and deleted objects.</em>

</center>

<p>Normally, new objects are placed at the end of the grid, while all other objects
maintain their positions between successive polls. However, when sorting mode has
been ordered, all objects, even new ones, are placed at the correct position
according to the sorting ordered (see also below).
</p>
<p>Immediately above the <strong>horizontal buttons</strong>, one or more <strong>keys</strong> may
appear. These keys indicates which elements that are used as indices in the
ETS/Mnesia table, i.e., which fields that are used by ETS/Mnesia as search keys when
looking up data.
</p>
<p>The grid columns may be resized, by clicking and dragging on the small black <strong>resize areas</strong> between any two horizontal buttons.
</p>
<p>The rows are enumerated, as a help when navigating through the table. Note: it shall
not be assumed that these numbers correspond to the placement of the objects in the
<strong>actual table</strong>! The row numbers, as presented in the TV, are
only temporary, and only valid within the TV!
<br />


The number on the <strong>vertical scrollbar</strong> corresponds to the number the
uppermost row has (or will have).
</p>
<p>The number shown on the horizontal scrollbar relates to the leftmost column shown.
</p><a name="1.5.1.2"><!-- Empty --></a>
<h5>1.5.1.2 How to Poll the Table</h5>

<p>The table is polled whenever the <strong>Poll Table</strong> option in the <strong>Options</strong>
menu is chosen (or the <strong>Poll Table</strong> toolbar button is pressed). <br />


The user may also choose to let the TV poll the table at regular
intervals. This is done via the <strong>Set Poll Interval...</strong> option in the
<strong>Options</strong> menu, which causes the <strong>Set Poll Interval window</strong> to appear. 
</p>
<p>In the Set Poll Interval window the user selects whether manual or automatic
polling shall be used, and, in the automatic polling case, the poll interval.
</p>
<center>
<img alt="set_poll_int" src="set_poll_int.gif"/><br/>
<em>The Set Poll Interval Window.</em>

</center>

<p>It shall be noted that, in the case of a large table (or a slow computer/operating
system), a short poll interval may cause the TV to be flooded, i.e., the
data resulting from one poll has not been fully treated and presented when the data from
the next poll arrives. The user is therefore kindly requested to use the automatic
polling facility with care!
</p><a name="1.5.1.3"><!-- Empty --></a>
<h5>1.5.1.3 How to Edit Objects in the Table</h5>

<p>Provided that the table is writable for other processes than the owning process,
the user may insert, change and delete objects.
</p>
<p>To <strong>delete</strong> an object, the corresponding row, or a single cell in the
corresponding row, has to be chosen, by clicking either on the vertical button
to the left of the row, or on a cell. Thereafter the <strong>Delete Object</strong>
option in the <strong>Edit Menu</strong>
is chosen. (Should the user regret the delete operation, the row may once again
be selected, whereupon the <strong>Return</strong> button simply is pressed.)
</p>
<p>To <strong>insert</strong> an object, the user may use the <strong>Record Editor</strong>, or simply
enter the object in the content and edit field, and then press the <strong>Return</strong>
button. <br />


The <strong>Record Editor</strong> is started via the <strong>Edit Object</strong> option in the
<strong>Edit</strong> menu, or via the <strong>Edit Object</strong> toolbar button. The editor that
appears looks different depending on the kind of table: for Mnesia tables,
a writable field is shown for each record entry, as well as the name of the entry.
For ETS tables, only a writable field is shown; this is due to the fact that the
size of the tuples inserted in ETS tables may vary, whereas the size of the records
inserted in a Mnesia table (more or less) is fixed.
One may select the next field in the record editor by pressing
the 'Tab' (or 'Arrow Down') button, and select the previous field by pressing
'Shift'+'Tab' (or 'Arrow Up'). <br />


When the editing is finished, the <strong>OK</strong> button may be clicked, or
'Return' pressed. The TV will then try to insert the new object.

</p>
<center>
<img alt="tv_record_editor_mnesia" src="tv_record_editor_mnesia.gif"/><br/>
<em>The Record Editor (shown for a Mnesia table).</em>

</center>

<p>To <strong>change</strong> an already existing object, the corresponding row, or a single cell
in the corresponding row, has to be selected first (see below). Then one may edit the
whole object (or the selected field in the object), either using the record editor
or the content and edit field, whereupon 'Return' may be pressed (or the 'OK' button
clicked).

</p>
<p>It shall be noted that it is hard to edit objects containing
<strong>process identifiers</strong>, <strong>references</strong>, <strong>binaries</strong> and <strong>ports</strong>,
since it is only a textual representation of these terms that is shown on the screen.
It is in the general case impossible for the TV to correctly
convert this textual representation back to the original term. As a courtesy to
the user, an attempt to do this will nevertheless be done if the edited field
consists of a single process identifier; however, this conversion will only be
correct provided
that the process identifier originates from the current Erlang session. (On
the other hand, why on earth should any user want to store old process identifiers?)

</p>
<p>It shall also be noted that it may be more or less confusing to edit the table,
depending on whether the table type is <strong>set</strong>, <strong>bag</strong>, or
<strong>duplicate_bag</strong>, i.e., depending on whether or not objects having the
same key (or even duplicate objetcts) are allowed. Please study the ETS or Mnesia
manual pages, should confusion arise!

</p><a name="1.5.1.4"><!-- Empty --></a>
<h5>1.5.1.4 How to Search For Objects</h5>

<p>One may search for an object, by choosing the <strong>Search Object</strong>
option in the <strong>Options</strong> menu (or by pressing the <strong>Search Object</strong>
toolbar button). In the <strong>Search Object window</strong> that appears, any valid
Erlang term or regular expression may be entered, whereupon all objects
containing (or consisting of) this term, or matching the regular expression,
will be shown.
</p>
<center>
<img alt="tv_search_window" src="tv_search_window.gif"/><br/>
<em>The Search Object Window.</em>

</center>

<p>In the search result list, by clicking on any object, the Table Browser will
immediately scroll to the corresponding row in the table shown. This enables
the user to in a very powerful way quickly find the objects he's interested in.
</p>
<center>
<img alt="tv_search_result" src="tv_search_result.gif"/><br/>
<em>The Search Object Window interworking with the Table Browser.</em>

</center>
<a name="1.5.1.5"><!-- Empty --></a>
<h5>1.5.1.5 How to Mark Table Data</h5>

<p>One may mark a row or a column by clicking on the buttons to the left and above
the grid, respectively. A single cell is marked by clicking on it. Even empty
rows and columns may be marked; an empty cell cannot be marked - on the contrary,
by clicking on an empty cell, all marks are removed.
</p>
<p>Marks are indicated by a cyan blue colour.
</p>
<center>
<img alt="tv_row_marked" src="tv_row_marked.gif"/><br/>
<em>The TV Main Window: a row has been marked.</em>

</center>

<p>When a row or a cell has been marked, the content will be shown in the content field,
together with an indication of the row (and column when applicable) the marked area
corresponds to. Should the object be very big, only a fraction of it may be shown in
this field. By clicking on the down-arrow button to the right of the content and
edit field, a pop-up content field will be shown, where the whole marked object
may be viewed. The content of this pop-up field may be marked and copied to
other windows; however, this field cannot be edited.
</p>
<center>
<img alt="tv_row_marked_popup" src="tv_row_marked_popup.gif"/><br/>
<em>The Table Browser: the pop-up content field.</em>

</center>

<p>It shall be noted that the user may choose whether lists shall be shown as
strings or lists; this is done via the <strong>View</strong> menu.

</p>
<p>A marked column may be subject to sorting, see below. When sorting is ordered,
marks are removed at each polling of the table (because of the difficulties to
keep track of a certain object, or element, in this case).
</p><a name="1.5.1.6"><!-- Empty --></a>
<h5>1.5.1.6 How to Sort Table Data</h5>

<p>The image of the table may be sorted in rising or falling order, using any element as
sorting key. The element desired is chosen by marking the corresponding column, and
then choose (either via the <strong>Options</strong> menu, or via the toolbar buttons) any
of the sorting options available, i.e., sorting in ascending or descending order.
The colour of the column button will then change to gold, to indicate that this
column is the basis for the sorting currently chosen.
</p>
<p>Should no column have been marked, when sorting is ordered, the first element in each
object (i.e, tuple) will be used as sorting key if the table is an ETS table; the
second element (i.e., the first field in the record) will be used if the table is a
Mnesia table.
</p>
<p>Even columns with no elements in them may be subject to sorting. In this case the
whole object is used as the sorting key.
</p>
<p>When sorting is ordered, new elements will be inserted according to the current
sorting mode. When the sorting is interrupted (via the <strong>No Sorting</strong> option),
the current image of the table keep the current order, but new elements will from
now on once again be inserted at the end of the image of the table.
</p><a name="1.5.1.7"><!-- Empty --></a>
<h5>1.5.1.7 How to Obtain Table Information</h5>

<p>Information about the actual table is obtained via the <strong>File</strong> menu (or via the
<strong>Table Info</strong> toolbar button). The information is printed in a separate window,
with similar pieces of information grouped together on &#34;flap cards&#34; of their own.
By clicking on a flap, the information on the corresponding card is made visible.
</p>
<center>
<img alt="info_window" src="info_window.gif"/><br/>
<em>The Table Information Window, showing information about a Mnesia table.</em>

</center>

<p>The Table Information window may also be opened from the TV Main
Window, by selecting a table and then choose the <strong>Table Info</strong> option
in the <strong>File</strong> menu (or by double-clicking on the <strong>Table Size</strong>
field.
</p>
<p>Note: The Table Information window will automatically be opened if the user tries
to open an unreadable table, since this is the only information available in this
case.
</p><a name="1.5.2"><!-- Empty --></a>
<h4>1.5.2 The Table Browser Menus</h4>

<p>The Table Browser offers the following menus:
</p>
<p>
</p><a name="1.5.2.1"><!-- Empty --></a>
<h5>1.5.2.1 The File Menu</h5>

<dl>

<dt>
<strong>Table Info</strong>
</dt>

<dd>

Opens the Table Information window, which shows the available information
about the current table. <br />


</dd>

<dt>
<strong>Close</strong>
</dt>

<dd>

Closes the Table Browser window.<br />


</dd>

</dl>
<a name="1.5.2.2"><!-- Empty --></a>
<h5>1.5.2.2 The Edit Menu</h5>

<dl>

<dt>
<strong>Edit Object...</strong>
</dt>

<dd>

Opens the Record Editor. If an object is marked, it will be shown in
the Record Editor.<br />


</dd>

<dt>
<strong>Delete Object</strong>
</dt>

<dd>

Deletes a marked object.<br />


</dd>

</dl>
<a name="1.5.2.3"><!-- Empty --></a>
<h5>1.5.2.3 The View Menu</h5>

<dl>

<dt>
<strong>Lists As Lists</strong>
</dt>

<dd>

Causes lists in the table to be shwon as lists.<br />


</dd>

<dt>
<strong>Lists As Strings</strong>
</dt>

<dd>

Causes lists in the table to be shown as strings.<br />


</dd>

</dl>
<a name="1.5.2.4"><!-- Empty --></a>
<h5>1.5.2.4 The Options Menu</h5>

<dl>

<dt>
<strong>Poll Table</strong>
</dt>

<dd>

An explicit order to poll the table, i.e., to scan the content.<br />


</dd>

<dt>
<strong>Poll Interval...</strong>
</dt>

<dd>

Choose between manual and automatic polling. In the case of automatic
polling, the user gets the opportunity to choose the polling interval.<br />


</dd>

<dt>
<strong>Search Object</strong>
</dt>

<dd>

Enables search for objects containing (or consisting of) a specified
Erlang term, or matching a regular pattern. The search result may be used
for quick navigation in the table.<br />


</dd>

<dt>
<strong>Sort Ascending Order</strong>
</dt>

<dd>

Shows the table content sorted in ascending (i.e., rising) order.
New objects will be shown with correct placement as long the as the sorting
is going on. <br />


Please note that it is only the image of the table that is affected,
<strong>not</strong> the table itself!<br />


</dd>

<dt>
<strong>Sort Descending Order</strong>
</dt>

<dd>

Shows the table content sorted in descending (i.e., falling) order.
New objects will be shown with correct placement as long the as the
sorting is going on.<br />


</dd>

<dt>
<strong>No Sorting</strong>
</dt>

<dd>

Sorting mode is left. New objects will be shown last in the
table. However, older objects will remain in the position they had when
the sorting mode was left, i.e., their placement will not reflect their
actual placement in the ETS/Mnesia table.<br />


</dd>

</dl>
<a name="1.5.2.5"><!-- Empty --></a>
<h5>1.5.2.5 The Help Menu</h5>

<dl>

<dt>
<strong>Help</strong>
</dt>

<dd>

Shows the help (about TV usage) that is available.
(The help will be shown in the Netscape Internet browser, if available.)<br />


</dd>

<dt>
<strong>OTP Documentation</strong>
</dt>

<dd>

Shows the Documentation about all OTP components that is available
in the local installation of OTP.<br />


</dd>

</dl>
<a name="1.6"><!-- Empty --></a>
<h3>1.6 Tracing the Owner Process</h3>

<p>The process owning the table may easily be traced, by selecting either
the <strong>Owner Pid</strong> or the <strong>Owner Name</strong> field, and then choosing
the <strong>Trace Process</strong> option in the <strong>File</strong> menu. <br />


(It is also possible to double-click on any of these fields.)
</p><a name="1.7"><!-- Empty --></a>
<h3>1.7 Creating a New Table</h3>

<p>A new table may easily be created using the <strong>New Table window</strong>.
Currently only ETS tables may be created. Since ETS tables
dies together with the parent process, a special process, registered
as <strong>tv_table_owner</strong>, will be the owner of tables created this way.
This process will not be affected by any termination of the TV,
i.e., the ETS tables created will live on until they are explicitly killed.

</p>
<center>
<img alt="tv_create_table" src="tv_create_table.gif"/><br/>
<em>The New Table Window, enabling easy creation of ETS tables.</em>

</center>

<p>Note: the <strong>tv_table_owner</strong> is local to each node, meaning
that the creation of a table on a new node also will start such a process
on that node. This way only the tables on a specific node dies, should that
specific node crash.
</p><a name="1.8"><!-- Empty --></a>
<h3>1.8 The TV Main Window Menus</h3>

<p>The Main Window offers the following menus:
</p>
<p>
</p><a name="1.8.1"><!-- Empty --></a>
<h4>1.8.1 The File Menu</h4>

<dl>

<dt>
<strong>Open Table</strong>
</dt>

<dd>

Open a selected table in a new Table Browser.<br />


</dd>

<dt>
<strong>New Table</strong>
</dt>

<dd>

Open the New Table window, enabling easy creation of ETS tables.<br />


</dd>

<dt>
<strong>Table Info</strong>
</dt>

<dd>

Opens the Table Information window, showing the available
information about a selected table. <br />


</dd>

<dt>
<strong>Nodes...</strong>
</dt>

<dd>

Open the Connected Nodes window, enabling the user to view
tables residing on remote nodes.<br />


</dd>

<dt>
<strong>Trace Process</strong>
</dt>

<dd>
Opens a trace window, where the process owning a selected table can
be traced.
</dd>

<dt>
<strong>Exit</strong>
</dt>

<dd>

Terminates the TV.<br />


</dd>

</dl>
<a name="1.8.2"><!-- Empty --></a>
<h4>1.8.2 The View Menu</h4>

<dl>

<dt>
<strong>ETS Tables</strong>
</dt>

<dd>

Shows ETS tables on the current node.<br />


</dd>

<dt>
<strong>Mnesia tables</strong>
</dt>

<dd>

Shows Mnesia tables on the current node.<br />


</dd>

</dl>
<a name="1.8.3"><!-- Empty --></a>
<h4>1.8.3 The Options Menu</h4>

<dl>

<dt>
<strong>Refresh</strong>
</dt>

<dd>

An explicit order to once again check the current node for existing
tables, and list them.<br />


</dd>

<dt>
<strong>Unreadable Tables</strong>
</dt>

<dd>

Option to choose whether or not unreadable tables shall be shown.<br />


</dd>

<dt>
<strong>System Tables</strong>
</dt>

<dd>

Option to choose whether or not system tables shall be shown.<br />


</dd>

<dt>
<strong>Sort by Name</strong>
</dt>

<dd>

Shows the tables sorted by their names.<br />


</dd>

<dt>
<strong>Sort by Id</strong>
</dt>

<dd>

Shows the tables sorted by their table identifiers.<br />


</dd>

<dt>
<strong>Sort by Owner PID</strong>
</dt>

<dd>

Shows the tables sorted by the process identifiers of the owning
processes.<br />


</dd>

<dt>
<strong>Sort by Owner Name</strong>
</dt>

<dd>

Shows the tables sorted by the registered names of the owning processes.<br />


</dd>

<dt>
<strong>Error Messages in Haiku</strong>
</dt>

<dd>

Option to choose whether or not error messages shall be shown
in the Japanes poetry style called <strong>Haiku</strong>.<br />


</dd>

</dl>
<a name="1.8.4"><!-- Empty --></a>
<h4>1.8.4 The Help Menu</h4>

<dl>

<dt>
<strong>Help</strong>
</dt>

<dd>

Shows the help (about TV usage) that is available.
(The help will be shown in the Netscape Internet browser, if available.)<br />


</dd>

<dt>
<strong>OTP Documentation</strong>
</dt>

<dd>

Shows the Documentation about all OTP components that is available
in the local installation of OTP.<br />


</dd>

</dl>
<center>
<hr/>
<small>tv 2.1.4.2<br/>
  Copyright &copy; 1991-2008
  <a href="http://www.ericsson.com/technology/opensource/erlang">Ericsson AB</a><br/>
</small>
</center></body>
</html>