SequoiaDB
 All Classes Functions
Public Member Functions | List of all members
pysequoiadb.lob.lob Class Reference
Inheritance diagram for pysequoiadb.lob.lob:

Public Member Functions

def __init__
 
def __del__
 
def close
 
def get_size
 
def get_oid
 
def get_create_time
 
def get_modification_time
 
def lock
 
def lock_and_seek
 
def seek
 
def read
 
def write
 
def is_eof
 

Member Function Documentation

def pysequoiadb.lob.lob.close (   self)
close lob

Exceptions:
   pysequoiadb.error.SDBBaseError
def pysequoiadb.lob.lob.get_create_time (   self)
get create time of lob

Return Values:
   a long int of time
Exceptions:
   pysequoiadb.error.SDBBaseError
def pysequoiadb.lob.lob.get_modification_time (   self)
get the last modification time of lob

Return Values:
   a long int of time
Exceptions:
   pysequoiadb.error.SDBBaseError
def pysequoiadb.lob.lob.get_oid (   self)
get the oid of lob.

Return Values:
   the oid of current lob
Exceptions:
   pysequoiadb.error.SDBBaseError
def pysequoiadb.lob.lob.get_size (   self)
get the size of lob.

Return Values:
   the size of current lob
Exceptions:
   pysequoiadb.error.SDBBaseError
def pysequoiadb.lob.lob.is_eof (   self)
Check whether current offset has reached the max size of current lob.
Return Values:
   True if current offset has reached the max size, otherwise False.
def pysequoiadb.lob.lob.lock (   self,
  offset,
  length 
)
lock lob data section.

Parameters:
    Name        Type                Info:
   offset    long(int in python3)   The lock start position
   length    long(int in python3)   The lock length, -1 means lock from offset to the end of lob
Exceptions:
   pysequoiadb.error.SDBBaseError
def pysequoiadb.lob.lob.lock_and_seek (   self,
  offset,
  length 
)
lock lob data section and seek to the offset position.

Parameters:
    Name        Type                Info:
   offset    long(int in python3)   The lock start position
   length    long(int in python3)   The lock length, -1 means lock from offset to the end of lob
Exceptions:
   pysequoiadb.error.SDBBaseError
def pysequoiadb.lob.lob.read (   self,
  length 
)
ream data from lob.

Parameters:
   Name     Type                 Info:
   length   int                  The length of data to be read
Return Values:
   binary data of read
Exceptions:
   pysequoiadb.error.SDBBaseError
def pysequoiadb.lob.lob.seek (   self,
  seek_pos,
  whence = 0 
)
seek in lob.

Parameters:
   Name        Type           Info:
   seek_pos    int            The length to seek
   whence      int            whence of seek, it must be 0/1/2
                            0 means seek from begin to end of lob
                            1 means seek from currend position to end of lob
                            2 means seek from end to begin of lob
Exceptions:
   pysequoiadb.error.SDBBaseError
def pysequoiadb.lob.lob.write (   self,
  data,
  length 
)
write data into lob.

Parameters:
   Name     Type                 Info:
   data     str                  The data to be written
   length   int                  The length of data to be written
Exceptions:
   pysequoiadb.error.SDBBaseError

The documentation for this class was generated from the following file: