受支持版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发版本: devel

33.3. 客户端接口 #

本节描述PostgreSQLlibpq客户端接口库为访问大对象所提供的功能。PostgreSQL的大对象接口是仿照Unix文件系统接口设计的,提供了与openreadwritelseek等相对应的操作。

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

如果执行其中任何一个函数时发生错误,该函数将返回一个原本不可能的值,通常是 0 或 -1。描述该错误的消息会存储在连接对象中,可以用PQerrorMessage取得。

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

当 libpq 连接处于管道模式时,客户端应用不能使用这些函数。

33.3.1. 创建一个大对象 #

函数

Oid lo_create(PGconn *conn, Oid lobjId);

创建一个新的大对象。要分配的 OID 可以由lobjId指定;如果指定了它,而该 OID 已经被某个大对象使用,则会失败。如果lobjIdInvalidOid(零),则lo_create会分配一个未使用的 OID。返回值是分配给新大对象的 OID,失败时为InvalidOid(零)。

例如:

inv_oid = lo_create(conn, desired_oid);

较旧的函数

Oid lo_creat(PGconn *conn, int mode);

也会创建一个新的大对象,并且总是分配一个未使用的 OID。返回值是分配给新大对象的 OID,失败时为InvalidOid(零)。

PostgreSQL 8.1 及以后的版本中,mode会被忽略,因此lo_creat与第二个参数为零的lo_create完全等价。不过,除非需要与早于 8.1 的服务器配合使用,否则几乎没有理由使用lo_creat。若要与这种旧服务器协作,必须使用lo_creat而不是lo_create,并且必须把mode设置为INV_READINV_WRITEINV_READ | INV_WRITE之一。(这些符号常量定义在头文件libpq/libpq-fs.h中。)

例如:

inv_oid = lo_creat(conn, INV_READ|INV_WRITE);

33.3.2. 导入一个大对象 #

要把一个操作系统文件导入为大对象,调用

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

filename指定要作为大对象导入的操作系统文件名。返回值是分配给新大对象的 OID,失败时为InvalidOid(零)。注意,该文件是由客户端接口库读取的,而不是由服务器读取的;因此它必须存在于客户端文件系统中,并且对客户端应用可读。

函数

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

也会导入一个新的大对象。要分配的 OID 可以由lobjId指定;如果指定了它,而该 OID 已经被某个大对象使用,则会失败。如果lobjIdInvalidOid(零),则lo_import_with_oid会分配一个未使用的 OID(其行为与lo_import相同)。返回值是分配给新大对象的 OID,失败时为InvalidOid(零)。

lo_import_with_oidPostgreSQL 8.4 新增的,它在内部使用了 8.1 新增的lo_create;如果将该函数用于 8.0 或更早版本的服务器,它会失败并返回InvalidOid

33.3.3. 导出一个大对象 #

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

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

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

33.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 SELECT命令在REPEATABLE READREAD COMMITTED事务模式下的行为差异。

如果对该大对象没有SELECT权限,或者指定了INV_WRITE但没有UPDATE权限,则lo_open会失败。(在PostgreSQL 11 之前,这些权限检查是在首次使用该描述符执行实际读或写调用时进行的。)这些权限检查可以通过lo_compat_privileges运行时参数禁用。

例如:

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

33.3.5. 向大对象写入数据 #

函数

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

buf中的len字节(其大小必须为len)写入大对象描述符fdfd参数必须是先前由lo_open返回的大对象描述符。返回值是实际写入的字节数(在当前实现中,除非出错,否则它总会等于len)。发生错误时,返回值为 -1。

虽然len参数被声明为size_t,但该函数会拒绝大于INT_MAX的长度值。实际上,无论如何最好按每块最多几兆字节来传输数据。

33.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的长度值。实际上,无论如何最好按每块最多几兆字节来传输数据。

33.3.7. 在大对象中定位 #

要改变与大对象描述符关联的当前读或写位置,调用

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

该函数将由fd标识的大对象描述符的当前位置指针移动到由offset指定的新位置。whence的有效值是SEEK_SET(从对象起始处定位)、SEEK_CUR(从当前位置定位)以及SEEK_END(从对象末尾定位)。返回值是新的位置指针,出错时为 -1。

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

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

该函数的行为与lo_lseek相同,但它既可以接受大于 2 GB 的offset,也可以返回大于 2 GB 的结果。请注意,如果新位置指针会大于 2 GB,lo_lseek将失败。

lo_lseek64PostgreSQL 9.3 新增的。如果将该函数用于更早版本的服务器,它会失败并返回 -1。

33.3.8. 获取大对象的当前位置 #

要取得大对象描述符当前的读或写位置,调用

int lo_tell(PGconn *conn, int fd);

如果发生错误,返回值是 -1。

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

int64_t lo_tell64(PGconn *conn, int fd);

该函数的行为与lo_tell相同,但它可以返回大于 2 GB 的结果。请注意,如果当前读/写位置大于 2 GB,lo_tell将失败。

lo_tell64PostgreSQL 9.3 新增的。如果将该函数用于更早版本的服务器,它会失败并返回 -1。

33.3.9. 截断一个大对象 #

要把一个大对象截断为给定长度,调用

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

该函数把大对象描述符fd截断为长度lenfd参数必须是先前由lo_open返回的大对象描述符。如果len大于大对象当前的长度,则会用空字节('\0')把该大对象扩展到指定长度。成功时,lo_truncate返回零;出错时返回值为 -1。

与描述符fd关联的读/写位置不会改变。

虽然len参数被声明为size_t,但lo_truncate会拒绝大于INT_MAX的长度值。

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

int lo_truncate64(PGconn *conn, int fd, int64_t len);

该函数的行为与lo_truncate相同,但它可以接受大于 2 GB 的len值。

lo_truncatePostgreSQL 8.3 新增的;如果将该函数用于更早版本的服务器,它会失败并返回 -1。

lo_truncate64PostgreSQL 9.3 新增的;如果将该函数用于更早版本的服务器,它会失败并返回 -1。

33.3.10. 关闭一个大对象描述符 #

可以通过调用

int lo_close(PGconn *conn, int fd);

来关闭一个大对象描述符,其中fd是由lo_open返回的大对象描述符。成功时,lo_close返回零;出错时返回值为 -1。

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

提交更正

如果您发现文档中有不正确的内容、与您使用特定功能的经验不符或需要进一步说明,请使用此表单来报告文档问题。