Sparksee class. More...

Public Member Functions
void	ResizeInMemoryPool (long newCapacity) throws System.SystemException
	Resizes the in memory pool allocator.

bool	RemoveChecksums (System.String path) throws System.IO.IOException, System.ApplicationException
	Converts a database WITH checksums into a database WITHOUT checksums.

com.sparsity.sparksee.gdb.Database	RestoreEncryptedBackup (System.String path, System.String backupFile, System.String keyInHex, System.String ivInHex) throws System.IO.IOException, System.ApplicationException
	Restores a Database from an encrypted backup file.

bool	Decrypt (System.String path) throws System.IO.IOException, System.ApplicationException
	Converts a database WITH encryption into a database WITHOUT encryption.

	Sparksee (com.sparsity.sparksee.gdb.SparkseeConfig config)
	Creates a new instance.

com.sparsity.sparksee.gdb.Database	Create (System.String path, System.String alias) throws System.IO.IOException, System.ApplicationException
	Creates a new Database instance.

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

com.sparsity.sparksee.gdb.Database	RestoreEncryptedBackup (System.String path, System.String backupFile, com.sparsity.sparksee.gdb.SparkseeConfig config, System.String keyInHex, System.String ivInHex) throws System.IO.IOException, System.ApplicationException
	Restores a Database from an encrypted backup file.

com.sparsity.sparksee.gdb.Database	Open (System.String path, bool readOnly) throws System.IO.IOException, System.ApplicationException
	Opens an existing Database instance.

bool	VerifyChecksums (System.String path) throws System.IO.IOException, System.ApplicationException
	Verifies the Checksum integrity of the given image file and it's recovery log file.

boolean	IsClosed ()
	Gets if Sparksee instance has been closed or not.

bool	AddChecksums (System.String path) throws System.IO.IOException, System.ApplicationException
	Converts a database WITHOUT checksums into a database WITH checksums.

void	Close ()
	Closes the Sparksee instance.

bool	Encrypt (System.String path) throws System.IO.IOException, System.ApplicationException
	Converts a database WITHOUT encryption into an encrypted database.

com.sparsity.sparksee.gdb.Database	Open (System.String path, bool readOnly, com.sparsity.sparksee.gdb.SparkseeConfig config) throws System.IO.IOException, System.ApplicationException
	Opens an existing Database instance.

com.sparsity.sparksee.gdb.Database	Restore (System.String path, System.String backupFile) throws System.IO.IOException, System.ApplicationException
	Restores a Database from a backup file.

com.sparsity.sparksee.gdb.Database	Create (System.String path, System.String alias, com.sparsity.sparksee.gdb.SparkseeConfig config) throws System.IO.IOException, System.ApplicationException
	Creates a new Database instance.

com.sparsity.sparksee.gdb.Database	Restore (System.String path, System.String backupFile, com.sparsity.sparksee.gdb.SparkseeConfig config) throws System.IO.IOException, System.ApplicationException
	Restores a Database from a backup file.

Static Public Attributes
static System.String	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

com.sparsity.sparksee.gdb.Sparksee.Sparksee ( com.sparsity.sparksee.gdb.SparkseeConfig config )

Creates a new instance.

Parameters

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

Member Function Documentation

bool com.sparsity.sparksee.gdb.Sparksee.AddChecksums ( System.String path ) throws System.IO.IOException, System.ApplicationException

Converts a database WITHOUT checksums into a database WITH checksums.

Any error found is logged. The database (and it's recovery log if present) does NOT have checksums. sparksee::gdb::FileNotFoundExceptionsparksee::gdb::Error

Parameters

path	The path to the database image file

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

Exceptions

System.IO.IOException	null
System.ApplicationException	null

void com.sparsity.sparksee.gdb.Sparksee.Close ( )

Closes the Sparksee instance.

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

com.sparsity.sparksee.gdb.Database com.sparsity.sparksee.gdb.Sparksee.Create	(	System.String	path,
		System.String	alias
	)		throws System.IO.IOException, System.ApplicationException

Creates a new Database instance.

Parameters

path	[in] Database storage file.
alias	[in] Database alias name.

Returns: A Database instance.

Exceptions

System.IO.IOException	If the given file cannot be created.
System.ApplicationException	null

com.sparsity.sparksee.gdb.Database com.sparsity.sparksee.gdb.Sparksee.Create	(	System.String	path,
		System.String	alias,
		com.sparsity.sparksee.gdb.SparkseeConfig	config
	)		throws System.IO.IOException, System.ApplicationException

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

System.IO.IOException	If the given file cannot be created.
System.ApplicationException	null

bool com.sparsity.sparksee.gdb.Sparksee.Decrypt ( System.String path ) throws System.IO.IOException, System.ApplicationException

Converts a database WITH encryption into a database WITHOUT encryption.

Any error found is logged. The database (and it's recovery log if present) is encrypted. The current encryption had been configured using SparkseeConfig. sparksee::gdb::FileNotFoundExceptionsparksee::gdb::Error

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

System.IO.IOException	null
System.ApplicationException	null

bool com.sparsity.sparksee.gdb.Sparksee.Encrypt ( System.String path ) throws System.IO.IOException, System.ApplicationException

Converts a database WITHOUT encryption into an encrypted database.

Any error found is logged. The database (and it's recovery log if present) does is NOT encrypted. The encryption had already been configured using SparkseeConfig. sparksee::gdb::FileNotFoundExceptionsparksee::gdb::Error

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

System.IO.IOException	null
System.ApplicationException	null

long com.sparsity.sparksee.gdb.Sparksee.GetInMemoryPoolCapacity ( )

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

Returns: Returns the capacity of the in memory pool

boolean com.sparsity.sparksee.gdb.Sparksee.IsClosed ( )

Gets if Sparksee instance has been closed or not.

See Also: Close()

Returns: TRUE if the Sparksee instance has been closed, FALSE otherwise.

com.sparsity.sparksee.gdb.Database com.sparsity.sparksee.gdb.Sparksee.Open	(	System.String	path,
		bool	readOnly
	)		throws System.IO.IOException, System.ApplicationException

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

System.IO.IOException	If the given file does not exist.
System.ApplicationException	null

com.sparsity.sparksee.gdb.Database com.sparsity.sparksee.gdb.Sparksee.Open	(	System.String	path,
		bool	readOnly,
		com.sparsity.sparksee.gdb.SparkseeConfig	config
	)		throws System.IO.IOException, System.ApplicationException

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

System.IO.IOException	If the given file does not exist.
System.ApplicationException	null

bool com.sparsity.sparksee.gdb.Sparksee.RemoveChecksums ( System.String path ) throws System.IO.IOException, System.ApplicationException

Converts a database WITH checksums into a database WITHOUT checksums.

Any error found is logged. The database (and it's recovery log if present) have checksums. sparksee::gdb::FileNotFoundExceptionsparksee::gdb::Error

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

System.IO.IOException	null
System.ApplicationException	null

void com.sparsity.sparksee.gdb.Sparksee.ResizeInMemoryPool ( long newCapacity ) throws System.SystemException

Resizes the in memory pool allocator.

Parameters

newCapacity The new capacity of the in memory pool allocator

Returns: Returns true if was successful

Exceptions

System.SystemException null

com.sparsity.sparksee.gdb.Database com.sparsity.sparksee.gdb.Sparksee.Restore	(	System.String	path,
		System.String	backupFile
	)		throws System.IO.IOException, System.ApplicationException

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

System.IO.IOException	If the given file cannot be created, or the exported data file does not exists.
System.ApplicationException	null

com.sparsity.sparksee.gdb.Database com.sparsity.sparksee.gdb.Sparksee.Restore	(	System.String	path,
		System.String	backupFile,
		com.sparsity.sparksee.gdb.SparkseeConfig	config
	)		throws System.IO.IOException, System.ApplicationException

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

System.IO.IOException	If the given file cannot be created, or the exported data file does not exists.
System.ApplicationException	null

com.sparsity.sparksee.gdb.Database com.sparsity.sparksee.gdb.Sparksee.RestoreEncryptedBackup	(	System.String	path,
		System.String	backupFile,
		System.String	keyInHex,
		System.String	ivInHex
	)		throws System.IO.IOException, System.ApplicationException

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

System.IO.IOException	If the given file cannot be created, or the exported data file does not exists.
System.ApplicationException	null

com.sparsity.sparksee.gdb.Database com.sparsity.sparksee.gdb.Sparksee.RestoreEncryptedBackup	(	System.String	path,
		System.String	backupFile,
		com.sparsity.sparksee.gdb.SparkseeConfig	config,
		System.String	keyInHex,
		System.String	ivInHex
	)		throws System.IO.IOException, System.ApplicationException

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

System.IO.IOException	If the given file cannot be created, or the exported data file does not exists.
System.ApplicationException	null

bool com.sparsity.sparksee.gdb.Sparksee.VerifyChecksums ( System.String path ) throws System.IO.IOException, System.ApplicationException

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.

sparksee::gdb::FileNotFoundExceptionsparksee::gdb::Error

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

System.IO.IOException	null
System.ApplicationException	null

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation