XPATFFI
Section: User Commands (1)
Updated: November 2000
Index
Return to Main Contents
NAME
xpatffi - XPAT Fast-Find Index builder
SYNOPSIS
xpatffi
[
-v
]
[
-b block_size
]
[
-I index_name
]
[
-m memory
k|m ]
[
-o output_name
]
[
-t temp
]
-D
data_dictionary
DESCRIPTION
xpatffi builds an Fast-Find Index for a Main Index of the database specified
by data_dictionary. The Fast-Find Index, combined with the Fast-Find Word List,
greatly increases the speed of text searching
in xpat. The Fast-Find Index is about 1/4 to 1/3 the size
of the Main Index. During index building, additional temporary file
space equal to about 1 1/4 the size of the Main Index is required.
OPTIONS
The following options are available:
- -v
-
Specify verbose mode. If this option is specified, xpatffi prints progress
messages as it builds the Fast-Find Index. By default, xpatffi works
quietly, only printing a message if it encounters an error condition.
- -b block_size
-
Specify compression block size (in bytes).
The Fast-Find Index is compressed as it is built, and is uncompressed
in blocks as it is used. If the index is to be used on a machine with very
little memory, it may be desirable to make the uncompressed blocks
as small as possible (this is usually only needed in extreme cases).
By default, xpatffi uses 8192 byte blocks.
- -I index_name
-
Specify the index name over which to build the Fast-Find Index. The default
is the first index in the data_dictionary.
- -m Nk
-
- -m Nm
-
memory size - use N kilobytes or N megabytes
of physical memory for building the Fast-Find Index.
A larger memory allocation results in faster indexing. Note that
the amount of memory specified is
limited by the amount of available system memory. Also note
that the memory parameter is usually the same as that specified
to xpatbld. Refer to the xpatbld(1) man page for further details.
- -o output_name
-
Specify the file name prefix for the Fast-Find Index files. xpatffi produces two
files, with the suffixes `.ffc' and `.ffi'. By default
xpatffi takes the prefixes for those two files from the
`FastFind' section in the data_dictionary, or uses the prefix of the data_dictionary file itself
if that file does not already contain any Fast-Find specifications.
- -t temp
-
Specify the full path prefix for temporary files. The default is
to put these in the local directory using a file prefix of "ll".
RESTRICTIONS
The Main Index must already have been built using xpatbld.
EXAMPLE
xpatffi -v -m 8m -o /text/fastfind -t /tmp/svec -I first -D text.dd
SEE ALSO
Database Administration Guide
xpat(1), xpatffw(1), xpatbld(1)
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- OPTIONS
-
- RESTRICTIONS
-
- EXAMPLE
-
- SEE ALSO
-
This document was created by
man2html,
using the manual pages.
Time: 18:03:38 GMT, March 26, 2001