Inheritance diagram for Sparksee:

Collaboration diagram for Sparksee:

Public Member Functions
	Sparksee (SparkseeConfig &config)
	Creates a new instance. More...

virtual	~Sparksee ()
	Destructor.

Database *	Create (const std::wstring &path, const std::wstring &alias) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)
	Creates a new Database instance. More...

Database *	Create (const std::wstring &path, const std::wstring &alias, const SparkseeConfig &config) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)
	Creates a new Database instance. More...

Database *	Open (const std::wstring &path, bool_t readOnly) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)
	Opens an existing Database instance. More...

Database *	Open (const std::wstring &path, bool_t readOnly, const SparkseeConfig &config) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)
	Opens an existing Database instance. More...

Database *	Restore (const std::wstring &path, const std::wstring &backupFile) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)
	Restores a Database from a backup file. More...

Database *	Restore (const std::wstring &path, const std::wstring &backupFile, const SparkseeConfig &config) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)
	Restores a Database from a backup file. More...

Database *	RestoreEncryptedBackup (const std::wstring &path, const std::wstring &backupFile, const std::wstring &keyInHex, const std::wstring &ivInHex) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)
	Restores a Database from an encrypted backup file. More...

Database *	RestoreEncryptedBackup (const std::wstring &path, const std::wstring &backupFile, const SparkseeConfig &config, const std::wstring &keyInHex, const std::wstring &ivInHex) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)
	Restores a Database from an encrypted backup file. More...

bool_t	VerifyChecksums (const std::wstring &path) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)
	Verifies the Checksum integrity of the given image file and it's recovery log file. More...

bool_t	AddChecksums (const std::wstring &path) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)
	Converts a database WITHOUT checksums into a database WITH checksums. More...

bool_t	RemoveChecksums (const std::wstring &path) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)
	Converts a database WITH checksums into a database WITHOUT checksums. More...

void	SetUnrecoverableErrorCallback (SPARKSEE_UNRECOVERABLE_ERR_CALLBACK callback)
	Sets the unrecoverable error callback. More...

bool_t	Encrypt (const std::wstring &path) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)
	Converts a database WITHOUT encryption into an encrypted database. More...

bool_t	Decrypt (const std::wstring &path) throw (sparksee::gdb::FileNotFoundException, sparksee::gdb::Error)
	Converts a database WITH encryption into a database WITHOUT encryption. More...

void	ResizeInMemoryPool (int64_t newCapacity) throw (sparksee::gdb::SystemError)
	Resizes the in memory pool allocator. More...

int64_t	GetInMemoryPoolCapacity ()
	Gets the capacity of the in-memory pool (in Megabytes) More...

Static Public Attributes
static const std::wstring	Version
	Sparksee version.

Private Member Functions
sparksee_core::SPARKSEE *	GetHandler ()
	Gets the handled reference. More...

const sparksee_core::SPARKSEE *	GetHandler () const
	Gets the handled reference. More...

void	SetHandler (sparksee_core::SPARKSEE *h)
	Sets the handled reference. More...

void	FreeHandler ()
	Frees (deletes) the handled reference.

bool_t	IsNull () const
	Gets if the handler is NULL. More...

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 ( SparkseeConfig & config )

Creates a new instance.

Parameters

config [in/out] Sparksee configuration (may be updated).

Member Function Documentation

bool_t Sparksee::AddChecksums	(	const std::wstring &	path	)
throw	(	sparksee::gdb::FileNotFoundException,
		sparksee::gdb::Error
	)

Converts a database WITHOUT checksums into a database WITH checksums.

Any error found is logged.

