From 39740d75bd7de8209032e92d6ef26fcfd92fe145 Mon Sep 17 00:00:00 2001 From: "Thomas G. Lockhart" Date: Sat, 4 Apr 1998 16:35:22 +0000 Subject: [PATCH] Clean up formatting. Add more URL links for GiST information. --- doc/src/sgml/gist.sgml | 11 +++ doc/src/sgml/libpq.sgml | 162 ++++++++++++++++++++++++++++++++++------ 2 files changed, 152 insertions(+), 21 deletions(-) diff --git a/doc/src/sgml/gist.sgml b/doc/src/sgml/gist.sgml index 84310a85f3..63feea7ee2 100644 --- a/doc/src/sgml/gist.sgml +++ b/doc/src/sgml/gist.sgml @@ -10,6 +10,17 @@ GiST Indices + +The information about GIST is at + http://GiST.CS.Berkeley.EDU:8000/gist/ + +with more on different indexing and sorting schemes at +http://s2k-ftp.CS.Berkeley.EDU:8000/personal/jmh/ + +And there is more interesting reading at the Berkely database site at +http://epoch.cs.berkeley.edu:8000/. + + Author diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index a01c472660..127f24517d 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -13,9 +13,9 @@ following directories: -../src/test/regress - ../src/test/examples - ../src/bin/psql + ../src/test/regress + ../src/test/examples + ../src/bin/psql @@ -82,19 +82,21 @@ -PQsetdb +PQsetdbLogin Makes a new connection to a backend. -PGconn *PQsetdb(char *pghost, - char *pgport, - char *pgoptions, - char *pgtty, - char *dbName); +PGconn *PQsetdbLogin(const char *pghost, + const char *pgport, + const char *pgoptions, + const char *pgtty, + const char *dbName, + const char *login, + const char *pwd); If any argument is NULL, then the corresponding environment variable is checked. If the environment variable is also not set, then hardwired defaults are used. - PQsetdb always returns a valid PGconn pointer. + PQsetdbLogin always returns a valid PGconn pointer. The PQstatus (see below) command should be called to ensure that a connection was properly made before queries are sent via the connection. libpq @@ -107,6 +109,51 @@ PGconn *PQsetdb(char *pghost, + + +PQsetdb + Makes a new connection to a backend. + +PGconn *PQsetdb(char *pghost, + char *pgport, + char *pgoptions, + char *pgtty, + char *dbName); + + This is a macro that calls PQsetdbLogin() with null pointers + for the login and pwd parameters. + + + + + +PQconndefaults + Returns the database name of the connection. + +PQconninfoOption *PQconndefaults(void) + +struct PQconninfoOption + { + char *keyword; /* The keyword of the option */ + char *environ; /* Fallback environment variable name */ + char *compiled; /* Fallback compiled in default value */ + char *val; /* Options value */ + char *label; /* Label for field in connect dialog */ + char *dispchar; /* Character to display for this field + in a connect dialog. Values are: + "" Display entered value as is + "*" Password field - hide value + "D" Debug options - don't + create a field by default */ + int dispsize; /* Field size in characters for dialog */ + }; + + + Returns the address of the connection options structure. This may + be used to determine all possible options and their current values. + + + PQdb @@ -345,7 +392,7 @@ Oid PQftype(PGresult *res, field. Field indices start at 0. int2 PQfsize(PGresult *res, - int field_index); + int field_index); @@ -374,6 +421,20 @@ char* PQgetvalue(PGresult *res, + + +PQgetisnull + Tests a field for a NULL entry. + +int PQgetisnull(PGresult *res, + int tup_num, + int field_num); + + This function returns 1 if the field contains a NULL, 0 if + it contains a known value.. + + + PQgetlength @@ -384,8 +445,8 @@ char* PQgetvalue(PGresult *res, less. int PQgetlength(PGresult *res, - int tup_num, - int field_num); + int tup_num, + int field_num); @@ -401,6 +462,19 @@ char *PQcmdStatus(PGresult *res); + + +PQcmdTuples + Returns the number of rows affected by the last command. + +const char *PQcmdTuples(PGresult *res); + + If the last command was INSERT, UPDATE or DELETE, this returns + a string containing the number of rows affected. If the last + command was anything else, it returns the empty string. + + + PQoidStatus @@ -413,6 +487,35 @@ char* PQoidStatus(PGresult *res); + + +PQprint + Prints out all the tuples and, optionally, the + attribute names to the specified output stream. + +void PQprint(FILE* fout, /* output stream */ + PGresult* res, + PQprintOpt* po); + +struct _PQprintOpt + { + pqbool header; /* print output field headings and row count */ + pqbool align; /* fill align the fields */ + pqbool standard; /* old brain dead format */ + pqbool html3; /* output html tables */ + pqbool expanded; /* expand tables */ + pqbool pager; /* use pager for output if needed */ + char *fieldSep; /* field separator */ + char *tableOpt; /* insert to HTML <table ...> */ + char *caption; /* HTML <caption> */ + char **fieldName; /* null terminated array of replacement field names */ + }; + + This funtion is intended to replace PQprintTuples(), which is + now obsolete. + + + PQprintTuples @@ -420,16 +523,33 @@ char* PQoidStatus(PGresult *res); attribute names to the specified output stream. The programs psql and monitor both use PQprintTuples for output. -void PQprintTuples( - PGresult* res, - FILE* fout, /* output stream */ - int printAttName,/* print attribute names or not*/ - int terseOutput, /* delimiter bars or not?*/ - int width /* width of column, variable width if 0*/ - ); +void PQprintTuples(PGresult* res, + FILE* fout, /* output stream */ + int printAttName,/* print attribute names or not*/ + int terseOutput, /* delimiter bars or not?*/ + int width); /* width of column, variable width if 0*/ + + + +PQdisplayTuples + Prints out all the tuples and, optionally, the + attribute names to the specified output stream. + +void PQdisplayTuples( + PGresult* res, + FILE* fout, /* output stream */ + int fillAlign, /* space fill to align columns */ + const char *fieldSep, /* field separator */ + int printHeader, /* display headers? */ + int quiet); /* suppress print of row count at end */ + + PQdisplayTuples() was intended to supersede PQprintTuples(), and + is in turn superseded by PQprint(). + + PQclear @@ -479,7 +599,7 @@ typedef struct { int isint; union { int *ptr; - int integer; + int integer; } u; } PQArgBlock;