Last updated: Fri, 14 Aug 2009

pg_query_params

(PHP 5 >= 5.1.0)

pg_query_params — Envoie une commande au serveur et attend le résultat, avec les capacités de passer des paramètres séparément de la commande texte SQL

Description

resource pg_query_params ([ resource $connection ], string $query , array $params )

Envoie une commande au serveur et attend le résultat, avec les capacités de passer des paramètres séparément de la commande texte SQL.

pg_query_params() est comme pg_query(), mais offre des fonctionnalités additionnelles : les valeurs des paramètres peuvent être spécifiées séparément de la ligne de commande propre. pg_query_params() est supportée seulement avec les versions PostgreSQL 7.4 ou plus récentes; la commande échouera si vous l'utilisez avec des versions antérieures.

Si des paramètres sont utilisés, ils sont référés à $1, $2, etc. dans query . params spécifie les valeurs actuelles des paramètres. Une valeur NULL dans ce tableau signifie que le paramètre correspondant est SQL NULL.

Le principal avantage de pg_query_params() sur pg_query() est que les valeurs des paramètres peuvent être séparées de la requête query , par conséquent, on invite les échappements de caractères ennuyeux et source d'erreurs. Contrairement à pg_query(), pg_query_params() permet seulement une seule commande SQL dans la chaîne donnée. (Il peut y avoir des points-virgules à l'intérieur mais pas plus d'une seule commande.)

Liste de paramètres

connection: La ressource de connexion de la base de données PostgreSQL. Lorsque connection n'est pas présent, la connexion par défaut est utilisée. La connexion par défaut est la dernière connexion faite par pg_connect() ou pg_pconnect().
query: La requête SQL avec ses paramètres. Elle doit contenir seulement une seule requête. Plusieurs requêtes séparées par des points-virgules ne sont pas autorisées. Si des paramètres sont utilisés, ils sont référés à $1, $2, etc.
params: Un tableau de valeurs de paramètres pour substituer les variables $1, $2, etc. dans la requête préparée originale. Le nombre d'éléments présents dans le tableau doit concorder avec le nombre de variables à remplacer.

Valeurs de retour

Une ressource de résultats en cas de succès ou FALSE en cas d'échec.

Exemples

Exemple #1 Exemple avec pg_query_params()


<?php
// Connexion à une base de données nommée "marie"
$dbconn = pg_connect("dbname=marie");

// Cherche tous les magasins nommés Joe's Widgets. Notez qu'il n'est pas
// nécessaire d'échapper la chaîne "Joe's Widgets"
$result = pg_query_params($dbconn, 'SELECT * FROM magasins WHERE nom = $1', array("Joe's Widgets"));

// Compare en utilisant pg_query
$str = pg_escape_string("Joe's Widgets");
$result = pg_query($dbconn, "SELECT * FROM magasins WHERE nom = '{$str}'");

?>

Voir aussi

pg_query() - Exécute une requête PostgreSQL

pg_query

pg_put_line

Last updated: Fri, 14 Aug 2009

add a note User Contributed Notes
pg_query_params

strata_ranger at hotmail dot com
24-May-2009 04:03


Regarding boolean values, just typecast them as (integer) when passing them in your query -- '0' and '1' are perfectly acceptable literals for SQL boolean input:



- http://www.postgresql.org/docs/8.2/interactive/datatype-boolean.html



It is also safe to write your paramerized query in double-quotes, which allows you to mix constant values and placeholders in your query without having to worry about how whether PHP will attempt to substitute any variables in your parameterized string.



Of course this also means that unlike PHP's double-quoted string syntax, you CAN include literal $1, $2, etc. inside SQL strings, e.g:



<?php

// Works ($1 is a placeholder, $2 is meant literally)

pg_query_params("INSERT INTO foo (col1, col2) VALUES ($1, 'costs $2')", Array($data1));



// Throws an E_WARNING (passing too many parameters)

