目录搜索
前言何为PostgreSQL?PostgreSQL简史格式约定更多信息臭虫汇报指导I. 教程章1. 从头开始1.1. 安装1.2. 体系基本概念1.3. 创建一个数据库1.4. 访问数据库章2. SQL语言2.1. 介绍2.2. 概念2.3. 创建新表2.4. 向表中添加行2.5. 查询一个表2.6. 表间链接2.7. 聚集函数2.8. 更新2.9. 删除章3. 高级特性3.1. 介绍3.2. 视图3.3. 外键3.4. 事务3.5. 窗口函数3.6. 继承3.7. 结论II. SQL语言章4. SQL语法4.1. 词法结构4.2. 值表达式4.3. 调用函数章5. 数据定义5.1. 表的基本概念5.2. 缺省值5.3. 约束5.4. 系统字段5.5. 修改表5.6. 权限5.7. 模式5.8. 继承5.9. 分区5.10. 其它数据库对象5.11. 依赖性跟踪章 6. 数据操作6.1. 插入数据6.2. 更新数据6.3. 删除数据章7. 查询7.1. 概述7.2. 表表达式7.3. 选择列表7.4. 组合查询7.5. 行排序7.6. LIMIT和OFFSET7.7. VALUES列表7.8. WITH的查询(公用表表达式)章8. 数据类型8.1. 数值类型8.2. 货币类型8.3. 字符类型8.4. 二进制数据类型8.5. 日期/时间类型8.6. 布尔类型8.7. 枚举类型8.8. 几何类型8.9. 网络地址类型8.10. 位串类型8.11. 文本搜索类型8.12. UUID类型8.13. XML类型8.14. 数组8.15. 复合类型8.16. 对象标识符类型8.17. 伪类型章 9. 函数和操作符9.1. 逻辑操作符9.2. 比较操作符9.3. 数学函数和操作符9.4. 字符串函数和操作符9.5. 二进制字符串函数和操作符9.6. 位串函数和操作符9.7. 模式匹配9.8. 数据类型格式化函数9.9. 时间/日期函数和操作符9.10. 支持枚举函数9.11. 几何函数和操作符9.12. 网络地址函数和操作符9.13. 文本检索函数和操作符9.14. XML函数9.15. 序列操作函数9.16. 条件表达式9.17. 数组函数和操作符9.18. 聚合函数9.19. 窗口函数9.20. 子查询表达式9.21. 行和数组比较9.22. 返回集合的函数9.23. 系统信息函数9.24. 系统管理函数9.25. 触发器函数章10. 类型转换10.3. 函数10.2. 操作符10.1. 概述10.4. 值存储10.5. UNION章11. 索引11.1. 介绍11.2. 索引类型11.3. 多字段索引11.4. 索引和ORDER BY11.5. 组合多个索引11.6. 唯一索引11.7. 表达式上的索引11.8. 部分索引11.9. 操作类和操作簇11.10. 检查索引的使用章12. Full Text Search12.1. Introduction12.2. Tables and Indexes12.3. Controlling Text Search12.4. Additional Features12.5. Parsers12.6. Dictionaries12.7. Configuration Example12.8. Testing and Debugging Text Search12.9. GiST and GIN Index Types12.10. psql Support12.11. Limitations12.12. Migration from Pre-8.3 Text Search章13. 并发控制13.1. 介绍13.2. 事务隔离13.3. 明确锁定13.4. 应用层数据完整性检查13.5. 锁和索引章14. 性能提升技巧14.1. 使用EXPLAIN14.2. 规划器使用的统计信息14.3. 用明确的JOIN语句控制规划器14.4. 向数据库中添加记录14.5. 非持久性设置III. 服务器管理章15. 安装指导15.1. 简版15.2. 要求15.3. 获取源码15.4. 升级15.5. 安装过程15.6. 安装后的设置15.7. 支持的平台15.8. 特殊平台的要求章16. Installation from Source Code on Windows16.1. Building with Visual C++ or the Platform SDK16.2. Building libpq with Visual C++ or Borland C++章17. 服务器安装和操作17.1. PostgreSQL用户帐户17.2. 创建数据库集群17.3. 启动数据库服务器17.4. 管理内核资源17.5. 关闭服务17.6. 防止服务器欺骗17.7. 加密选项17.8. 用SSL进行安全的TCP/IP连接17.9. Secure TCP/IP Connections with SSH Tunnels章18. 服务器配置18.1. 设置参数18.2. 文件位置18.3. 连接和认证18.4. 资源消耗18.5. 预写式日志18.6. 查询规划18.7. 错误报告和日志18.8. 运行时统计18.9. 自动清理18.10. 客户端连接缺省18.12. 版本和平台兼容性18.11. 锁管理18.13. 预置选项18.14. 自定义的选项18.15. 开发人员选项18.16. 短选项章19. 用户认证19.1. pg_hba.conf 文件19.2. 用户名映射19.3. 认证方法19.4. 用户认证章20. 数据库角色和权限20.1. 数据库角色20.2. 角色属性20.3. 权限20.4. 角色成员20.5. 函数和触发器章21. 管理数据库21.1. 概述21.2. 创建一个数据库21.3. 临时库21.4. 数据库配置21.5. 删除数据库21.6. 表空间章22. 本土化22.1. 区域支持22.2. 字符集支持章23. 日常数据库维护工作23.1. Routine Vacuuming日常清理23.2. 经常重建索引23.3. 日志文件维护章24. 备份和恢复24.1. SQL转储24.2. 文件系统级别的备份24.3. 在线备份以及即时恢复(PITR)24.4. 版本间迁移章25. 高可用性与负载均衡,复制25.1. 不同解决方案的比较25.2. 日志传送备份服务器25.3. 失效切换25.4. 日志传送的替代方法25.5. 热备章26. 恢复配置26.1. 归档恢复设置26.2. 恢复目标设置26.3. 备服务器设置章27. 监控数据库的活动27.1. 标准Unix工具27.2. 统计收集器27.3. 查看锁27.4. 动态跟踪章28. 监控磁盘使用情况28.1. 判断磁盘的使用量28.2. 磁盘满导致的失效章29. 可靠性和预写式日志29.1. 可靠性29.2. 预写式日志(WAL)29.3. 异步提交29.4. WAL配置29.5. WAL内部章30. Regression Tests30.1. Running the Tests30.2. Test Evaluation30.3. Variant Comparison Files30.4. Test Coverage ExaminationIV. 客户端接口章31. libpq-C库31.1. 数据库联接函数31.2. 连接状态函数31.3. 命令执行函数31.4. 异步命令处理31.5. 取消正在处理的查询31.6. 捷径接口31.7. 异步通知31.8. 与COPY命令相关的函数31.9. Control Functions 控制函数31.10. 其他函数31.11. 注意信息处理31.12. 事件系统31.13. 环境变量31.14. 口令文件31.15. 连接服务的文件31.16. LDAP查找连接参数31.17. SSL支持31.18. 在多线程程序里的行为31.19. 制作libpq程序31.20. 例子程序章32. 大对象32.1. 介绍32.2. 实现特点32.3. 客户端接口32.4. 服务器端函数32.5. 例子程序章33. ECPG - Embedded SQL in C33.1. The Concept33.2. Connecting to the Database Server33.3. Closing a Connection33.4. Running SQL Commands33.5. Choosing a Connection33.6. Using Host Variables33.7. Dynamic SQL33.8. pgtypes library33.9. Using Descriptor Areas33.10. Informix compatibility mode33.11. Error Handling33.12. Preprocessor directives33.13. Processing Embedded SQL Programs33.14. Library Functions33.15. Internals章34. 信息模式34.1. 关于这个模式34.2. 数据类型34.3. information_schema_catalog_name34.4. administrable_role_authorizations34.5. applicable_roles34.6. attributes34.7. check_constraint_routine_usage34.8. check_constraints34.9. column_domain_usage34.10. column_privileges34.11. column_udt_usage34.12. 字段34.13. constraint_column_usage34.14. constraint_table_usage34.15. data_type_privileges34.16. domain_constraints34.18. domains34.17. domain_udt_usage34.19. element_types34.20. enabled_roles34.21. foreign_data_wrapper_options34.22. foreign_data_wrappers34.23. foreign_server_options34.24. foreign_servers34.25. key_column_usage34.26. parameters34.27. referential_constraints34.28. role_column_grants34.29. role_routine_grants34.30. role_table_grants34.31. role_usage_grants34.32. routine_privileges34.33. routines34.34. schemata34.35. sequences34.36. sql_features34.37. sql_implementation_info34.38. sql_languages34.39. sql_packages34.40. sql_parts34.41. sql_sizing34.42. sql_sizing_profiles34.43. table_constraints34.44. table_privileges34.45. tables34.46. triggered_update_columns34.47. 触发器34.48. usage_privileges34.49. user_mapping_options34.50. user_mappings34.51. view_column_usage34.52. view_routine_usage34.53. view_table_usage34.54. 视图V. 服务器端编程章35. 扩展SQL35.1. 扩展性是如何实现的35.2. PostgreSQL类型系统35.3. User-Defined Functions35.4. Query Language (SQL) Functions35.5. Function Overloading35.6. Function Volatility Categories35.7. Procedural Language Functions35.8. Internal Functions35.9. C-Language Functions35.10. User-Defined Aggregates35.11. User-Defined Types35.12. User-Defined Operators35.13. Operator Optimization Information35.14. Interfacing Extensions To Indexes35.15. 用C++扩展章36. 触发器36.1. 触发器行为概述36.3. 用 C 写触发器36.2. 数据改变的可视性36.4. 一个完整的例子章37. 规则系统37.1. The Query Tree37.2. 视图和规则系统37.3. 在INSERT,UPDATE和DELETE上的规则37.4. 规则和权限37.5. 规则和命令状态37.6. 规则与触发器得比较章38. Procedural Languages38.1. Installing Procedural Languages章39. PL/pgSQL - SQL过程语言39.1. 概述39.2. PL/pgSQL的结构39.3. 声明39.4. 表达式39.5. 基本语句39.6. 控制结构39.7. 游标39.8. 错误和消息39.9. 触发器过程39.10. PL/pgSQL Under the Hood39.11. 开发PL/pgSQL的一些提示39.12. 从OraclePL/SQL 进行移植章40. PL/Tcl - Tcl Procedural Language40.1. Overview40.2. PL/Tcl Functions and Arguments40.3. Data Values in PL/Tcl40.4. Global Data in PL/Tcl40.5. Database Access from PL/Tcl40.6. Trigger Procedures in PL/Tcl40.7. Modules and the unknown command40.8. Tcl Procedure Names章41. PL/Perl - Perl Procedural Language41.1. PL/Perl Functions and Arguments41.2. Data Values in PL/Perl41.3. Built-in Functions41.4. Global Values in PL/Perl41.6. PL/Perl Triggers41.5. Trusted and Untrusted PL/Perl41.7. PL/Perl Under the Hood章42. PL/Python - Python Procedural Language42.1. Python 2 vs. Python 342.2. PL/Python Functions42.3. Data Values42.4. Sharing Data42.5. Anonymous Code Blocks42.6. Trigger Functions42.7. Database Access42.8. Utility Functions42.9. Environment Variables章43. Server Programming Interface43.1. Interface FunctionsSpi-spi-connectSpi-spi-finishSpi-spi-pushSpi-spi-popSpi-spi-executeSpi-spi-execSpi-spi-execute-with-argsSpi-spi-prepareSpi-spi-prepare-cursorSpi-spi-prepare-paramsSpi-spi-getargcountSpi-spi-getargtypeidSpi-spi-is-cursor-planSpi-spi-execute-planSpi-spi-execute-plan-with-paramlistSpi-spi-execpSpi-spi-cursor-openSpi-spi-cursor-open-with-argsSpi-spi-cursor-open-with-paramlistSpi-spi-cursor-findSpi-spi-cursor-fetchSpi-spi-cursor-moveSpi-spi-scroll-cursor-fetchSpi-spi-scroll-cursor-moveSpi-spi-cursor-closeSpi-spi-saveplan43.2. Interface Support FunctionsSpi-spi-fnameSpi-spi-fnumberSpi-spi-getvalueSpi-spi-getbinvalSpi-spi-gettypeSpi-spi-gettypeidSpi-spi-getrelnameSpi-spi-getnspname43.3. Memory ManagementSpi-spi-pallocSpi-reallocSpi-spi-pfreeSpi-spi-copytupleSpi-spi-returntupleSpi-spi-modifytupleSpi-spi-freetupleSpi-spi-freetupletableSpi-spi-freeplan43.4. Visibility of Data Changes43.5. ExamplesVI. 参考手册I. SQL命令Sql-abortSql-alteraggregateSql-alterconversionSql-alterdatabaseSql-alterdefaultprivilegesSql-alterdomainSql-alterforeigndatawrapperSql-alterfunctionSql-altergroupSql-alterindexSql-alterlanguageSql-alterlargeobjectSql-alteroperatorSql-alteropclassSql-alteropfamilySql-alterroleSql-alterschemaSql-altersequenceSql-alterserverSql-altertableSql-altertablespaceSql-altertsconfigSql-altertsdictionarySql-altertsparserSql-altertstemplateSql-altertriggerSql-altertypeSql-alteruserSql-alterusermappingSql-alterviewSql-analyzeSql-beginSql-checkpointSql-closeSql-clusterSql-commentSql-commitSql-commit-preparedSql-copySql-createaggregateSql-createcastSql-createconstraintSql-createconversionSql-createdatabaseSql-createdomainSql-createforeigndatawrapperSql-createfunctionSql-creategroupSql-createindexSql-createlanguageSql-createoperatorSql-createopclassSql-createopfamilySql-createroleSql-createruleSql-createschemaSql-createsequenceSql-createserverSql-createtableSql-createtableasSql-createtablespaceSql-createtsconfigSql-createtsdictionarySql-createtsparserSql-createtstemplateSql-createtriggerSql-createtypeSql-createuserSql-createusermappingSql-createviewSql-deallocateSql-declareSql-deleteSql-discardSql-doSql-dropaggregateSql-dropcastSql-dropconversionSql-dropdatabaseSql-dropdomainSql-dropforeigndatawrapperSql-dropfunctionSql-dropgroupSql-dropindexSql-droplanguageSql-dropoperatorSql-dropopclassSql-dropopfamilySql-drop-ownedSql-droproleSql-dropruleSql-dropschemaSql-dropsequenceSql-dropserverSql-droptableSql-droptablespaceSql-droptsconfigSql-droptsdictionarySql-droptsparserSql-droptstemplateSql-droptriggerSql-droptypeSql-dropuserSql-dropusermappingSql-dropviewSql-endSql-executeSql-explainSql-fetchSql-grantSql-insertSql-listenSql-loadSql-lockSql-moveSql-notifySql-prepareSql-prepare-transactionSql-reassign-ownedSql-reindexSql-release-savepointSql-resetSql-revokeSql-rollbackSql-rollback-preparedSql-rollback-toSql-savepointSql-selectSql-selectintoSql-setSql-set-constraintsSql-set-roleSql-set-session-authorizationSql-set-transactionSql-showSql-start-transactionSql-truncateSql-unlistenSql-updateSql-vacuumSql-valuesII. 客户端应用程序App-clusterdbApp-createdbApp-createlangApp-createuserApp-dropdbApp-droplangApp-dropuserApp-ecpgApp-pgconfigApp-pgdumpApp-pg-dumpallApp-pgrestoreApp-psqlApp-reindexdbApp-vacuumdbIII. PostgreSQL服务器应用程序App-initdbApp-pgcontroldataApp-pg-ctlApp-pgresetxlogApp-postgresApp-postmasterVII. 内部章44. PostgreSQL内部概览44.1. 查询路径44.2. 连接是如何建立起来的44.3. 分析器阶段44.4. ThePostgreSQL规则系统44.5. 规划器/优化器44.6. 执行器章45. 系统表45.1. 概述45.2. pg_aggregate45.3. pg_am45.4. pg_amop45.5. pg_amproc45.6. pg_attrdef45.7. pg_attribute45.8. pg_authid45.9. pg_auth_members45.10. pg_cast45.11. pg_class45.12. pg_constraint45.13. pg_conversion45.14. pg_database45.15. pg_db_role_setting45.16. pg_default_acl45.17. pg_depend45.18. pg_description45.19. pg_enum45.20. pg_foreign_data_wrapper45.21. pg_foreign_server45.22. pg_index45.23. pg_inherits45.24. pg_language45.25. pg_largeobject45.26. pg_largeobject_metadata45.27. pg_namespace45.28. pg_opclass45.29. pg_operator45.30. pg_opfamily45.31. pg_pltemplate45.32. pg_proc45.33. pg_rewrite45.34. pg_shdepend45.35. pg_shdescription45.36. pg_statistic45.37. pg_tablespace45.38. pg_trigger45.39. pg_ts_config45.40. pg_ts_config_map45.41. pg_ts_dict45.42. pg_ts_parser45.43. pg_ts_template45.44. pg_type45.45. pg_user_mapping45.46. System Views45.47. pg_cursors45.48. pg_group45.49. pg_indexes45.50. pg_locks45.51. pg_prepared_statements45.52. pg_prepared_xacts45.53. pg_roles45.54. pg_rules45.55. pg_settings45.56. pg_shadow45.57. pg_stats45.58. pg_tables45.59. pg_timezone_abbrevs45.60. pg_timezone_names45.61. pg_user45.62. pg_user_mappings45.63. pg_views章46. Frontend/Backend Protocol46.1. Overview46.2. Message Flow46.3. Streaming Replication Protocol46.4. Message Data Types46.5. Message Formats46.6. Error and Notice Message Fields46.7. Summary of Changes since Protocol 2.047. PostgreSQL Coding Conventions47.1. Formatting47.2. Reporting Errors Within the Server47.3. Error Message Style Guide章48. Native Language Support48.1. For the Translator48.2. For the Programmer章49. Writing A Procedural Language Handler章50. Genetic Query Optimizer50.1. Query Handling as a Complex Optimization Problem50.2. Genetic Algorithms50.3. Genetic Query Optimization (GEQO) in PostgreSQL50.4. Further Reading章51. 索引访问方法接口定义51.1. 索引的系统表记录51.2. 索引访问方法函数51.3. 索引扫描51.4. 索引锁的考量51.5. 索引唯一性检查51.6. 索引开销估计函数章52. GiST Indexes52.1. Introduction52.2. Extensibility52.3. Implementation52.4. Examples52.5. Crash Recovery章53. GIN Indexes53.1. Introduction53.2. Extensibility53.3. Implementation53.4. GIN tips and tricks53.5. Limitations53.6. Examples章54. 数据库物理存储54.1. 数据库文件布局54.2. TOAST54.3. 自由空间映射54.4. 可见映射54.5. 数据库分页文件章55. BKI后端接口55.1. BKI 文件格式55.2. BKI命令55.3. 系统初始化的BKI文件的结构55.4. 例子章56. 规划器如何使用统计信息56.1. 行预期的例子VIII. 附录A. PostgreSQL错误代码B. 日期/时间支持B.1. 日期/时间输入解析B.2. 日期/时间关键字B.3. 日期/时间配置文件B.4. 日期单位的历史C. SQL关键字D. SQL ConformanceD.1. Supported FeaturesD.2. Unsupported FeaturesE. Release NotesRelease-0-01Release-0-02Release-0-03Release-1-0Release-1-01Release-1-02Release-1-09Release-6-0Release-6-1Release-6-1-1Release-6-2Release-6-2-1Release-6-3Release-6-3-1Release-6-3-2Release-6-4Release-6-4-1Release-6-4-2Release-6-5Release-6-5-1Release-6-5-2Release-6-5-3Release-7-0Release-7-0-1Release-7-0-2Release-7-0-3Release-7-1Release-7-1-1Release-7-1-2Release-7-1-3Release-7-2Release-7-2-1Release-7-2-2Release-7-2-3Release-7-2-4Release-7-2-5Release-7-2-6Release-7-2-7Release-7-2-8Release-7-3Release-7-3-1Release-7-3-10Release-7-3-11Release-7-3-12Release-7-3-13Release-7-3-14Release-7-3-15Release-7-3-16Release-7-3-17Release-7-3-18Release-7-3-19Release-7-3-2Release-7-3-20Release-7-3-21Release-7-3-3Release-7-3-4Release-7-3-5Release-7-3-6Release-7-3-7Release-7-3-8Release-7-3-9Release-7-4Release-7-4-1Release-7-4-10Release-7-4-11Release-7-4-12Release-7-4-13Release-7-4-14Release-7-4-15Release-7-4-16Release-7-4-17Release-7-4-18Release-7-4-19Release-7-4-2Release-7-4-20Release-7-4-21Release-7-4-22Release-7-4-23Release-7-4-24Release-7-4-25Release-7-4-26Release-7-4-27Release-7-4-28Release-7-4-29Release-7-4-3Release-7-4-30Release-7-4-4Release-7-4-5Release-7-4-6Release-7-4-7Release-7-4-8Release-7-4-9Release-8-0Release-8-0-1Release-8-0-10Release-8-0-11Release-8-0-12Release-8-0-13Release-8-0-14Release-8-0-15Release-8-0-16Release-8-0-17Release-8-0-18Release-8-0-19Release-8-0-2Release-8-0-20Release-8-0-21Release-8-0-22Release-8-0-23Release-8-0-24Release-8-0-25Release-8-0-26Release-8-0-3Release-8-0-4Release-8-0-5Release-8-0-6Release-8-0-7Release-8-0-8Release-8-0-9Release-8-1Release-8-1-1Release-8-1-10Release-8-1-11Release-8-1-12Release-8-1-13Release-8-1-14Release-8-1-15Release-8-1-16Release-8-1-17Release-8-1-18Release-8-1-19Release-8-1-2Release-8-1-20Release-8-1-21Release-8-1-22Release-8-1-23Release-8-1-3Release-8-1-4Release-8-1-5Release-8-1-6Release-8-1-7Release-8-1-8Release-8-1-9Release-8-2Release-8-2-1Release-8-2-10Release-8-2-11Release-8-2-12Release-8-2-13Release-8-2-14Release-8-2-15Release-8-2-16Release-8-2-17Release-8-2-18Release-8-2-19Release-8-2-2Release-8-2-20Release-8-2-21Release-8-2-3Release-8-2-4Release-8-2-5Release-8-2-6Release-8-2-7Release-8-2-8Release-8-2-9Release-8-3Release-8-3-1Release-8-3-10Release-8-3-11Release-8-3-12Release-8-3-13Release-8-3-14Release-8-3-15Release-8-3-2Release-8-3-3Release-8-3-4Release-8-3-5Release-8-3-6Release-8-3-7Release-8-3-8Release-8-3-9Release-8-4Release-8-4-1Release-8-4-2Release-8-4-3Release-8-4-4Release-8-4-5Release-8-4-6Release-8-4-7Release-8-4-8Release-9-0Release-9-0-1Release-9-0-2Release-9-0-3Release-9-0-4F. 额外提供的模块F.1. adminpackF.2. auto_explainF.3. btree_ginF.4. btree_gistF.5. chkpassF.6. citextF.7. cubeF.8. dblinkContrib-dblink-connectContrib-dblink-connect-uContrib-dblink-disconnectContrib-dblinkContrib-dblink-execContrib-dblink-openContrib-dblink-fetchContrib-dblink-closeContrib-dblink-get-connectionsContrib-dblink-error-messageContrib-dblink-send-queryContrib-dblink-is-busyContrib-dblink-get-notifyContrib-dblink-get-resultContrib-dblink-cancel-queryContrib-dblink-get-pkeyContrib-dblink-build-sql-insertContrib-dblink-build-sql-deleteContrib-dblink-build-sql-updateF.9. dict_intF.10. dict_xsynF.11. earthdistanceF.12. fuzzystrmatchF.13. hstoreF.14. intaggF.15. intarrayF.16. isnF.17. loF.18. ltreeF.19. oid2nameF.20. pageinspectF.21. passwordcheckF.22. pg_archivecleanupF.23. pgbenchF.24. pg_buffercacheF.25. pgcryptoF.26. pg_freespacemapF.27. pgrowlocksF.28. pg_standbyF.29. pg_stat_statementsF.30. pgstattupleF.31. pg_trgmF.32. pg_upgradeF.33. segF.34. spiF.35. sslinfoF.36. tablefuncF.37. test_parserF.38. tsearch2F.39. unaccentF.40. uuid-osspF.41. vacuumloF.42. xml2G. 外部项目G.1. 客户端接口G.2. 过程语言G.3. 扩展H. The Source Code RepositoryH.1. Getting The Source Via GitI. 文档I.1. DocBookI.2. 工具集I.3. 制作文档I.4. 文档写作I.5. 风格指导J. 首字母缩略词参考书目BookindexIndex
文字

31.3. 命令执行函数

一旦与数据库服务器的连接成功建立,便可用这里描述的函数执行SQL查询和命令。

31.3.1. 主函数

PQexec

给服务器提交一条命令并且等待结果。

PGresult *PQexec(PGconn *conn,const char *command);

返回一个PGresult指针或者也可能是一个NULL指针。通常返回一个非空的指针, 除非没有内存或发生了象不能把命令发送到服务器这样的严重错误。如果返回的是NULL, 它应该被当作PGRES_FATAL_ERROR结果处理。用PQerrorMessage获取有关错误的更多信息。

我们可以在命令行字串里包含多个SQL命令(用分号分隔)。在一次PQexec调用中发送的多个查询是在一 个事务里处理的,除非在查询字串里有明确的BEGIN/COMMIT命令用于把整个字串分隔成多个事务。 请注意这样返回的PGresult结构只描述字串里执行的最后一条命令的结果。如果有一个命令失败, 那么字串处理的过程就会停止并且返回的PGresult会描述错误条件。

PQexecParams

向服务器提交一条命令并且等待结果,还有额外的传递与SQL命令文本独立的参数的能力。

PGresult *PQexecParams(PGconn *conn,
                       const char *command,
                       int nParams,
                       const Oid *paramTypes,
                       const char * const *paramValues,
                       const int *paramLengths,
                       const int *paramFormats,
                       int resultFormat);

PQexecParams类似PQexec,但是提供了额外的功能:参数值可以独立于命令串进行声明, 并且可以要求查询结果的格式是文本或者二进制格式。PQexecParams只是在协议3.0以及以后的版本中支持; 在使用2.0的版本的时候会失败。

函数的参数是:

conn

连接对象通过发送命令。

command

要执行的SQL命令字符串。如果使用参数, 他们被称为命令字符串作为$1$2等等。

nParams

提供的参数数目;它是paramTypes[]paramValues[]paramLengths[],a和paramFormats[].数组的长度 ( 数组指针可以是NULL,当nParams为零。)

paramTypes[]

通过OID,将声明数据类型指定到参数标记。如果paramTypesNULL, 或数组中任何的特定参数是0,服务器为参数标记推断数据类型,采用的方式与一个未定义类型 的文本字符串相同。

paramValues[]

声明参数的实际值。在这个数组中的一个空指针表示相应的参数是空; 要么指针指向一个以零结尾的文本字符串或以服务器希望的方式存在的二进制数据。

paramLengths[]

为二进制格式的参数声明实际数据长度,该设置忽略空参数或文本格式的参数。 如果没有二进制参数,那么数组指针可以为空。

paramFormats[]

声明参数为一个文本(为相应参数在数组条目中放置一个0)还是一个二进制格式 (为相应参数在一个数组条目中放置一个1)。 如果数组指针是空,那么所有参数被看做是文本字符串。

以二进制格式传递的值需要能够被后台识别的内部表示。 例如,整数必须以网络字节顺序来传递; 传递numeric时需要服务器存储格式的识别,如在src/backend/utils/adt/numeric.c::numeric_send()src/backend/utils/adt/numeric.c::numeric_recv()中那样。

resultFormat

声明0用于以文本格式获得结果,或1用于以二进制格式获得结果。 (目前没有规定以不同的格式来获取不同的结果列,即使底层协议中可能实现)。

PQexecParamsPQexec主要优势是 参数值可以分开字符串命令,从而避免了繁琐和容易出错的需要 引用和逃逸。

PQexec不同的是,PQexecParams在一个给出的字串里最多允 许一个 SQL 命令。(里面可以有分号,但是不得超过一个非空的命令。)这是下层的协议的一个限制, 但是也有些额外的好处,比如可以有另外一层防止SQL攻击的层次。

Tip: 提示: 通过OID声明参数类型是非常烦琐的,尤其是你不希望在你的程序里写死特定的 OID 值的时候。 不过,你可以避免这么做,即使在服务器自己无法判断参数类型,或者是选择了一种与你预期不同的 参数类型的时候也一样。在 SQL 命令文本里,给参数负号附加一个明确的类型转换, 显示你准备发送的数据类型。比如:

SELECT * FROM mytable WHERE x = $1::bigint;

这样强制参数$1当作bigint看待,即使缺省情况下它会被赋予和x。一样的类型。 在以二进制格式发送参数值的时候,我们强烈建议通过这种方法或者是声明数字类型OID的方法强制类型判断, 因为二进制格式比文本格式少一些冗余,因此服务器就会少一些机会捕捉类型的错误匹配。

PQprepare

用给定的参数提交请求,创建一个准备好的语句,然后等待结束。

PGresult *PQprepare(PGconn *conn,
                    const char *stmtName,
                    const char *query,
                    int nParams,
                    const Oid *paramTypes);

PQprepare创建一个为后面PQexecPrepared执行用的准备好语句。这个特性允许那 些重复使用的语句只分析和规划一次,而不是每次执行都分析规划。这个语句必须在当前 会话的前面已经准备好。只是在协议3.0和以后的连接里支持PQprepare; 在使用2.0协议的时候,它会失败。

这个函数从query字串里创建一个叫stmtName的准备好的语句,query 必须只包含 一个 SQL 命令。stmtName可以是"",这样就创建一个无名的语句,这种情况下,任何前面 存在的无名语句都会自动被代替;否则,如果语句名已经在当前会话里定义,那就是一个错误。 如果使用了参数,那么在查询里它们引用成$1$2等等。nParams是参数的个数,参数的类型在 数组paramTypes[]里事先声明好了。(如果 nParams 是零,那么这个数组指针可以是NULL。) paramTypes[]. 用 OID 的方式声明与参数符号关联的数据类型。如果paramTypesNULL,或者数组中 某个特定元素是零,那么服务器将用处理无类型文本同样的方法给这个参数符号赋予数据类型。还有, 查询可以使用比 nParams 数值更大的参数符号编号;这些参数的数据类型也是用一样的方法推导的。 (见 PQdescribePrepared作为一种手段,以找出> 什么样的数据类型推断。)

PQexec似,结果通常是一个PGresult对象,其内容表明服务器端是成功还是失败。 空的结果表示内存耗尽或者完全不能发送命令。使用PQerrorMessage获取有关这类错误的更多信息。

用于PQexecPrepared的准备好语句也可以通过执行 SQLPREPARE语句来创建。 (不过 PQprepare 更灵活,因为它不要求预先声明参数类型。)还有,尽管没有libpq函数 可以删除一个准备好语句,SQLDEALLOCATE语句却可以删除。

PQexecPrepared

发送一个请求,执行一个带有给出参数的准备好的语句,并且等待结果。

PGresult *PQexecPrepared(PGconn *conn,
                         const char *stmtName,
                         int nParams,
                         const char * const *paramValues,
                         const int *paramLengths,
                         const int *paramFormats,
                         int resultFormat);

PQexecPreparedPQexecParams类似,但是要执行的命令是通过命名一个前面准备好的语句声明的, 而不是给出一个查询字串。这个特性允许那些要重复使用的命令只进行一次分析和规划, 而不是每次执行都来一遍。PQexecPrepared只在协议 3.0 和以后的版本里支持; 在使用 2.0 版本的协议的时候,它们会失败。

参数和PQexecParams一样,只是给出的是一个准备好语句的名字,而不是一个查询字串, 并且没有paramTypes[]参数(没必要,因为准备好语句的参数类型是在创建的时候确定的)。

PQdescribePrepared

提交请求以获取有关指定的信息 准备的声明,并等待完成。

PGresult *PQdescribePrepared(PGconn *conn,const char *stmtName);

PQdescribePrepared允许应用程序获取 有关先前准备的语句。PQdescribePrepared只在协议 3.0 和以后的版本里支持; 在使用 2.0 版本的协议的时候,它们会失败。

stmtName可以是""NULL以指向未命名声明, 要么必须与现有的预处理声明同名,成功时,会返回一个带有PGRES_COMMAND_OKPGresult。 可以在这个PGresult中使用PQnparamsPQparamtype函数以 获得预处理声明中的参数信息,同时PQnfieldsPQfnamePQftype 三个函数提供声明的结果列的信息。

PQdescribePortal

提交请求以获取有关指定的信息 门户网站,并等待完成......

PGresult *PQdescribePortal(PGconn *conn,const char *portalName);

PQdescribePortal允许应用程序获得关于之前创建的端口的信息。 (libpq不提供与端口的直接连接,但可以使用这个函数来检查 DECLARE CURSOR命令创建的游标的属性)。PQdescribePortal 只支持3.0及其之后的连接协议。

portalName可以是""NULL以指向未命名端口, 要么必须与现有的端口同名,成功时,会返回一个带有PGRES_COMMAND_OKPGresult。 可以在这个PGresult中使用PQnfieldsPQfnamePQftype函数以 获得端口的结果列的信息。

PGresult结构封装了服务器返回的结果。 libpq应该小心维护PGresult的抽象。 使用下面的访问函数获取PGresult的内容。 避免直接引用PGresult里面的字段 ,因为它们在未来版本里可能会被修改。

PQresultStatus

返回命令的结果状态。

ExecStatusType PQresultStatus(const PGresult *res);

PQresultStatus可以返回下面数值之一:

PGRES_EMPTY_QUERY

发送给服务器的字串是空的

PGRES_COMMAND_OK

成功完成一个不返回数据的命令

PGRES_TUPLES_OK

成功执行一个返回数据的查询查询(比如SELECT或者SHOW)。

PGRES_COPY_OUT

(从服务器)Copy Out (拷贝出)数据传输开始

PGRES_COPY_IN

Copy In(拷贝入)(到服务器)数据传输开始

PGRES_BAD_RESPONSE

服务器的响应无法理解

PGRES_NONFATAL_ERROR

发生了一个非致命错误(通知或者警告)

PGRES_FATAL_ERROR

发生了一个致命错误

如果结果状态是PGRES_TUPLES_OK,那么可以用下面的函数从查询的返回中抽取元组信息。 注意一个碰巧检索了零条元组的SELECT仍然显示PGRES_TUPLES_OKPGRES_COMMAND_OK 用于不返回元组的命令(INSERTUPDATE等)。返回PGRES_EMPTY_QUERY 的响应通常意味着暴露了客户端软件里面的臭虫。

状态为PGRES_NONFATAL_ERROR的结果永远不会直接由PQexec或者其它查询执行函数返回; 这类的结果会被传递给通知处理器(参阅Section 31.11)。

PQresStatus

把PPQresultStatus返回的枚举类型转换成一个描述状态码的字符串常量。 调用者不应该释放结果。

char *PQresStatus(ExecStatusType status);

PQresultErrorMessage

返回与查询关联的错误信息,或在没有错误时返回一个空字符串。

char *PQresultErrorMessage(const PGresult *res);

如果有错误,那么返回的字串将包括一个结尾的新行。调用者不应该直接释放结果。 在相关的PGresult句柄传递给PQclear之后,它会自动释放。

紧跟在一个PQexecPQgetResult调用后面,PQerrorMessage(对连接)将返回 与PQresultErrorMessage(对结果)一样的字符串。不过,一个PGresult将保有其错误信息直到被删除, 而连结的错误信息将在后续的操作完成时被改变。当你想知道与某个PGresult相关联的状态时 用PQresultErrorMessage;当你想知道与连接的最近一个操作相关联的状态时用PQerrorMessage

PQresultErrorField

返回一个独立的错误报告字段。

char *PQresultErrorField(const PGresult *res,int fieldcode);

fieldcode是一个错误字段标识符;参阅下面列出的符号。如果PGresult不是错误或者警告结 果或者不包括指定的字段,那么返回NULL。字段值通常将不包括结尾的新行。调用者不应该直接释放结果。 在相关联的PGresult句柄传递给PQclear之后,它将被自动释放。

The following field codes are available: 下列代码是可用的:

PG_DIAG_SEVERITY

严重程度,这个字段的内容是ERRORFATAL或者PANIC(在错误信息里), 或者WARNINGNOTICEDEBUGINFOLOG(在注意信息里), 或者是这些东西的一个本地化翻译。总是出现。 PG_DIAG_SQLSTATE

PG_DIAG_SQLSTATE

这个错误的 SQLSTATE 代码。SQLSTATE 代码表示所发生的错误的类型; 可以由前端应用用于对特定的数据库错误执行特定的操作(比如错误处理)。关于可能 的 SQLSTATE 代码的列表,请参阅Appendix A。这个字段是不能区域化的,并且总是出现。

PG_DIAG_MESSAGE_PRIMARY

主要的人类可读错误的信息(通常一条线)。 Always present.

PG_DIAG_MESSAGE_DETAIL

细节:一个可选的从属错误信息,里面有更多有关该问题的细节。可能有多行。

PG_DIAG_MESSAGE_HINT

提示:一个可选的有关如何处理该问题的建议。它和细节的区别是它提供了建议 (可能不太合适)而不光是事实。可能有好几行。

PG_DIAG_STATEMENT_POSITION

一个包含十进制整数的字串,当作一个错误游标使用,指出最初的语句串出错的地方的下标。 第一个字符的索引是 1,并且这个位置是用字符计,而不是用字节计。

PG_DIAG_INTERNAL_POSITION

这个和PG_DIAG_STATEMENT_POSITION字段定义是一样的,区别是它用于内部生成的命令的下标指示, 而不是客户端提交的命令。如果出现了这个字段,那么PG_DIAG_INTERNAL_QUERY字段也总是出现。

PG_DIAG_INTERNAL_QUERY

一个失败的内部生成的命令的文本。比如,这个可能是一个 PL/pgSQL 函数发出的 SQL 查询。

PG_DIAG_CONTEXT

一个指示器,表明错误发生的环境。目前这个包括活跃的过程语言函数和内部生成的查询的调用堆栈。 堆栈是每行一条,最近的在上面。

PG_DIAG_SOURCE_FILE

所报告的错误的源代码位置的所在文件。

PG_DIAG_SOURCE_LINE

报告的这个错误所在的源代码位置的行号。

PG_DIAG_SOURCE_FUNCTION

报告这个错误的源代码函数的名字。

按照自身的要求格式化显示信息是客户端的责任;特别是根据需要对长行进行折行。在错误信息字段里出现的新行字符应该当作分段符号,而不是换行。

libpq生成的错误将会有严重性和主信息,但是通常没有其它字段。3.0 协议之前返回的错误 将包含严重性和主信息,有时候还有详细信息,但是没有其它字段。

请注意这些错误字段只能从PGresult对象里获得, 而不是PGconn对象;没有PQerrorField函数。

PQclear

PQclear释放于PGresult相关联的存储空间。 任何不再需要的查询结果在不需要的时候都应该用PQclear释放掉。

void PQclear(PGresult *res);

只要你需要,你可以保留PGresult对象任意长的时间; 当你提交新的查询时它并不消失, 甚至你断开连接后也是这样。要删除它,你必须调用PQclear。 不这么做将导致你的应用中的内存泄漏。

31.3.2. Retrieving Query Result Information检索查询结果信息

这些函数用于从一个代表着成功查询结果(也就是说,状态为PGRES_TUPLES_OK的查询)的PGresult对象。 对于其它状态值的对象,他们的行为会好像他们有零行和零列一样。

PQntuples

返回查询结果里的行(元组)个数。因为在32位操作系统 它返回一个整数的结果,大型结果集可能溢出返回值。

int PQntuples(const PGresult *res);

PQnfields

返回查询结果里数据行的数据域(字段)的个数。

int PQnfields(const PGresult *res);

PQfname

返回与给出的数据域编号相关联的数据域(字段)的名称。数据域编号从 0 开始。 调用者不应该直接释放结果。在相关联的PGresult 句柄传递给PQclear之后,结果会被自动释放。

char *PQfname(const PGresult *res,
              int column_number);

如果字段编号超出范围,那么返回NULL

PQfnumber

返回与给出的数据域名称相关联的数据域(字段)的编号。

int PQfnumber(const PGresult *res,
              const char *column_name);

如果给出的名字不匹配任何字段,返回 -1。

给出的名字是当作 SQL 命令里的一个标识符看待的,也就是说,如果没有加双引号, 那么会转换为小写。比如,如果我们有一个从 SQL 命令里生成的查询结果

SELECT 1 AS FOO,2 AS "BAR";

那么我们会有下面的结果:

PQfname(res,0)          foo
PQfname(res,1)          BAR
PQfnumber(res,"FOO")    0
PQfnumber(res,"foo")    0
PQfnumber(res,"BAR")    -1
PQfnumber(res,"\"BAR\"")1

PQftable

返回我们抓取的字段所在的表的 OID。字段编号从 0 开始。

Oid PQftable(const PGresult *res,
             int column_number);

如果字段编号超出了范围,或者声明的字段不是一个指向某个表的字段的简单引用, 或者使用了 3.0 版本之前的协议,那么就会返回InvalidOid。 你可以查询系统表pg_class来判断究竟引用了哪个表。

在你包含libpq头文件的时候, 就会定义类型Oid和常量InvalidOid。 他们都是相同的整数类型。

PQftablecol

返回组成声明的查询结果字段的字段号(在它的表内部)。查询结果字段编号从 0 开始,但是表字段编号不会是 0。

int PQftablecol(const PGresult *res,
                int column_number);

如果字段编号超出范围,或者声明的字段并不是一个表字段的简单引用,或者使用的是 3.0 之前的协议,那么返回零。

PQfformat

返回说明给出字段的格式的格式代码。字段编号从 0 开始。

int PQfformat(const PGresult *res,
              int column_number);

格式码为 0 表示文本数据,而格式码是一表示二进制数据。 (其它编码保留给将来定义。)

PQftype

返回与给定数据域编号关联的数据域类型。 返回的整数是一个该类型的内部 OID 号。数据域编号从0 开始。

Oid PQftype(const PGresult *res,
            int column_number);

你可以查询系统表pg_type以获取各种数据类型的名称和属性。 内建的数据类型的 OID 在源码树的src/include/catalog/pg_type.h文件里定义。

PQfmod

返回与给定字段编号相关联的类型修饰词。 字段编号从 0 开始。

int PQfmod(const PGresult *res,
           int column_number);

类型修饰符的值是类型相关的;他们通常包括精度或者尺寸限制。数值 -1 用 于表示"没有可用信息"。大多数数据类型不用修饰词,这种情况下该值总是 -1。

PQfsize

返回与给定字段编号关联的字段以字节计的大小。 字段编号从0 开始。

int PQfsize(const PGresult *res,
            int column_number);

PQfsize返回在数据库行里面给该数据字段分配的空间,换句话说就是该数据类型在 服务器里的二进制形式的大小(尺寸)。(因此,这个对客户端没有什么用。) 如果该数据域是可变尺寸,返回 -1。

PQbinaryTuples

如果PGresult包含二进制元组数据时返回 1, 如果包含 ASCII 数据返回 0。

int PQbinaryTuples(const PGresult *res);

这个函数已经废弃了(除了还用于与COPY连接之外),因为我们可能在 一个PGresult的某些字段里包含文本数据,而另外一些字段包含二进制数据 。更好的是使用PQfformatPQbinaryTuples只有在结果中的所有字段 都是二进制(格式 1)的时候才返回 1。

PQgetvalue

返回一个PGresult里面一行的单独的一个字段的值。行和字段编号从 0 开始。 调用者不应该直接释放结果。在把PGresult句柄传递给PQclear之后, 结果会被自动释放。

char *PQgetvalue(const PGresult *res,
                 int row_number,
                 int column_number);

对于文本格式的数据,PQgetvalue返回的值是一个表示字段值的空(NULL) 结尾的字符串。对于二进制格式,返回的值就是由该数据类型的typsendtypreceive决定的二进制表现形式。(在这种情况下,数值实际上也跟着一个字节零, 但是通常这个字节没什么用处,因为数值本身很可能包含内嵌的空。)

如果字段值是空,则返回一个空字串。参阅PQgetisnull来区别空值和空字串值。

PQgetvalue返回的指针指向一个本身是PGresult结构的一部分的存储区域。我们不能更改它, 并且如果我们要在PGresult结构的生存期后还要使用它的话, 我们必须明确地把该数值拷贝到其他存储器中。

PQgetisnull

测试一个字段是否为空(NULL)。行和字段编号从 0 开始。

int PQgetisnull(const PGresult *res,
                int row_number,
                int column_number);

如果该域包含 NULL,函数返回 1,如果包含非空(non-null )值,返回 0。 (注意,对一个 NULL 数据域,PQgetvalue将返回一个空字符串,不是一个空指针。)

PQgetlength

返回以字节计的字段的长度。行和字段编号从 0 开始。

int PQgetlength(const PGresult *res,
                int row_number,
                int column_number);

这是某一特定数据值的实际数据长度。行和字段编号从 0 开始。 这是特定数值的实际数据长度,也就是说,PQgetvalue指向的对象的大小。 对于文本数据格式,它和strlen()相同。对于二进制格式,这是潜在的信息。 请注意我们不应该依靠PQfsize获取实际数据长度。

PQnparams

返回一份声明中的参数的数目。

int PQnparams(const PGresult *res);

检查的结果时,这个功能是非常有用的 PQdescribePrepared。对于其他类型的查询 将返回零。

PQparamtype

返回指示语句中的参数的数据类型。 参数编号从0开始。

Oid PQparamtype(const PGresult *res,int param_number);

检查的结果时,这个功能是非常有用的 PQdescribePrepared。对于其他类型的查询 将返回零。

PQprint

向指定的输出流打印所有的行和(可选的)字段名称。

void PQprint(FILE *fout,/* output stream */
             const PGresult *res,
             const PQprintOpt *po);
typedef struct
{
    pqbool  header;      /* 打印输出域头和行计数*/
    pqbool  align;       /*填充对齐各字段*/
    pqbool  standard;    /* 旧的傻格式  */
    pqbool  html3;       /* 输出 HTML 表 */
    pqbool  expanded;    /* 扩展表*/
    pqbool  pager;       /* 必要时在输出中使用分页器 */
    char    *fieldSep;   /* 字段分隔符*/
    char    *tableOpt;   /* 在 HTML 中插入 table ... */
    char    *caption;    /* HTML caption */
    char    **fieldName; /* 替换字段名组成的空零结尾的数组*/
} PQprintOpt;

这个函数以前被psql用于打印查询结果,但是现在已经不用这个函数了。请注意它假设所有的数据都是文本格式。

31.3.3. 检索其它命令的结果信息

这些函数用于从PGresult对象里检索那些非 SELECT 结果的信息。

PQcmdStatus

返回产生PGresult的 SQL 命令的命令状态字符串。

char *PQcmdStatus(PGresult *res);

通常这只是命令的名字,但是它可能包括额外的数据,比如处理过的行数。调用者不应该释放 结果。结果会在把PGresult句柄传递给PQclear的时候释放。

PQcmdTuples

返回被 SQL 命令影响的行的数量。

char *PQcmdTuples(PGresult *res);

这个函数返回一个生成这个PGresult的这个SQL语句影响的行数的字串。 这个函数只能用于SELECTCREATE TABLE ASINSERTUPDATEDELETEMOVEFETCH,或者COPY或者COPYEXECUTE语句执行之后的结果。 或者是一个包含INSERTUPDATEDELETE或者DELETE语句EXECUTE的一个准备好的查询。 如果生成这个PGresult的命令是其他的东西,那么 PQcmdTuples 返回一个空字串。 调用者不应该直接释放返回的数值。在相关联的PGresult被传递给PQclear之后, 它会被自动释放。

PQoidValue

返回一个插入的行的对象标识()—— 如果SQL命令是INSERT, 或者是一个包含合适INSERT语句的准备好的EXECUTE的时候。否则, 函数返回InvalidOid。如果受INSERT影响的表不包含 OID, 也返回InvalidOid

Oid PQoidValue(const PGresult *res);

PQoidStatus

如果SQL命令是INSERT,或者包含合适INSERT的准备好语句EXECUTE了。 返回一个被插入的行的 OID 的字串。(如果INSERT并非恰好插入一行, 或者目标表没有OID,那么字串将是0。) 如果命令不是INSERT,则返回一个空字串。

char *PQoidStatus(const PGresult *res);

这个函数已经废弃了,因为有了PQoidValue,而且它也不是线程安全的。

31.3.4. 逃逸包含在 SQL 命令中的字串

PQescapeLiteral

char *PQescapeLiteral(PGconn *conn,const char *str,size_t length);

PQescapeLiteral为在 SQL 命令中使用字串而对之进行逃逸处理。在我们向 SQL 命令里把数据值当作文本常量插入的时候很有用。有些字符(比如单引号和反斜杠) 必须被逃逸,以避免他们被 SQL 分析器作为特殊字符解析。 PQescapeLiteral执行这个操作。

PQescapeLiteral返回一个内存中分配有malloc()str参数 的逃逸版本。当结果不在需要时,需要通过PQfreemem()来释放这块内存。 不需要一个0字节结束,并且不应以length排序。 (如果在处理length字节之前出现0字节的结束,PQescapeLiteral在此处结束; 不同于strncpy)。返回的字符串包含所有更换的声明的字符,因此 可以很好的被PostgreSQL字符串文本解析器处理,同样,允许增加一个0字节结尾。 必须在PostgreSQL字符串文本两边的单引号包含在结果字符串中。

一旦错误,PQescapeLiteral返回NULL和在CONN对象存储合适的信息。

Tip: 处理从不可信来源收到的字符串是必须进行合适的逃逸,否则存在一定的安全风险: 容易受到"SQL injection"攻击,数据库中会被写入未知的SQL命令。

需要注意的是,当一个数据以PQexecParams或它的兄弟格式,作为一个单独的参数传递时, 做逃逸是不必要,也是不正确的。

PQescapeIdentifier

char *PQescapeIdentifier(PGconn *conn,const char *str,size_t length);

PQescapeIdentifier逃逸一个字符串作为一个SQL标识符使用,如 一个表,列,或函数名。当一个用户自定义标识符需要包含特殊的字符,否则将不能被SQL解析器解析为标识符的一部分时, 或者当标识符需要包含大写字母,且这种情况必须保留时,这样做是很有用的。

PQescapeIdentifier返回str参数逃逸为一个内存中分配有malloc()的SQL标识符 的版本。当结果不再需要时,这块内存必须使用PQfreemem()来释放。 不需要一个0字节结束,并且不应以length排序。 (如果在处理length字节之前出现0字节的结束,PQescapeLiteral在此处结束; 不同于strncpy)。返回的字符串包含所有更换的声明的字符,因此 可以很好的被PostgreSQL字符串文本解析器处理,同样,允许增加一个0字节结尾。 返回结果也是被双引号环绕。

出错时,PQescapeIdentifier返回NULL,并且在conn对象中存贮合适的信息。

Tip: 由于带有字符串常量,为阻止SQL攻击,当从一个不可信任资源获得时,SQL标识符必须逃逸。

PQescapeStringConn

size_t PQescapeStringConn(PGconn *conn,
                          char *to,const char *from,size_t length,
                          int *error);

PQescapeStringConn逃逸字符串常量,必须同于PQescapeLiteral。 不同于PQescapeLiteral,请求应该提供一个适当大小的缓冲区。 更重要的是,PQescapeStringConn不会生成一个必须在PostgreSQL字符串 常量两端的单引号;SQL命令中应该提供,这样结果中会被插入。 from参数指向字符串的第一个字符(用以逃逸), length参数指出了在这个字符串中的字节数。 不需要一个0字节结束,并且不应以length排序。 (如果在处理length字节之前出现0字节的结束,PQescapeLiteral在此处结束; 不同于strncpy)。to应该指向一个包含至少多余两倍length大小的 缓冲区,要么就不会定义该行为。如果tofrom字符串交叠,那么 也不会定义该行为。

error参数非NULL,那么在成功的时候*error会被设置为空, 失败的时候设置为非0。目前唯一可能的错误条件涉及在源字符串中无效的多字节编码。 输出字符串同样产生错误,但服务器可以视其为异常以拒绝。一旦发生错误,一条合适的信息会存储在conn对象中, 无论error是否为NULL

PQescapeStringConn返回写到to的字节数,不包含0字节终止。

PQescapeString

PQescapeString是一个老的,已经被PQescapeStringConn弃用了的版本。

size_t PQescapeString (char *to,const char *from,size_t length);

PQescapeStringConn唯一的不同是,PQescapeString不适用PGconnerror参数。 因此,不能够根据连接属性(如字符编码)来调整其行为,因此可能会给出错误的结果,同样, 不会报告错误条件。

PQescapeString可以在客户端编程(一次只有一个PostgreSQL连接)中安全的使用。 在这种情况下,它可以找到"在屏幕背后"想要知道的。 在其他情况下,这是一个安全隐患,在使用PQescapeStringConn应该避免。

PQescapeByteaConn

逃逸那些在 SQL 命令中使用的用bytea表示的二进制数据。和PQescapeStringConn一样, 这个函数只有在直接向 SQL 字串插入数据的时候使用。

unsigned char *PQescapeByteaConn(PGconn *conn,
                                 const unsigned char *from,
                                 size_t from_length,
                                 size_t *to_length);

SQL语句中用做bytea字串文本的一部分的时候,有些字节值必需逃逸(但是对于所有字节而言是可以逃逸), PQescapeByteaConn执行这个操作,它只逃逸需要逃逸的最少的字符。参阅Section 8.4获取更多信息。

from参数指向需要逃逸的字串的第一个字节,from_length参数反映在这个二进制字串( 结尾的字节零既不必要也不计算在内的字串)里字节的个数。to_length参数应该是一个指向某个缓冲区的指针, 它的空间应该能够保存逃逸后的结果字串长度。结果字串长度不包括结果结尾的字节零。

PQescapeByteaConn在内存重返回一个from参数的二进制字串的逃逸后的版本, 这片内存是用malloc()分配的(如果无法分配内存,则返回空指针)。在不再需要结果的时候, 必须用PQfreemem()释放它。返回的字串已经把所有特殊的字符替换掉了, 这样他们就可以由PostgreSQL的字串文本分析器以及bytea的输入函数正确地处理。 同时还追加了一个结尾的字节零。那些必需包围在PostgreSQL字串文本周围的单引号并非结果字串的一部分。

当出错时,返回一个空指针,一个合适的错误信息会被储存在conn对象中,事实上唯一可能的错误是结果字符串的内存不足。

PQescapeBytea

PQescapeByteaPQescapeByteaConn的一个旧的,过时的版本。

unsigned char *PQescapeBytea(const unsigned char *from,
                             size_t from_length,
                             size_t *to_length);

PQescapeByteaConn唯一的不同之处在于,PQescapeBytea不使用PGconn参数, 因此,PQescapeBytea可以在客户端编程(一次只有一个PostgreSQL连接)中安全的使用。 在这种情况下,它可以找到"在屏幕背后"想要知道的。 如果在编程中使用多个数据库连接(在这种情况下使用PQescapeByteaConn),那么可能会给出错误结果。

PQunescapeBytea

把一个二进制数据的逃逸后的字串表现形式转换成二进制数据 —PQescapeBytea的反作用。 在以文本格式抽取bytea数据的时候是必须的, 但是在以二进制格式抽取的时候是不必要的。

unsigned char *PQunescapeBytea(const unsigned char *from,size_t *to_length);

from参数指向一个逃逸后的字串,比如PQgetvalue处理过一个bytea字段后返回的。 PQunescapeBytea把它的字串表现形式转换成二进制形式, 它返回一个用malloc()分配的指向该缓冲区的指针,或者是出错时返回空, 缓冲区的尺寸放在to_length里。在不再需要这个结果之后,这片内存必须用PQfreemem释放。

这种PQescapeBytea转换实际上是不可逆的, 因为,当从PQgetvalue接收时,字符串不被希望逃逸。 尤其是,这意味着,不需要考虑字符串引用,并且不需要PGconn参数。

上一篇:下一篇: