Sparksee class. More...

Public Member Functions
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.ApplicationException, System.IO.IOException
	Restores a Database from an encrypted backup file.

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

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

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

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

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

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

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

void	RebuildDatabase (System.String path, com.sparsity.sparksee.gdb.SparkseeConfig config, bool minimizeDisk) throws System.ApplicationException, System.IO.IOException
	Rebuild the database from scratch with the same data.

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

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

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

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

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

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

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

void	Close ()
	Closes the Sparksee instance.

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

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

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

◆ Sparksee()

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

◆ AddChecksums()

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

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.ApplicationException	null
System.IO.IOException	null

◆ Close()

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

Closes the Sparksee instance.

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

◆ Create() [1/2]

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

Creates a new Database instance.

Errorfor other issues.

Parameters

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

Returns: A Database instance.

Exceptions

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

◆ Create() [2/2]

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.ApplicationException, System.IO.IOException

Creates a new Database instance.

Errorfor other issues.

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.ApplicationException	null
System.IO.IOException	If the given file cannot be created.

◆ Decrypt()

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

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.ApplicationException	null
System.IO.IOException	null

◆ Encrypt()

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

Converts a database WITHOUT encryption into an encrypted database.

Any error found is logged. The database (and it's recovery log if present) 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.ApplicationException	null
System.IO.IOException	null

◆ GetInMemoryPoolCapacity()

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

◆ IsClosed()

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.

◆ Open() [1/2]

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

Opens an existing Database instance.

Errorfor other issues.

Parameters

path	[in] Database storage file.
readOnly	[in] If TRUE, open Database in read-only mode.

Returns: A Database instance.

Exceptions

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

◆ Open() [2/2]

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

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. Errorfor other issues.

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.ApplicationException	null
System.IO.IOException	If the given file does not exist.

◆ RebuildDatabase()

void com.sparsity.sparksee.gdb.Sparksee.RebuildDatabase	(	System.String	path,
		com.sparsity.sparksee.gdb.SparkseeConfig	config,
		bool	minimizeDisk ) throws System.ApplicationException, System.IO.IOException

Rebuild the database from scratch with the same data.

It will create a new database on the same file with the same data but rebuilt from scratch, so the internal OIDs may change and the storage usage may be compacted.

It's the equivalent to extract a backup of the data and restore it. This operation can take a long time and the result file should be smaller than the original if there had been data removals or the data was not loaded in the most optimal order. But the file size could also end up being slightly bigger the the original in some cases (the data creation in the database was optimal and nothing had beed removed).

WARNING: If anything goes wrong while the database is being rebuilt you may lose the database. The data should not be lost, but it may require an additional process to recover it.

To avoid data loss, the next open after a failed rebuild operation will attempt to automatically recover the database by the fastest solution available (restoring the original file, finishing the almost completed rebuild or restoring a backup).

The source database is also kept until the rebuilt database is available to reduce the recovery time after a rebuild failure and avoid data loss risks. But if reducing the temporary disk usage is more important, you can use the minimizeDisk to delete it as soon as possible instead.

The final rebuilt database size will be the same whether you use the minimizeDisk argument or not.

Parameters

path	[In] The Sparksee database to rebuild.
config	[in] Use a specific configuration instead of the one in this Sparksee.
minimizeDisk	[in] Use less temporary disk space.

Exceptions

System.ApplicationException	null
System.IO.IOException	null

◆ RemoveChecksums()

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

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.ApplicationException	null
System.IO.IOException	null

◆ ResizeInMemoryPool()

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

Resizes the in memory pool allocator.

sparksee::gdb::SystemError

Parameters

newCapacity The new capacity of the in memory pool allocator

Returns: Returns true if was successful

Exceptions

System.SystemException null

◆ Restore() [1/2]

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

Restores a Database from a backup file.

See the Graph class Backup method. Errorfor other issues.

Parameters

path	[in] Database storage file.
backupFile	[in] The Backup file to be restored.

Returns: A Database instance.

Exceptions

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

◆ Restore() [2/2]

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.ApplicationException, System.IO.IOException

Restores a Database from a backup file.

See the Graph class Backup method. Errorfor other issues.

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.ApplicationException	null
System.IO.IOException	If the given file cannot be created, or the exported data file does not exists.

◆ RestoreEncryptedBackup() [1/2]

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.ApplicationException, System.IO.IOException

Restores a Database from an encrypted backup file.

See the Graph class EncryptedBackup method. Errorfor other issues.

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.ApplicationException	null
System.IO.IOException	If the given file cannot be created, or the exported data file does not exists.

◆ RestoreEncryptedBackup() [2/2]

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.ApplicationException, System.IO.IOException

Restores a Database from an encrypted backup file.

See the Graph class EncryptedBackup method. Errorfor other issues.

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.ApplicationException	null
System.IO.IOException	If the given file cannot be created, or the exported data file does not exists.

◆ VerifyChecksums()

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

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.ApplicationException	null
System.IO.IOException	null

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Sparksee()

Member Function Documentation

◆ AddChecksums()

◆ Close()

◆ Create() [1/2]

◆ Create() [2/2]

◆ Decrypt()

◆ Encrypt()

◆ GetInMemoryPoolCapacity()

◆ IsClosed()

◆ Open() [1/2]

◆ Open() [2/2]

◆ RebuildDatabase()

◆ RemoveChecksums()

◆ ResizeInMemoryPool()

◆ Restore() [1/2]

◆ Restore() [2/2]

◆ RestoreEncryptedBackup() [1/2]

◆ RestoreEncryptedBackup() [2/2]

◆ VerifyChecksums()