Lần đầu tiên một kèo bóng đá pháp do người dùng xác định trong một tệp đối tượng có thể tải cụ thể được gọi trong phiên, trình tải động tải tệp đối tượng đó vào bộ nhớ để có thể gọi kèo bóng đá pháp. TheTạo chức năngĐối với chức năng C do người dùng xác định phải chỉ định hai phần thông tin cho kèo bóng đá pháp: tên của tệp đối tượng có thể tải và tên C (ký hiệu liên kết) của kèo bóng đá pháp cụ thể để gọi trong tệp đối tượng đó. Nếu tên C không được chỉ định rõ ràng thì nó được coi là giống như tên kèo bóng đá pháp SQL.

Thuật toán sau được sử dụng để định vị tệp đối tượng được chia sẻ dựa trên tên được đưa ra kèo bóng đá phápTạo chức nănglệnh:

Nếu chuỗi này không hoạt động, tiện ích mở rộng tên thư viện chia sẻ dành riêng cho nền tảng (thường là.so) được thêm vào tên đã cho và chuỗi này được thử lại. Nếu điều đó cũng thất bại, tải sẽ không thành công.

Nên định vị kèo bóng đá pháp thư viện được chia sẻ liên quan đến$ libdirhoặc thông qua đường dẫn thư viện động. Điều này đơn giản hóa phiên bản nâng cấp nếu cài đặt mới ở kèo bóng đá pháp vị trí khác.$ libdirViết tắt có thể được tìm thấy với lệnhpg_config - -pkglibdir.

ID người dùngPostgreSQLMáy chủ chạy vì phải có thể đi qua đường dẫn đến tệp bạn định tải. Làm cho tệp hoặc kèo bóng đá pháp thư mục cấp cao hơn không thể đọc được và/hoặc không thể thực thi bởiPostgresNgười dùng là kèo bóng đá pháp sai lầm phổ biến.

kèo bóng đá pháp mọi trường hợp, tên tệp được đưa ra kèo bóng đá phápTạo chức năngLệnh được ghi lại theo nghĩa đen kèo bóng đá pháp danh mục hệ thống, vì vậy nếu tệp cần được tải lại, quy trình tương tự được áp dụng.

Để đảm bảo rằng kèo bóng đá pháp tệp đối tượng được tải động không được tải vào kèo bóng đá pháp máy chủ không tương thích,PostgreSQLKiểm tra xem tệp có chứaKhối ma thuậtVới kèo bóng đá pháp nội dung thích hợp. Điều này cho phép máy chủ phát hiện sự không tương thích rõ ràng, chẳng hạn như mã được biên dịch cho một phiên bản chính khác củaPostgreSQL. Để bao gồm một khối ma thuật, hãy viết nó vào một (và chỉ một) của kèo bóng đá pháp tệp nguồn mô -đun, sau khi bao gồm tiêu đềfmgr.h:

pg_module_magic;

Sau khi nó được sử dụng lần đầu tiên, một tệp đối tượng được tải động được giữ lại trong bộ nhớ. kèo bóng đá pháp cuộc gọi trong tương lai trong cùng một phiên đến (kèo bóng đá pháp) hàm trong tệp đó sẽ chỉ phải chịu chi phí nhỏ của tra cứu bảng ký hiệu.

Tùy chọn, một tệp được tải động có thể chứa chức năng khởi tạo. Nếu tệp bao gồm một kèo bóng đá pháp có tên_pg_init, kèo bóng đá pháp đó sẽ được gọi ngay sau khi tải tệp. kèo bóng đá pháp không nhận được thông số và nên trả lại void.

Để biết cách viết kèo bóng đá pháp chức năng ngôn ngữ C, bạn cần biết làm thế nàoPostgreSQLnội bộ đại diện cho kèo bóng đá pháp loại dữ liệu cơ sở và cách chúng có thể được truyền đến và từ kèo bóng đá pháp chức năng. Trong nội bộ,PostgreSQLcoi loại cơ sở làBlob of MemoryHồi. kèo bóng đá pháp chức năng do người dùng xác định mà bạn xác định qua một loại lần lượt xác định cáchPostgreSQLcó thể hoạt động trên nó. Đó là,PostgreSQLSẽ chỉ lưu trữ và truy xuất dữ liệu từ đĩa và sử dụng kèo bóng đá pháp chức năng do người dùng xác định của bạn vào đầu vào, xử lý và xuất dữ liệu.

kèo bóng đá pháp loại cơ sở có thể có một trong ba định dạng nội bộ:

kèo bóng đá pháp loại giá trị chỉ có thể là 1, 2 hoặc 4 byte theo chiều dài (cũng là 8 byte, nếusizeof (mốc dữ liệu)là 8 trên máy của bạn). Bạn nên cẩn thận để xác định kèo bóng đá pháp loại của bạn sao cho chúng sẽ có cùng kích thước (tính bằng byte) trên tất cả kèo bóng đá pháp kiến ​​trúc.LongLoại nguy hiểm vì nó là 4 byte trên một số máy và 8 byte trên kèo bóng đá pháp máy khác, trong khiintLoại là 4 byte trên hầu hết kèo bóng đá pháp máy Unix. Một triển khai hợp lý củaINT4gõ trên máy Unix có thể là:

/ * 4 byte số nguyên, được truyền theo giá trị */

(Mã PostgreSQL C thực tế gọi loại nàyINT32, bởi vì đó là kèo bóng đá pháp quy ước trong C màintXXcó nghĩa làXX bit. Do đó, lưu ý rằng loại cINT8có kích thước 1 byte. Loại SQLINT8được gọi làINT64kèo bóng đá pháp C. Xem thêmBảng 38.2.)

Mặt khác, kèo bóng đá pháp loại có độ dài cố định có thể được truyền theo tham chiếu. Ví dụ: đây là việc triển khai mẫu củaPostgreSQLloại:

/ * cấu trúc 16 byte, được truyền qua tham chiếu */

Chỉ có thể sử dụng kèo bóng đá pháp gợi ý cho kèo bóng đá pháp loại như vậy khi chuyển chúng vào và ra khỏiPostgreSQLchức năng. Để trả về giá trị của kèo bóng đá pháp loại như vậy, hãy phân bổ đúng lượng bộ nhớ vớiPalloC, điền vào bộ nhớ được phân bổ và trả về kèo bóng đá pháp con trỏ cho nó. .PalloCVà chỉ cần trả con trỏ về giá trị đầu vào.)

Cuối cùng, tất cả kèo bóng đá pháp loại có độ dài thay đổi cũng phải được truyền bằng tham chiếu. Tất cả kèo bóng đá pháp loại có độ dài thay đổi phải bắt đầu bằng trường chiều dài mờ có chính xác 4 byte, sẽ được đặt bởiset_varsize; Không bao giờ đặt trường này trực tiếp!

Một điểm quan trọng khác là tránh để lại bất kỳ bit không chính thức nào trong kèo bóng đá pháp giá trị kiểu dữ liệu; Ví dụ, hãy cẩn thận với bất kỳ byte đệm căn chỉnh nào có thể có trong kèo bóng đá pháp cấu trúc.

Ví dụ, chúng ta có thể xác định loạiTextnhư sau:

typedef struct

The23312_23337Ký hiệu có nghĩa là độ dài thực tế của phần dữ liệu không được chỉ định bởi Tuyên bố này.

Khi thao tác kèo bóng đá pháp loại độ dài biến, chúng ta phải cẩn thận để phân bổ số lượng bộ nhớ chính xác và đặt trường độ dài một cách chính xác. Ví dụ: nếu chúng tôi muốn lưu trữ 40 byte trongTextCấu trúc, chúng ta có thể sử dụng kèo bóng đá pháp đoạn mã như thế này:

#include "Postgres.h"

Varhdrszgiống nhưsizeof (int32), nhưng nó được coi là phong cách tốt để sử dụng macroVarhdrszđể chỉ kích thước của chi phí cho kèo bóng đá pháp loại có độ dài thay đổi. Ngoài ra, trường chiều dàiphảiđược đặt bằngset_varsizeMacro, không phải bằng cách gán đơn giản.

Bảng 38.2Hiển thị kèo bóng đá pháp loại C tương ứng với nhiều loại dữ liệu SQL tích hợp củaPostgreSQL. Theđược xác định kèo bóng đá phápHồiCột cung cấp tệp tiêu đề cần được đưa vào để có được định nghĩa loại. .Postgres.hĐầu tiên trong bất kỳ tệp nguồn nào của mã máy chủ, vì nó tuyên bố một số điều mà bạn sẽ cần và vì bao gồm kèo bóng đá pháp tiêu đề khác trước tiên có thể gây ra kèo bóng đá pháp vấn đề về tính di động.

Bây giờ chúng tôi đã vượt qua tất cả kèo bóng đá pháp cấu trúc có thể cho kèo bóng đá pháp loại cơ sở, chúng tôi có thể hiển thị một số ví dụ về kèo bóng đá pháp chức năng thực.

quy ước gọi phiên bản-1 dựa trên kèo bóng đá pháp macro để đàn áp hầu hết sự phức tạp của việc truyền kèo bóng đá pháp đối số và kết quả. Tuyên bố C của hàm phiên bản-1 luôn luôn:

Datum funcname (pg_function_args)

Ngoài ra, cuộc gọi macro:

pg_function_info_v1 (funcname);

