Using the API

The Texis API is provided for users with special requirements. Most applications can be developed with Vortex scripts run with the texis program. The Texis API is in the directory /usr/local/morph3/api. The files to note are:

makefile:

Contains the rules for how to make Texis clients and loaders.

tstone.h:

The header for the network API.

netex3s.c:

A simple example of using the network API.

netex3.c:

A larger example of using the network API.

dbquery.h:

The header for the low level loader API.

loader.c:

An example of using the loader API. Builds and loads the sample patent database.

You should not work in the morph3/api directory. You should point your include and library paths there during compiling. The supplied makefile demonstrates how to do that.

Copy the makefile and example source files netex3s.c, netex3.c, and loader.c to a working directory. Then Build the examples by running:

   make netex3s
   make netex3
   make netex3f
   make loader

Use our makefile as a basis for building your own or watch the compile commands as they go by when building the examples and use them in your own makefile.

The network clients obviously depend on a running server daemon. See below.

netex3s:

with no arguments will execute the query ``select pdate,pcountry,pnumber,pabstract from patent where pabstract like ' magnetic  coil' '' against the sample database via the server daemon. You can supply your own ``where'' clause on the command line. See the source code for further options.

netex3:

with no arguments will execute the query ``select * from patent where pabstract like ' magnetic  coil' '' against the sample database via the server daemon. You can supply your own SQL statement on the command line. See the source code for further options.

netex3f:

is the same as netex3 (it even uses the same source file), but is compiled as a standalone client. It does not depend on the server daemon. See the source code and makefile to see what's different.

loader:

takes one argument as the filename of the file to get patents from. mmex2.dat in the api directory is what the sample database is built with. See the source code for further options.

See Part V, Chapters , , and  for full documentation.