Phần này mô tả các cơ sởPostgreSQL'slibpqThư viện giao diện soi kèo bóng đá truoctran cung cấp để truy cập các đối tượng lớn. ThePostgreSQLGiao soi kèo bóng đá truoctran đối tượng lớn được mô hình hóa sauUNIXGiao soi kèo bóng đá truoctran hệ thống tệp, với các chất tương tự củaMở, đọc, Viết, LSEEK, v.v.
Tất cả các thao tác đối tượng soi kèo bóng đá truoctran bằng cách sử dụng các chức năng nàyphảidiễn ra trong một khối giao dịch SQL, vì các mô tả tệp đối tượng soi kèo bóng đá truoctran chỉ có giá trị trong suốt thời gian giao dịch.
Nếu xảy ra lỗi trong khi thực hiện bất kỳ một trong các hàm này, hàm sẽ trả về giá trị không thể xảy ra, thường là 0 hoặc -1. Một thông báo mô tả lỗi được lưu trữ trong đối tượng kết nối và có thể được truy xuất vớipqerrormessage.
Ứng dụng soi kèo bóng đá truoctran sử dụng các chức năng này nên bao gồm tệp tiêu đềlibpq/libpq-fs.hvà liên kết vớilibpqThư viện.
oid lo_creat (pgconn *Conn, int mode);
Tạo một đối tượng soi kèo bóng đá truoctran mới. Giá trị trả về là OID được gán cho đối tượng soi kèo bóng đá truoctran mới hoặckhông hợp lệ(không) về thất bại.Modekhông được sử dụng và bỏ qua nhưPostgreSQL8.1; Tuy nhiên, để tương thích ngược với các bản phát hành trước đó, tốt nhất là đặt nó thànhinv_read, inv_writehoặcinv_read | inv_write. (Các hằng số tượng trưng này được xác định trong tệp tiêu đềlibpq/libpq-fs.h.)
Một ví dụ:
inv_oid = lo_creat (Conn, inv_read | inv_write);
oid lo_create (pgconn *Conn, oid lobjid);
cũng tạo ra một đối tượng soi kèo bóng đá truoctran mới. OID được gán có thể được chỉ định bởilobjid; Nếu vậy, thất bại xảy ra nếu OID đó đã được sử dụng cho một số đối tượng soi kèo bóng đá truoctran. Nếu nhưlobjidlàkhông hợp lệ(không) sau đóLO_CREATEgán OID không sử dụng (đây là hành vi tương tự nhưlo_creat). Giá trị trả về là OID được gán cho đối tượng soi kèo bóng đá truoctran mới hoặckhông hợp lệ(không) về thất bại.
LO_CREATElà mới nhưPostgreSQL8.1; Nếu chức năng này chạy so với phiên bản soi kèo bóng đá truoctran chủ cũ hơn, nó sẽ thất bại và trả vềkhông hợp lệ.
Một ví dụ:
15862_15905
Để nhập tệp hệ điều hành dưới dạng đối tượng soi kèo bóng đá truoctran, hãy gọi
oid lo_import (pgconn *Conn, const char *filename);
FileNameChỉ định tên hệ điều hành của tệp được nhập dưới dạng một đối tượng soi kèo bóng đá truoctran. Giá trị trả về là OID được gán cho đối tượng soi kèo bóng đá truoctran mới hoặckhông hợp lệ(không) về thất bại. Lưu ý rằng tệp được đọc bởi thư viện giao diện soi kèo bóng đá truoctran, không phải bởi máy chủ; Vì vậy, nó phải tồn tại trong hệ thống tệp soi kèo bóng đá truoctran và có thể đọc được bởi ứng dụng soi kèo bóng đá truoctran.
oid lo_import_with_oid (pgconn *Conn, const char *filename, oid lobjid);
Cũng nhập một đối tượng soi kèo bóng đá truoctran mới. OID được gán có thể được chỉ định bởilobjid; Nếu vậy, thất bại xảy ra nếu OID đó đã được sử dụng cho một số đối tượng soi kèo bóng đá truoctran. Nếu nhưlobjidlàkhông hợp lệ(không) sau đólo_import_with_oidgán OID không sử dụng (đây là hành vi tương tự nhưlo_import). Giá trị trả về là OID được gán cho đối tượng soi kèo bóng đá truoctran mới hoặckhông hợp lệ(không) về thất bại.
lo_import_with_oidlà mới nhưPostgreSQL8.4 và sử dụnglo_createNội bộ mới trong 8.1; Nếu chức năng này được chạy so với 8.0 hoặc trước đó, nó sẽ thất bại và trả vềkhông hợp lệ.
Để xuất một đối tượng soi kèo bóng đá truoctran vào tệp hệ điều hành, gọi
int lo_export (pgconn *Conn, oid lobjid, const char *filename);
ThelobjidĐối số chỉ định oid của đối tượng soi kèo bóng đá truoctran để xuất vàFileNameĐối số Chỉ định tên hệ điều hành của tệp. Lưu ý rằng tệp được viết bởi thư viện giao diện soi kèo bóng đá truoctran, không phải bởi máy chủ. Trả về 1 khi thành công, -1 khi thất bại.
Để mở một đối tượng soi kèo bóng đá truoctran hiện có để đọc hoặc viết, gọi
int lo_open (pgconn *Conn, oid lobjid, int mode);
ThelobjidĐối số chỉ định oid của đối tượng soi kèo bóng đá truoctran để mở. TheModeĐiều khiển bit xem đối tượng có được mở để đọc không (inv_read), viết (inv_write) hoặc cả hai. (Các hằng số tượng trưng này được xác định trong tệp tiêu đềlibpq/libpq-fs.h.)lo_openTrả về một mô tả đối tượng soi kèo bóng đá truoctran (không âm) để sử dụng saulo_read, lo_write, lo_lseek, LO_LSEEK64, lo_tell, lo_tell64, lo_truncate, LO_TRUNCATE64vàlo_close. Bộ mô tả chỉ có giá trị trong suốt thời gian của giao dịch hiện tại. Khi thất bại, -1 được trả về.
soi kèo bóng đá truoctran chủ hiện không phân biệt giữa các chế độinv_writevàinv_read | inv_write: Bạn được phép đọc từ bộ mô tả trong cả hai trường hợp. Tuy nhiên có một sự khác biệt đáng kể giữa các chế độ này vàinv_readmột mình: vớiinv_readBạn không thể viết trên bộ mô tả và dữ liệu được đọc từ nó sẽ phản ánh nội dung của đối tượng soi kèo bóng đá truoctran tại thời điểm chụp nhanh giao dịch đã hoạt động khiLO_OPENđã được thực thi, bất kể sau đó viết bởi các giao dịch này hoặc các giao dịch khác. Đọc từ một mô tả được mở bằnginv_writeTrả về dữ liệu phản ánh tất cả các văn bản của các giao dịch cam kết khác cũng như ghi của giao dịch hiện tại. Điều này tương tự như hành vi củaĐọc lặp lạiso vớiĐọc cam kếtChế độ giao dịch cho SQL thông thườngChọnlệnh.
LO_OPENsẽ thất bại nếuChọnĐặc quyền không có sẵn cho đối tượng soi kèo bóng đá truoctran hoặc nếuinv_writeđược chỉ định vàCập nhậtĐặc quyền không có sẵn. (TrướcPostgreSQL11, các kiểm tra đặc quyền này được thực hiện tại cuộc gọi đọc hoặc ghi thực tế đầu tiên bằng cách sử dụng bộ mô tả.)LO_COMPAT_PRIVILEGES21844_21866
Một ví dụ:
inv_fd = lo_open (Conn, inv_oid, inv_read | inv_write);
22324_22392
Writeslenbyte từBUF(phải có kích thướclen) đến mô tả đối tượng soi kèo bóng đá truoctranFD. TheFDĐối số phải được trả lại bởi trước đóLO_OPEN. Số lượng byte thực sự được viết được trả về (trong quá trình triển khai hiện tại, điều này sẽ luôn bằng nhaulenTrừ khi có lỗi). Trong trường hợp lỗi, giá trị trả về là -1.
mặc dùlenTham số được khai báo làsize_t, Hàm này sẽ từ chối các giá trị độ dài soi kèo bóng đá truoctran hơnint_max. Trong thực tế, tốt nhất là chuyển dữ liệu trong các phần soi kèo bóng đá truoctran nhất là một vài megabyte.
23653_23714
đọc lên đếnlenbyte từ mô tả đối tượng soi kèo bóng đá truoctranFDthànhBUF(phải có kích thướclen). TheFDĐối số phải được trả lại bởi trước đólo_open24109_24183lenNếu kết thúc của đối tượng soi kèo bóng đá truoctran đạt được trước tiên. Trong trường hợp lỗi, giá trị trả về là -1.
mặc dùlentham số được khai báo làsize_t, Hàm này sẽ từ chối các giá trị độ dài soi kèo bóng đá truoctran hơnint_max24539_24627
Để thay đổi vị trí đọc hoặc ghi hiện tại được liên kết với một mô tả đối tượng soi kèo bóng đá truoctran, gọi
int lo_lseek (pgconn *Conn, int fd, int offset, int whence);
Hàm này di chuyển con trỏ vị trí hiện tại cho bộ mô tả đối tượng soi kèo bóng đá truoctran được xác định bởiFDđến vị trí mới được chỉ định bởiOffset. Các giá trị hợp lệ chowhencelàSeek_set(tìm kiếm từ bắt đầu đối tượng),Seek_cur(tìm kiếm từ vị trí hiện tại) vàSeek_end(tìm kiếm từ đầu đối tượng). Giá trị trả về là con trỏ vị trí mới hoặc -1 trên lỗi.
Khi xử lý các đối tượng soi kèo bóng đá truoctran có thể vượt quá kích thước 2GB, thay vào đó sử dụng
25856_25931
Hàm này có hành vi tương tự nhưlo_lseek, nhưng nó có thể chấp nhậnOffsetsoi kèo bóng đá truoctran hơn 2GB và/hoặc mang lại kết quả soi kèo bóng đá truoctran hơn 2GB. Lưu ý rằnglo_lseekSẽ thất bại nếu con trỏ vị trí mới sẽ soi kèo bóng đá truoctran hơn 2GB.
LO_LSEEK64là mới nhưPostgreSQL9.3. Nếu chức năng này được chạy so với phiên bản soi kèo bóng đá truoctran chủ cũ hơn, nó sẽ thất bại và trả về -1.
Để có được vị trí đọc hoặc ghi hiện tại của một mô tả đối tượng soi kèo bóng đá truoctran, gọi
int lo_tell (pgconn *Conn, int fd);
Nếu có lỗi, giá trị trả về là -1.
Khi xử lý các đối tượng soi kèo bóng đá truoctran có thể vượt quá kích thước 2GB, thay vào đó sử dụng
pg_int64 lo_tell64 (pgconn *Conn, int fd);
Hàm này có hành vi tương tự nhưlo_tell, nhưng nó có thể mang lại kết quả soi kèo bóng đá truoctran hơn 2GB. Lưu ý rằnglo_tellSẽ thất bại nếu vị trí đọc/ghi hiện tại soi kèo bóng đá truoctran hơn 2GB.
LO_TELL64là mới nhưPostgreSQL9.3. Nếu chức năng này được chạy so với phiên bản soi kèo bóng đá truoctran chủ cũ hơn, nó sẽ thất bại và trả về -1.
Để cắt một đối tượng soi kèo bóng đá truoctran thành một độ dài nhất định, gọi
int lo_truncate (pgconn *Conn, int fd, size_t len);
Hàm này cắt giảm mô tả đối tượng soi kèo bóng đá truoctranFDto Longlen. TheFDĐối số phải được trả lại bởi trước đóLO_OPEN. Nếu nhưlensoi kèo bóng đá truoctran hơn chiều dài dòng điện của đối tượng soi kèo bóng đá truoctran, đối tượng soi kèo bóng đá truoctran được mở rộng đến độ dài được chỉ định với các byte null ('\ 0'). Về thành công,28600_28613Trả về 0. Khi lỗi, giá trị trả về là -1.
Vị trí đọc/ghi được liên kết với mô tảFDkhông thay đổi.
mặc dùlenTham số được khai báo làsize_t, LO_TRUNCATEsẽ từ chối các giá trị độ dài soi kèo bóng đá truoctran hơnint_max.
Khi xử lý các đối tượng soi kèo bóng đá truoctran có thể vượt quá kích thước 2GB, thay vào đó sử dụng
int lo_truncate64 (pgconn *Conn, int fd, pg_int64 len);
Hàm này có hành vi tương tự nhưLO_TRUNCATE, nhưng nó có thể chấp nhận AlenGiá trị vượt quá 2GB.
LO_TRUNCATElà mới nhưPostgreSQL29573_29665
LO_TRUNCATE64là mới nhưPOSTGRESQL9.3; Nếu chức năng này được chạy so với phiên bản soi kèo bóng đá truoctran chủ cũ hơn, nó sẽ thất bại và trả về -1.
Một mô tả đối tượng soi kèo bóng đá truoctran có thể được đóng bằng cách gọi
int lo_close (pgconn *Conn, int fd);
WHEREFDlà một mô tả đối tượng soi kèo bóng đá truoctran được trả về bởiLO_OPEN. Về thành công,lo_closeTrả về 0. Khi lỗi, giá trị trả về là -1.
Bất kỳ mô tả đối tượng soi kèo bóng đá truoctran nào vẫn mở vào cuối giao dịch sẽ được đóng tự động.