Precondition: The database (and it's recovery log if present) does NOT have checksums.

Parameters

path	The path to the database image file

Returns: Returns true if the checksum could be added or false otherwise.

Exceptions

sparksee::gdb::FileNotFoundException
sparksee::gdb::Error

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::Create	(	const std::wstring &	path,
		const std::wstring &	alias,
		const SparkseeConfig &	config
	)
throw	(	sparksee::gdb::FileNotFoundException,
		sparksee::gdb::Error
	)

Creates a new Database instance.

Parameters

path	[in] Database storage file.
alias	[in] Database alias name.
config	[in] Use a specific configuration instead of the one in this Sparksee

Returns: A Database instance.

Exceptions

FileNotFoundException If the given file cannot be created.

bool_t Sparksee::Decrypt	(	const std::wstring &	path	)
throw	(	sparksee::gdb::FileNotFoundException,
		sparksee::gdb::Error
	)

Converts a database WITH encryption into a database WITHOUT encryption.

Any error found is logged.

Precondition: The database (and it's recovery log if present) is encrypted.; The current encryption had been configured using SparkseeConfig.

Parameters

path	The path to the database image file

Returns: Returns true if the database could be unencrypted. The errors are returned with an exception.

Exceptions

sparksee::gdb::FileNotFoundException
sparksee::gdb::Error

bool_t Sparksee::Encrypt	(	const std::wstring &	path	)
throw	(	sparksee::gdb::FileNotFoundException,
		sparksee::gdb::Error
	)

Converts a database WITHOUT encryption into an encrypted database.

Any error found is logged.

Precondition: The database (and it's recovery log if present) does is NOT encrypted.; The encryption had already been configured using SparkseeConfig.

Parameters

path	The path to the database image file

Returns: Returns true if the database could be encrypted. The errors are returned with an exception.

Exceptions

sparksee::gdb::FileNotFoundException
sparksee::gdb::Error

int64_t Sparksee::GetInMemoryPoolCapacity ( )

Gets the capacity of the in-memory pool (in Megabytes)

Returns: Returns the capacity of the in memory pool

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::Open	(	const std::wstring &	path,
		bool_t	readOnly,
		const SparkseeConfig &	config
	)
throw	(	sparksee::gdb::FileNotFoundException,
		sparksee::gdb::Error
	)

Opens an existing Database instance.

The provided configuration will be used for all the database settings but not for the license, which must already be properly setup in this class.

Parameters

path	[in] Database storage file.
readOnly	[in] If TRUE, open Database in read-only mode.
config	[in] Use a specific configuration instead of the one in this Sparksee

Returns: A Database instance.

Exceptions

FileNotFoundException If the given file does not exist.

bool_t Sparksee::RemoveChecksums	(	const std::wstring &	path	)
throw	(	sparksee::gdb::FileNotFoundException,
		sparksee::gdb::Error
	)

Converts a database WITH checksums into a database WITHOUT checksums.

Any error found is logged.

Precondition: The database (and it's recovery log if present) have checksums.

Parameters

path	The path to the database image file

Returns: Returns true if the checksum could be removed. The errors are returned with an exception.

Exceptions

sparksee::gdb::FileNotFoundException
sparksee::gdb::Error

void Sparksee::ResizeInMemoryPool	(	int64_t	newCapacity	)
throw	(	sparksee::gdb::SystemError
	)

Resizes the in memory pool allocator.

Parameters

newCapacity The new capacity of the in memory pool allocator

Returns: Returns true if was successful

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.

Database* Sparksee::Restore	(	const std::wstring &	path,
		const std::wstring &	backupFile,
		const SparkseeConfig &	config
	)
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.
config	[in] Use a specific configuration instead of the one in this Sparksee

Returns: A Database instance.

Exceptions

FileNotFoundException If the given file cannot be created, or the exported data file does not exists.

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

Restores a Database from an encrypted backup file.

See the Graph class EncryptedBackup method.

Parameters

path	[in] Database storage file.
backupFile	[in] The Backup file to be restored.
keyInHex	[In] The AES encryption Key of the backup file as an hexadecimal string (8, 16 or 32 bytes).
ivInHex	[In] The AES Initialization Vector of the backup file as an hexadecimal string (16 bytes).

Returns: A Database instance.

Exceptions

FileNotFoundException If the given file cannot be created, or the exported data file does not exists.

Database* Sparksee::RestoreEncryptedBackup	(	const std::wstring &	path,
		const std::wstring &	backupFile,
		const SparkseeConfig &	config,
		const std::wstring &	keyInHex,
		const std::wstring &	ivInHex
	)
throw	(	sparksee::gdb::FileNotFoundException,
		sparksee::gdb::Error
	)

Restores a Database from an encrypted backup file.

See the Graph class EncryptedBackup method.

Parameters

path	[in] Database storage file.
backupFile	[in] The Backup file to be restored.
config	[in] Use a specific configuration instead of the one in this Sparksee
keyInHex	[In] The AES encryption Key of the backup file as an hexadecimal string (8, 16 or 32 bytes).
ivInHex	[In] The AES Initialization Vector of the backup file as an hexadecimal string (16 bytes).

Returns: A Database instance.

Exceptions

FileNotFoundException If the given file cannot be created, or the exported data file does not exists.

void Sparksee::SetUnrecoverableErrorCallback ( SPARKSEE_UNRECOVERABLE_ERR_CALLBACK callback )

Sets the unrecoverable error callback.

Parameters

callback The unrecoverable error callback to set

bool_t Sparksee::VerifyChecksums	(	const std::wstring &	path	)
throw	(	sparksee::gdb::FileNotFoundException,
		sparksee::gdb::Error
	)

Verifies the Checksum integrity of the given image file and it's recovery log file.

The main database file checksums are always checked.

When the recovery log file exists, the recovery log file is also checked for checksum and format errors.

When the checksums of the main file or the recovery file are incorrect, the funcion returns false, in any other error it throws an exception.

Any error found is logged as a WARNING.

Parameters

path	The path to the image file

Returns: Returns true if the checksum verification succeeded. Returns false if an invalid checksum was detected.

Exceptions

sparksee::gdb::FileNotFoundException
sparksee::gdb::Error

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

Sparksee.h

Public Member Functions

Static Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation