PostgreSQL 10.1 手册_部分 IV. 客户端接口_第 33 章 libpq - C 库_33.11. 杂项函数
33.11.?雜項函數
一如往常，總有一些函數不適合放在任何其他地方。
PQfreemem釋放libpq分配的內存。
void PQfreemem(void *ptr);釋放libpq分配的內存，尤其是PQescapeByteaConn、PQescapeBytea、PQunescapeBytea和PQnotifies分配的內存。特別重要的是，在微軟 Windows 上使用這個函數，而不是free()。這是因為只有 DLL 和應用的當多線程/單線程、發布/調試以及靜態/動態標志相同時，才能在一個 DLL 中分配內存并且在應用中釋放它。在非微軟 Windows 平臺上，這個函數與標準庫函數free()相同。
釋放PQconndefaults或PQconninfoParse分配的數據結構。
void PQconninfoFree(PQconninfoOption *connOptions);一個簡單的PQfreemem不會做這些，因為數組包含對子字符串的引用。
準備一個PostgreSQL口令的加密形式。
char *PQencryptPasswordConn(PGconn *conn, const char *passwd, const char *user, const char *algorithm);這個函數旨在用于那些希望發送類似于ALTER USER joe PASSWORD 'pwd'命令的客戶端應用。不在這樣一個命令中發送原始的明文密碼是一個好習慣，因為它可能被暴露在命令日志、活動顯示等等中。相反，在發送之前使用這個函數可以將口令轉換為加密的形式。
algorithm指定用于加密口令的加密算法。目前支持的算法是?md5和scram-sha-256，（on和off?也被接受為md5的別名，以與舊版服務器版本兼容）。 請注意，在PostgreSQL版本10中引入了對scram-sha-256?的支持，并且在舊版服務器版本中無法正常工作。如果algorithm?是NULL，則此函數將向服務器查詢password_encryption?設置的當前值。如果當前事務中止，或者連接忙于執行另一個查詢，則可能會阻塞， 并會失敗。如果您希望服務器使用默認算法，但希望避免阻塞， 請在調用PQencryptPasswordConn之前親自查詢?password_encryption，并將該值作為algorithm傳遞。
返回值是malloc分配的一個字符串。 調用者可以假定該字符串中不包含任何需要轉義的特殊字符。當使用結束之后， 用PQfreemem釋放結果。錯誤時，返回NULL， 并且一個合適的消息被存儲在連接對象中。
準備一個PostgreSQL口令的md5加密形式。
char *PQencryptPassword(const char *passwd, const char *user);PQencryptPassword是PQencryptPasswodConn?的一個較舊的，廢棄的版本。區別在于PQencryptPassword?不需要連接對象，并且始終使用md5作為加密算法。
用給定的狀態，構造一個空PGresult對象。
PGresult *PQmakeEmptyPGresult(PGconn *conn, ExecStatusType status);這是libpq內部用于分配并初始化一個空PGresult對象的函數。如果不能分配內存，那么這個函數返回NULL。它也是可以對外使用的，因為一些應用認為它可以用于產生結果對象（特別是帶有錯誤狀態的對象）本身。如果conn非空，并且status表示一個錯誤，那么指定連接的當前錯誤消息會被復制到PGresult中。如果conn非空，那么連接中的任何已注冊事件過程也會被復制到PGresult中（它們不會獲得PGEVT_RESULTCREATE調用，但會看到PQfireResultCreateEvents）。注意在該對象上最終應該調用PQclear，正如對libpq本身返回的PGresult對象所作的那樣。
為每一個在PGresult對象中注冊的事件過程觸發一個PGEVT_RESULTCREATE事件（見第?33.13?節）。成功時返回非 0，如果任何事件過程失敗則返回 0。
int PQfireResultCreateEvents(PGconn *conn, PGresult *res);conn參數被傳送給事件過程，但不會被直接使用。如果事件過程不使用它，則會返回NULL。
已經接收到這個對象的PGEVT_RESULTCREATE或PGEVT_RESULTCOPY事件的事件過程不會被再次觸發。
這個函數與PQmakeEmptyPGresult分開的主要原因是在調用事件過程之前創建一個PGresult并且填充它常常是合適的。
為一個PGresult對象創建一個拷貝。這個拷貝不會以任何方式鏈接到源結果，并且當該拷貝不再需要時，必須調用PQclear進行清理。如果函數失敗，返回NULL。
PGresult *PQcopyResult(const PGresult *src, int flags);這個函數的意圖并非是制作一個準確的拷貝。返回的結果總是會被放入PGRES_TUPLES_OK狀態，并且不會拷貝來源中的任何錯誤消息（不過它確實會拷貝命令狀態字符串）。flags參數決定還要拷貝些什么。它通常是幾個標志的按位 OR。PG_COPYRES_ATTRS指定復制源結果的屬性（列定義）。PG_COPYRES_TUPLES指定復制源結果的元組（這也意味著復制屬性）。PG_COPYRES_NOTICEHOOKS指定復制源結果的提醒鉤子。PG_COPYRES_EVENTS指定復制源結果的事件（但是不會復制與源結果相關的實例數據）。
設置PGresult對象的屬性。
int PQsetResultAttrs(PGresult *res, int numAttributes, PGresAttDesc *attDescs);提供的attDescs被復制到結果中。如果attDescs指針為NULL或numAttributes小于1，那么請求將被忽略并且函數成功。如果res已經包含屬性，那么函數會失敗。如果函數失敗，返回值是 0。如果函數成功，返回值是非 0。
設置一個PGresult對象的一個元組域值。
int PQsetvalue(PGresult *res, int tup_num, int field_num, char *value, int len);這個函數將自動按需增加結果的內置元組數組。但是，tup_num參數必須小于等于PQntuples，意味著這個函數對元組數組一次只能增加一個元組。但已存在的任意元組中的任意域可以以任意順序進行調整。如果field_num的一個值已經存在，它會被覆蓋。如果len是 -1，或value是NULL， 該域值會被設置為一個 SQL 空值。value會被復制到結果的私有存儲中，因此函數返回后就不再需要了。如果函數失敗，返回值是 0。如果函數成功，返回值會是非 0。
為一個PGresult對象分配附屬存儲。
void *PQresultAlloc(PGresult *res, size_t nBytes);當res被清除時，這個函數分配的內存也會被釋放掉。如果函數失敗，返回值是NULL。結果被保證為按照數據的任意類型充分地對齊，正如malloc所作的。
返回所使用的libpq版本。
int PQlibVersion(void);在運行時，這個函數的結果可以被用來決定在當前已載入的 libpq 版本中特定的功能是否可用。 例如，這個函數可以被用來決定哪些選項可以被用于PQconnectdb。
結果是通過將庫的主要版本號乘以10000并添加次要版本號形成的。 例如，版本10.1將返回100001，版本11.0將返回110000。如果連接不正確，則返回零。
在主版本10之前，PostgreSQL使用三部分版本號， 前兩部分代表主要版本。對于這些版本，PQserverVersion?對每個部分使用兩個數字；例如版本9.1.5將返回90105，版本9.2.0將返回90200。
因此，為確定功能兼容性，應用程序應將PQserverVersion?的結果除以100而不是10000，以確定邏輯主要版本號。在所有發行版系列中， 只有最后兩位數字在次版本（錯誤修復版本）之間有所不同。
注意
這個函數出現于PostgreSQL版本 9.1，因此它不能被用來在早期的版本中檢測所需的功能，因為調用它將會創建一個對版本 9.1 或更高版本的鏈接依賴。
本文轉自PostgreSQL中文社區，原文鏈接：33.11.?雜項函數
總結
以上是生活随笔為你收集整理的PostgreSQL 10.1 手册_部分 IV. 客户端接口_第 33 章 libpq - C 库_33.11. 杂项函数的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： Tomcat启动过程源码解读
- 下一篇： 笔记：后端 - Redis