pg_query_params("INSERT INTO foo (col1, col2) VALUES ($1, 'costs $2')", Array($data1, $data2));

?>

jsnell at e-normous dot com
26-Sep-2007 10:57


When inserting into a pg column of type bool, you cannot supply a PHP type of bool.  You must instead use a string "t" or "f". PHP attempts to change boolean values supplied as parameters to strings, and then attempts to use a blank string for false.



Example of Failure:

pg_query_params('insert into table1 (bool_column) values ($1)', array(false));



Works:

pg_query_params('insert into lookup_permissions (system) values ($1)', array(false ? 't' : 'f'));

dt309 at f2s dot com
22-Dec-2006 08:11


If you need to provide multiple possible values for a field in a select query, then the following will help.



<?php

// Assume that $values[] is an array containing the values you are interested in.

$values = array(1, 4, 5, 8);



// To select a variable number of arguments using pg_query() you can use:

$valuelist = implode(', ', $values);

$query = "SELECT * FROM table1 WHERE col1 IN ($valuelist)";

$result = pg_query($query)

    or die(pg_last_error());



// You may therefore assume that the following will work.

$query = 'SELECT * FROM table1 WHERE col1 IN ($1)';

$result = pg_query_params($query, array($valuelist))

    or die(pg_last_error());

// Produces error message: 'ERROR: invalid input syntax for integer'

// It only works when a SINGLE value specified.



// Instead you must use the following approach:

$valuelist = '{' . implode(', ', $values . '}'

$query = 'SELECT * FROM table1 WHERE col1 = ANY ($1)';

$result = pg_query_params($query, array($valuelist));

?>



The error produced in this example is generated by PostGreSQL.



The last method works by creating a SQL array containing the desired values. 'IN (...)' and ' = ANY (...)' are equivalent, but ANY is for working with arrays, and IN is for working with simple lists.

mledford
04-Oct-2006 03:18


If you are trying to replicate the function pg_query_params, you might also want to support NULL values. While is_int returns true for a NULL value, the formatting for the SQL.



function pg_query_params( $db, $query, $parameters ) {

    // Escape parameters as required & build parameters for callback function

    global $pg_query_params__parameters;

    foreach( $parameters as $k=>$v ) {

        if ( is_null($v) ) {

            $parameters[$k] = 'NULL';

        } else {

            $parameters[$k] = ( is_int( $v ) ? $v : "'".pg_escape_string( $v )."'" );

        }

    }

    $pg_query_params__parameters = $parameters;

        

    // Call using pg_query

    return pg_query( $db, preg_replace_callback( '/\$([0-9]+)/', 'pg_query_params__callback', $query));

}

cc+php at c2se dot com
02-Sep-2006 12:17


This is a useful function for preventing SQL injection attacks, so, for those of us who are not yet able to upgrade to PHP5.1, here is a replacement function which works similarly on older versions of PHP...



<?php   # Parameterised query implementation for Postgresql and older versions of PHP



        if( !function_exists( 'pg_query_params' ) ) {



                function pg_query_params__callback( $at ) {

                        global $pg_query_params__parameters;

                        return $pg_query_params__parameters[ $at[1]-1 ];

                }



                function pg_query_params( $db, $query, $parameters ) {



                        // Escape parameters as required & build parameters for callback function

                        global $pg_query_params__parameters;

                        foreach( $parameters as $k=>$v )

                                $parameters[$k] = ( is_int( $v ) ? $v : "'".pg_escape_string( $v )."'" );

                        $pg_query_params__parameters = $parameters;



                        // Call using pg_query

                        return pg_query( $db, preg_replace_callback( '/\$([0-9]+)/', 'pg_query_params__callback', $query ) );



                }

        }



        // Example: pg_query_params( $db_resource, "SELECT * FROM table WHERE col1=$1 AND col2=$2", array( 42, "It's ok" ) );

?>

add a note

pg_query

pg_put_line

Last updated: Fri, 14 Aug 2009