pgestraier/trunk/README.pod

1. pgestraier - search Hyper Estraier indexes from PostgreSQL

This package is essentially PostgreSQL C function which calls Hyper Estraier
API and returns results in user defined format.

2. Why is it written?

Aside from providing single API to query your RDBMS and full text index
(using any language that has PostgreSQL client libraries), real power is
hidden in ability to join results from full text index and structured data
in RDBMS.

3. How to install

Installation should be simple. However, you will have to have following
software already installed before you try this function:

 * PostgreSQL (tested with version 7.4.8) with development libraries
 * Hyper Estraier (tested with versions 0.3.9 and 0.3.10)

To run tests you will also need:

 * working perl installation
 * perl modules DBI, DBD::Pg, Test::More
 * trivia.list.gz from Internet Movie Database in data/ directory
 * database "test" with permissions for current user

If you have all that, you should be able to type

  make

and see sample results. You will be asked your password once (via sudo) to
install pgest.so shared library in system-wide location so that PostgreSQL
could access it.

To run tests (which require that you have estcmd in your $PATH) issue

  make test

See also included file test.sql for more examples of usage.

4. Who wrote this?

Hyper Estraier is written by Mikio Hirabayashi.

PostgreSQL is written by hackers calling themselves PostgreSQL Global
Development Group.

This small C function is written by Dobrica Pavlinusic, dpavlin@rot13.org.
1	1. pgestraier - search Hyper Estraier indexes from PostgreSQL
2
3	This package is essentially PostgreSQL C function which calls Hyper Estraier
4	API and returns results in user defined format.
5
6	2. Why is it written?
7
8	Aside from providing single API to query your RDBMS and full text index
9	(using any language that has PostgreSQL client libraries), real power is
10	hidden in ability to join results from full text index and structured data
11	in RDBMS.
12
13	3. How to install
14
15	Installation should be simple. However, you will have to have following
16	software already installed before you try this function:
17
18	* PostgreSQL (tested with version 7.4.8) with development libraries
19	* Hyper Estraier (tested with versions 0.3.9 and 0.3.10)
20
21	To run tests you will also need:
22
23	* working perl installation
24	* perl modules DBI, DBD::Pg, Test::More
25	* trivia.list.gz from Internet Movie Database in data/ directory
26	* database "test" with permissions for current user
27
28	If you have all that, you should be able to type
29
30	make
31
32	and see sample results. You will be asked your password once (via sudo) to
33	install pgest.so shared library in system-wide location so that PostgreSQL
34	could access it.
35
36	To run tests (which require that you have estcmd in your $PATH) issue
37
38	make test
39
40	See also included file test.sql for more examples of usage.
41
42	4. Who wrote this?
43
44	Hyper Estraier is written by Mikio Hirabayashi.
45
46	PostgreSQL is written by hackers calling themselves PostgreSQL Global
47	Development Group.
48
49	This small C function is written by Dobrica Pavlinusic, dpavlin@rot13.org.