phải xuất hiện trong cùng kèo bóng đá pháp tệp nguồn. (Thông thường, nó được viết ngay trước chính chức năng.) Cuộc gọi macro này không cần thiết choNội bộ33246_33275POSTGRESQLGiả sử rằng tất cả kèo bóng đá pháp chức năng nội bộ đều sử dụng quy ước phiên bản-1. Tuy nhiên, nó được yêu cầu cho kèo bóng đá pháp chức năng được tải động.

Trong kèo bóng đá pháp phiên bản-1, mỗi đối số thực tế được tìm nạp bằng cách sử dụngpg_getarg_xxx()Macro tương ứng với kiểu dữ liệu của đối số. .pg_argisnull (); xem bên dưới.) Kết quả được trả về bằngpg_return_xxx()Macro cho loại trả về.pg_getarg_xxx()lấy đối số của nó Số lượng đối số kèo bóng đá pháp để tìm nạp, trong đó số lượng bắt đầu ở 0.pg_return_xxx()lấy đối số của nó giá trị thực tế để trả về.

Dưới đây là kèo bóng đá pháp số ví dụ sử dụng quy ước gọi phiên bản-1:

#include "Postgres.h"

Giả sử rằng mã trên đã được chuẩn bị kèo bóng đá pháp Tệpfuncs.cvà biên dịch thành một đối tượng được chia sẻ, chúng ta có thể xác định kèo bóng đá pháp chức năng thànhPostgreSQLVới kèo bóng đá pháp lệnh như thế này:

Tạo kèo bóng đá pháp add_one (số nguyên) Trả về số nguyênThư mục/funcs ',' add_one 'Thư mục/funcs ',' add_one_float8 'Thư mục/funcs ',' makepoint 'Thư mục/funcs ',' copytext 'Thư mục/funcs ',' concat_text '

ở đây,Thư mụclà viết tắt của thư mục của tệp thư viện được chia sẻ (ví dụPostgreSQLThư mục hướng dẫn, chứa mã cho kèo bóng đá pháp ví dụ được sử dụng trong phần này). (Phong cách tốt hơn sẽ là sử dụng chỉ'funcs'kèo bóng đá phápASmệnh đề, sau khi đã thêmThư mụcđến đường dẫn tìm kiếm. kèo bóng đá pháp mọi trường hợp, chúng tôi có thể bỏ qua tiện ích mở rộng dành riêng cho hệ thống cho thư viện được chia sẻ, thường là.so.)

Lưu ý rằng chúng tôi đã chỉ định kèo bóng đá pháp chức năng làMạnhnghiêm ngặtKhăn, có nghĩa là hệ thống sẽ tự động giả định kết quả null nếu bất kỳ giá trị đầu vào nào là null. Bằng cách này, chúng tôi tránh phải kiểm tra kèo bóng đá pháp đầu vào null trong mã chức năng.pg_argisnull ().

Macropg_argisnull (n)Cho phép một hàm kiểm tra xem mỗi đầu vào có phải là null hay không. (Tất nhiên, làm điều này chỉ cần thiết trong kèo bóng đá pháp chức năng không được khai báonghiêm ngặt”.) Như vớipg_getarg_xxx()macro, kèo bóng đá pháp đối số đầu vào được tính bắt đầu ở 0. Lưu ý rằng người ta nên không thực thipg_getarg_xxx()Cho đến khi người ta xác minh rằng đối số không phải là null. Để trả về kết quả null, thực thipg_return_null (); Điều này hoạt động kèo bóng đá pháp cả hai chức năng nghiêm ngặt và không thành công.

Thoạt nhìn, kèo bóng đá pháp quy ước mã hóa phiên bản-1 có thể chỉ là chủ nghĩa tối nghĩa vô nghĩa, so với sử dụng đơn giảnCGọi quy ước. Tuy nhiên, họ cho phép chúng tôi đối phó vớinullĐối số có thể/giá trị trả về vàMạnhNướng(nén hoặc ngoài dòng) giá trị.

kèo bóng đá pháp tùy chọn khác được cung cấp bởi giao diện phiên bản-1 là hai biến thể củapg_getarg_xxx()macro. Cái đầu tiên kèo bóng đá pháp số này,pg_getarg_xxx_copy (), Đảm bảo trả lại kèo bóng đá pháp bản sao của đối số được chỉ định an toàn khi viết vào. .pg_getarg_xxx_copy ()macro đảm bảo kết quả có thể ghi.) Biến thể thứ hai bao gồmpg_getarg_xxx_slice ()Macro có ba đối số. Đầu tiên là số lượng đối số kèo bóng đá pháp (như trên).bên ngoài”. (Loại lưu trữ của kèo bóng đá pháp cột có thể được chỉ định bằng cách sử dụngBảng thay đổiTableNameCột thay đổicolnameĐặt lưu trữStorAgetype.StorAgetypelà kèo bóng đá pháp trongtrơn,bên ngoài,Mở rộnghoặcchính.)

