9.3 9.4 9.5 9.6 10 11 12 13 14
阿里云PostgreSQL 问题报告 纠错本页面

35.3. 客户端接口

35.3.1. 创建一个大对象
35.3.2. 导入一个大对象
35.3.3. 导出一个大对象
35.3.4. 打开一个现有的大对象
35.3.5. 向一个大对象写入数据
35.3.6. 从一个大对象读取数据
35.3.7. 在一个大对象中查找
35.3.8. 获取一个大对象的查找位置
35.3.9. 截断一个大对象
35.3.10. 关闭一个大对象描述符
35.3.11. 移除一个大对象

本节描述PostgreSQLlibpq客户端接口为访问大对象所提供的功能。PostgreSQL的大对象接口按照Unix文件系统的接口建模,也有相似的openreadwritelseek等。

所有使用这些函数对大对象的操作都必须发生在一个SQL事务块中,因为大对象文件描述符只在事务期间有效。

在执行任何一个这种函数期间如果发生一个错误,该函数将会返回一个其他的不可能值,典型的是0或-1。 一个关于该错误的消息亦会被保存在连接对象中,可以通过PQerrorMessage检索到。

使用这些函数的客户端应用应该包括头文件libpq/libpq-fs.h并链接libpq库。

35.3.1. 创建一个大对象

函数

Oid lo_creat(PGconn *conn, int mode);

创建一个新的大对象。其返回值是分配给这个新大对象的OID或者InvalidOid(0)表示失败。 modePostgreSQL 8.1就不再使用且会被忽略。但是,为了和以前的发行兼容,它最好被设置为INV_READINV_WRITEINV_READ | INV_WRITE(这些符号常量定义在头文件libpq/libpq-fs.h中)。

一个例子:

inv_oid = lo_creat(conn, INV_READ|INV_WRITE);

函数

Oid lo_create(PGconn *conn, Oid lobjId);

也创建一个新的大对象。分配给该大对象的OID可以通过lobjId指定,如果这样做,该OID已经被某个大对象使用时会产生错误。如果lobjIdInvalidOid(0),则lo_create会分配一个未使用的OID(这时和lo_creat的行为相同)。返回值是分配给新大对象的OID或InvalidOid(0)表示发生错误。

lo_create在从PostgreSQL 8.1开始的版本中是新的,如果该函数在旧服务器版本上运行,它将失败并返回InvalidOid

一个例子:

inv_oid = lo_create(conn, desired_oid);

35.3.2. 导入一个大对象

要将一个操作系统文件导入成一个大对象,调用:

Oid lo_import(PGconn *conn, const char *filename);

filename指定了要导入为大对象的操作系统文件名。返回值是分配给新大对象的OID或InvalidOid(0)表示发生错误。注意该文件是被客户端接口库而不是服务器所读取,因此它必须存在于客户端文件系统中并且对于客户端应用是可读的。

函数

Oid lo_import_with_oid(PGconn *conn, const char *filename, Oid lobjId);

也可以导入一个新大对象。分配给新大对象的OID可以用lobjId指定,如果这样做,该OID已经被某个大对象使用时会产生错误。如果lobjIdInvalidOid(0),则lo_import_with_oid会分配一个未使用的OID(这和lo_import的行为相同)。返回值是分配给新大对象的OID或InvalidOid(0)表示发生错误。

lo_import_with_oid在从PostgreSQL 8.1开始的版本中是新的并且在内部使用了lo_create(在8.1中也是新的),如果该函数在旧服务器版本上运行,它将失败并返回InvalidOid

35.3.3. 导出一个大对象

要把一个大对象导出到一个操作系统文件,调用:

int lo_export(PGconn *conn, Oid lobjId, const char *filename);

lobjId参数指定要导出的大对象的OID,filename参数指定操作系统文件名。注意该文件是被客户端接口库而不是服务器写入。成功返回1,错误返回-1。

35.3.4. 打开一个现有的大对象

要打开一个现有的大对象进行读写,调用:

int lo_open(PGconn *conn, Oid lobjId, int mode);

lobjId参数指定要打开的大对象的OID。mode位控制着打开对象是为了只读(INV_READ)、只写(INV_WRITE)或者读写(这些符号常量定义在头文件libpq/libpq-fs.h中)。lo_open返回一个(非负)大对象描述符以便后面用于lo_readlo_writelo_lseeklo_lseek64lo_telllo_tell64lo_truncatelo_truncate64以及lo_close。该描述符只在当前事务期间有效。如果打开错误将会返回-1。

