Class: PGlarge

Inherits:

Object

• Object
• PGlarge

Defined in:

ext/postgres.c,
ext/postgres.c

Overview

******************************************************************

The class to access large objects.
An instance of this class is created as the  result of
PGconn#lo_import, PGconn#lo_create, and PGconn#lo_open.

Constant Summary

INV_WRITE =

INT2FIX(INV_WRITE)

INV_READ =

INT2FIX(INV_READ)

SEEK_SET =

INT2FIX(SEEK_SET)

SEEK_CUR =

INT2FIX(SEEK_CUR)

SEEK_END =

INT2FIX(SEEK_END)

Instance Method Summary

• #close ⇒ Object

  Closes a large object.

• #export(file) ⇒ Object

  Saves the large object to a file.

• #oid ⇒ Object

  Returns the large object’s oid.

• #open([mode]) ⇒ Object

  Opens a large object.

• #read([length]) ⇒ Object

  Attempts to read length bytes from large object.

• #seek(offset, whence) ⇒ Object

  Move the large object pointer to the offset.

• #size ⇒ Object

  Returns the size of the large object.

• #tell ⇒ Object

  Returns the current position of the large object pointer.

• #unlink ⇒ Object

  Deletes the large object.

• #write(str) ⇒ Object

  Writes the string str to the large object.

Instance Method Details

#close ⇒ Object

Closes a large object. Closed when they are garbage-collected.

# File 'ext/postgres.c', line 2226

static VALUE
pglarge_close(obj)
VALUE obj;

#export(file) ⇒ Object

Saves the large object to a file.

# File 'ext/postgres.c', line 2402

static VALUE
pglarge_export(obj, filename)
VALUE obj, filename;

#oid ⇒ Object

Returns the large object’s oid.

# File 'ext/postgres.c', line 2177

static VALUE
pglarge_oid(obj)
VALUE obj;

#open([mode]) ⇒ Object

Opens a large object. The mode argument specifies the mode for the opened large object, which is either INV_READ or INV_WRITE.

# File 'ext/postgres.c', line 2194

static VALUE
pglarge_open(argc, argv, obj)
int argc;

#read([length]) ⇒ Object

Attempts to read length bytes from large object. If no length is given, reads all data.

# File 'ext/postgres.c', line 2290

static VALUE
pglarge_read(argc, argv, obj)
int argc;

#seek(offset, whence) ⇒ Object

Move the large object pointer to the offset. Valid values for whence are SEEK_SET, SEEK_CUR, and SEEK_END. (Or 0, 1, or 2.)

# File 'ext/postgres.c', line 2354

static VALUE
pglarge_seek(obj, offset, whence)
VALUE obj, offset, whence;

#size ⇒ Object

Returns the size of the large object.

# File 'ext/postgres.c', line 2374

static VALUE
pglarge_size(obj)
VALUE obj;

#tell ⇒ Object

Returns the current position of the large object pointer.

# File 'ext/postgres.c', line 2246

static VALUE
pglarge_tell(obj)
VALUE obj;

#unlink ⇒ Object

Deletes the large object.

# File 'ext/postgres.c', line 2423

static VALUE
pglarge_unlink(obj)
VALUE obj;

#write(str) ⇒ Object

Writes the string str to the large object. Returns the number of bytes written.

# File 'ext/postgres.c', line 2326

static VALUE
pglarge_write(obj, buffer)
VALUE obj, buffer;