Cuối cùng, kèo bóng đá pháp quy ước gọi chức năng phiên bản-1 có thể trả về kết quả tập hợp (Phần 38.10.8) và thực hiện kèo bóng đá pháp chức năng kích hoạt (Chương 39) và Trình xử lý cuộc gọi bằng kèo bóng đá pháp ngữ thủ tục (Chương 58). Để biết thêm chi tiết, xemsrc/backend/utils/fmgr/readmekèo bóng đá pháp phân phối nguồn.

Trước khi chúng ta chuyển sang kèo bóng đá pháp chủ đề nâng cao hơn, chúng ta nên thảo luận về một số quy tắc mã hóa choPOSTGRESQLkèo bóng đá pháp ngữ c. Mặc dù có thể tải các hàm được viết bằng các ngôn ngữ khác với C thànhPostgreSQL42852_43210

kèo bóng đá pháp quy tắc cơ bản để viết và xây dựng kèo bóng đá pháp hàm C như sau:

Trước khi bạn có thể sử dụngPostgreSQLkèo bóng đá pháp chức năng mở rộng được viết bằng C, chúng phải được biên dịch và liên kết theo cách đặc biệt để tạo một tệp có thể được máy chủ tải động. Để chính xác, AThư viện chia sẻcần được tạo.

Để biết thông tin ngoài những gì có trong phần này, bạn nên đọc tài liệu của hệ điều hành của mình, đặc biệt là kèo bóng đá pháp trang thủ công cho trình biên dịch C,CCvà Trình chỉnh sửa liên kết,LD. Ngoài ra,POSTGRESQLMã nguồn chứa kèo bóng đá pháp số ví dụ làm việc trongĐóng gópThư mục. Nếu bạn dựa vào kèo bóng đá pháp ví dụ này, bạn sẽ làm cho kèo bóng đá pháp mô -đun của mình phụ thuộc vào tính khả dụng củaPostgreSQLTuy nhiên, mã nguồn.

Tạo thư viện chia sẻ thường tương tự như liên kết kèo bóng đá pháp tệp thực thi: Đầu tiên kèo bóng đá pháp tệp nguồn được biên dịch thành kèo bóng đá pháp tệp đối tượng, sau đó kèo bóng đá pháp tệp đối tượng được liên kết với nhau. kèo bóng đá pháp tệp đối tượng cần được tạo dưới dạngMã độc lập vị trí(pic),Điều này có nghĩa là chúng có thể được đặt tại kèo bóng đá pháp vị trí tùy ý trong bộ nhớ khi chúng được thực thi. .

Trong kèo bóng đá pháp ví dụ sau, chúng tôi cho rằng mã nguồn của bạn nằm trong một tệpfoo.cVà chúng tôi sẽ tạo kèo bóng đá pháp thư viện được chia sẻfoo.so. Tệp đối tượng trung gian sẽ được gọi làfoo.otrừ khi có ghi chú khác. Thư viện được chia sẻ có thể chứa nhiều hơn kèo bóng đá pháp tệp đối tượng, nhưng chúng tôi chỉ sử dụng kèo bóng đá pháp tệp ở đây.

Tệp thư viện chia sẻ kết quả sau đó có thể được tải vàoPOSTGRESQL. Khi chỉ định tên tệp thànhTạo chức năngLệnh, người ta phải đặt tên cho tệp thư viện được chia sẻ, không phải tệp đối tượng trung gian. Lưu ý rằng tiện ích mở rộng thư viện chia sẻ tiêu chuẩn của hệ thống (thường là.sohoặc.SL) có thể được bỏ qua từTạo chức năngLệnh và thông thường nên được bỏ qua để có tính di động tốt nhất.

Tham khảo lạiPhần 38.10.1Về nơi máy chủ mong đợi tìm thấy kèo bóng đá pháp tệp thư viện được chia sẻ.

kèo bóng đá pháp loại tổng hợp không có bố cục cố định như cấu trúc C. kèo bóng đá pháp thể hiện của một loại tổng hợp có thể chứa kèo bóng đá pháp trường null.PostgreSQLCung cấp giao diện chức năng để truy cập kèo bóng đá pháp trường của kèo bóng đá pháp loại tổng hợp từ C.

Giả sử chúng ta muốn viết kèo bóng đá pháp chức năng để trả lời truy vấn:

Chọn Tên, C_OverPaid (EMP, 1500) làm trả quá nhiều tiền

Sử dụng kèo bóng đá pháp quy ước gọi phiên bản-1, chúng ta có thể xác địnhc_overpaidAs:

#include "Postgres.h"

GetAttributionByNamelàPostgreSQLHàm hệ thống trả về kèo bóng đá pháp thuộc tính ra khỏi hàng được chỉ định. Nó có ba đối số: đối số của loạiHeaptupleHeaderđược chuyển vào kèo bóng đá pháp, tên của thuộc tính mong muốn và tham số trả về cho biết thuộc tính có phải là null hay không.GetAttributionByNameTrả về ADatumGiá trị mà bạn có thể chuyển đổi sang kiểu dữ liệu phù hợp bằng cách sử dụng thích hợpDatumgetxxx()Macro. Lưu ý rằng giá trị trả về là vô nghĩa nếu cờ null được đặt;

Ngoài ra còn cóGetAttributebyNum, chọn thuộc tính đích theo số cột thay vì tên.

lệnh sau đây khai báo chức năngc_overpaidkèo bóng đá pháp SQL:

Tạo chức năng c_overpaid (EMP, Integer) Trả về BooleanThư mục/funcs ',' c_overpaid '

Thông báo chúng tôi đã sử dụngnghiêm ngặtđể chúng tôi không phải kiểm tra xem kèo bóng đá pháp đối số đầu vào có vô giá trị không.

Để trả về giá trị loại hoặc loại tổng hợp từ hàm ngôn ngữ C, bạn có thể sử dụng API đặc biệt cung cấp kèo bóng đá pháp macro và kèo bóng đá pháp hàm để ẩn hầu hết độ phức tạp của việc xây dựng kèo bóng đá pháp loại dữ liệu tổng hợp. Để sử dụng API này, tệp nguồn phải bao gồm:

#include "funcapi.h"

Có hai cách bạn có thể xây dựng giá trị dữ liệu tổng hợp (từ đó ATuple): Bạn có thể xây dựng nó từ một mảng kèo bóng đá pháp giá trị mốc hoặc từ một mảng kèo bóng đá pháp chuỗi C có thể được truyền đến kèo bóng đá pháp hàm chuyển đổi đầu vào của kèo bóng đá pháp loại dữ liệu cột của Tuple. Trong cả hai trường hợp, trước tiên bạn cần phải có được hoặc xây dựng mộttupledescMô tả cho cấu trúc tuple. Khi làm việc với Datums, bạn vượt quatupledescđếnBlesstupledesc, rồi gọiheap_form_tuplecho mỗi hàng. Khi làm việc với kèo bóng đá pháp chuỗi C, bạn vượt quatupledescđếntupledescgetattinmetadata, rồi gọibuildTupleFromCStringscho mỗi hàng. Trong trường hợp của một hàm trả về một tập hợp kèo bóng đá pháp bộ dữ liệu, tất cả kèo bóng đá pháp bước thiết lập đều có thể được thực hiện một lần trong cuộc gọi đầu tiên của hàm.

kèo bóng đá pháp số chức năng trợ giúp có sẵn để thiết lập cần thiếttupledesc. Cách được đề xuất để thực hiện điều này trong hầu hết kèo bóng đá pháp chức năng trả về kèo bóng đá pháp giá trị tổng hợp là gọi:

59504_59684

Vượt qua cùng kèo bóng đá phápfcinfoCấu trúc được chuyển đến chính chức năng gọi. (Tất nhiên điều này yêu cầu bạn sử dụng kèo bóng đá pháp quy ước gọi phiên bản 1.)resultTypeIDcó thể được chỉ định lànullhoặc là địa chỉ của biến cục bộ để nhận loại kết quả của kèo bóng đá pháp OID.resulttupledescnên là địa chỉ của kèo bóng đá pháp địa phươngtupledescBiến. Kiểm tra xem kết quả làTypeFunc_Composite; Nếu vậy,resulttupledescđã được lấp đầy với cần thiếttupledesc. (Nếu không, bạn có thể báo cáo lỗi dọc theo kèo bóng đá pháp dòngBản ghi trả về chức năng được gọi kèo bóng đá pháp ngữ cảnh không thể chấp nhận bản ghi loạiHồi.)

kèo bóng đá pháp chức năng cũ hơn, hiện đang được ghi nhận để có đượctupledescS là:

61950_62009

Để có đượctupledescĐối với loại hàng của kèo bóng đá pháp mối quan hệ được đặt tên và:

62151_62212

Để có đượctupledescDựa trên kèo bóng đá pháp loại oid. Điều này có thể được sử dụng để có được kèo bóng đá pháptupledescĐối với loại cơ sở hoặc loại tổng hợp. Nó sẽ không hoạt động cho một kèo bóng đá pháp trả vềRecordTuy nhiên, và nó không thể giải quyết kèo bóng đá pháp loại đa hình.

kèo bóng đá pháp khi bạn cótupledesc, gọi:

62641_62688

Nếu bạn có kế hoạch làm việc với kèo bóng đá pháp mốc dữ liệu, hoặc:

62773_62836

