sqlsrv_prepare

發行項
06/02/2023

建立與指定的連接相關聯的陳述式資源。此函數有助於您執行多個查詢。

語法

  
sqlsrv_prepare(resource $conn, string $tsql [, array $params [, array $options]])

參數

$conn：與已建立的陳述式相關聯的連接資源。

$tsql：與所建立陳述式對應的 Transact-SQL 運算式。

$params [OPTIONAL]：對應至參數化查詢中參數的值陣列。陣列的每個元素可以是下列其中一項：

常值。
PHP 變數的參考。

具有下列結構的陣列：

array(&$value [, $direction [, $phpType [, $sqlType]]])

注意

傳遞做為查詢參數的變數應由參考傳遞，而不是由值傳遞。例如，應傳遞 &$myVariable ，而不是 $myVariable。在執行具有傳值參數的查詢時，會引發 PHP 警告。

下表說明這些陣列元素：

項目	描述
&$value	常值或 PHP 變數的參考。
$direction[OPTIONAL]	下列其中一項 SQLSRV_PARAM_* 常數，用於指定參數方向：SQLSRV_PARAM_IN、SQLSRV_PARAM_OUT、SQLSRV_PARAM_INOUT。預設值為 SQLSRV_PARAM_IN。如需 PHP 常數的詳細資訊，請參閱常數 (Microsoft Drivers for PHP for SQL Server)。
$phpType[OPTIONAL]	SQLSRV_PHPTYPE_* 常數，指定傳回值的 PHP 資料類型。
$sqlType[OPTIONAL]	SQLSRV_SQLTYPE_* 常數，指定輸入值的 SQL Server 資料類型。

$options [選擇性]：設定查詢屬性的關聯陣列。下表列出支援的 Key 和對應的值：

Key	支援的值	描述
ClientBufferMaxKBSize	正整數	設定將保留用戶端資料指標結果集的緩衝區大小。預設值是 10240 KB。如需詳細資訊，請參閱指定資料指標類型及選取資料列。
DecimalPlaces	介於 0 和 4 (含) 之間的整數	指定將擷取的貨幣值格式化時的小數位數。將忽略任何大於 4 的負整數或值。這個選項只有當 FormatDecimals 為 true 時才能運作。
FormatDecimals	[True] 或 [False] 預設值為 false。	指定是否要在適當時於十進位字串中新增前置零，並啟用 `DecimalPlaces` 選項來將貨幣類型格式化。如需詳細資訊，請參閱將十進位字串及貨幣值格式化 (SQLSRV 驅動程式)。
QueryTimeout	正整數	設定查詢逾時 (以秒為單位)。根據預設，驅動程式會無限期等候結果。
ReturnDatesAsStrings	[True] 或 [False] 預設值為 false。	設定陳述式，以使用字串形式來擷取日期和時間類型 (true)。如需詳細資訊，請參閱如何：使用 SQLSRV 驅動程式以字串的形式擷取日期和時間類型。
可捲動	SQLSRV_CURSOR_FORWARD SQLSRV_CURSOR_STATIC SQLSRV_CURSOR_DYNAMIC SQLSRV_CURSOR_KEYSET SQLSRV_CURSOR_CLIENT_BUFFERED	如需這些值的詳細資訊，請參閱指定資料指標類型及選取資料列。
SendStreamParamsAtExec	[True] 或 [False] 預設值為 true。	設定驅動程式在執行時傳送所有資料流資料 (true)，或是以區塊傳送資料流資料 (false)。依預設，此值設定為 true。如需詳細資訊，請參閱 sqlsrv_send_stream_data。

傳回值

陳述式資源。如果無法建立陳述式資源，將會傳回 false 。

備註

當您準備以變數做為參數的陳述式時，這些變數會繫結至陳述式。這表示如果您更新變數的值，下一次執行陳述式時，就會以更新的參數值來執行。

sqlsrv_prepare 和 sqlsrv_execute 的組合可將陳述式準備和陳述式執行分成兩個函式呼叫中，並可用於執行參數化查詢。此函數非常適合用來執行陳述式多次 (每次執行時使用不同的參數值)。

如需寫入和讀取大量資訊的替代策略，請參閱 SQL 陳述式的批次和 BULK INSERT。

如需詳細資訊，請參閱如何：使用 SQLSRV 驅動程式擷取輸出參數。

範例 1

下列範例會準備及執行陳述式。若執行陳述式 (請參閱 sqlsrv_execute)，其會更新 AdventureWorks 資料庫之 Sales.SalesOrderDetail 資料表中的欄位。此範例假設本機電腦上已安裝 SQL Server 和 AdventureWorks 資料庫。從命令列執行範例時，所有輸出都會寫入至主控台。

<?php  
/* Connect to the local server using Windows Authentication and  
specify the AdventureWorks database as the database in use. */  
$serverName = "(local)";  
$connectionInfo = array("Database"=>"AdventureWorks");  
$conn = sqlsrv_connect($serverName, $connectionInfo);  
if ($conn === false) {  
    echo "Could not connect.\n";  
    die(print_r(sqlsrv_errors(), true));  
}  
  
/* Set up Transact-SQL query. */  
$tsql = "UPDATE Sales.SalesOrderDetail   
         SET OrderQty = ?   
         WHERE SalesOrderDetailID = ?";  
  
