2025年9月25日: PostgreSQL 18 釋出!
支援的版本:當前 (18) / 17 / 16 / 15 / 14 / 13
開發版本:devel
不支援的版本:12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0

43.3. 內建函式 #

43.3.1. 從 PL/Perl 訪問資料庫 #

可以透過以下函式從 Perl 函式訪問資料庫本身:

spi_exec_query(query [, limit])

spi_exec_query 執行 SQL 命令,並將整個行集作為雜湊引用陣列的引用返回。如果指定了 limit 且大於零,則 spi_exec_query 最多檢索 limit 行,很像是查詢包含了一個 LIMIT 子句。省略 limit 或將其指定為零表示不限制行數。

您應該只在此命令結果集相對較小時使用它。 以下是帶有可選最大行數的查詢(SELECT 命令)示例:

$rv = spi_exec_query('SELECT * FROM my_table', 5);

這會從 my_table 表返回最多 5 行。如果 my_table 有一個名為 my_column 的列,您可以像這樣從結果的第 $i 行獲取該值:

$foo = $rv->{rows}[$i]->{my_column};

可以這樣訪問 SELECT 查詢返回的總行數:

$nrows = $rv->{processed}

以下是使用不同命令型別的示例:

$query = "INSERT INTO my_table VALUES (1, 'test')";
$rv = spi_exec_query($query);

您可以透過這種方式訪問命令狀態(例如,SPI_OK_INSERT):

$res = $rv->{status};

要獲取受影響的行數,請執行:

$nrows = $rv->{processed};

這是一個完整的示例:

CREATE TABLE test (
    i int,
    v varchar
);

INSERT INTO test (i, v) VALUES (1, 'first line');
INSERT INTO test (i, v) VALUES (2, 'second line');
INSERT INTO test (i, v) VALUES (3, 'third line');
INSERT INTO test (i, v) VALUES (4, 'immortal');

CREATE OR REPLACE FUNCTION test_munge() RETURNS SETOF test AS $$
    my $rv = spi_exec_query('select i, v from test;');
    my $status = $rv->{status};
    my $nrows = $rv->{processed};
    foreach my $rn (0 .. $nrows - 1) {
        my $row = $rv->{rows}[$rn];
        $row->{i} += 200 if defined($row->{i});
        $row->{v} =~ tr/A-Za-z/a-zA-Z/ if (defined($row->{v}));
        return_next($row);
    }
    return undef;
$$ LANGUAGE plperl;

SELECT * FROM test_munge();
spi_query(command)
spi_fetchrow(cursor)
spi_cursor_close(cursor)

spi_queryspi_fetchrow 配對使用,適用於可能很大的行集,或者您希望在行到達時返回它們的情況。spi_fetchrow spi_query 一起使用。以下示例說明了如何將它們一起使用:

CREATE TYPE foo_type AS (the_num INTEGER, the_text TEXT);

CREATE OR REPLACE FUNCTION lotsa_md5 (INTEGER) RETURNS SETOF foo_type AS $$
    use Digest::MD5 qw(md5_hex);
    my $file = '/usr/share/dict/words';
    my $t = localtime;
    elog(NOTICE, "opening file $file at $t" );
    open my $fh, '<', $file # ooh, it's a file access!
        or elog(ERROR, "cannot open $file for reading: $!");
    my @words = <$fh>;
    close $fh;
    $t = localtime;
    elog(NOTICE, "closed file $file at $t");
    chomp(@words);
    my $row;
    my $sth = spi_query("SELECT * FROM generate_series(1,$_[0]) AS b(a)");
    while (defined ($row = spi_fetchrow($sth))) {
        return_next({
            the_num => $row->{a},
            the_text => md5_hex($words[rand @words])
        });
    }
    return;
$$ LANGUAGE plperlu;

SELECT * from lotsa_md5(500);

通常,應該重複呼叫 spi_fetchrow 直到它返回 undef,表示沒有更多可讀取的行。spi_query 返回的游標在 spi_fetchrow 返回 undef 時會自動釋放。如果您不想讀取所有行,請呼叫 spi_cursor_close 來釋放游標。否則將導致記憶體洩漏。

spi_prepare(command, argument types)
spi_query_prepared(plan, arguments)
spi_exec_prepared(plan [, attributes], arguments)
spi_freeplan(plan)

spi_preparespi_query_preparedspi_exec_preparedspi_freeplan 實現相同的功能,但用於預準備查詢。spi_prepare 接受一個帶有編號引數佔位符($1、$2 等)的查詢字串和一個引數型別的字串列表:

$plan = spi_prepare('SELECT * FROM test WHERE id > $1 AND name = $2',
                                                     'INTEGER', 'TEXT');

透過呼叫 spi_prepare 準備好查詢計劃後,該計劃可以代替字串查詢,無論是用於 spi_exec_prepared(結果與 spi_exec_query 返回的結果相同),還是用於 spi_query_prepared(它返回一個與 spi_query 完全相同的遊標,該遊標稍後可以傳遞給 spi_fetchrow)。spi_exec_prepared 的可選第二個引數是一個屬性的雜湊引用;當前支援的唯一屬性是 limit,它設定從查詢返回的最大行數。省略 limit 或將其指定為零表示不限制行數。

預準備查詢的優勢在於可以為一個以上的查詢執行使用一個預準備計劃。在不再需要該計劃後,可以使用 spi_freeplan 來釋放它。

CREATE OR REPLACE FUNCTION init() RETURNS VOID AS $$
        $_SHARED{my_plan} = spi_prepare('SELECT (now() + $1)::date AS now',
                                        'INTERVAL');
$$ LANGUAGE plperl;

CREATE OR REPLACE FUNCTION add_time( INTERVAL ) RETURNS TEXT AS $$
        return spi_exec_prepared(
                $_SHARED{my_plan},
                $_[0]
        )->{rows}->[0]->{now};
$$ LANGUAGE plperl;

CREATE OR REPLACE FUNCTION done() RETURNS VOID AS $$
        spi_freeplan( $_SHARED{my_plan});
        undef $_SHARED{my_plan};
$$ LANGUAGE plperl;

SELECT init();
SELECT add_time('1 day'), add_time('2 days'), add_time('3 days');
SELECT done();

  add_time  |  add_time  |  add_time
------------+------------+------------
 2005-12-10 | 2005-12-11 | 2005-12-12

請注意,spi_prepare 中的引數下標是透過 $1、$2、$3 等定義的,因此請避免在雙引號中宣告查詢字串,這很容易導致難以發現的 bug。

另一個示例說明了 spi_exec_prepared 中可選引數的用法:

CREATE TABLE hosts AS SELECT id, ('192.168.1.'||id)::inet AS address
                      FROM generate_series(1,3) AS id;

CREATE OR REPLACE FUNCTION init_hosts_query() RETURNS VOID AS $$
        $_SHARED{plan} = spi_prepare('SELECT * FROM hosts
                                      WHERE address << $1', 'inet');
$$ LANGUAGE plperl;

CREATE OR REPLACE FUNCTION query_hosts(inet) RETURNS SETOF hosts AS $$
        return spi_exec_prepared(
                $_SHARED{plan},
                {limit => 2},
                $_[0]
        )->{rows};
$$ LANGUAGE plperl;

CREATE OR REPLACE FUNCTION release_hosts_query() RETURNS VOID AS $$
        spi_freeplan($_SHARED{plan});
        undef $_SHARED{plan};
$$ LANGUAGE plperl;

SELECT init_hosts_query();
SELECT query_hosts('192.168.1.0/30');
SELECT release_hosts_query();

    query_hosts
-----------------
 (1,192.168.1.1)
 (2,192.168.1.2)
(2 rows)
spi_commit()
spi_rollback()

提交或回滾當前事務。這隻能在從頂層呼叫的過程中或匿名程式碼塊(DO 命令)中呼叫。(請注意,無法透過 spi_exec_query 或類似方法執行 COMMITROLLBACK SQL 命令。必須使用這些函式來完成。)事務結束後,會自動啟動一個新事務,因此沒有單獨的函式來處理。

以下是一個例子

CREATE PROCEDURE transaction_test1()
LANGUAGE plperl
AS $$
foreach my $i (0..9) {
    spi_exec_query("INSERT INTO test1 (a) VALUES ($i)");
    if ($i % 2 == 0) {
        spi_commit();
    } else {
        spi_rollback();
    }
}
$$;

CALL transaction_test1();

43.3.2. PL/Perl 中的實用函式 #

elog(level, msg)

發出日誌或錯誤訊息。可能的級別有 DEBUGLOGINFONOTICEWARNINGERRORERROR 會引發錯誤條件;如果它未被周圍的 Perl 程式碼捕獲,該錯誤將傳播到呼叫查詢,導致當前事務或子事務被中止。這實際上與 Perl 的 die 命令相同。其他級別只會生成不同優先順序的訊息。是否將特定優先順序的訊息報告給客戶端、寫入伺服器日誌或兩者兼有,由 log_min_messagesclient_min_messages 配置變數控制。有關更多資訊,請參閱 第 19 章

quote_literal(string)

返回給定字串的適當引用,以便在 SQL 語句字串中用作字串字面量。嵌入的單引號和反斜槓會被正確地加倍。請注意,quote_literalundef 輸入返回 undef;如果引數可能為 undef,則 quote_nullable 通常更合適。

quote_nullable(string)

返回給定字串的適當引用,以便在 SQL 語句字串中用作字串字面量;或者,如果引數是 undef,則返回未引用的字串 "NULL"。嵌入的單引號和反斜槓會被正確地加倍。

quote_ident(string)

返回給定字串的適當引用,以便在 SQL 語句字串中用作識別符號。只有在必要時(即,如果字串包含非識別符號字元或會被摺疊大小寫)才會新增引號。嵌入的引號會被正確地加倍。

decode_bytea(string)

返回給定字串內容所表示的未轉義的二進位制資料,該字串應為 bytea 編碼。

encode_bytea(string)

返回給定字串內容的 bytea 編碼格式的二進位制資料。

encode_array_literal(array)
encode_array_literal(array, delimiter)

將引用陣列的內容作為字串返回,格式為陣列字面量(參見 8.15.2. 陣列值輸入)。如果引數不是陣列引用,則原樣返回引數值。陣列字面量元素之間的分隔符預設為 ", ",如果未指定分隔符或分隔符為 undef

encode_typed_literal(value, typename)

將 Perl 變數轉換為第二個引數指定的型別的值,並返回該值的字串表示。正確處理巢狀陣列和複合型別的值。

encode_array_constructor(array)

將引用陣列的內容作為字串返回,格式為陣列建構函式(參見 4.2.12. 陣列建構函式)。單個值使用 quote_nullable 進行引用。如果引數不是陣列引用,則返回該引數值,並使用 quote_nullable 進行引用。

looks_like_number(string)

如果給定字串的內容看起來像數字(根據 Perl 的判斷),則返回 true 值,否則返回 false。如果引數為 undef,則返回 undef。忽略前導和尾隨空格。InfInfinity 被視為數字。

is_array_ref(argument)

如果給定引數可以被視為陣列引用,則返回 true 值,即引數的 refARRAYPostgreSQL::InServer::ARRAY。否則返回 false。

提交更正

如果您在文件中看到任何不正確、與您對特定功能的體驗不符或需要進一步澄清的內容,請使用 此表格 報告文件問題。