從您的 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_query
和 spi_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_fetchrow
傳回 undef
時,spi_query
傳回的游標會自動釋放。如果您不想讀取所有資料列,請改為呼叫 spi_cursor_close
以釋放游標。否則會導致記憶體洩漏。
spi_prepare(command
, argument types
)
spi_query_prepared(plan
, arguments
)
spi_exec_prepared(plan
[, attributes
], arguments
)
spi_freeplan(plan
)
spi_prepare
、spi_query_prepared
、spi_exec_prepared
和 spi_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 等定義的,因此請避免在雙引號中宣告查詢字串,這很容易導致難以發現的錯誤。
另一個範例說明了在 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
或類似函數來執行 SQL 命令 COMMIT
或 ROLLBACK
。必須使用這些函數來完成。)交易結束後,會自動開始新的交易,因此沒有單獨的函數來執行此操作。
這是一個範例
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();
elog(level
, msg
)
發出日誌或錯誤訊息。 可能的層級包括 DEBUG
、LOG
、INFO
、NOTICE
、WARNING
和 ERROR
。ERROR
會引發錯誤狀況;如果周圍的 Perl 程式碼沒有捕獲此錯誤,該錯誤會傳播到呼叫查詢,導致當前交易或子交易中止。 這實際上與 Perl die
命令相同。 其他層級僅產生不同優先級的訊息。 特定優先級的訊息是否報告給客戶端、寫入伺服器日誌或兩者都執行,由 log_min_messages 和 client_min_messages 設定變數控制。 更多資訊請參閱 第 19 章。
quote_literal(string
)
傳回適當引用的給定字串,以便在 SQL 語句字串中用作字串文字。 嵌入的單引號和反斜線會正確地加倍。 請注意,quote_literal
在 undef 輸入時傳回 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。 忽略前導和尾隨空格。Inf
和 Infinity
被視為數字。
is_array_ref(argument
)
如果給定參數可以被視為陣列參考,也就是說,如果參數的 ref 是 ARRAY
或 PostgreSQL::InServer::ARRAY
,則傳回 true 值。 否則傳回 false。
如果您在文件中發現任何不正確、與您使用特定功能的經驗不符,或需要進一步澄清之處,請使用此表單回報文件問題。