sparksee.Sparksee Class Reference

Sparksee class. More...

List of all members.

Public Member Functions

def create
 Creates a new Database instance.
def restore
 Restores a Database from a backup file.
def open
 Opens an existing Database instance.
def __init__
 Creates a new instance.
def close
 Closes the Sparksee instance.

Static Public Attributes

float VERSION = 5.0
 Sparksee version.


Detailed Description

Sparksee class.

All Sparksee programs must have one single Sparksee instance to manage one or more Database instances.

This class allows for the creation of new Databases or open an existing one.

Author:
Sparsity Technologies http://www.sparsity-technologies.com

Member Function Documentation

def sparksee.Sparksee.create (   self,
  path,
  alias 
)

Creates a new Database instance.

Parameters:
path [in] Database storage file.
alias [in] Database alias name.
Returns:
A Database instance.
Exceptions:
IOError If the given file cannot be created.
RuntimeError null

def sparksee.Sparksee.restore (   self,
  path,
  backupFile 
)

Restores a Database from a backup file.

See the Graph class Backup method.

Parameters:
path [in] Database storage file.
backupFile [in] The Backup file to be restored.
Returns:
A Database instance.
Exceptions:
IOError If the given file cannot be created, or the exported data file does not exists.
RuntimeError null

def sparksee.Sparksee.open (   self,
  path,
  readOnly 
)

Opens an existing Database instance.

Parameters:
path [in] Database storage file.
readOnly [in] If TRUE, open Database in read-only mode.
Returns:
A Database instance.
Exceptions:
IOError If the given file does not exist.
RuntimeError null

def sparksee.Sparksee.__init__ (   self,
  config 
)

Creates a new instance.

Parameters:
config [in] Sparksee configuration.

def sparksee.Sparksee.close (   self  ) 

Closes the Sparksee instance.

It must be called to ensure the integrity of all data.


Generated on Fri Sep 12 13:39:43 2014 for SparkseePython by  doxygen 1.5.6