2024 年 9 月 26 日: PostgreSQL 17 发布!
支持的版本:当前 (17) / 16 / 15 / 14 / 13 / 12
开发版本:devel
不支持的版本:11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4 / 7.3 / 7.2 / 7.1

34.17. 内部机制 #

本节介绍 ECPG 的内部工作原理。此信息偶尔对用户了解如何使用 ECPG 有用。

ecpg 写入输出的前四行是固定行。其中两行是注释,两行是与库交互所需的 include 行。然后预处理器读取文件并写入输出。通常它只是将所有内容回显到输出。

当它看到 EXEC SQL 语句时,它会介入并更改它。命令以 EXEC SQL 开头,以 ; 结束。两者之间的所有内容都被视为SQL语句并解析以进行变量替换。

当符号以冒号 (:) 开头时,会发生变量替换。具有该名称的变量将在之前在 EXEC SQL DECLARE 部分内声明的变量中查找。

库中最重要的函数是 ECPGdo,它负责执行大多数命令。它接受可变数量的参数。这很容易累积到 50 个左右的参数,我们希望这不会在任何平台上成为问题。

参数是

行号 #

这是原始行的行号;仅在错误消息中使用。

字符串 #

这是SQL要发出的命令。它由输入变量修改,即在编译时未知但在命令中要输入的变量。变量应该放在哪里,字符串包含 ?

输入变量 #

每个输入变量都会创建十个参数。(见下文。)

ECPGt_EOIT #

一个 enum 表示没有更多输入变量。

输出变量 #

每个输出变量都会创建十个参数。(见下文。)这些变量由函数填充。

ECPGt_EORT #

一个 enum 表示没有更多变量。

对于命令中包含的每个变量SQL命令,该函数获得十个参数

  1. 类型作为特殊符号。

  2. 指向值的指针或指向指针的指针。

  3. 如果变量是 charvarchar,则为变量的大小。

  4. 数组中的元素数量(用于数组提取)。

  5. 数组中下一个元素的偏移量(用于数组提取)。

  6. 指示器变量的类型作为特殊符号。

  7. 指向指示器变量的指针。

  8. 0

  9. 指示器数组中的元素数量(用于数组提取)。

  10. 指示器数组中下一个元素的偏移量(用于数组提取)。

注意,并非所有 SQL 命令都以这种方式处理。例如,像这样的打开游标语句

EXEC SQL OPEN cursor;

不会复制到输出。相反,游标的 DECLARE 命令在 OPEN 命令的位置使用,因为它确实打开了游标。

以下是一个完整的示例,描述文件 foo.pgc 的预处理器的输出(细节可能会随着预处理器的每个特定版本而改变)

EXEC SQL BEGIN DECLARE SECTION;
int index;
int result;
EXEC SQL END DECLARE SECTION;
...
EXEC SQL SELECT res INTO :result FROM mytable WHERE index = :index;

被翻译成

/* Processed by ecpg (2.6.0) */
/* These two include files are added by the preprocessor */
#include <ecpgtype.h>;
#include <ecpglib.h>;

/* exec sql begin declare section */

#line 1 "foo.pgc"

 int index;
 int result;
/* exec sql end declare section */
...
ECPGdo(__LINE__, NULL, "SELECT res FROM mytable WHERE index = ?     ",
        ECPGt_int,&(index),1L,1L,sizeof(int),
        ECPGt_NO_INDICATOR, NULL , 0L, 0L, 0L, ECPGt_EOIT,
        ECPGt_int,&(result),1L,1L,sizeof(int),
        ECPGt_NO_INDICATOR, NULL , 0L, 0L, 0L, ECPGt_EORT);
#line 147 "foo.pgc"

(这里缩进是为了可读性,而不是预处理器所做的。)

提交更正

如果您在文档中看到任何不正确的内容,与您对特定功能的体验不符,或者需要进一步说明,请使用 此表格 报告文档问题。