普洱企業建站

返回值

SPI_prepare返回一個指向SPIPlan 的非空指針，它是一個表示一個預備語句的不透明結構。發生錯誤時， 將會返回NULL，并且 SPI_result將被設置為一個也被 SPI_execute使用的錯誤碼，不過當 command為NULL、 或者nargs小于零、或者nargs大于 零但是argtypes為NULL 時它會被設置為SPI_ERROR_ARGUMENT。

注解

如果沒有定義參數，在第一次使用SPI_execute_plan 時將會創建一個一般的計劃，并且把它用于所有的后續執行。如果有參數， SPI_execute_plan的前幾次使用將根據提供的參數值 產生定制計劃。在使用同一個預備語句足夠多次后， SPI_execute_plan將構建一個一般計劃，并且如果它 并不比定制計劃昂貴太多， SPI_execute_plan將開始 使用一般計劃來取代每次都進行重新規劃。如果這種默認的行為不合適，你可以 通過傳遞CURSOR_OPT_GENERIC_PLAN或 CURSOR_OPT_CUSTOM_PLAN標志給 SPI_prepare_cursor，以分別強制使用一般或者定制 計劃。

盡管一個預備語句的要點是避免對語句的重復解析分析以及規劃，只要語句中 用到的數據庫對象從上一次使用該預備語句以來經歷過定義性（DDL）改變， PostgreSQL將會強制重新分析和重新規劃該語句。還有， 如果search_path的值從一個改變成下一個，該語句將 會使用新的search_path進行重新解析（后一種行為是從 PostgreSQL 9.3 開始的新行為）。更多 有關預備語句行為的信息請見PREPARE。

這個函數只能從一個已連接的過程調用。

SPIPlanPtr被聲明為spi.h中的一種不透明結構類型 的指針。嘗試直接訪問其內容是不明智的，因為那會讓你的代碼更有可能會在未 來版本的PostgreSQL中崩潰。

SPIPlanPtr這個名字多少有點歷史原因，因為該數據結構不再需要包 含一個執行計劃。