Using browse
The browse command-line tool can be used to browse the documents table files (filename
.ddd
) in the /parts
directory of a collection. Field names and values are displayed.
A documents table is built for each partition in a collection. The documents table is used for field searching and for sorting search results. The fields within the documents table are defined by the following collection style files:
The value of each field can be filled in from source documents or can be provided explicitly. If a field is blank, it has not been populated.
browse can be found in the Verity bin directory. In a typical installation, the path is:
- /
verity
/prdname
/k2/_platform
/bin/browse
where verity/prdname
represents the user-definable portion of the Verity installation directory name, and _
platform
represents the platform name (like _nti40
for Windows NT v4.0).
Displaying Fields in a Documents Table File
You should be in the /parts
directory of a collection when you run the browse tool. This saves you the effort of having to type the full path to the documents table files (filename
.ddd
).
To display all the document fields in a documents table file, follow these steps.
- 1. Use the following command to start the browse tool and display the set of menu options:
- D:\VERITY\colltest\parts\>browse
filename
.ddd
- where
filename
is an incrementing number, such as 00000002
. The path provided above is for illustrative purposes. The paths to your collections will be different.
- The system displays the following menu of options available for the browse tool.
-
D:\VERITY\colltest\parts>browse 00000003.ddd
BROWSE OPTIONS
?) help
q) quit
c) Number of entries in field
_) Toggle viewing fields beginning with '_'
v) Toggle viewing selected fields
##) Display all fields in specified record number
Dispatch/Compound field options:
n) No dispatch
d) Dispatch
s) Dispatch as stream
Action (? for help):
- 2. Optionally, type the underscore character (_), and then press Enter to suppress the display of the internal fields.
-
D:\VERITY\colltest\parts>_
View non `_' fields
Action (? for help):
NOTE: At any time, you can type the underscore character (_) and press Enter to toggle between displaying all fields, only internal fields, or only non-internal fields. After you type the underscore character (_) and press Enter, the browse tool will display a status message regarding the types of fields that are to be displayed. Then you will see the Action prompt.
- 3. At the Action prompt, press Enter to display the fields for the first document record.
-
Action (? for help):
<Enter>
- The following partial display of the results of the browse command includes internal fields, used by the Verity search engine. An internal field name starts with an underscore (_) character.
-
Record number: 0
50 Created FIX-date ( 4) = 12-Jan-2001 01:52:27 pm
51 Modified FIX-date ( 4) = 24-Apr-2001 02:40:26 pm
52 Size FIX-unsg ( 4) = 5381
53 DOC_OF FIX-unsg ( 4) = 0
54 DOC_SZ FIX-unsg ( 4) = 4294967295
55 DOC_FN_OF FIX-unsg ( 4) = 436
Action (? for help):
- NOTE: Depending on the size of your command prompt, the list of fields may scroll past the visible portion of the command prompt. You may want to increase the size of the command prompt so that you can see more of the fields at one time. Or you may want to increase the display buffer size of the command prompt (on Windows), so that you can scroll back to view some of the fields.
- 4. At the Action prompt, press Enter again to display the fields for the next document record.
-
Action (? for help):
<Enter>
Record number: 1
50 Created FIX-date ( 4) = 12-Jan-2001 01:52:27 pm
51 Modified FIX-date ( 4) = 24-Apr-2001 02:40:26 pm
52 Size FIX-unsg ( 4) = 5381
53 DOC_OF FIX-unsg ( 4) = 0
54 DOC_SZ FIX-unsg ( 4) = 4294967295
55 DOC_FN_OF FIX-unsg ( 4) = 436
Action (? for help):
Copyright © 2002, Verity, Inc. All rights
reserved.