sqlsrv_prepare

(No version information available, might only be in Git)

sqlsrv_prepare — Prépare une requête pour exécution

Description

sqlsrv_prepare(
    resource $conn,
    string $sql,
    array $params = ?,
    array $options = ?
): mixed

Prépare une requête pour exécution. Cette fonction est idéale pour préparer une requête qui sera exécutée plusieurs fois avec des valeurs de paramètres différents.

Liste de paramètres

conn

Une ressource de connexion retournée par la fonction sqlsrv_connect().

sql

La chaîne qui définit la requête à préparer et à exécuter.

params

Un tableau spécifiant les informations de paramètres lors de l'exécution d'une requête contenant des paramètres. Les éléments du tableau peuvent être n'importe lequel de ceux qui suivent :

Une valeur litérale
Une variable PHP
Un tableau avec la structure suivante : array($value [, $direction [, $phpType [, $sqlType]]])

La table suivante décrit les éléments de la structure du tableau ci-dessus :

**Structure du tableau**
Elément	Description
$value	Une valeur liétrale, une variable PHP ou une variable PHP passée par référence.
$direction (optional)	Une des constantes SQLSRV suivantes, utilisées pour indiquer la direction du paramètre : SQLSRV_PARAM_IN, SQLSRV_PARAM_OUT, SQLSRV_PARAM_INOUT. La valeur par défaut est SQLSRV_PARAM_IN.
$phpType (optional)	Une constante SQLSRV_PHPTYPE_* qui spécifie le type de données PHP de la valeur retournée.
$sqlType (optional)	Une constante SQLSRV_SQLTYPE_* qui spécifie le type de données du serveur SQL de la valeur d'entrée.

options

Un tableau spécifiant les options de propriétés de la requête. Les clés supportées sont décrites dans le tableau suivant :

**Options de la requête**
Clé	Valeurs	Description
QueryTimeout	Une valeur entière positive.	Définit le délai maximal d'exécution de la requête, en seconde. Par défaut, le driver attendra indéfiniment les résultats.
SendStreamParamsAtExec	`true` ou `false` (par défaut, `true`)	Configure le driver pour envoyer les données du flux à l'exécution (`true`), ou envoyer les données du flux par morceaux (`false`). Par défaut, la valeur est définie à `true`. Pour plus d'informations, reportez-vous à la fonction sqlsrv_send_stream_data().
Scrollable	SQLSRV_CURSOR_FORWARD, SQLSRV_CURSOR_STATIC, SQLSRV_CURSOR_DYNAMIC, ou SQLSRV_CURSOR_KEYSET	Voir la section sur » la sécification d'un type de curseur et la sélection de lignes de la documentation Microsoft SQLSRV.

Valeurs de retour

Retourne une ressource de requête en cas de succès, ou false si une erreur survient.

Exemples

Exemple #1 Exemple avec sqlsrv_prepare()

Cet exemple montre la façon de préparer une requête avec la fonction sqlsrv_prepare() et sa ré-exécution à plusieurs reprises (avec des valeurs de paramètres différents) en utilisant la fonction sqlsrv_execute().

<?php
$serverName = "serverName\sqlexpress";
$connectionInfo = array( "Database"=>"dbName", "UID"=>"username", "PWD"=>"password");
$conn = sqlsrv_connect( $serverName, $connectionInfo);
if( $conn === false) {
    die( print_r( sqlsrv_errors(), true));
}

$sql = "UPDATE Table_1
        SET OrderQty = ?
        WHERE SalesOrderID = ?";

// Initialise les paramètres et prépare la requête.
// Les variables $qty et $id sont liées à la requête $stmt.
$qty = 0; $id = 0;
$stmt = sqlsrv_prepare( $conn, $sql, array( &$qty, &$id));
if( !$stmt ) {
    die( print_r( sqlsrv_errors(), true));
}

// Définit les informations SalesOrderDetailID et OrderQty.
// Ce tableau lie l'ordre des IDs avec l'ordre des quantités avec des paires clé=>valeur.
$orders = array( 1=>10, 2=>20, 3=>30);

