org.postgresql.largeobject
public class LargeObject extends Object
Normally, client code would use the getAsciiStream, getBinaryStream, or getUnicodeStream methods in ResultSet, or setAsciiStream, setBinaryStream, or setUnicodeStream methods in PreparedStatement to access Large Objects.
However, sometimes lower level access to Large Objects are required, that are not supported by the JDBC specification.
Refer to org.postgresql.largeobject.LargeObjectManager on how to gain access to a Large Object, or how to create one.
LargeObjectManager
,
ResultSet.getAsciiStream(int)
,
ResultSet.getBinaryStream(int)
,
ResultSet.getUnicodeStream(int)
,
PreparedStatement.setAsciiStream(int, java.io.InputStream, int)
,
PreparedStatement.setBinaryStream(int, java.io.InputStream, int)
,
PreparedStatement.setUnicodeStream(int, java.io.InputStream, int)
Modifier and Type | Field and Description |
---|---|
static int |
SEEK_CUR
Indicates a seek from the current position
|
static int |
SEEK_END
Indicates a seek from the end of a file
|
static int |
SEEK_SET
Indicates a seek from the begining of a file
|
Modifier | Constructor and Description |
---|---|
protected |
LargeObject(Fastpath fp,
long oid,
int mode)
This opens a large object.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
This method closes the object.
|
LargeObject |
copy() |
InputStream |
getInputStream()
Returns an InputStream from this object.
|
long |
getLongOID() |
int |
getOID()
Deprecated.
As of 8.3, replaced by
getLongOID() |
OutputStream |
getOutputStream()
Returns an OutputStream to this object.
|
int |
read(byte[] buf,
int off,
int len)
Reads some data from the object into an existing array
|
byte[] |
read(int len)
Reads some data from the object, and return as a byte[] array
|
void |
seek(int pos)
Sets the current position within the object.
|
void |
seek(int pos,
int ref)
Sets the current position within the object.
|
int |
size()
This method is inefficient, as the only way to find out the size of
the object is to seek to the end, record the current position, then
return to the original position.
|
int |
tell() |
void |
truncate(int len)
Truncates the large object to the given length in bytes.
|
void |
write(byte[] buf)
Writes an array to the object
|
void |
write(byte[] buf,
int off,
int len)
Writes some data from an array to the object
|
public static final int SEEK_SET
public static final int SEEK_CUR
public static final int SEEK_END
protected LargeObject(Fastpath fp, long oid, int mode) throws SQLException
If the object does not exist, then an SQLException is thrown.
fp
- FastPath API for the connection to useoid
- of the Large Object to openmode
- Mode of opening the large object
(defined in LargeObjectManager)SQLException
- if a database-access error occurs.LargeObjectManager
public LargeObject copy() throws SQLException
SQLException
public int getOID()
getLongOID()
public long getLongOID()
public void close() throws SQLException
SQLException
- if a database-access error occurs.public byte[] read(int len) throws SQLException
len
- number of bytes to readSQLException
- if a database-access error occurs.public int read(byte[] buf, int off, int len) throws SQLException
buf
- destination arrayoff
- offset within arraylen
- number of bytes to readSQLException
- if a database-access error occurs.public void write(byte[] buf) throws SQLException
buf
- array to writeSQLException
- if a database-access error occurs.public void write(byte[] buf, int off, int len) throws SQLException
buf
- destination arrayoff
- offset within arraylen
- number of bytes to writeSQLException
- if a database-access error occurs.public void seek(int pos, int ref) throws SQLException
This is similar to the fseek() call in the standard C library. It allows you to have random access to the large object.
pos
- position within objectref
- Either SEEK_SET, SEEK_CUR or SEEK_ENDSQLException
- if a database-access error occurs.public void seek(int pos) throws SQLException
This is similar to the fseek() call in the standard C library. It allows you to have random access to the large object.
pos
- position within object from beginingSQLException
- if a database-access error occurs.public int tell() throws SQLException
SQLException
- if a database-access error occurs.public int size() throws SQLException
A better method will be found in the future.
SQLException
- if a database-access error occurs.public void truncate(int len) throws SQLException
SQLException
public InputStream getInputStream() throws SQLException
This InputStream can then be used in any method that requires an InputStream.
SQLException
- if a database-access error occurs.public OutputStream getOutputStream() throws SQLException
This OutputStream can then be used in any method that requires an OutputStream.
SQLException
- if a database-access error occurs.