服务器目前并不区分模式INV_WRITEINV_READ |INV_WRITE:在两种情况中都允许从描述符读取。但是在这些模式和单独的INV_READ之间有明显的区别:使用INV_READ我们不能向描述符写入,从中读取的数据则反映了该大对象在活动事务快照时刻的内容(该快照在lo_open被执行时创建),而不管之后被该事务或其他事务写入的内容。从一个以INV_WRITE模式打开的描述符读取的数据所有其他已提交事务以及当前事务所作的写入。这与普通SQL命令 SELECTREPEATABLE READREAD COMMITTED事务模式之间的区别相似。

如果大对象的SELECT特权不可用,或者如果在指定了INV_WRITEUPDATE特权不可用,则lo_open将会失败(在PostgreSQL 11之前,这些特权的检查是在使用该描述符的第一次实际读取或写入时进行)。这些特权检查可以用lo_compat_privileges运行时参数禁用。

一个例子:

inv_fd = lo_open(conn, inv_oid, INV_READ|INV_WRITE);

35.3.5. 向一个大对象写入数据

函数

int lo_write(PGconn *conn, int fd, const char *buf, size_t len);

buf(大小必须是 len)中写出len字节到大对象描述符fd。参数fd必须是已经由前面的lo_open返回的大对象描述符。函数将返回实际写入的字节数(在当前的实现中,除非出错,返回的字节数总是等于len)。在出错时,返回值为-1。

尽管参数len被声明为类型size_t,该函数会拒绝超过INT_MAX的长度值。在实际中,被传送的数据最好是每块最多数兆字节。

35.3.6. 从一个大对象读取数据

函数

int lo_read(PGconn *conn, int fd, char *buf, size_t len);

从大对象描述符fd中读取最多len字节到buf (大小必须是len)中。参数fd必须是已经由前面的lo_open返回的大对象描述符。实际读出的字节数将被返回,如果先到达了大对象的末尾返回值可能会小于len。出错时返回值为-1。

尽管参数len被声明为类型size_t,该函数会拒绝超过INT_MAX的长度值。在实际中,被传送的数据最好是每块最多数兆字节。

35.3.7. 在一个大对象中查找

要改变一个大对象描述符的当前读或写位置,调用:

int lo_lseek(PGconn *conn, int fd, int offset, int whence);

该函数将大对象文件描述符fd的当前位置指针移动到由offset指定的新位置。whence的可用值是SEEK_SET(从对象开头定位)、SEEK_CUR (从当前位置定位)以及SEEK_END(从对象末尾定位)。返回值是新位置的指针,或者是-1表示出错。

在处理可能超过2GB大小的大对象时,换用

pg_int64 lo_lseek64(PGconn *conn, int fd, pg_int64 offset, int whence);

该函数的行为和lo_lseek相同,但是它能接受一个超过2GB的offset并/或传送一个超过2GB的结果。注意如果新位置的指针超过2GB,lo_lseek会失败。

lo_lseek64是从 PostgreSQL 9.3开始增加的新函数。如果该函数在一个旧服务器版本上执行,将会失败并返回-1。

35.3.8. 获取一个大对象的查找位置

要得到一个大对象描述符的当前读或写位置,调用:

int lo_tell(PGconn *conn, int fd);

如果出现错误,返回值是-1。

在处理可能超过2GB大小的大对象时,换用:

pg_int64 lo_tell64(PGconn *conn, int fd);

该函数和lo_tell的行为相同,但是它能传递超过2GB的结果。注意如果当前读/写位置超过2GB,lo_tell将会失败。

lo_tell64是从PostgreSQL 9.3开始新增的函数。如果该函数在旧服务器版本上运行,将会失败并返回-1。

35.3.9. 截断一个大对象

要将一个大对象截断成一个给定长度,调用:

int lo_truncate(PGcon *conn, int fd, size_t len);

该函数将大对象描述符fd截断为长度len。参数fd必须是已经由前面的lo_open返回的大对象描述符。如果len超过了大对象的当前长度,大对象将会被使用空字节('\0')扩展到指定长度。成功时lo_truncate返回0,失败时返回值为-1。

描述fd的读/写位置不变。

尽管参数len被声明为类型size_tlo_truncate会拒绝超过INT_MAX的长度值。

在处理可能超过2GB大小的大对象时,换用:

int lo_truncate64(PGcon *conn, int fd, pg_int64 len);

该函数和lo_truncate的行为相同,但它能够接受超过2GB的len值。

lo_truncate是从PostgreSQL 8.3开始新的函数,如果该函数运行在一个旧服务器版本上,它将失败并返回-1。

lo_truncate64是从PostgreSQL 9.3开始新的函数,如果该函数运行在一个旧服务器版本上,它将失败并返回-1。

35.3.10. 关闭一个大对象描述符

要关闭一个大对象描述符,调用:

int lo_close(PGconn *conn, int fd);

其中fd是由lo_open返回的大对象描述符。成功时,lo_close返回0,失败时返回-1。

在事务末尾仍然保持打开的任何大对象描述符都会自动被关闭。