// Exécute la requête pour chaque ordre.
foreach( $orders as $id => $qty) {
    // En raison du fait que $id et $qty sont liés à $stmt1,
    // leurs valeurs mises à jour sont utilisées lors de chaque exécution
    // de la requête.
    if( sqlsrv_execute( $stmt ) === false ) {
          die( print_r( sqlsrv_errors(), true));
    }
}
?>

Notes

Lorsque vous préparez une requête qui utilisent des variables comme paramètres, les variables sont liées à la requête. Cela signifie que si vous mettez à jour les valeurs de ces variables, la prochaine exécution de la requête prendra en compte ces nouvelles valeurs. Pour les requêtes que vous ne prévoyez exécuter qu'une seule fois, utilisez la fonction sqlsrv_query().

Voir aussi

sqlsrv_execute() - Exécute une requête préparée avec la fonction sqlsrv_prepare
sqlsrv_query() - Prépare et exécute une requête

add a note

User Contributed Notes 2 notes

down

tuxedobob ¶

9 years ago


Be careful with your variables once you bind them to a statement with sqlsrv_prepare.

Consider the following:

<?php
$dude = '';
$time = new DateTime();
$sql = "INSERT INTO my_table (person, timein) VALUES (?, ?)";
$stmt = sqlsrv_prepare($conn, $sql, array(&$dude, &$time));

...
// many lines later

foreach ($times as &$time) {
   //do stuff
}

// later still...
$time = $times['start'];
if( sqlsrv_execute( $stmt ) === false ) {
          die( print_r( sqlsrv_errors(), true));
}
?>

I did something like this. I prepared a statement at the start, used the variable again in the middle, and then set the value I wanted before running the query.

Trouble is, I used the variable as an iterator instead of a simple scalar. This caused PHP to use a different location in memory, and the location it was previously bound to was invalid. So SQL simply inserted a default date/time.

Worse, because SQL just inserted a default, it didn't throw any errors, and in trying to debug it, I did something like this:

<?php
var_dump($time);
sqlsrv_execute($stmt);
$q = "SELECT * FROM my_table WHERE id=@@IDENTITY";
$r = sqlsrv_query($conn, $q);
$row = sqlsrv_fetch_array($r); $id = $row[0];
var_dump($row['time']);
?>

Having it appear as though you're sending SQL the correct data, and seeing it spitting back something else entirely is absolutely maddening.

So if SQL seems to be inserting garbage with prepared statements, MAKE SURE YOU'RE NOT USING THE VARIABLES ANYWHERE ELSE.

down

-1

matt at bigbadweb dot co dot uk ¶

10 years ago


Example of how to formally specify the params, AND get output.
<?php

// Setup connection
$serverName = "serverName\sqlexpress";
$connectionInfo = array( "Database"=>"dbName", "UID"=>"username", "PWD"=>"password");
$conn = sqlsrv_connect( $serverName, $connectionInfo);
if( $conn === false) {
  die( print_r( sqlsrv_errors(), true));
}

// specify params - MUST be a variable that can be passed by reference!
$myparams['Item_ID'] = intval(-2);
$myparams['Item_Name'] = "Foo";

// Set up the proc params array - be sure to pass the param by reference
$procedure_params = array(
 array(&$myparams['Item_ID'], SQLSRV_PARAM_OUT),
 array(&$myparams['Item_Name'], SQLSRV_PARAM_OUT)
);

// EXEC the procedure, {call stp_Create_Item (@Item_ID = ?, @Item_Name = ?)} seems to fail with various errors in my experiments
$sql = "EXEC stp_Create_Item @Item_ID = ?, @Item_Name = ?";

$stmt = sqlsrv_prepare($conn, $sql, $procedure_params);

if( !$stmt ) {
 die( print_r( sqlsrv_errors(), true));
}

if(sqlsrv_execute($stmt)){
  while($res = sqlsrv_next_result($stmt)){
    // make sure all result sets are stepped through, since the output params may not be set until this happens
  }
  // Output params are now set,
  print_r($params);
  print_r($myparams);
}else{
  die( print_r( sqlsrv_errors(), true));
}
?>

add a note