Funciones PostgreSQL

CXVII. Funciones PostgreSQL

Introducci贸n

La base de datos PostgreSQL es un producto Open Source y disponible sin costo. Postgres, desarrollado originalmente en el Deportamento de Ciencias de Computaci贸n de UC Berkeley, fue pionero en muchos de los conceptos de objetos y relacionales que ahora est谩n apareciendo en algunas bases de datos comerciales. Provee soporte para lenguajes SQL92/SQL99, transacciones, integridad referencial, procedimientos almacenados y extensibilidad de tipos. PostgreSQL es un descendiente de c贸digo abierto de su c贸digo original de Berkeley.

Requisitos

Para hacer uso del soporte PostgreSQL, necesita PostgreSQL 6.5 o posterior, PostgreSQL 8.0 o posterior para habilitar todas las caracter铆sticas del m贸dulo. PostgreSQL soporta varias codificaciones de caracteres, incluyendo codificaci贸n de caracteres multibyte. Su versi贸n actual, asi como m谩s informaci贸n sobre PostgreSQL se encuentra disponible en http://www.postgresql.org/ y la Documentaci贸n de PostgreSQL.

Instalaci贸n

Para habilitar el soporte de PostgreSQL, se requiere la opci贸n --with-pgsql[=DIR] cuando se compila PHP. DIR es el directorio de instalaci贸n base de PostgreSQL, su valor predeterminado es /usr/local/pgsql. Si se encuentra disponible un objeto m贸dulo compartido, el m贸dulo PostgreSQL puede ser cargado usando la directiva extension en php.ini o con la funci贸n dl().

Configuraci贸n en tiempo de ejecuci贸n

El comportamiento de estas funciones est谩 afectado por los valores definidos en php.ini.

Tabla 1. Opciones de configuraci贸n de PostgreSQL

NombrePredeterminadoModificableCambios
pgsql.allow_persistent"1"PHP_INI_SYSTEM 
pgsql.max_persistent"-1"PHP_INI_SYSTEM 
pgsql.max_links"-1"PHP_INI_SYSTEM 
pgsql.auto_reset_persistent"0"PHP_INI_SYSTEMDisponible desde PHP 4.2.0.
pgsql.ignore_notice"0"PHP_INI_ALLDisponible desde PHP 4.3.0.
pgsql.log_notice"0"PHP_INI_ALLDisponible desde PHP 4.3.0.
For further details and definitions of the PHP_INI_* constants, see the Ap茅ndice G.

A continuaci贸n se presenta una corta explicaci贸n de las directivas de configuraci贸n.

pgsql.allow_persistent boolean

Indica si se permiten conexiones Postgres persistentes.

pgsql.max_persistent integer

El m谩ximo n煤mero de conexiones Postgres persistentes por proceso.

pgsql.max_links integer

El m谩ximo n煤mero de conexiones Postgres por proceso, incluyendo conexiones persistentes.

pgsql.auto_reset_persistent integer

Detectar enlaces persistentes rotos con pg_pconnect(). Necesita un poco de carga extra.

pgsql.ignore_notice integer

Indica si se ignoran o no las noticias desde PostgreSQL.

pgsql.log_notice integer

Indica si se registran o no las noticias desde PostgreSQL. La directiva de PHP pgsql.ignore_notice debe estar deshabilitada para registrar mensajes tipo noticia.

Tipos de recursos

Existen dos tipos de recurso usados en el m贸dulo PostgreSQL. El primero es el identificador de enlace para una conexi贸n de base de datos, el segundo es un recurso que contiene el resultado de una consulta.

Constantes predefinidas

Estas constantes est谩n definidas por esta extensi贸n y estar谩n disponibles solamente cuando la extensi贸n ha sido o bien compilada dentro de PHP o grabada din谩micamente en tiempo de ejecuci贸n.

PGSQL_ASSOC (integer)

Pasada a pg_fetch_array(). Devolver una matriz asociativa de nombres y valores de campo.

PGSQL_NUM (integer)

Pasada a pg_fetch_array(). Devolver una matriz indexada num茅ricamente con nombres y valores de campo.

PGSQL_BOTH (integer)

Pasada a pg_fetch_array(). Devolver una matriz de valores de campo que sea indexada num茅ricamente (por n煤mero de campo) y asociativamente (por nombre de campo).

PGSQL_CONNECT_FORCE_NEW (integer)

Pasada a pg_connect() para forzar la creaci贸n de una nueva conexi贸n, en lugar de re-usar una conexi贸n existente id茅ntica.

PGSQL_CONNECTION_BAD (integer)

Devuelta por pg_connection_status() indicando que la conexi贸n de base de datos est谩 en un estado inv谩lido.

PGSQL_CONNECTION_OK (integer)

Devuelta por pg_connection_status() indicando que la conexi贸n de base de datos est谩 en un estado v谩lido.

PGSQL_SEEK_SET (integer)

Pasada a pg_lo_seek(). La operaci贸n de b煤squeda ha de comenzar desde el inicio del objeto.

PGSQL_SEEK_CUR (integer)

Pasada a pg_lo_seek(). La operaci贸n de b煤squeda ha de comenzar desde la posici贸n actual.

PGSQL_SEEK_END (integer)

Pasada a pg_lo_seek(). La operaci贸n de b煤squeda ha de comenzar desde el final del objeto.

PGSQL_EMPTY_QUERY (integer)

Devuelta por pg_result_status(). La cadena enviada al servidor era vac铆a.

PGSQL_COMMAND_OK (integer)

Devuelta por pg_result_status(). Culminaci贸n exitosa de un comando que no devuelve datos.

PGSQL_TUPLES_OK (integer)

Devuelta por pg_result_status(). Culminaci贸n exitosa de un comando que devuelve datos (como SELECT o SHOW).

PGSQL_COPY_OUT (integer)

Devuelta por pg_result_status(). Transferencia de datos de copia hacia afuera (desde el servidor) ha iniciado.

PGSQL_COPY_IN (integer)

Devuelta por pg_result_status(). Transferencia de datos de copia hacia adentro (al servidor) ha iniciado.

PGSQL_BAD_RESPONSE (integer)

Devuelta por pg_result_status(). La respuesta del servidor no fue entendida.

PGSQL_NONFATAL_ERROR (integer)

Devuelta por pg_result_status(). Ocurri贸 un error no-fatal (una noticia o una advertencia).

PGSQL_FATAL_ERROR (integer)

Devuelta por pg_result_status(). Ocurri贸 un error fatal.

PGSQL_TRANSACTION_IDLE (integer)

Devuelta por pg_transaction_status(). La conexi贸n est谩 en espera actualmente, no en una transacci贸n.

PGSQL_TRANSACTION_ACTIVE (integer)

Devuelta por pg_transaction_status(). Un comando est谩 en progreso en la conexi贸n. Una consulta ha sido enviada a trav茅s de la conexi贸n y no se ha completado aun.

PGSQL_TRANSACTION_INTRANS (integer)

Devuelta por pg_transaction_status(). La conexi贸n se encuentra en espera, en un bloque de transacci贸n.

PGSQL_TRANSACTION_INERROR (integer)

Devuelta por pg_transaction_status(). La conexi贸n est谩 en espera, en un bloque fallido de transacci贸n.

PGSQL_TRANSACTION_UNKNOWN (integer)

Devuelta por pg_transaction_status(). La conexi贸n est谩 mal.

PGSQL_DIAG_SEVERITY (integer)

Pasada a pg_result_error_field(). La severidad; los contenidos del campo son ERROR, FATAL, o PANIC (en un mensaje de error), o WARNING, NOTICE, DEBUG, INFO, o LOG (en un mensaje de noticia), o una traducci贸n localizada de uno de 茅stos. Siempre presente.

PGSQL_DIAG_SQLSTATE (integer)

Pasada a pg_result_error_field(). El c贸digo SQLSTATE del error. El c贸digo SQLSTATE identifica el tipo de error que ha ocurrido; puede usarse por aplicaciones cliente para realizar operaciones espec铆ficas (tales como manejo de errores) en respuesta a un error de base de datos particular. Este campo no es localizable, y est谩 siempre presente.

PGSQL_DIAG_MESSAGE_PRIMARY (integer)

Pasada a pg_result_error_field(). El mensaje de error principalmente legible para humanos (t铆picamente una l铆nea). Siempre presente.

PGSQL_DIAG_MESSAGE_DETAIL (integer)

Pasada a pg_result_error_field(). Detalle: un mensaje de error opcional secundario que lleva m谩s detalles sobre el problema. Puede extenderse a m煤ltiples l铆neas.

PGSQL_DIAG_MESSAGE_HINT (integer)

Pasada a pg_result_error_field(). Pista: una sugerencia adicional sobre qu茅 hacer acerca del problema. Se espera que este valor difiera del detalle en tanto que ofrece consejos (potencialmente inapropriados) en lugar de meros hechos. Puede extenderse por m煤ltiples l铆neas.

PGSQL_DIAG_STATEMENT_POSITION (integer)

Pasada a pg_result_error_field(). Una cadena que contiene un entero decimal indicando la posici贸n de un cursor de error como un 铆ndice en la cadena de sentencia original. El primer caracter tiene el 铆ndice 1, y las posiciones son medidas en caracteres, no bytes.

PGSQL_DIAG_INTERNAL_POSITION (integer)

Pasada a pg_result_error_field(). Este valor es definido igual que el campo PG_DIAG_STATEMENT_POSITION, pero es usado cuando la posici贸n del cursor se refiere a un comando generado internamente en lugar de uno enviado por el cliente. El campo PG_DIAG_INTERNAL_QUERY siempre aparecer谩 cuando este campo aparece.

PGSQL_DIAG_INTERNAL_QUERY (integer)

Pasada a pg_result_error_field(). El texto de un comando fallido generado internamente. 脡ste puede ser, por ejemplo, una consulta SQL remitida por una funci贸n PL/pgSQL.

PGSQL_DIAG_CONTEXT (integer)

Pasada a pg_result_error_field(). Una indicaci贸n del contexto en el que ocurri贸 el error. Actualmente esto incluye una pila de llamadas hacia atr谩s de funciones de lenguaje procedimental activas y consulta generadas internamente. El rastreo es una entrada por l铆nea, la m谩s reciente primero.

PGSQL_DIAG_SOURCE_FILE (integer)

Pasada a pg_result_error_field(). El nombre de archivo del c贸digo fuente de PostgreSQL en donde el error fue reportado.

PGSQL_DIAG_SOURCE_LINE (integer)

Pasada a pg_result_error_field(). El n煤mero de l铆nea del c贸digo fuente de PostgreSQL en donde se report贸 el error.

PGSQL_DIAG_SOURCE_FUNCTION (integer)

Pasada a pg_result_error_field(). El nombre de la funci贸n en el c贸digo fuente de PostgreSQL en donde se report贸 el error.

PGSQL_ERRORS_TERSE (integer)

Pasada a pg_set_error_verbosity(). Especifica que los mensajes retornados incluyen severidad, texto primario, y posici贸n solamente; esto por lo general cabe en una l铆nea sencilla.

PGSQL_ERRORS_DEFAULT (integer)

Pasada a pg_set_error_verbosity(). El modo predeterminado produce mensajes que incluyen lo anterior m谩s cualquier detalle, pista, o campos de contexto (茅stos pueden ocupar m煤ltiples l铆neas).

PGSQL_ERRORS_VERBOSE (integer)

Pasada a pg_set_error_verbosity(). Este modo incluye todos los campos disponibles.

PGSQL_STATUS_LONG (integer)

Pasada a pg_result_status(). Indica que se desea un c贸digo de resultado num茅rico.

PGSQL_STATUS_STRING (integer)

Pasada a pg_result_status(). Indica que se desea una etiqueta de comando textual como resultado.

PGSQL_CONV_IGNORE_DEFAULT (integer)

Pasada a pg_convert(). Ignorar valores predeterminados en la tabla durante la conversi贸n.

PGSQL_CONV_FORCE_NULL (integer)

Pasada a pg_convert(). Usar el valor SQL NULL en lugar de un valor string vac铆o.

PGSQL_CONV_IGNORE_DEFAULT (integer)

Pasada a pg_convert(). Ignorar la conversi贸n de NULL en columnas SQL NOT NULL.

Notes

Nota: No todas las funciones est谩n soportadas por todas las versiones compiladas de PHP. Depende de la versi贸n de libpq (la biblioteca cliente en C de PostgreSQL) y la forma en que 茅sta haya sido compilada. Si hacen falta extensiones de PostreSQL en PHP, ha de ser porque su versi贸n de libpq no las soporta.

Nota: La mayor铆a de funciones de PostgreSQL aceptan conexion como el primer par谩metro opcional. Si 茅ste no es definido, es usada la 煤ltima conexi贸n abierta. Si no existe, las funciones devuelven FALSE.

Nota: PostgreSQL convierte autom谩ticamente todos los identificadores (p.ej. nombres de tablas/columnas) a valores en min煤sculas al momento de crear objetos y al momento de hacer consultas. Para forzar el uso de identificadores en may煤sculas o estilo mixto, es necesario escapar el identificador usando comillas dobles ("").

Nota: PostgreSQL no cuenta con comandos especiales para recuperar informaci贸n de esquemas de bases de datos (p.ej. todas las tablas en la base de datos actual). En su lugar, existe un esquema est谩ndar llamado information_schema en PostgreSQL 7.4 y versiones posteriores, que contiene vistas de sistema con toda la informaci贸n necesaria, en un formato de f谩cil consulta. Vea la Documentaci贸n de PostgreSQL para m谩s detalles.

Ejemplos

Este sencillo ejemplo muestra c贸mo conectarse, ejecutar una consulta, imprimer las filas de resultado y desconectarse de una base de datos PostgreSQL.

Ejemplo 1. Ejemplo de vista general de la extensi贸n PostgreSQL

<?php
// Conexion, seleccion de base de datos
$conexion_bd = pg_connect("host=localhost dbname=publicaciones user=www password=foo")
    or die(
'No pudo conectarse: ' . pg_last_error());

// Realizar una consulta SQL
$consulta = 'SELECT * FROM autores';
$resultado = pg_query($consulta) or die('Consulta fallida: ' . pg_last_error());

// Impresion de resultados en HTML
echo "<table>\n";
while (
$linea = pg_fetch_array($resultado, null, PGSQL_ASSOC)) {
    echo
"\t<tr>\n";
    foreach (
$linea as $valor_col) {
        echo
"\t\t<td>$valor_col</td>\n";
    }
    echo
"\t</tr>\n";
}
echo
"</table>\n";

// Liberar conjunto de resultados
pg_free_result($resultado);

// Cerrar conexion
pg_close($conexion_bd);

?>

Tabla de contenidos
pg_affected_rows -- Returns number of affected records (tuples)
pg_cancel_query --  Cancel an asynchronous query
pg_client_encoding --  Gets the client encoding
pg_Close -- Cierra una conexi贸n PostgreSQL
pg_Connect -- Abre una conexi贸n
pg_connection_busy --  Get connection is busy or not
pg_connection_reset --  Reset connection (reconnect)
pg_connection_status --  Get connection status
pg_convert --  Convert associative array values into suitable for SQL statement
pg_copy_from --  Insert records into a table from an array
pg_copy_to --  Copy a table to an array
pg_DBname -- Nombre de la base de datos
pg_delete --  Deletes records
pg_end_copy -- Sync with PostgreSQL backend
pg_escape_bytea --  Escape a string for insertion into a bytea field
pg_escape_string --  Escape a string for insertion into a text field
pg_execute -- Sends a request to execute a prepared statement with given parameters, and waits for the result.
pg_fetch_all_columns -- Fetches all rows in a particular result column as an array
pg_fetch_all -- Fetches all rows from a result as an array
pg_Fetch_Array -- obtiene una fila en la forma de un array
pg_fetch_assoc -- Fetch a row as an associative array
pg_Fetch_Object -- obtener una fila en forma de objeto
pg_fetch_result -- Returns values from a result resource
pg_Fetch_Row -- obtiene la fila como un array enumerado
pg_field_is_null -- Test if a field is SQL NULL
pg_field_name -- Returns the name of a field
pg_field_num -- Returns the field number of the named field
pg_field_prtlen -- Returns the printed length
pg_field_size --  Returns the internal storage size of the named field
pg_field_type_oid --  Returns the type ID (OID) for the corresponding field number
pg_field_type --  Returns the type name for the corresponding field number
pg_free_result -- Free result memory
pg_get_notify -- Gets SQL NOTIFY message
pg_get_pid -- Gets the backend's process ID
pg_get_result --  Get asynchronous query result
pg_Host -- Devuelve el nombre del host
pg_insert --  Insert array into table
pg_last_error -- Get the last error message string of a connection
pg_last_notice --  Returns the last notice message from PostgreSQL server
pg_last_oid -- Returns the last row's OID
pg_lo_close -- Close a large object
pg_lo_create -- Create a large object
pg_lo_export -- Export a large object to file
pg_lo_import -- Import a large object from file
pg_lo_open -- Open a large object
pg_lo_read_all --  Reads an entire large object and send straight to browser
pg_lo_read -- Read a large object
pg_lo_seek --  Seeks position within a large object
pg_lo_tell --  Returns current seek position a of large object
pg_lo_unlink -- Delete a large object
pg_lo_write -- Write to a large object
pg_meta_data --  Get meta data for table
pg_num_fields -- Returns the number of fields in a result
pg_num_rows -- Returns the number of rows in a result
pg_Options -- Devuelve opciones
pg_parameter_status -- Looks up a current parameter setting of the server.
pg_pConnect --  Crea una conexi贸n persistente con una base de datos
pg_ping -- Ping database connection
pg_Port -- Devuelve el n煤mero de puerto
pg_prepare --  Submits a request to create a prepared statement with the given parameters, and waits for completion.
pg_put_line -- Send a NULL-terminated string to PostgreSQL backend
pg_query_params -- Submits a command to the server and waits for the result, with the ability to pass parameters separately from the SQL command text.
pg_query -- Execute a query
pg_result_error_field -- Returns an individual field of an error report.
pg_result_error --  Get error message associated with result
pg_result_seek -- Set internal row offset in result resource
pg_result_status --  Get status of query result
pg_select --  Select records
pg_send_execute -- Sends a request to execute a prepared statement with given parameters, without waiting for the result(s).
pg_send_prepare -- Sends a request to create a prepared statement with the given parameters, without waiting for completion.
pg_send_query_params -- Submits a command and separate parameters to the server without waiting for the result(s).
pg_send_query --  Sends asynchronous query
pg_set_client_encoding --  Set the client encoding
pg_set_error_verbosity --  Determines the verbosity of messages returned by pg_last_error() and pg_result_error().
pg_trace -- Enable tracing a PostgreSQL connection
pg_transaction_status -- Returns the current in-transaction status of the server.
pg_tty -- Devuelve el nombre del tty
pg_unescape_bytea --  Unescape binary for bytea type
pg_untrace -- Disable tracing of a PostgreSQL connection
pg_update --  Update table
pg_version --  Returns an array with client, protocol and server version (when available)