Debian Codegraph @

README

raw
1
2 -------------------------
3 DBIx::FullTextSearch
4 -------------------------
5
6 This is the README file for the DBIx::FullTextSearch module. Please read it
7 fully, especially if you install or use the module for the first time and
8 have some troubles with it. I probably won't be polite if you email me and I
9 will realize that you did not read what I've written to help you to use
10 the thing. That includes both the questions that are covered here and
11 in the DBIx::FullTextSearch documentation, and the form of the email.
12
13 DBIx::FullTextSearch is a Perl module that provides ways to index various text
14 documents (Perl scalars, files, web pages, database fields) using the
15 MySQL database in such a way, that queries like "what documents contain
16 words penguin and yellow but not red" (written +penguin +yellow -red)
17 can be processed. You can also index phrases, so that query
18 "little penguin" returns list of documents where these two words appear
19 in this sequence. A work on support of more complex queries, like
20 "little penguin near swim% not penguin flies" is under way -- you are
21 welcome to send patches for this feature.
22
23 Perl interface is available that includes create method for creating
24 new index, index_document to add (or update) info about document in
25 the index and methods contains and econtains to fetch list of documents
26 (document names, like filenames or URLs) that contain specified set of
27 words or phrase.
28
29 Main goals were:
30 use of MySQL, since database provides remote access and
31 access control and is generally nice; the mixture of
32 database indexes for speed with blobs for compact
33 storage seem very effective;
34 many flexible ways of storing the data -- you can have index
35 that is small but slow for upgrades, or bigger index
36 that is usefull for documents that change often, or
37 index for phrases; read the man page to understand the
38 concept of frontend and backend;
39 documents may be indexed (named) either by integers or by string
40 names -- conversion to internal numeric form (where
41 needed) is done by the module;
42 extendable design that provides easy ways of adding new storage
43 backends or application frontends; this makes this
44 modules suitable for tests and benchmarks of various
45 ideas;
46 perlish ways of specifying things -- you can provide your own
47 Perl code to specify how document is divided into words
48 and how words are treated; using stemming algorithms
49 and the like is easy -- just specify you Perl code
50 that will be called to do the job;
51 usefull for indexing mailinglist archives or small to medium web
52 page collections, or generally documents;
53 command line utility to maintain the indexes -- you do not need
54 to write Perl code to do tests or simple things.
55
56 Installation:
57 Download the tar.gz, unpack it, change to the DBIx::FullTextSearch-*
58 directory. Then do
59
60 perl Makefile.PL
61 make
62 make test
63 make install
64
65 You will be asked about way to connect to your MySQL server and
66 this information will be used to run the tests. If the MySQL
67 server is not available or you enter incorrect data, the tests
68 will be skipped.
69
70 You need perl at least 5.004, DBI at least 1.0, sufficiently
71 recent MySQL server (like 3.23+) and DBD::mysql sufficiently
72 recent. I myself use 5.005_03 and 5.6.0, 1.14, 3.23.31 and
73 2.0407. The module will probably run on older versions as
74 well, but if you experience problems and you are not sure,
75 upgrade first. Also, make sure you use the latest available
76 version of this (DBIx::FullTextSearch) module.
77
78 This is pure-Perl module -- you do not need to compile anything.
79 However I assume you know how modules and their installation
80 work with Perl. If not, please read the documentation that comes
81 with Perl and any platform specific notes -- I won't be very
82 helpful unless we make a deal about support contract.
83
84 Problems and bug reports:
85 If anything goes wrong during make test, make sure you have the
86 most recent versions of the software (this and other) first.
87 If that is the case please send me the output of
88
89 make
90 make test TEST_VERBOSE=1
91
92 together with any info that may be relevant. That includes
93 version of perl (perl -V), version of MySQL server and of this
94 any other modules. Please mention the words DBIx::FullTextSearch somewhere
95 in the Subject of your email so that I know what it's about.
96 Subjects containing stupid words like Help, all-uppercase and
97 use of exclamation points is considered rude, so avoid them.
98 Thank you.
99
100 Before you use the module, read the man page DBIx::FullTextSearch. If
101 reporting problems on your own data (after the installation went
102 fine), please describe the situation as clearly as possible.
103 More info is better than less.
104
105 Success reports and ideas:
106 I'll appreciate and ideas and comments you might have about the
107 module.
108
109 Available:
110 http://www.cpan.org/
111
112 Copyright: (c) 2000,2001 Thomas J. Mather, [email protected],
113 (c) 1999 Jan Pazdziora, [email protected].
114 All rights
115 reserved. This package is free software; you can redistribute
116 it and/or modify it under the same terms as Perl itself. It is
117 provided as is, without any warranty of it's purpose or
118 usefullness (you can't sue me if the module breaks your toaster
119 or annoys your fish either).