/* Assign parameter values. */  
$param1 = 5;  
$param2 = 10;  
$params = array(&$param1, &$param2);  
  
/* Prepare the statement. */  
if ($stmt = sqlsrv_prepare($conn, $tsql, $params)) {
    echo "Statement prepared.\n";  
} else {  
    echo "Statement could not be prepared.\n";  
    die(print_r(sqlsrv_errors(), true));  
}  
  
/* Execute the statement. */  
if (sqlsrv_execute($stmt)) {  
    echo "Statement executed.\n";  
} else {  
    echo "Statement could not be executed.\n";  
    die(print_r(sqlsrv_errors(), true));  
}  
  
/* Free the statement and connection resources. */  
sqlsrv_free_stmt($stmt);  
sqlsrv_close($conn);  
?>

範例 2

下列範例示範如何準備陳述式，然後以不同的參數值重新加以執行。此範例會更新 AdventureWorks 資料庫中 Sales.SalesOrderDetail 資料表的 OrderQty 資料行。更新執行之後，將會查詢資料庫以確認更新已成功。此範例假設本機電腦上已安裝 SQL Server 和 AdventureWorks 資料庫。從命令列執行範例時，所有輸出都會寫入至主控台。

<?php  
/* Connect to the local server using Windows Authentication and  
specify the AdventureWorks database as the database in use. */  
$serverName = "(local)";  
$connectionInfo = array("Database"=>"AdventureWorks");  
$conn = sqlsrv_connect($serverName, $connectionInfo);  
if ($conn === false) {  
     echo "Could not connect.\n";  
     die(print_r(sqlsrv_errors(), true));  
}  
  
/* Define the parameterized query. */  
$tsql = "UPDATE Sales.SalesOrderDetail  
         SET OrderQty = ?  
         WHERE SalesOrderDetailID = ?";  
  
/* Initialize parameters and prepare the statement. Variables $qty  
and $id are bound to the statement, $stmt1. */  
$qty = 0; $id = 0;  
$stmt1 = sqlsrv_prepare($conn, $tsql, array(&$qty, &$id));  
if ($stmt1) {  
    echo "Statement 1 prepared.\n";  
} else {  
    echo "Error in statement preparation.\n";  
    die(print_r(sqlsrv_errors(), true));  
}  
  
/* Set up the SalesOrderDetailID and OrderQty information. This array  
maps the order ID to order quantity in key=>value pairs. */  
$orders = array(1=>10, 2=>20, 3=>30);  
  
/* Execute the statement for each order. */  
foreach ($orders as $id => $qty) {  
    // Because $id and $qty are bound to $stmt1, their updated  
    // values are used with each execution of the statement.   
    if (sqlsrv_execute($stmt1) === false) {  
        echo "Error in statement execution.\n";  
        die(print_r(sqlsrv_errors(), true));  
    }  
}  
echo "Orders updated.\n";  
  
/* Free $stmt1 resources.  This allows $id and $qty to be bound to a different statement.*/  
sqlsrv_free_stmt($stmt1);  
  
/* Now verify that the results were successfully written by selecting   
the newly inserted rows. */  
$tsql = "SELECT OrderQty   
         FROM Sales.SalesOrderDetail   
         WHERE SalesOrderDetailID = ?";  
  
/* Prepare the statement. Variable $id is bound to $stmt2. */  
$stmt2 = sqlsrv_prepare($conn, $tsql, array(&$id));  
if ($stmt2) {  
    echo "Statement 2 prepared.\n";  
} else {  
    echo "Error in statement preparation.\n";  
    die(print_r(sqlsrv_errors(), true));  
}  
  
/* Execute the statement for each order. */  
foreach (array_keys($orders) as $id)  
{  
    /* Because $id is bound to $stmt2, its updated value   
    is used with each execution of the statement. */  
    if (sqlsrv_execute($stmt2)) {  
        sqlsrv_fetch($stmt2);  
        $quantity = sqlsrv_get_field($stmt2, 0);  
        echo "Order $id is for $quantity units.\n";  
    } else {  
        echo "Error in statement execution.\n";  
        die(print_r(sqlsrv_errors(), true));  
    }  
}  
  
/* Free $stmt2 and connection resources. */  
sqlsrv_free_stmt($stmt2);  
sqlsrv_close($conn);  
?>

注意

建議在將值繫結至 decimal 或 numeric 資料行時使用字串作為輸入，以確保精確度與正確性，因為 PHP 所具備的浮點數 $英文$ 精確度有限。這同樣適用於 bigint 資料行，尤其當值不在某個整數的範圍內時。

範例 3

此程式碼範例示範如何繫結十進位值作為輸入參數。

<?php
$serverName = "(local)";
$connectionInfo = array("Database"=>"YourTestDB");  
$conn = sqlsrv_connect($serverName, $connectionInfo);  
if ($conn === false) {  
    echo "Could not connect.\n";  
    die(print_r(sqlsrv_errors(), true));  
}  

// Assume TestTable exists with a decimal field 
$input = "9223372036854.80000";
$params = array($input);
$stmt = sqlsrv_prepare($conn, "INSERT INTO TestTable (DecimalCol) VALUES (?)", $params);
sqlsrv_execute($stmt);

sqlsrv_free_stmt($stmt);  
sqlsrv_close($conn);  

?>