This is ../info/lispref.info, produced by makeinfo version 4.0 from lispref/lispref.texi. INFO-DIR-SECTION XEmacs Editor START-INFO-DIR-ENTRY * Lispref: (lispref). XEmacs Lisp Reference Manual. END-INFO-DIR-ENTRY Edition History: GNU Emacs Lisp Reference Manual Second Edition (v2.01), May 1993 GNU Emacs Lisp Reference Manual Further Revised (v2.02), August 1993 Lucid Emacs Lisp Reference Manual (for 19.10) First Edition, March 1994 XEmacs Lisp Programmer's Manual (for 19.12) Second Edition, April 1995 GNU Emacs Lisp Reference Manual v2.4, June 1995 XEmacs Lisp Programmer's Manual (for 19.13) Third Edition, July 1995 XEmacs Lisp Reference Manual (for 19.14 and 20.0) v3.1, March 1996 XEmacs Lisp Reference Manual (for 19.15 and 20.1, 20.2, 20.3) v3.2, April, May, November 1997 XEmacs Lisp Reference Manual (for 21.0) v3.3, April 1998 Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995 Free Software Foundation, Inc. Copyright (C) 1994, 1995 Sun Microsystems, Inc. Copyright (C) 1995, 1996 Ben Wing. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be stated in a translation approved by the Foundation. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided also that the section entitled "GNU General Public License" is included exactly as in the original, and provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that the section entitled "GNU General Public License" may be included in a translation approved by the Free Software Foundation instead of in the original English.  File: lispref.info, Node: LDAP Variables, Next: The High-Level LDAP API, Prev: XEmacs LDAP API, Up: XEmacs LDAP API LDAP Variables -------------- - Variable: ldap-default-host The default LDAP server hostname. A TCP port number can be appended to that name using a colon as a separator. - Variable: ldap-default-port Default TCP port for LDAP connections. Initialized from the LDAP library. Default value is 389. - Variable: ldap-default-base Default base for LDAP searches. This is a string using the syntax of RFC 1779. For instance, "o=ACME, c=US" limits the search to the Acme organization in the United States. - Variable: ldap-host-parameters-alist An alist of per host options for LDAP transactions. The list elements look like `(HOST PROP1 VAL1 PROP2 VAL2 ...)' HOST is the name of an LDAP server. A TCP port number can be appended to that name using a colon as a separator. PROPN and VALN are property/value pairs describing parameters for the server. Valid properties: `binddn' The distinguished name of the user to bind as. This may look like `cn=Babs Jensen,o=ACME,c=US', see RFC 1779 for details. `passwd' The password to use for authentication. `auth' The authentication method to use, possible values depend on the LDAP library XEmacs was compiled with, they may include `simple', `krbv41' and `krbv42'. `base' The base for the search. This may look like `cÿ, o¬me', see RFC 1779 for syntax details. `scope' One of the symbols `base', `onelevel' or `subtree' indicating the scope of the search limited to a base object, to a single level or to the whole subtree. `deref' The dereference policy is one of the symbols `never', `always', `search' or `find' and defines how aliases are dereferenced. `never' Aliases are never dereferenced `always' Aliases are always dereferenced `search' Aliases are dereferenced when searching `find' Aliases are dereferenced when locating the base object for the search `timelimit' The timeout limit for the connection in seconds. `sizelimit' The maximum number of matches to return for searches performed on this connection. - Variable: ldap-verbose If non-`nil', LDAP operations will echo progress messages. Defaults to `nil'.  File: lispref.info, Node: The High-Level LDAP API, Next: The Low-Level LDAP API, Prev: LDAP Variables, Up: XEmacs LDAP API The High-Level LDAP API ----------------------- The following functions provide the most convenient interface to perform LDAP operations. All of them open a connection to a host, perform an operation (add/search/modify/delete) on one or several entries and cleanly close the connection thus insulating the user from all the details of the low-level interface such as LDAP Lisp objects *note The Low-Level LDAP API::. Note that `ldap-search' which used to be the name of the high-level search function in XEmacs 21.1 is now obsolete. For consistency in the naming as well as backward compatibility, that function now acts as a wrapper that calls either `ldap-search-basic' (low-level search function) or `ldap-search-entries' (high-level search function) according to the actual parameters. A direct call to one of these two functions is preferred since it is faster and unambiguous. - Function: ldap-search-entries filter &optional host attributes attrsonly withdn Perform an LDAP search. FILTER is the search filter *note Syntax of Search Filters:: HOST is the LDAP host on which to perform the search. ATTRIBUTES is the specific attributes to retrieve, `nil' means retrieve all. ATTRSONLY if non-`nil' retrieves the attributes only without their associated values. If WITHDN is non-`nil' each entry in the result will be prepended with its distinguished name DN. Additional search parameters can be specified through `ldap-host-parameters-alist'. The function returns a list of matching entries. Each entry is itself an alist of attribute/value pairs optionally preceded by the DN of the entry according to the value of WITHDN. - Function: ldap-add-entries entries &optional host binddn passwd Add entries to an LDAP directory. ENTRIES is a list of entry specifications of the form `(DN (ATTR . VALUE) (ATTR . VALUE) ...)' where DN the distinguished name of an entry to add, the following are cons cells containing attribute/value string pairs. HOST is the LDAP host, defaulting to `ldap-default-host' BINDDN is the DN to bind as to the server PASSWD is the corresponding password. - Function: ldap-modify-entries entry-mods &optional host binddn passwd Modify entries of an LDAP directory. ENTRY_MODS is a list of entry modifications of the form `(DN MOD-SPEC1 MOD-SPEC2 ...)' where DN is the distinguished name of the entry to modify, the following are modification specifications. A modification specification is itself a list of the form `(MOD-OP ATTR VALUE1 VALUE2 ...)' MOD-OP and ATTR are mandatory, VALUES are optional depending on MOD-OP. MOD-OP is the type of modification, one of the symbols `add', `delete' or `replace'. ATTR is the LDAP attribute type to modify. HOST is the LDAP host, defaulting to `ldap-default-host' BINDDN is the DN to bind as to the server PASSWD is the corresponding password" - Function: ldap-delete-entries dn &optional host binddn passwd Delete an entry from an LDAP directory. DN is the distinguished name of an entry to delete or a list of those. HOST is the LDAP host, defaulting to `ldap-default-host' BINDDN is the DN to bind as to the server PASSWD is the corresponding password.  File: lispref.info, Node: The Low-Level LDAP API, Next: LDAP Internationalization, Prev: The High-Level LDAP API, Up: XEmacs LDAP API The Low-Level LDAP API ---------------------- The low-level API should be used directly for very specific purposes (such as multiple operations on a connection) only. The higher-level functions provide a more convenient way to access LDAP directories hiding the subtleties of handling the connection, translating arguments and ensuring compliance with LDAP internationalization rules and formats (currently partly implemented only). See *note The High-Level LDAP API:: Note that the former functions `ldap-*-internal' functions have been renamed in XEmacs 21.2 * Menu: * The LDAP Lisp Object:: * Opening and Closing a LDAP Connection:: * Low-level Operations on a LDAP Server::  File: lispref.info, Node: The LDAP Lisp Object, Next: Opening and Closing a LDAP Connection, Prev: The Low-Level LDAP API, Up: The Low-Level LDAP API The LDAP Lisp Object .................... An internal built-in `ldap' lisp object represents a LDAP connection. - Function: ldapp object This function returns non-`nil' if OBJECT is a `ldap' object. - Function: ldap-host ldap Return the server host of the connection represented by LDAP - Function: ldap-live-p ldap Return non-`nil' if LDAP is an active LDAP connection  File: lispref.info, Node: Opening and Closing a LDAP Connection, Next: Low-level Operations on a LDAP Server, Prev: The LDAP Lisp Object, Up: The Low-Level LDAP API Opening and Closing a LDAP Connection ..................................... - Function: ldap-open host &optional plist Open a LDAP connection to HOST. PLIST is a property list containing additional parameters for the connection. Valid keys in that list are: `port' The TCP port to use for the connection if different from `ldap-default-port' or the library builtin value `auth' The authentication method to use, possible values depend on the LDAP library XEmacs was compiled with, they may include `simple', `krbv41' and `krbv42'. `binddn' The distinguished name of the user to bind as. This may look like `c=com, o=Acme, cn=Babs Jensen', see RFC 1779 for details. `passwd' The password to use for authentication. `deref' The dereference policy is one of the symbols `never', `always', `search' or `find' and defines how aliases are dereferenced. `never' Aliases are never dereferenced `always' Aliases are always dereferenced `search' Aliases are dereferenced when searching `find' Aliases are dereferenced when locating the base object for the search The default is `never'. `timelimit' The timeout limit for the connection in seconds. `sizelimit' The maximum number of matches to return for searches performed on this connection. - Function: ldap-close ldap Close the connection represented by LDAP  File: lispref.info, Node: Low-level Operations on a LDAP Server, Prev: Opening and Closing a LDAP Connection, Up: The Low-Level LDAP API Low-level Operations on a LDAP Server ..................................... `ldap-search-basic' is the low-level primitive to perform a search on a LDAP server. It works directly on an open LDAP connection thus requiring a preliminary call to `ldap-open'. Multiple searches can be made on the same connection, then the session must be closed with `ldap-close'. - Function: ldap-search-basic ldap filter base scope attrs attrsonly Perform a search on an open connection LDAP created with `ldap-open'. FILTER is a filter string for the search *note Syntax of Search Filters:: BASE is the distinguished name at which to start the search. SCOPE is one of the symbols `base', `onelevel' or `subtree' indicating the scope of the search limited to a base object, to a single level or to the whole subtree. The default is `subtree'. `attrs' is a list of strings indicating which attributes to retrieve for each matching entry. If `nil' all available attributes are returned. If `attrsonly' is non-`nil' then only the attributes are retrieved, not their associated values If `withdn' is non-`nil' then each entry in the result is prepended with its distinguished name DN If `verbose' is non-`nil' then progress messages are echoed The function returns a list of matching entries. Each entry is itself an alist of attribute/value pairs optionally preceded by the DN of the entry according to the value of `withdn'. - Function: ldap-add ldap dn entry Add ENTRY to a LDAP directory which a connection LDAP has been opened to with `ldap-open'. DN is the distinguished name of the entry to add. ENTRY is an entry specification, i.e., a list of cons cells containing attribute/value string pairs. - Function: ldap-modify ldap dn mods Modify an entry in an LDAP directory. LDAP is an LDAP connection object created with `ldap-open'. DN is the distinguished name of the entry to modify. MODS is a list of modifications to apply. A modification is a list of the form `(MOD-OP ATTR VALUE1 VALUE2 ...)' MOD-OP and ATTR are mandatory, VALUES are optional depending on MOD-OP. MOD-OP is the type of modification, one of the symbols `add', `delete' or `replace'. ATTR is the LDAP attribute type to modify - Function: ldap-delete ldap dn Delete an entry to an LDAP directory. LDAP is an LDAP connection object created with `ldap-open'. DN is the distinguished name of the entry to delete  File: lispref.info, Node: LDAP Internationalization, Prev: The Low-Level LDAP API, Up: XEmacs LDAP API LDAP Internationalization ------------------------- The XEmacs LDAP API provides basic internationalization features based on the LDAP v3 specification (essentially RFC2252 on "LDAP v3 Attribute Syntax Definitions"). Unfortunately since there is currently no free LDAP v3 server software, this part has not received much testing and should be considered experimental. The framework is in place though. - Function: ldap-decode-attribute attr Decode the attribute/value pair ATTR according to LDAP rules. The attribute name is looked up in `ldap-attribute-syntaxes-alist' and the corresponding decoder is then retrieved from `ldap-attribute-syntax-decoders'' and applied on the value(s). * Menu: * LDAP Internationalization Variables:: * Encoder/Decoder Functions::  File: lispref.info, Node: LDAP Internationalization Variables, Next: Encoder/Decoder Functions, Prev: LDAP Internationalization, Up: LDAP Internationalization LDAP Internationalization Variables ................................... - Variable: ldap-ignore-attribute-codings If non-`nil', no encoding/decoding will be performed LDAP attribute values - Variable: ldap-coding-system Coding system of LDAP string values. LDAP v3 specifies the coding system of strings to be UTF-8. You need an XEmacs with Mule support for this. - Variable: ldap-default-attribute-decoder Decoder function to use for attributes whose syntax is unknown. Such a function receives an encoded attribute value as a string and should return the decoded value as a string - Variable: ldap-attribute-syntax-encoders A vector of functions used to encode LDAP attribute values. The sequence of functions corresponds to the sequence of LDAP attribute syntax object identifiers of the form 1.3.6.1.4.1.1466.1115.121.1.* as defined in RFC2252 section 4.3.2. As of this writing, only a few encoder functions are available. - Variable: ldap-attribute-syntax-decoders A vector of functions used to decode LDAP attribute values. The sequence of functions corresponds to the sequence of LDAP attribute syntax object identifiers of the form 1.3.6.1.4.1.1466.1115.121.1.* as defined in RFC2252 section 4.3.2. As of this writing, only a few decoder functions are available. - Variable: ldap-attribute-syntaxes-alist A map of LDAP attribute names to their type object id minor number. This table is built from RFC2252 Section 5 and RFC2256 Section 5  File: lispref.info, Node: Encoder/Decoder Functions, Prev: LDAP Internationalization Variables, Up: LDAP Internationalization Encoder/Decoder Functions ......................... - Function: ldap-encode-boolean bool A function that encodes an elisp boolean BOOL into a LDAP boolean string representation - Function: ldap-decode-boolean str A function that decodes a LDAP boolean string representation STR into an elisp boolean - Function: ldap-decode-string str Decode a string STR according to `ldap-coding-system' - Function: ldap-encode-string str Encode a string STR according to `ldap-coding-system' - Function: ldap-decode-address str Decode an address STR according to `ldap-coding-system' and replacing $ signs with newlines as specified by LDAP encoding rules for addresses - Function: ldap-encode-address str Encode an address STR according to `ldap-coding-system' and replacing newlines with $ signs as specified by LDAP encoding rules for addresses  File: lispref.info, Node: Syntax of Search Filters, Prev: XEmacs LDAP API, Up: LDAP Support Syntax of Search Filters ======================== LDAP search functions use RFC1558 syntax to describe the search filter. In that syntax simple filters have the form: ( ) `' is an attribute name such as `cn' for Common Name, `o' for Organization, etc... `' is the corresponding value. This is generally an exact string but may also contain `*' characters as wildcards `filtertype' is one `=' `~=', `<=', `>=' which respectively describe equality, approximate equality, inferiority and superiority. Thus `(cn=John Smith)' matches all records having a canonical name equal to John Smith. A special case is the presence filter `(=*' which matches records containing a particular attribute. For instance `(mail=*)' matches all records containing a `mail' attribute. Simple filters can be connected together with the logical operators `&', `|' and `!' which stand for the usual and, or and not operators. `(&(objectClass=Person)(mail=*)(|(sn=Smith)(givenname=John)))' matches records of class `Person' containing a `mail' attribute and corresponding to people whose last name is `Smith' or whose first name is `John'.  File: lispref.info, Node: PostgreSQL Support, Next: Internationalization, Prev: LDAP Support, Up: Top PostgreSQL Support ****************** XEmacs can be linked with PostgreSQL libpq run-time support to provide relational database access from Emacs Lisp code. * Menu: * Building XEmacs with PostgreSQL support:: * XEmacs PostgreSQL libpq API:: * XEmacs PostgreSQL libpq Examples::  File: lispref.info, Node: Building XEmacs with PostgreSQL support, Next: XEmacs PostgreSQL libpq API, Up: PostgreSQL Support Building XEmacs with PostgreSQL support ======================================= XEmacs PostgreSQL support requires linking to the PostgreSQL libpq.so library. Describing how to build and install PostgreSQL is beyond the scope of this document, see the PostgreSQL manual for details. If you have installed XEmacs from one of the binary kits on (), or are using an XEmacs binary from a CD ROM, you should have XEmacs PostgreSQL support by default. If you are building XEmacs from source on a Linux system with PostgreSQL installed into the default location, it should be autodetected when you run configure. If you have installed PostgreSQL into its non-Linux default location, `/usr/local/pgsql', you must specify `--site-prefixes=/usr/local/pgsql' when you run configure. If you installed PostgreSQL into another location, use that instead of `/usr/local/pgsql' when specifying `--site-prefixes'. As of XEmacs 21.2, PostgreSQL versions 6.5.3 and 7.0 are supported. XEmacs Lisp support for V7.0 is somewhat more extensive than support for V6.5. In particular, asynchronous queries are supported.  File: lispref.info, Node: XEmacs PostgreSQL libpq API, Next: XEmacs PostgreSQL libpq Examples, Prev: Building XEmacs with PostgreSQL support, Up: PostgreSQL Support XEmacs PostgreSQL libpq API =========================== XEmacs PostgreSQL API is intended to be a policy-free, low-level binding to libpq. The intent is to provide all the basic functionality and then let high level Lisp code decide its own policies. This documentation assumes that the reader has knowledge of SQL, but requires no prior knowledge of libpq. There are many examples in this manual and some setup will be required. In order to run most of the following examples, the following code needs to be executed. In addition to the data is in this table, nearly all of the examples will assume that the free variable `P' refers to this database connection. The examples in the original edition of this manual were run against Postgres 7.0beta1. (progn (setq P (pq-connectdb "")) ;; id is the primary key, shikona is a Japanese word that ;; means `the professional name of a Sumo wrestler', and ;; rank is the Sumo rank name. (pq-exec P (concat "CREATE TABLE xemacs_test" " (id int, shikona text, rank text);")) (pq-exec P "COPY xemacs_test FROM stdin;") (pq-put-line P "1\tMusashimaru\tYokuzuna\n") (pq-put-line P "2\tDejima\tOozeki\n") (pq-put-line P "3\tMusoyama\tSekiwake\n") (pq-put-line P "4\tMiyabiyama\tSekiwake\n") (pq-put-line P "5\tWakanoyama\tMaegashira\n") (pq-put-line P "\\.\n") (pq-end-copy P)) => nil * Menu: * libpq Lisp Variables:: * libpq Lisp Symbols and DataTypes:: * Synchronous Interface Functions:: * Asynchronous Interface Functions:: * Large Object Support:: * Other libpq Functions:: * Unimplemented libpq Functions::  File: lispref.info, Node: libpq Lisp Variables, Next: libpq Lisp Symbols and DataTypes, Prev: XEmacs PostgreSQL libpq API, Up: XEmacs PostgreSQL libpq API libpq Lisp Variables -------------------- Various Unix environment variables are used by libpq to provide defaults to the many different parameters. In the XEmacs Lisp API, these environment variables are bound to Lisp variables to provide more convenient access to Lisp Code. These variables are passed to the backend database server during the establishment of a database connection and when the `pq-setenv' call is made. - Variable: pg:host Initialized from the PGHOST environment variable. The default host to connect to. - Variable: pg:user Initialized from the PGUSER environment variable. The default database user name. - Variable: pg:options Initialized from the PGOPTIONS environment variable. Default additional server options. - Variable: pg:port Initialized from the PGPORT environment variable. The default TCP port to connect to. - Variable: pg:tty Initialized from the PGTTY environment variable. The default debugging TTY. Compatibility note: Debugging TTYs are turned off in the XEmacs Lisp binding. - Variable: pg:database Initialized from the PGDATABASE environment variable. The default database to connect to. - Variable: pg:realm Initialized from the PGREALM environment variable. The default Kerberos realm. - Variable: pg:client-encoding Initialized from the PGCLIENTENCODING environment variable. The default client encoding. Compatibility note: This variable is not present in non-Mule XEmacsen. This variable is not present in versions of libpq prior to 7.0. In the current implementation, client encoding is equivalent to the `file-name-coding-system' format. - Variable: pg:authtype Initialized from the PGAUTHTYPE environment variable. The default authentication scheme used. Compatibility note: This variable is unused in versions of libpq after 6.5. It is not implemented at all in the XEmacs Lisp binding. - Variable: pg:geqo Initialized from the PGGEQO environment variable. Genetic optimizer options. - Variable: pg:cost-index Initialized from the PGCOSTINDEX environment variable. Cost index options. - Variable: pg:cost-heap Initialized from the PGCOSTHEAP environment variable. Cost heap options. - Variable: pg:tz Initialized from the PGTZ environment variable. Default timezone. - Variable: pg:date-style Initialized from the PGDATESTYLE environment variable. Default date style in returned date objects. - Variable: pg-coding-system This is a variable controlling which coding system is used to encode non-ASCII strings sent to the database. Compatibility Note: This variable is not present in InfoDock.  File: lispref.info, Node: libpq Lisp Symbols and DataTypes, Next: Synchronous Interface Functions, Prev: libpq Lisp Variables, Up: XEmacs PostgreSQL libpq API libpq Lisp Symbols and Datatypes -------------------------------- The following set of symbols are used to represent the intermediate states involved in the asynchronous interface. - Symbol: pgres::polling-failed Undocumented. A fatal error has occurred during processing of an asynchronous operation. - Symbol: pgres::polling-reading An intermediate status return during an asynchronous operation. It indicates that one may use `select' before polling again. - Symbol: pgres::polling-writing An intermediate status return during an asynchronous operation. It indicates that one may use `select' before polling again. - Symbol: pgres::polling-ok An asynchronous operation has successfully completed. - Symbol: pgres::polling-active An intermediate status return during an asynchronous operation. One can call the poll function again immediately. - Function: pq-pgconn conn field CONN A database connection object. FIELD A symbol indicating which field of PGconn to fetch. Possible values are shown in the following table. `pq::db' Database name `pq::user' Database user name `pq::pass' Database user's password `pq::host' Hostname database server is running on `pq::port' TCP port number used in the connection `pq::tty' Debugging TTY Compatibility note: Debugging TTYs are not used in the XEmacs Lisp API. `pq::options' Additional server options `pq::status' Connection status. Possible return values are shown in the following table. `pg::connection-ok' The normal, connected status. `pg::connection-bad' The connection is not open and the PGconn object needs to be deleted by `pq-finish'. `pg::connection-started' An asynchronous connection has been started, but is not yet complete. `pg::connection-made' An asynchronous connect has been made, and there is data waiting to be sent. `pg::connection-awaiting-response' Awaiting data from the backend during an asynchronous connection. `pg::connection-auth-ok' Received authentication, waiting for the backend to start up. `pg::connection-setenv' Negotiating environment during an asynchronous connection. `pq::error-message' The last error message that was delivered to this connection. `pq::backend-pid' The process ID of the backend database server. The `PGresult' object is used by libpq to encapsulate the results of queries. The printed representation takes on four forms. When the PGresult object contains tuples from an SQL `SELECT' it will look like: (setq R (pq-exec P "SELECT * FROM xemacs_test;")) => # The number in brackets indicates how many rows of data are available. When the PGresult object is the result of a command query that doesn't return anything, it will look like: (pq-exec P "CREATE TABLE a_new_table (i int);") => # When either the query is a command-type query that can affect a number of different rows, but doesn't return any of them it will look like: (progn (pq-exec P "INSERT INTO a_new_table VALUES (1);") (pq-exec P "INSERT INTO a_new_table VALUES (2);") (pq-exec P "INSERT INTO a_new_table VALUES (3);") (setq R (pq-exec P "DELETE FROM a_new_table;"))) => # Lastly, when the underlying PGresult object has been deallocated directly by `pq-clear' the printed representation will look like: (progn (setq R (pq-exec P "SELECT * FROM xemacs_test;")) (pq-clear R) R) => # The following set of functions are accessors to various data in the PGresult object. - Function: pq-result-status result Return status of a query result. RESULT is a PGresult object. The return value is one of the symbols in the following table. `pgres::empty-query' A query contained no text. This is usually the result of a recoverable error, or a minor programming error. `pgres::command-ok' A query command that doesn't return anything was executed properly by the backend. `pgres::tuples-ok' A query command that returns tuples was executed properly by the backend. `pgres::copy-out' Copy Out data transfer is in progress. `pgres::copy-in' Copy In data transfer is in progress. `pgres::bad-response' An unexpected response was received from the backend. `pgres::nonfatal-error' Undocumented. This value is returned when the libpq function `PQresultStatus' is called with a NULL pointer. `pgres::fatal-error' Undocumented. An error has occurred in processing the query and the operation was not completed. - Function: pq-res-status result Return the query result status as a string, not a symbol. RESULT is a PGresult object. (setq R (pq-exec P "SELECT * FROM xemacs_test;")) => # (pq-res-status R) => "PGRES_TUPLES_OK" - Function: pq-result-error-message result Return an error message generated by the query, if any. RESULT is a PGresult object. (setq R (pq-exec P "SELECT * FROM xemacs-test;")) => (pq-result-error-message R) => "ERROR: parser: parse error at or near \"-\" " - Function: pq-ntuples result Return the number of tuples in the query result. RESULT is a PGresult object. (setq R (pq-exec P "SELECT * FROM xemacs_test;")) => # (pq-ntuples R) => 5 - Function: pq-nfields result Return the number of fields in each tuple of the query result. RESULT is a PGresult object. (setq R (pq-exec P "SELECT * FROM xemacs_test;")) => # (pq-nfields R) => 3 - Function: pq-binary-tuples result Returns t if binary tuples are present in the results, nil otherwise. RESULT is a PGresult object. (setq R (pq-exec P "SELECT * FROM xemacs_test;")) => # (pq-binary-tuples R) => nil - Function: pq-fname result field-index Returns the name of a specific field. RESULT is a PGresult object. FIELD-INDEX is the number of the column to select from. The first column is number zero. (let (i l) (setq R (pq-exec P "SELECT * FROM xemacs_test;")) (setq i (pq-nfields R)) (while (>= (decf i) 0) (push (pq-fname R i) l)) l) => ("id" "shikona" "rank") - Function: pq-fnumber result field-name Return the field number corresponding to the given field name. -1 is returned on a bad field name. RESULT is a PGresult object. FIELD-NAME is a string representing the field name to find. (setq R (pq-exec P "SELECT * FROM xemacs_test;")) => # (pq-fnumber R "id") => 0 (pq-fnumber R "Not a field") => -1 - Function: pq-ftype result field-num Return an integer code representing the data type of the specified column. RESULT is a PGresult object. FIELD-NUM is the field number. The return value of this function is the Object ID (Oid) in the database of the type. Further queries need to be made to various system tables in order to convert this value into something useful. - Function: pq-fmod result field-num Return the type modifier code associated with a field. Field numbers start at zero. RESULT is a PGresult object. FIELD-INDEX selects which field to use. - Function: pq-fsize result field-index Return size of the given field. RESULT is a PGresult object. FIELD-INDEX selects which field to use. (let (i l) (setq R (pq-exec P "SELECT * FROM xemacs_test;")) (setq i (pq-nfields R)) (while (>= (decf i) 0) (push (list (pq-ftype R i) (pq-fsize R i)) l)) l) => ((23 23) (25 25) (25 25)) - Function: pq-get-value result tup-num field-num Retrieve a return value. RESULT is a PGresult object. TUP-NUM selects which tuple to fetch from. FIELD-NUM selects which field to fetch from. Both tuples and fields are numbered from zero. (setq R (pq-exec P "SELECT * FROM xemacs_test;")) => # (pq-get-value R 0 1) => "Musashimaru" (pq-get-value R 1 1) => "Dejima" (pq-get-value R 2 1) => "Musoyama" - Function: pq-get-length result tup-num field-num Return the length of a specific value. RESULT is a PGresult object. TUP-NUM selects which tuple to fetch from. FIELD-NUM selects which field to fetch from. (setq R (pq-exec P "SELECT * FROM xemacs_test;")) => # (pq-get-length R 0 1) => 11 (pq-get-length R 1 1) => 6 (pq-get-length R 2 1) => 8 - Function: pq-get-is-null result tup-num field-num Return t if the specific value is the SQL NULL. RESULT is a PGresult object. TUP-NUM selects which tuple to fetch from. FIELD-NUM selects which field to fetch from. - Function: pq-cmd-status result Return a summary string from the query. RESULT is a PGresult object. (pq-exec P "INSERT INTO xemacs_test VALUES (6, 'Wakanohana', 'Yokozuna');") => # (pq-cmd-status R) => "INSERT 542086 1" (setq R (pq-exec P "UPDATE xemacs_test SET rank='retired' WHERE shikona='Wakanohana';")) => # (pq-cmd-status R) => "UPDATE 1" Note that the first number returned from an insertion, like in the example, is an object ID number and will almost certainly vary from system to system since object ID numbers in Postgres must be unique across all databases. - Function: pq-cmd-tuples result Return the number of tuples if the last command was an INSERT/UPDATE/DELETE. If the last command was something else, the empty string is returned. RESULT is a PGresult object. (setq R (pq-exec P "INSERT INTO xemacs_test VALUES (7, 'Takanohana', 'Yokuzuna');")) => # (pq-cmd-tuples R) => "1" (setq R (pq-exec P "SELECT * from xemacs_test;")) => # (pq-cmd-tuples R) => "" (setq R (pq-exec P "DELETE FROM xemacs_test WHERE shikona LIKE '%hana';")) => # (pq-cmd-tuples R) => "2" - Function: pq-oid-value result Return the object id of the insertion if the last command was an INSERT. 0 is returned if the last command was not an insertion. RESULT is a PGresult object. In the first example, the numbers you will see on your local system will almost certainly be different, however the second number from the right in the unprintable PGresult object and the number returned by `pq-oid-value' should match. (setq R (pq-exec P "INSERT INTO xemacs_test VALUES (8, 'Terao', 'Maegashira');")) => # (pq-oid-value R) => 542089 (setq R (pq-exec P "SELECT shikona FROM xemacs_test WHERE rank='Maegashira';")) => # (pq-oid-value R) => 0 - Function: pq-make-empty-pgresult conn status Create an empty pgresult with the given status. CONN a database connection object STATUS a value that can be returned by `pq-result-status'. The caller is responsible for making sure the return value gets properly freed.  File: lispref.info, Node: Synchronous Interface Functions, Next: Asynchronous Interface Functions, Prev: libpq Lisp Symbols and DataTypes, Up: XEmacs PostgreSQL libpq API Synchronous Interface Functions ------------------------------- - Function: pq-connectdb conninfo Establish a (synchronous) database connection. CONNINFO A string of blank separated options. Options are of the form "OPTION = VALUE". If VALUE contains blanks, it must be single quoted. Blanks around the equal sign are optional. Multiple option assignments are blank separated. (pq-connectdb "dbname=japanese port = 25432") => # The printed representation of a database connection object has four fields. The first field is the hostname where the database server is running (in this case localhost), the second field is the port number, the third field is the database user name, and the fourth field is the name of the database. Database connection objects which have been disconnected and will generate an immediate error if they are used look like: # Bad connections can be reestablished with `pq-reset', or deleted entirely with `pq-finish'. A database connection object that has been deleted looks like: (let ((P1 (pq-connectdb ""))) (pq-finish P1) P1) => # Note that database connection objects are the most heavy weight objects in XEmacs Lisp at this writing, usually representing as much as several megabytes of virtual memory on the machine the database server is running on. It is wisest to explicitly delete them when you are finished with them, rather than letting garbage collection do it. An example idiom is: (let ((P (pq-connectiondb ""))) (unwind-protect (progn (...)) ; access database here (pq-finish P))) The following options are available in the options string: `authtype' Authentication type. Same as PGAUTHTYPE. This is no longer used. `user' Database user name. Same as PGUSER. `password' Database password. `dbname' Database name. Same as PGDATABASE `host' Symbolic hostname. Same as PGHOST. `hostaddr' Host address as four octets (eg. like 192.168.1.1). `port' TCP port to connect to. Same as PGPORT. `tty' Debugging TTY. Same as PGTTY. This value is suppressed in the XEmacs Lisp API. `options' Extra backend database options. Same as PGOPTIONS. A database connection object is returned regardless of whether a connection was established or not. - Function: pq-reset conn Reestablish database connection. CONN A database connection object. This function reestablishes a database connection using the original connection parameters. This is useful if something has happened to the TCP link and it has become broken. - Function: pq-exec conn query Make a synchronous database query. CONN A database connection object. QUERY A string containing an SQL query. A PGresult object is returned, which in turn may be queried by its many accessor functions to retrieve state out of it. If the query string contains multiple SQL commands, only results from the final command are returned. (setq R (pq-exec P "SELECT * FROM xemacs_test; DELETE FROM xemacs_test WHERE id=8;")) => # - Function: pq-notifies conn Return the latest async notification that has not yet been handled. CONN A database connection object. If there has been a notification, then a list of two elements will be returned. The first element contains the relation name being notified, the second element contains the backend process ID number. nil is returned if there aren't any notifications to process. - Function: PQsetenv conn Synchronous transfer of environment variables to a backend CONN A database connection object. Environment variable transfer is done as a normal part of database connection. Compatibility note: This function was present but not documented in versions of libpq prior to 7.0.  File: lispref.info, Node: Asynchronous Interface Functions, Next: Large Object Support, Prev: Synchronous Interface Functions, Up: XEmacs PostgreSQL libpq API Asynchronous Interface Functions -------------------------------- Making command by command examples is too complex with the asynchronous interface functions. See the examples section for complete calling sequences. - Function: pq-connect-start conninfo Begin establishing an asynchronous database connection. CONNINFO A string containing the connection options. See the documentation of `pq-connectdb' for a listing of all the available flags. - Function: pq-connect-poll conn An intermediate function to be called during an asynchronous database connection. CONN A database connection object. The result codes are documented in a previous section. - Function: pq-is-busy conn Returns t if `pq-get-result' would block waiting for input. CONN A database connection object. - Function: pq-consume-input conn Consume any available input from the backend. CONN A database connection object. Nil is returned if anything bad happens. - Function: pq-reset-start conn Reset connection to the backend asynchronously. CONN A database connection object. - Function: pq-reset-poll conn Poll an asynchronous reset for completion CONN A database connection object. - Function: pq-reset-cancel conn Attempt to request cancellation of the current operation. CONN A database connection object. The return value is t if the cancel request was successfully dispatched, nil if not (in which case conn->errorMessage is set). Note: successful dispatch is no guarantee that there will be any effect at the backend. The application must read the operation result as usual. - Function: pq-send-query conn query Submit a query to Postgres and don't wait for the result. CONN A database connection object. Returns: t if successfully submitted nil if error (conn->errorMessage is set) - Function: pq-get-result conn Retrieve an asynchronous result from a query. CONN A database connection object. NIL is returned when no more query work remains. - Function: pq-set-nonblocking conn arg Sets the PGconn's database connection non-blocking if the arg is TRUE or makes it non-blocking if the arg is FALSE, this will not protect you from PQexec(), you'll only be safe when using the non-blocking API. CONN A database connection object. - Function: pq-is-nonblocking conn Return the blocking status of the database connection CONN A database connection object. - Function: pq-flush conn Force the write buffer to be written (or at least try) CONN A database connection object. - Function: PQsetenvStart conn Start asynchronously passing environment variables to a backend. CONN A database connection object. Compatibility note: this function is only available with libpq-7.0. - Function: PQsetenvPoll conn Check an asynchronous enviroment variables transfer for completion. CONN A database connection object. Compatibility note: this function is only available with libpq-7.0. - Function: PQsetenvAbort conn Attempt to terminate an asynchronous environment variables transfer. CONN A database connection object. Compatibility note: this function is only available with libpq-7.0.  File: lispref.info, Node: Large Object Support, Next: Other libpq Functions, Prev: Asynchronous Interface Functions, Up: XEmacs PostgreSQL libpq API Large Object Support -------------------- - Function: pq-lo-import conn filename Import a file as a large object into the database. CONN a database connection object FILENAME filename to import On success, the object id is returned. - Function: pq-lo-export conn oid filename Copy a large object in the database into a file. CONN a database connection object. OID object id number of a large object. FILENAME filename to export to.  File: lispref.info, Node: Other libpq Functions, Next: Unimplemented libpq Functions, Prev: Large Object Support, Up: XEmacs PostgreSQL libpq API Other libpq Functions --------------------- - Function: pq-finish conn Destroy a database connection object by calling free on it. CONN a database connection object It is possible to not call this routine because the usual XEmacs garbage collection mechanism will call the underlying libpq routine whenever it is releasing stale `PGconn' objects. However, this routine is useful in `unwind-protect' clauses to make connections go away quickly when unrecoverable errors have occurred. After calling this routine, the printed representation of the XEmacs wrapper object will contain the string "DEAD". - Function: pq-client-encoding conn Return the client encoding as an integer code. CONN a database connection object (pq-client-encoding P) => 1 Compatibility note: This function did not exist prior to libpq-7.0 and does not exist in a non-Mule XEmacs. - Function: pq-set-client-encoding conn encoding Set client coding system. CONN a database connection object ENCODING a string representing the desired coding system (pq-set-client-encoding P "EUC_JP") => 0 The current idiom for ensuring proper coding system conversion is the following (illustrated for EUC Japanese encoding): (setq P (pq-connectdb "...")) (let ((file-name-coding-system 'euc-jp) (pg-coding-system 'euc-jp)) (pq-set-client-encoding "EUC_JP") ...) (pq-finish P) Compatibility note: This function did not exist prior to libpq-7.0 and does not exist in a non-Mule XEmacs. - Function: pq-env-2-encoding Return the integer code representing the coding system in PGCLIENTENCODING. (pq-env-2-encoding) => 0 Compatibility note: This function did not exist prior to libpq-7.0 and does not exist in a non-Mule XEmacs. - Function: pq-clear res Destroy a query result object by calling free() on it. RES a query result object Note: The memory allocation systems of libpq and XEmacs are different. The XEmacs representation of a query result object will have both the XEmacs version and the libpq version freed at the next garbage collection when the object is no longer being referenced. Calling this function does not release the XEmacs object, it is still subject to the usual rules for Lisp objects. The printed representation of the XEmacs object will contain the string "DEAD" after this routine is called indicating that it is no longer useful for anything. - Function: pq-conn-defaults Return a data structure that represents the connection defaults. The data is returned as a list of lists, where each sublist contains info regarding a single option.