Sparksee Class Reference
[Gdb]

Sparksee class. More...

Inheritance diagram for Sparksee:

Inheritance graph
Collaboration diagram for Sparksee:

Collaboration graph

List of all members.

Public Member Functions

 Sparksee (const SparkseeConfig &config)
 Creates a new instance.
virtual ~Sparksee ()
 Destructor.
DatabaseCreate (const std::wstring &path, const std::wstring &alias) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)
 Creates a new Database instance.
DatabaseOpen (const std::wstring &path, bool_t readOnly) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)
 Opens an existing Database instance.
DatabaseRestore (const std::wstring &path, const std::wstring &backupFile) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)
 Restores a Database from a backup file.

Static Public Attributes

static const std::wstring Version
 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

Constructor & Destructor Documentation

Sparksee::Sparksee ( const SparkseeConfig config  ) 

Creates a new instance.

Parameters:
config [in] Sparksee configuration.


Member Function Documentation

Database* Sparksee::Create ( const std::wstring &  path,
const std::wstring &  alias 
) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)

Creates a new Database instance.

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

Database* Sparksee::Open ( const std::wstring &  path,
bool_t  readOnly 
) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)

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:
FileNotFoundException If the given file does not exist.

Database* Sparksee::Restore ( const std::wstring &  path,
const std::wstring &  backupFile 
) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)

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:
FileNotFoundException If the given file cannot be created, or the exported data file does not exists.


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

Generated on Tue Jun 2 13:44:26 2015 for Sparksee by  doxygen 1.5.6