Nếu bạn có kế hoạch làm việc với kèo bóng đá pháp chuỗi C. Nếu bạn đang viết một bộ trả lại chức năng, bạn có thể lưu kết quả của kèo bóng đá pháp chức năng này trongfunccallcontextCấu trúc - Sử dụngTUPE_DESChoặcAttinMetatrường tương ứng.

Khi làm việc với Datums, sử dụng:

63236_63313

Để xây dựng AHeaptupleĐã cho dữ liệu người dùng ở dạng mốc dữ liệu.

Khi làm việc với kèo bóng đá pháp chuỗi C, sử dụng:

63490_63567

Để xây dựng AĐã cho dữ liệu người dùng ở dạng chuỗi C.Giá trịlà một mảng chuỗi C, một cho mỗi thuộc tính của hàng trả lại. Mỗi chuỗi C phải ở dạng dự kiến ​​bởi kèo bóng đá pháp đầu vào của kiểu dữ liệu thuộc tính.Giá trịMảng phải được đặt thànhnull. Chức năng này sẽ cần được gọi lại cho mỗi hàng bạn trở lại.

Khi bạn đã xây dựng kèo bóng đá pháp tuple để trở về từ chức năng của mình, nó phải được chuyển đổi thành ADatum. Sử dụng:

64311_64349

Để chuyển đổi Athành kèo bóng đá pháp mốc thời gian hợp lệ. Cái nàyDatumCó thể được trả về trực tiếp nếu bạn có ý định trả về chỉ một hàng hoặc nó có thể được sử dụng làm giá trị trả về hiện tại trong kèo bóng đá pháp hoàn trả lại.

kèo bóng đá pháp ví dụ xuất hiện trong phần tiếp theo.

Hàm ngôn ngữ C có hai tùy chọn để trả về kèo bóng đá pháp bộ (nhiều hàng). Trong một phương thức, được gọi làValuePercallMODE, Hàm hoàn trả đã được gọi là lặp đi lặp lại (chuyển kèo bóng đá pháp đối số giống nhau mỗi lần) và nó trả về một hàng mới cho mỗi cuộc gọi, cho đến khi nó không còn hàng để trả về và tín hiệu bằng cách trả về NULL. Chức năng trả lại thiết lập (SRF) Do đó, phải lưu đủ trạng thái qua kèo bóng đá pháp cuộc gọi để nhớ những gì nó đã làm và trả về mục tiếp theo chính xác trên mỗi cuộc gọi. Trong phương thức khác, được gọi làvật chất hóaMODE, SRF điền và trả về kèo bóng đá pháp đối tượng tuplestore chứa toàn bộ kết quả của nó; sau đó chỉ có kèo bóng đá pháp cuộc gọi xảy ra cho toàn bộ kết quả và không cần trạng thái liên hệ.

Khi sử dụng chế độ ValuePerCall, điều quan trọng cần nhớ là truy vấn không được đảm bảo sẽ được chạy để hoàn thành; nghĩa là, do kèo bóng đá pháp tùy chọn nhưGiới hạn, Người thực thi có thể ngừng thực hiện kèo bóng đá pháp cuộc gọi đến chức năng trả lại trước khi tất cả kèo bóng đá pháp hàng đã được tìm nạp. Điều này có nghĩa là không an toàn khi thực hiện kèo bóng đá pháp hoạt động dọn dẹp trong cuộc gọi cuối cùng, bởi vì điều đó có thể không bao giờ xảy ra.

Phần còn lại của phần này ghi lại một tập hợp kèo bóng đá pháp macro trợ giúp thường được sử dụng (mặc dù không bắt buộc phải được sử dụng) cho SRF bằng chế độ ValuePercall. Chi tiết bổ sung về chế độ vật chất hóa có thể được tìm thấy trongsrc/backend/utils/fmgr/readme. Ngoài ra,Đóng gópMô -đun kèo bóng đá phápPostgreSQLPhân phối nguồn chứa nhiều ví dụ về SRF sử dụng cả chế độ ValuePercall và Mật vật.

Để sử dụng kèo bóng đá pháp macro hỗ trợ ValuePercall được mô tả ở đây, bao gồmfuncapi.h. kèo bóng đá pháp macro này hoạt động với một cấu trúcfunccallcontextchứa trạng thái cần được lưu qua kèo bóng đá pháp cuộc gọi. Trong cuộc gọi SRF,fcinfo- flinfo- fn_extrađược sử dụng để giữ kèo bóng đá pháp con trỏ tớifunccallcontextqua kèo bóng đá pháp cuộc gọi. kèo bóng đá pháp macro tự động điền vào trường đó khi sử dụng đầu tiên và mong đợi tìm thấy cùng một con trỏ ở đó trên kèo bóng đá pháp mục đích sử dụng tiếp theo.

typedef struct funccallcontext

Macro được sử dụng bởi kèo bóng đá phápSRFSử dụng cơ sở hạ tầng này là:

SRF_IS_FIRSTCALL ()

Sử dụng điều này để xác định xem chức năng của bạn có được gọi cho lần đầu tiên hay lần tiếp theo hay không. kèo bóng đá pháp cuộc gọi đầu tiên (chỉ), cuộc gọi:

srf_firstcall_init ()

Để khởi tạofunccallcontext. Trên mọi cuộc gọi chức năng, bao gồm cuộc gọi đầu tiên, cuộc gọi:

srf_percall_setup ()

Để thiết lập để sử dụngfunccallcontext.

Nếu chức năng của bạn có dữ liệu để trả về kèo bóng đá pháp cuộc gọi hiện tại, hãy sử dụng:

srf_return_next (funcctx, result)

Để trả lại cho người gọi. (resultphải loạiDatum70158_70285

srf_return_done (funcctx)

Để dọn dẹp và kết thúcSRF.

Bối cảnh bộ nhớ hiện tại khiSRFđược gọi là một bối cảnh thoáng qua sẽ được xóa giữa kèo bóng đá pháp cuộc gọi. Điều này có nghĩa là bạn không cần gọiPFREETrên mọi thứ bạn đã phân bổ bằng cách sử dụngPalloC; Nó sẽ biến mất dù sao.multi_call_memory_ctxlà kèo bóng đá pháp vị trí phù hợp cho bất kỳ dữ liệu nào cần tồn tại cho đến khiSRFđược hoàn thành chạy. Trong hầu hết kèo bóng đá pháp trường hợp, điều này có nghĩa là bạn nên chuyển thànhmulti_call_memory_ctxkèo bóng đá pháp khi thực hiện thiết lập cuộc gọi đầu tiên. Sử dụngfuncctx- user_fctxĐể giữ kèo bóng đá pháp con trỏ đến bất kỳ cấu trúc dữ liệu gọi chéo nào như vậy. (Dữ liệu bạn phân bổ trongmulti_call_memory_ctxSẽ tự động biến mất khi truy vấn kết thúc, do đó, không cần thiết phải giải phóng dữ liệu đó theo cách thủ công.)

kèo bóng đá pháp ví dụ Pseudo-Code hoàn chỉnh trông giống như sau:

DatumKhai báo tiếp theo khi cầnif (srf_is_firstcall ())Mã người dùng
        Nếu trả về composite
            Build tupledesc và có lẽ là attinmetadata
        endif trả về composite
        Mã người dùngMemoryContextSwitchto (OldContext);Mã người dùngfuncctx = srf_percall_setup ();Mã người dùng/ * Đây chỉ là kèo bóng đá pháp cách chúng tôi có thể kiểm tra xem chúng tôi đã hoàn thành: */Mã người dùng
        có được dữ liệu kết quảsrf_return_next (funcctx, result);

kèo bóng đá pháp ví dụ hoàn chỉnh về đơn giảnSRFTrả về loại tổng hợp trông giống như:

pg_function_info_v1 (retcposite);

kèo bóng đá pháp cách để khai báo chức năng này trong SQL là:

Tạo loại __retComposite AS (F1 Integer, F2 Integer, F3 Integer);FileName',' retcposite '

Một cách khác là sử dụng kèo bóng đá pháp tham số:

Tạo hoặc thay thế chức năng retcposite (tính bằng số nguyên, kèo bóng đá pháp số nguyên,FileName',' retcposite '

Lưu ý rằng trong phương pháp này, loại đầu ra của kèo bóng đá pháp chính thức là một ẩn danhRecordloại.

kèo bóng đá pháp ngữ C có thể được khai báo để chấp nhận và trả về các loại đa hình được mô tả trongPhần 38.2.5. Khi kèo bóng đá pháp đối số hoặc loại trả về của hàm được định nghĩa là kèo bóng đá pháp loại đa hình, tác giả chức năng không thể biết trước loại dữ liệu nào sẽ được gọi với hoặc cần quay lại.fmgr.hĐể cho phép hàm phiên bản-1 C khám phá kèo bóng đá pháp loại dữ liệu thực tế của kèo bóng đá pháp đối số và loại nó dự kiến ​​sẽ trả về. kèo bóng đá pháp thói quen được gọi làget_fn_expr_rettype (fmgrinfo *flinfo)vàget_fn_expr_argtype (fmgrinfo *flinfo, int argnum). Họ trả về kết quả hoặc loại đối số oid hoặckhông hợp lệNếu thông tin không có sẵn. Cấu trúcflinfothường được truy cập dưới dạngfcinfo- flinfo. Tham sốargnumlà không dựa trên.get_call_result_typecũng có thể được sử dụng thay thế choget_fn_expr_rettype. Ngoài ra còn cóGET_FN_EXPR_VARIADIC, có thể được sử dụng để tìm hiểu xem kèo bóng đá pháp đối số variadic có được hợp nhất thành một mảng hay không. Điều này chủ yếu hữu ích choVariadic "Any"kèo bóng đá pháp chức năng, vì sự hợp nhất đó sẽ luôn xảy ra đối với kèo bóng đá pháp hàm variadic Lấy kèo bóng đá pháp loại mảng thông thường.

Ví dụ: giả sử chúng ta muốn viết một kèo bóng đá pháp để chấp nhận một yếu tố duy nhất thuộc bất kỳ loại nào và trả về một mảng một chiều thuộc loại đó:

pg_function_info_v1 (make_array);

Lệnh sau đây khai báo chức năngmake_arraykèo bóng đá pháp SQL:

Tạo chức năng Make_array (AnyEuity) trả về AnyArrayThư mục/funcs ',' make_array '

Có một biến thể đa hình chỉ có sẵn cho kèo bóng đá pháp ngữ C: Chúng có thể được tuyên bố lấy các tham số loại"bất kỳ". (Lưu ý rằng tên loại này phải được trích dẫn kép, vì nó cũng là kèo bóng đá pháp từ dành riêng cho SQL.) Điều này hoạt động nhưAnyEuityNgoại trừ việc nó không hạn chế khác nhau"bất kỳ"Đối số là cùng loại, chúng cũng không giúp xác định loại kết quả của hàm. kèo bóng đá pháp ngữ C cũng có thể khai báo tham số cuối cùng của nó làVariadic "Any". Điều này sẽ phù hợp với kèo bóng đá pháp hoặc nhiều đối số thực tế thuộc bất kỳ loại nào (không nhất thiết phải cùng loại).khôngđược thu thập thành một mảng như xảy ra với kèo bóng đá pháp hàm variadic bình thường; Chúng sẽ được chuyển cho chức năng riêng biệt.pg_nargs ()Macro và kèo bóng đá pháp phương thức được mô tả ở trên phải được sử dụng để xác định số lượng đối số thực tế và kèo bóng đá pháp loại của chúng khi sử dụng tính năng này. Ngoài ra, người dùng của một chức năng như vậy có thể muốn sử dụngVariadicTừ khóa trong cuộc gọi chức năng của họ, với kỳ vọng rằng hàm sẽ coi kèo bóng đá pháp phần tử mảng là kèo bóng đá pháp đối số riêng biệt. Bản thân chức năng phải thực hiện hành vi đó nếu muốn, sau khi sử dụngGET_FN_EXPR_VARIADICĐể phát hiện ra rằng đối số thực tế được đánh dấu bằngVariadic.

add-ins có thể bảo lưu LWLOCKS và phân bổ bộ nhớ chia sẻ khi khởi động máy chủ. Thư viện chia sẻ của bổ trợ phải được tải trước bằng cách chỉ định nó kèo bóng đá phápshared_preload_l Libries. Thư viện được chia sẻ nên đăng ký ASHMEM_REQUEST_HOOKkèo bóng đá pháp nó_pg_initkèo bóng đá pháp. Cái nàySHMEM_REQUEST_HOOKCó thể bảo lưu LWLOCKS hoặc bộ nhớ chia sẻ. Bộ nhớ chia sẻ được bảo lưu bằng cách gọi:

void requestAddInshmemSpace (int size)

Từ bạnSHMEM_REQUEST_HOOK.

LWlocks được bảo lưu bằng cách gọi:

void requestNamedLwlockTranche (const char *tranche_name, int num_lwlocks)

Từ bạnSHMEM_REQUEST_HOOK. Điều này sẽ đảm bảo rằng kèo bóng đá pháp mảngnum_lwlockslwlocks có sẵn dưới tênTranche_name. Sử dụngGetNamedLwlockTrancheĐể có được kèo bóng đá pháp con trỏ đến mảng này.

kèo bóng đá pháp ví dụ về ASHMEM_REQUEST_HOOKCó thể tìm thấy kèo bóng đá pháp84299_84348kèo bóng đá phápPostgreSQLCây nguồn.

Để tránh điều kiện chủng tộc có thể, mỗi phụ trợ nên sử dụng LWLOCKaddinshmeminitlockKhi kết nối và khởi tạo phân bổ bộ nhớ chia sẻ, như được hiển thị ở đây:

MyStruct *ptr = null;

mặc dùPostgreSQLphụ trợ được viết bằng C, có thể ghi kèo bóng đá pháp tiện ích mở rộng trong C ++ nếu kèo bóng đá pháp hướng dẫn này được tuân thủ:

Tóm lại, tốt nhất là đặt mã C ++ phía sau kèo bóng đá pháp bức tường củaExtern Ckèo bóng đá pháp chức năng giao diện với phần phụ trợ và tránh ngoại lệ, bộ nhớ và gọi rò rỉ ngăn xếp.