VastbaseG100

基于openGauss内核开发的企业级关系型数据库。

Menu

LargeObject类

功能描述

此类提供运行接口所需的基本方法,以及为此对象提供 InputStream 和 OutputStream 类的一对方法

close

功能描述

此方法关闭对象。在此对象被调用后,不能再调用该对象中的方法。

语法格式

public void close()      
throws SQLException

参数说明

无。

返回值

无。

copy

功能描述

复制一个LargeObject对象。

语法格式

public LargeObject copy()         
   throws SQLException

参数说明

无。

返回值

返回一个LargeObject对象。

getInputStream()

功能描述

获取一个InputStream对象。然后可以在需要 InputStream 的任何方法中使用此 InputStream。

语法格式

public InputStream getInputStream()              throws SQLException

参数说明

无。

返回值

返回一个来自这个对象的 InputStream。

getInputStream(long limit)

功能描述

从此对象返回一个 InputStream,这将限制可见的数据量。

语法格式

public InputStream getInputStream(long limit)              throws SQLException

参数说明

参数名 参数说明
limit 结果流将提供的最大字节数

返回值

返回一个来自这个对象的 InputStream。

getLongOID

功能描述

获取这个大对象的 OID。

语法格式

public long getLongOID()

参数说明

无。

返回值

返回这个大对象的 OID。

getOID(Deprecated)

功能描述

获取这个大对象的 OID,已弃用。

语法格式

public int getOID()

参数说明

无。

返回值

返回这个大对象的 OID。

getOutputStream

功能描述

返回一个输出流到这个对象。

语法格式

public OutputStream getOutputStream()               throws SQLException 

参数说明

无。

返回值

该对象的输出流。

read(byte[] buf, int off, int len)

功能描述

从对象中读取一些数据到现有数组中。

语法格式

public int read(byte[] buf,        
        int off,        
        int len)     
        throws SQLException

参数说明

参数名 参数说明
buf 目标数组
off 数组内的偏移量
len 要读取的字节数

返回值

返回实际读取的字节数。

read(int len)

功能描述

从对象中读取一些数据,并作为 byte[] 数组返回。

语法格式

public byte[] read(int len)      
throws SQLException

参数说明

参数名 参数说明
len 要读取的字节数

返回值

返回包含读取数据的byte[]。

seek(int pos)

功能描述

设置对象内的当前位置。这类似于标准 C 库中的 fseek() 调用。 它允许您随机访问大对象。

语法格式

public void seek(int pos)     
	throws SQLException

参数说明

参数名 参数说明
pos 对象内部的开始位置

返回值

无。

seek(int pos, int ref)

功能描述

设置对象内的当前位置。这类似于标准 C 库中的 fseek() 调用。 它允许您随机访问大对象。

语法格式

public void seek(int pos,         
        int ref)     
        throws SQLException

参数说明

参数名 参数说明
pos 对象内的位置
ref SEEK_SET、SEEK_CUR 或 SEEK_END

返回值

无。

seek64

功能描述

使用 64 位值设置对象内的当前位置。

语法格式

public void seek64(long pos,          
        int ref)      
        throws SQLException

参数说明

参数名 参数说明
pos 对象内的位置
ref SEEK_SET、SEEK_CUR 或 SEEK_END

返回值

无。

size

功能描述

获取这个大对象的大小。这种方法效率低下,因为唯一的方法是寻找到最后,记录当前位置,然后返回到原来的位置,才能找到对象的大小。

语法格式

public int size()     
throws SQLException

参数说明

无。

返回值

返回这个大对象的大小。

size64

功能描述

有关效率的信息,请参见 #size()。

语法格式

public int size64()     
throws SQLException

参数说明

无。

返回值

返回这个大对象的大小。

tell

功能描述

获取对象内的当前位置。

语法格式

public int tell()     
	throws SQLException

参数说明

无。

返回值

返回对象内的当前位置。

tell64

功能描述

获取对象内的当前位置。

语法格式

public long tell64()      
	throws SQLException

参数说明

无。

返回值

返回对象内的当前位置。

truncate

功能描述

将大对象截断为给定的字节长度。 如果字节数大于当前大对象长度,则大对象将填充零字节。 此方法不会修改当前文件偏移量。

语法格式

public void truncate(int len)      
	throws SQLException

参数说明

参数名 参数说明
len 给定长度(以字节为单位)

返回值

无。

truncate64

功能描述

将大对象截断为给定的字节长度。 如果字节数大于当前大对象长度,则大对象将填充零字节。 此方法不会修改当前文件偏移量。

语法格式

public void truncate64(long len)        
throws SQLException

参数说明

参数名 参数说明
len 给定长度(以字节为单位)

返回值

无。

write(byte[] buf)

功能描述

将数组写入对象。

语法格式

public void write(byte[] buf)     
throws SQLException

参数说明

参数名 参数说明
buf 要写入的数组

返回值

无。

write(byte[] buf, int off, int len)

功能描述

将一些数据从数组写入对象。

语法格式

public void write(byte[] buf,        
int off,         
int len)      
throws SQLException

参数说明

参数名 参数说明
buf 要写入的数组
off 数组内的偏移量
len 要写入的字节数

返回值

无。