Sparksee configuration class. More...

Public Member Functions
void	SetRecoveryEnabled (bool status)
	Enables or disables the recovery.

void	SetLicensePreDownloadDays (int days)
	Start trying to automatically download a new license at the specified number of days before expiration.

int	GetExtentPages ()
	Gets the number of pages per extent.

bool	SaveAll ()
	Save all the current configuration settings in the specified config file.

System.String	GetAESKey ()
	Get the AES encryption key in a hexadecimal encoded string.

int	GetPoolPersistentMaxSize ()
	Gets the maximum size for the persistent pool in number of frames.

int	GetPoolTemporaryMinSize ()
	Gets the minimum size for the temporary pool in number of frames.

bool	GetCallStackDump ()
	Gets whether the signals will be captured to dump the call stack or not.

void	SetRecoveryCacheMaxSize (int extents)
	Sets the maximum size for the recovery log cache in extents.

bool	SetAESEncryptionEnabled (System.String keyInHex, System.String ivInHex)
	Enables storage encryption using AES with the given key and iv.

void	SetPluginsDir (System.String dirPath)
	Sets the Plugins directory.

bool	GetHighAvailabilityEnabled ()
	Gets whether high availability mode is enabled or disabled.

int	GetPoolPersistentMinSize ()
	Gets the minimum size for the persistent pool in number of frames.

void	SetChecksumEnabled (bool status)
	Enables or disables the storage checksum usage.

void	SetPoolPersistentMinSize (int frames)
	Sets the minimum size for the persistent pool in number of frames.

void	SetCacheStatisticsEnabled (bool status)
	Enables or disables cache statistics.

void	SetRecoveryCheckpointTime (long microSeconds)
	Sets the delay time (in microseconds) between automatic checkpoints.

void	SetEncryptionDisabled ()
	Disables storage encryption.

void	SetRecoveryLogFile (System.String filePath)
	Sets the recovery log file.

void	SetPoolFrameSize (int extents)
	Sets the size of a pool frame in number of extents.

System.String	GetRecoveryLogFile ()
	Gets the recovery log file.

void	SetHighAvailabilityEnabled (bool status)
	Enables or disables high availability mode.

long	GetCacheStatisticsSnapshotTime ()
	Gets the cache statistics snapshot time in microseconds.

int	GetExtentSize ()
	Gets the size of a extent.

System.String	GetSparkseeConfigFile ()
	Gets the config file path.

void	SetExtentSize (int kBytes)
	Sets the size of the extents in KB.

System.String	GetPluginsDir ()
	Gets the Plugins directory.

void	SetHighAvailabilityIP (System.String ip)
	Sets the IP address and port of the instance.

int	GetPoolTemporaryMaxSize ()
	Gets the maximum size for the temporary pool in number of frames.

void	SetInMemAllocSize (long size)
	Sets the in-memory allocator size.

	SparkseeConfig (System.String path)
	Creates a new instance with a specific config file.

void	SetHighAvailabilityMasterHistory (long filePath)
	Sets the master's history log.

void	SetTmpEnabled (bool enabled)
	Sets whether to use temporary storage for computations or not.

System.String	GetLogFile ()
	Gets the log file.

bool	GetTmpEnabled ()
	Gets whether using temporary storage for computations is enabled.

int	GetPoolFrameSize ()
	Gets the size of a pool frame in number of extents.

bool	GetCacheStatisticsEnabled ()
	Gets whether cache statistics are enabled or disabled.

void	SetHighAvailabilityCoordinators (System.String ip)
	Sets the coordinators address and port list.

void	SetHighAvailabilitySynchronization (long microSeconds)
	Sets the synchronization polling time.

System.String	GetClientId ()
	Gets the client identifier.

System.String	GetCacheStatisticsFile ()
	Gets the cache statistics log file.

void	SetSparkseeConfigFile (System.String path)
	Sets the config file path.

bool	Save ()
	Save the current configuration in the specified config file.

void	SetPoolPersistentMaxSize (int frames)
	Sets the maximum size for the persistent pool in number of frames.

com.sparsity.sparksee.gdb.LogLevel	GetLogLevel ()
	Gets the log level.

int	SetLicense (System.String key)
	Sets the license key.

System.String	GetDownloadStatus ()
	Gets a message with the license download result.

void	SetLicenseId (System.String licenseId)
	Set the license identifier.

System.String	GetLicense ()
	Gets the license key.

System.String	GetHighAvailabilityIP ()
	Gets the IP address and port of the instance.

bool	SetAESEncryptionEnabled (int keySize)
	Enables storage encryption using AES and GENARATES a key and an iv.

long	GetInMemAllocSize ()
	Gets the in-memory allocator size.

int	GetLicensePreDownloadDays ()
	Get the number of days before expiration when a new license will be downloaded.

void	SetCallStackDump (bool status)
	Sets whether the signals will be captured to dump the call stack or not.

int	DownloadLicense ()
	Try to download a license key Can be used to explicitly download a license when the autodownload is disabled (LicensePreDownloadDays == -1).

bool	GetRecoveryEnabled ()
	Gets whether the recovery is enabled or disabled.

System.String	GetLicenseRequest ()
	Get information useful to manually request a license.

void	SetCacheStatisticsFile (System.String filePath)
	Sets the cache statistics log file.

System.String	GetTmpFolder ()
	Gets the temporary folder used for temporary staging.

int	GetPoolPartitions ()
	Gets the number of partitions in each PartitionedPool.

System.String	GetHighAvailabilityCoordinators ()
	Gets the coordinators address and port list.

long	GetRecoveryCheckpointTime ()
	Gets the delay time (in microseconds) between automatic checkpoints.

void	SetLogFile (System.String filePath)
	Sets the log file.

void	SetExtentPages (int pages)
	Sets the number of pages per extent.

void	SetClientId (System.String clientId)
	Set the client identifier.

void	SetLogLevel (com.sparsity.sparksee.gdb.LogLevel level)
	Sets the log level.

int	GetRecoveryCacheMaxSize ()
	Gets the maximum size for the recovery log cache in extents.

bool	GetChecksumEnabled ()
	Gets whether the storage checksum usage is enabled or disabled.

long	GetHighAvailabilitySynchronization ()
	Gets the synchronization polling time.

long	GetHighAvailabilityMasterHistory ()
	Gets the master's history log.

System.String	GetLicenseId ()
	Gets the license identifier.

	SparkseeConfig (System.String path, System.String clientId, System.String licenseId)
	Creates a new instance with a specific config file and IDs.

System.String	GetAESIV ()
	Get the AES initialization vector in a hexadecimal encoded string.

bool	GetEncryptionEnabled ()
	Gets whether the storage encryption is enabled or disabled.

void	SetPoolPartitions (int pools)
	Sets the number of pools in each PartitionedPool.

bool	GetRollbackEnabled ()
	Gets whether the rollback is enabled or disabled.

void	SetPoolTemporaryMaxSize (int frames)
	Sets the maximum size for the temporary pool in number of frames.

int	GetCacheMaxSize ()
	Gets the maximum size for the cache (all pools) in MB.

void	SetRollbackEnabled (bool status)
	Enables or disables the rollback.

void	SetTmpFolder (System.String tmpFolder)
	Sets the temporary folder used for temporary staging.

void	SetCacheStatisticsSnapshotTime (long microSeconds)
	Sets the cache statistics snapshot time.

void	SetCacheMaxSize (int megaBytes)
	Sets the maximum size for the cache (all pools) in MB.

	SparkseeConfig ()
	Creates a new instance.

void	SetPoolTemporaryMinSize (int frames)
	Sets the minimum size for the temporary pool in number of frames.

bool	DownloadExpected ()
	Check if a new license will be automatically downloaded with the current settings.

Detailed Description

Sparksee configuration class.

If not specified, 0 means unlimited which is the maximum available. For the pools that's the total cache size. For the cache unlimited means nearly all the physical memory of the computer.

For each field, there is a default value. This value can be overrided with values from a properties file (see SparkseeProperties class). Also, this settings can be overrided calling a specific setter.

For each field, it is shown its default value and the property to override this value:

Extent size: 4KB ('sparksee.storage.extentsize' at SparkseeProperties).

Pages per extent: 1 page ('sparksee.storage.extentpages' at SparkseeProperties).

Checksums enabled: true ('sparksee.storage.checksum' at SparkseeProperties).

Pool frame size: 1 extent ('sparksee.io.pool.frame.size' at SparkseeProperties).

Minimum size for the persistent pool: 64 frames ('sparksee.io.pool.persistent.minsize' at SparkseeProperties).

Maximum size for the persistent pool: 0 frames ('sparksee.io.pool.persistent.maxsize' at SparkseeProperties).

Minimum size for the temporary pool: 16 frames ('sparksee.io.pool.temporal.minsize' at SparkseeProperties).

Maximum size for the temporary pool: 0 frames ('sparksee.io.pool.temporal.maxsize' at SparkseeProperties).

Number of pools in the pool cluster: 0 pools ('sparksee.io.pool.clustersize' at SparkseeProperties). 0 or 1 means the clustering is disabled.

Maximum size for the cache (all pools): 0 MB ('sparksee.io.cache.maxsize' at SparkseeProperties).

License code: "" ('sparksee.license' at SparkseeProperties). No license code means evaluation license.

Log level: Info ('sparksee.log.level' at SparkseeProperties).

Log file: "sparksee.log" ('sparksee.log.file' at SparkseeProperties).

Cache statistics: false (disabled) ('sparksee.cache.statistics' at SparkseeProperties).

Cache statistics log file: "statistics.log" ('sparksee.cache.statisticsFile' at SparkseeProperties).

Cache statistics snapshot time: 1000 msecs [TimeUnit] ('sparksee.cache.statisticsSnapshotTime' at SparkseeProperties).

Recovery enabled: false ('sparksee.io.recovery' at SparkseeProperties).

Recovery log file: "" ('sparksee.io.recovery.logfile' at SparkseeProperties).

Recovery cache max size: 1MB ('sparksee.io.recovery.cachesize' at SparkseeProperties).

Recovery checkpoint time: 60 seconds [TimeUnit] ('sparksee.io.recovery.checkpointTime' at SparkseeProperties).

High-availability: false (disabled) ('sparksee.ha' at SparkseeProperties).

High-availability coordinators: "" ('sparksee.ha.coordinators' at SparkseeProperties).

High-availability IP: "" ('sparksee.ha.ip' at SparkseeProperties).

High-availability sync polling: 0 (disabled) [TimeUnit] ('sparksee.ha.sync' at SparkseeProperties).

High-availability master history: 1D (1 day) [TimeUnit] ('sparksee.ha.master.history' at SparkseeProperties).

Use of TimeUnit:

Those variables using TimeUnit allow for:

<X>[D|H|M|S|s|m|u]

where <X> is a number followed by an optional character which represents the unit: D for days, H for hours, M for minutes, S or s for seconds, m for milliseconds and u for microseconds. If no unit character is given, seconds are assumed.

Capture abort signals to dump the call stack ('sparksee.callstackdump' at SparkseeProperties) is enabled by default on most platforms.

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

Constructor & Destructor Documentation

◆ SparkseeConfig() [1/3]

com.sparsity.sparksee.gdb.SparkseeConfig.SparkseeConfig ( System.String path )

Creates a new instance with a specific config file.

The config file will be loaded using the global properties class and the file may be automatically overwritten with the config changes. If the file doesn't exists, it will be created.

Parameters

path	[in] File path to the config file.

◆ SparkseeConfig() [2/3]

com.sparsity.sparksee.gdb.SparkseeConfig.SparkseeConfig	(	System.String	path,
		System.String	clientId,
		System.String	licenseId )

Creates a new instance with a specific config file and IDs.

The config file will be loaded using the global properties class and the file may be automatically overwritten with the config changes. If the config file already exists, the client and license ids should have the same values as the given arguments. If the file doesn't exists, it will be created.

Parameters

path	[in] File path to the config file.
clientId	[in] The client identifier.
licenseId	[in] The license identifier.

◆ SparkseeConfig() [3/3]

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

Creates a new instance.

Values are set with default values.

Member Function Documentation

◆ DownloadLicense()

int com.sparsity.sparksee.gdb.SparkseeConfig.DownloadLicense ( )

Try to download a license key Can be used to explicitly download a license when the autodownload is disabled (LicensePreDownloadDays == -1).

Returns: Returns -1 if a valid license key couldn't be downloaded, 0 if the same license was downloaded or 1 if a different license is downloaded.

◆ GetAESIV()

System.String com.sparsity.sparksee.gdb.SparkseeConfig.GetAESIV ( )

Get the AES initialization vector in a hexadecimal encoded string.

Returns: The AES initialization vector as an hexadecimal string.

◆ GetAESKey()

System.String com.sparsity.sparksee.gdb.SparkseeConfig.GetAESKey ( )

Get the AES encryption key in a hexadecimal encoded string.

Returns: The AES encryption Key as an hexadecimal string.

◆ GetCacheMaxSize()

int com.sparsity.sparksee.gdb.SparkseeConfig.GetCacheMaxSize ( )

Gets the maximum size for the cache (all pools) in MB.

Returns: The maximum size for the cache (all pools) in MB.

◆ GetCacheStatisticsEnabled()

bool com.sparsity.sparksee.gdb.SparkseeConfig.GetCacheStatisticsEnabled ( )

Gets whether cache statistics are enabled or disabled.

Returns: TRUE if cache statistics are enabled, FALSE otherwise.

◆ GetCacheStatisticsFile()

System.String com.sparsity.sparksee.gdb.SparkseeConfig.GetCacheStatisticsFile ( )

Gets the cache statistics log file.

Useless if cache statistics are disabled.

Returns: The cache statistics log file.

◆ GetCacheStatisticsSnapshotTime()

long com.sparsity.sparksee.gdb.SparkseeConfig.GetCacheStatisticsSnapshotTime ( )

Gets the cache statistics snapshot time in microseconds.

Useless if cache statistics are disabled.

Returns: The cache statistics snapshot time in microseconds.

◆ GetCallStackDump()

bool com.sparsity.sparksee.gdb.SparkseeConfig.GetCallStackDump ( )

Gets whether the signals will be captured to dump the call stack or not.

Returns: TRUE if the signals must be captured, FALSE otherwise.

◆ GetChecksumEnabled()

bool com.sparsity.sparksee.gdb.SparkseeConfig.GetChecksumEnabled ( )

Gets whether the storage checksum usage is enabled or disabled.

Returns: TRUE if the checksum is enabled, FALSE otherwise.

◆ GetClientId()

System.String com.sparsity.sparksee.gdb.SparkseeConfig.GetClientId ( )

Gets the client identifier.

Returns: The client identifier.

◆ GetDownloadStatus()

System.String com.sparsity.sparksee.gdb.SparkseeConfig.GetDownloadStatus ( )

Gets a message with the license download result.

It can be used when the DownloadLicense call failed.

Returns: The log download result.

◆ GetEncryptionEnabled()

bool com.sparsity.sparksee.gdb.SparkseeConfig.GetEncryptionEnabled ( )

Gets whether the storage encryption is enabled or disabled.

Returns: TRUE if the encryption is enabled, FALSE otherwise.

◆ GetExtentPages()

int com.sparsity.sparksee.gdb.SparkseeConfig.GetExtentPages ( )

Gets the number of pages per extent.

Returns: The number of pages per extent.

◆ GetExtentSize()

int com.sparsity.sparksee.gdb.SparkseeConfig.GetExtentSize ( )

Gets the size of a extent.

Returns: The size of a extent in KB.

◆ GetHighAvailabilityCoordinators()

System.String com.sparsity.sparksee.gdb.SparkseeConfig.GetHighAvailabilityCoordinators ( )

Gets the coordinators address and port list.

Returns: The coordinators address and port list.

◆ GetHighAvailabilityEnabled()

bool com.sparsity.sparksee.gdb.SparkseeConfig.GetHighAvailabilityEnabled ( )

Gets whether high availability mode is enabled or disabled.

Returns: TRUE if high availability mode is enabled, FALSE otherwise.

◆ GetHighAvailabilityIP()

System.String com.sparsity.sparksee.gdb.SparkseeConfig.GetHighAvailabilityIP ( )

Gets the IP address and port of the instance.

Returns: The IP address and port of the instance.

◆ GetHighAvailabilityMasterHistory()

long com.sparsity.sparksee.gdb.SparkseeConfig.GetHighAvailabilityMasterHistory ( )

Gets the master's history log.

Returns: The master's history log.

◆ GetHighAvailabilitySynchronization()

long com.sparsity.sparksee.gdb.SparkseeConfig.GetHighAvailabilitySynchronization ( )

Gets the synchronization polling time.

Returns: The Synchronization polling time.

◆ GetInMemAllocSize()

long com.sparsity.sparksee.gdb.SparkseeConfig.GetInMemAllocSize ( )

Gets the in-memory allocator size.

Returns: Returns the in-memory allocator size

◆ GetLicense()

System.String com.sparsity.sparksee.gdb.SparkseeConfig.GetLicense ( )

Gets the license key.

Returns: The license key.

◆ GetLicenseId()

System.String com.sparsity.sparksee.gdb.SparkseeConfig.GetLicenseId ( )

Gets the license identifier.

Returns: The license identifier.

◆ GetLicensePreDownloadDays()

int com.sparsity.sparksee.gdb.SparkseeConfig.GetLicensePreDownloadDays ( )

Get the number of days before expiration when a new license will be downloaded.

Returns: Returns the number of days or -1 if it will never be automatically downloaded.

◆ GetLogFile()

System.String com.sparsity.sparksee.gdb.SparkseeConfig.GetLogFile ( )

Gets the log file.

Returns: The log file.

◆ GetLogLevel()

com.sparsity.sparksee.gdb.LogLevel com.sparsity.sparksee.gdb.SparkseeConfig.GetLogLevel ( )

Gets the log level.

Returns: The LogLevel.

◆ GetPluginsDir()

System.String com.sparsity.sparksee.gdb.SparkseeConfig.GetPluginsDir ( )

Gets the Plugins directory.

Returns: The pulgins directory.

◆ GetPoolFrameSize()

int com.sparsity.sparksee.gdb.SparkseeConfig.GetPoolFrameSize ( )

Gets the size of a pool frame in number of extents.

Returns: The size of a pool frame in number of extents.

◆ GetPoolPartitions()

int com.sparsity.sparksee.gdb.SparkseeConfig.GetPoolPartitions ( )

Gets the number of partitions in each PartitionedPool.

Returns: The number of partitions in each PartitionedPool.

◆ GetPoolPersistentMaxSize()

int com.sparsity.sparksee.gdb.SparkseeConfig.GetPoolPersistentMaxSize ( )

Gets the maximum size for the persistent pool in number of frames.

Returns: The maximum size for the persistent pool in number of frames.

◆ GetPoolPersistentMinSize()

int com.sparsity.sparksee.gdb.SparkseeConfig.GetPoolPersistentMinSize ( )

Gets the minimum size for the persistent pool in number of frames.

Returns: The minimum size for the persistent pool in number of frames.

◆ GetPoolTemporaryMaxSize()

int com.sparsity.sparksee.gdb.SparkseeConfig.GetPoolTemporaryMaxSize ( )

Gets the maximum size for the temporary pool in number of frames.

Returns: The maximum size for the temporary pool in number of frames.

◆ GetPoolTemporaryMinSize()

int com.sparsity.sparksee.gdb.SparkseeConfig.GetPoolTemporaryMinSize ( )

Gets the minimum size for the temporary pool in number of frames.

Returns: The minimum size for the temporary pool in number of frames.

◆ GetRecoveryCacheMaxSize()

int com.sparsity.sparksee.gdb.SparkseeConfig.GetRecoveryCacheMaxSize ( )

Gets the maximum size for the recovery log cache in extents.

Returns: The maximum size for the recovery log cache in extents.

◆ GetRecoveryCheckpointTime()

long com.sparsity.sparksee.gdb.SparkseeConfig.GetRecoveryCheckpointTime ( )

Gets the delay time (in microseconds) between automatic checkpoints.

Returns: The delay time (in microseconds) between automatic checkpoints.

◆ GetRecoveryEnabled()

bool com.sparsity.sparksee.gdb.SparkseeConfig.GetRecoveryEnabled ( )

Gets whether the recovery is enabled or disabled.

Returns: TRUE if the recovery is enabled, FALSE otherwise.

◆ GetRecoveryLogFile()

System.String com.sparsity.sparksee.gdb.SparkseeConfig.GetRecoveryLogFile ( )

Gets the recovery log file.

Returns: The recovery log file.

◆ GetRollbackEnabled()

bool com.sparsity.sparksee.gdb.SparkseeConfig.GetRollbackEnabled ( )

Gets whether the rollback is enabled or disabled.

Returns: TRUE if the rollback is enabled, FALSE otherwise.

◆ GetSparkseeConfigFile()

System.String com.sparsity.sparksee.gdb.SparkseeConfig.GetSparkseeConfigFile ( )

Gets the config file path.

Returns: Returns the configured path or an empty string

◆ GetTmpEnabled()

bool com.sparsity.sparksee.gdb.SparkseeConfig.GetTmpEnabled ( )

Gets whether using temporary storage for computations is enabled.

Returns: True if enabled

◆ GetTmpFolder()

System.String com.sparsity.sparksee.gdb.SparkseeConfig.GetTmpFolder ( )

Gets the temporary folder used for temporary staging.

Returns: The temporary folder path

◆ Save()

bool com.sparsity.sparksee.gdb.SparkseeConfig.Save ( )

Save the current configuration in the specified config file.

It will try to save the current configuration only if a config file was specified. This method will be automatically used when a Sparksee class downloads a new License.

Returns: Returns true if the config file is successfully written or false otherwise.

◆ SaveAll()

bool com.sparsity.sparksee.gdb.SparkseeConfig.SaveAll ( )

Save all the current configuration settings in the specified config file.

It will try to save the current configuration only if a config file was specified. The saved config file WILL CONATAIN all the modified settings including the secret ENCRYPTION KEYS. You should usually just use the Save method instead.

Returns: Returns true if the config file is successfully written or false otherwise.

◆ SetAESEncryptionEnabled() [1/2]

bool com.sparsity.sparksee.gdb.SparkseeConfig.SetAESEncryptionEnabled ( int keySize )

Enables storage encryption using AES and GENARATES a key and an iv.

YOU MUST GET AND KEEP SAFE THE GENERATED KEY AND IV! The key and initialization vector will not be saved in the config file.

Parameters

keySize [In] The key size in bytes (8, 16 or 32).

Returns: Returns true if the encryption had been enabled.

◆ SetAESEncryptionEnabled() [2/2]

bool com.sparsity.sparksee.gdb.SparkseeConfig.SetAESEncryptionEnabled	(	System.String	keyInHex,
		System.String	ivInHex )

Enables storage encryption using AES with the given key and iv.

The key and initialization vector will not be saved in the config file.

Parameters

keyInHex	[In] The AES encryption Key as an hexadecimal string (8, 16 or 32 bytes).
ivInHex	[In] The AES Initialization Vector as an hexadecimal string (16 bytes).

Returns: Returns true if the encryption had been enabled with the given arguments or false otherwise.

◆ SetCacheMaxSize()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetCacheMaxSize ( int megaBytes )

Sets the maximum size for the cache (all pools) in MB.

Parameters

megaBytes [in] The maximum size for the cache (all pools) in MB. It must be non-negative.

◆ SetCacheStatisticsEnabled()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetCacheStatisticsEnabled ( bool status )

Enables or disables cache statistics.

Parameters

status [in] If TRUE this enables cache statistics, if FALSE this disables cache statistics.

◆ SetCacheStatisticsFile()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetCacheStatisticsFile ( System.String filePath )

Sets the cache statistics log file.

Useless if cache statistics are disabled.

Parameters

filePath [in] The cache statistics log file.

◆ SetCacheStatisticsSnapshotTime()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetCacheStatisticsSnapshotTime ( long microSeconds )

Sets the cache statistics snapshot time.

Useless if cache statistics are disabled.

Parameters

microSeconds [in] The cache statistics snapshot time in microseconds.

◆ SetCallStackDump()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetCallStackDump ( bool status )

Sets whether the signals will be captured to dump the call stack or not.

Parameters

status [in] If TRUE signals must be captured.

◆ SetChecksumEnabled()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetChecksumEnabled ( bool status )

Enables or disables the storage checksum usage.

Parameters

status [in] If TRUE this enables the checksum, if FALSE then disables it.

◆ SetClientId()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetClientId ( System.String clientId )

Set the client identifier.

If you don't have a client identifier, you may want to register at http://sparsity-technologies.com/#sparksee

Parameters

clientId [in] The client identifier.

◆ SetExtentPages()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetExtentPages ( int pages )

Sets the number of pages per extent.

Parameters

pages [in] The number of pages. It must be at least 1 page and the page size must be greater than or equal to 4KB.

◆ SetExtentSize()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetExtentSize ( int kBytes )

Sets the size of the extents in KB.

Parameters

kBytes [in] The size of an extent in KB. An extent can have a size between 4KB and 64KB, and it must be a power of 2.

◆ SetHighAvailabilityCoordinators()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetHighAvailabilityCoordinators ( System.String ip )

Sets the coordinators address and port list.

Parameters

ip	[in] The coordinators address and port list.

◆ SetHighAvailabilityEnabled()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetHighAvailabilityEnabled ( bool status )

Enables or disables high availability mode.

Parameters

status [in] If TRUE this enables high availability mode, if FALSE this disables high availability mode.

◆ SetHighAvailabilityIP()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetHighAvailabilityIP ( System.String ip )

Sets the IP address and port of the instance.

Parameters

ip	[in] The IP address and port of the instance.

◆ SetHighAvailabilityMasterHistory()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetHighAvailabilityMasterHistory ( long filePath )

Sets the master's history log.

Parameters

filePath [in] The master's history log.

◆ SetHighAvailabilitySynchronization()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetHighAvailabilitySynchronization ( long microSeconds )

Sets the synchronization polling time.

Parameters

microSeconds [in] The synchronization polling time.

◆ SetInMemAllocSize()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetInMemAllocSize ( long size )

Sets the in-memory allocator size.

Parameters

size	The size to set the in-memory allocator to

◆ SetLicense()

int com.sparsity.sparksee.gdb.SparkseeConfig.SetLicense ( System.String key )

Sets the license key.

Parameters

key	[in] The license key. Returns -1 if the new key can't be used, 0 if it's the same license or 1 if the new license is applied.

◆ SetLicenseId()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetLicenseId ( System.String licenseId )

Set the license identifier.

If you don't have a license identifier, you may want to register at http://sparsity-technologies.com/#sparksee

Parameters

licenseId [in] The license identifier.

◆ SetLicensePreDownloadDays()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetLicensePreDownloadDays ( int days )

Start trying to automatically download a new license at the specified number of days before expiration.

Parameters

days	[in] Number of days before expiration or -1 if the license should never be downloaded.

◆ SetLogFile()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetLogFile ( System.String filePath )

Sets the log file.

Parameters

filePath [in] The log file.

◆ SetLogLevel()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetLogLevel ( com.sparsity.sparksee.gdb.LogLevel level )

Sets the log level.

Parameters

level [in] The LogLevel.

◆ SetPluginsDir()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetPluginsDir ( System.String dirPath )

Sets the Plugins directory.

Parameters

dirPath [in] The plugins directory path.

◆ SetPoolFrameSize()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetPoolFrameSize ( int extents )

Sets the size of a pool frame in number of extents.

Parameters

extents [in] The size of a pool frame in number of extents. It must be non-negative.

◆ SetPoolPartitions()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetPoolPartitions ( int pools )

Sets the number of pools in each PartitionedPool.

Parameters

pools [in] The number of pools in each PartitionedPool. It must be non-negative.

◆ SetPoolPersistentMaxSize()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetPoolPersistentMaxSize ( int frames )

Sets the maximum size for the persistent pool in number of frames.

Parameters

frames [in] The maximum size for the persistent pool in number of frames. It must be non-negative.

◆ SetPoolPersistentMinSize()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetPoolPersistentMinSize ( int frames )

Sets the minimum size for the persistent pool in number of frames.

Parameters

frames [in] The minimum size for the persistent pool in number of frames. It must be non-negative.

◆ SetPoolTemporaryMaxSize()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetPoolTemporaryMaxSize ( int frames )

Sets the maximum size for the temporary pool in number of frames.

Parameters

frames [in] The maximum size for the temporary pool in number of frames. It must be non-negative.

◆ SetPoolTemporaryMinSize()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetPoolTemporaryMinSize ( int frames )

Sets the minimum size for the temporary pool in number of frames.

Parameters

frames [in] The minimum size for the temporary pool in number of frames. It must be non-negative.

◆ SetRecoveryCacheMaxSize()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetRecoveryCacheMaxSize ( int extents )

Sets the maximum size for the recovery log cache in extents.

Parameters

extents [in] The maximum size for the recovery log cache in extents. A 0 sets the default value (extents up to 1MB).

◆ SetRecoveryCheckpointTime()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetRecoveryCheckpointTime ( long microSeconds )

Sets the delay time (in microseconds) between automatic checkpoints.

Parameters

microSeconds [in] The delay time (in microseconds) between automatic checkpoints. A 0 forces a checkpoint after each commited transaction.

◆ SetRecoveryEnabled()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetRecoveryEnabled ( bool status )

Enables or disables the recovery.

Parameters

status [in] If TRUE this enables the recovery, if FALSE then disables it.

◆ SetRecoveryLogFile()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetRecoveryLogFile ( System.String filePath )

Sets the recovery log file.

Parameters

filePath [in] The recovery log file. Left it empty for the default log file (same as <database_file_name>.log)

◆ SetRollbackEnabled()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetRollbackEnabled ( bool status )

Enables or disables the rollback.

Parameters

status [in] If TRUE this enables the rollback, if FALSE then disables it.

◆ SetSparkseeConfigFile()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetSparkseeConfigFile ( System.String path )

Sets the config file path.

The file is not loaded in this operation, see the constructor options if you need to load the file. The config file may be automatically overwritten with the config changes. If the file doesn't exists, it will be created.

Parameters

path	[in] File path to the config file.

◆ SetTmpEnabled()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetTmpEnabled ( bool enabled )

Sets whether to use temporary storage for computations or not.

Parameters

enabled True to use temporary storage for computation

◆ SetTmpFolder()

void com.sparsity.sparksee.gdb.SparkseeConfig.SetTmpFolder ( System.String tmpFolder )

Sets the temporary folder used for temporary staging.

Parameters

tmpFolder The temporary folder to set

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SparkseeConfig() [1/3]

◆ SparkseeConfig() [2/3]

◆ SparkseeConfig() [3/3]

Member Function Documentation

◆ DownloadLicense()

◆ GetAESIV()

◆ GetAESKey()

◆ GetCacheMaxSize()

◆ GetCacheStatisticsEnabled()

◆ GetCacheStatisticsFile()

◆ GetCacheStatisticsSnapshotTime()

◆ GetCallStackDump()

◆ GetChecksumEnabled()

◆ GetClientId()

◆ GetDownloadStatus()

◆ GetEncryptionEnabled()

◆ GetExtentPages()

◆ GetExtentSize()

◆ GetHighAvailabilityCoordinators()

◆ GetHighAvailabilityEnabled()

◆ GetHighAvailabilityIP()

◆ GetHighAvailabilityMasterHistory()

◆ GetHighAvailabilitySynchronization()

◆ GetInMemAllocSize()

◆ GetLicense()

◆ GetLicenseId()

◆ GetLicensePreDownloadDays()

◆ GetLogFile()

◆ GetLogLevel()

◆ GetPluginsDir()

◆ GetPoolFrameSize()

◆ GetPoolPartitions()

◆ GetPoolPersistentMaxSize()

◆ GetPoolPersistentMinSize()

◆ GetPoolTemporaryMaxSize()

◆ GetPoolTemporaryMinSize()

◆ GetRecoveryCacheMaxSize()

◆ GetRecoveryCheckpointTime()

◆ GetRecoveryEnabled()

◆ GetRecoveryLogFile()

◆ GetRollbackEnabled()

◆ GetSparkseeConfigFile()

◆ GetTmpEnabled()

◆ GetTmpFolder()

◆ Save()

◆ SaveAll()

◆ SetAESEncryptionEnabled() [1/2]

◆ SetAESEncryptionEnabled() [2/2]

◆ SetCacheMaxSize()

◆ SetCacheStatisticsEnabled()

◆ SetCacheStatisticsFile()

◆ SetCacheStatisticsSnapshotTime()

◆ SetCallStackDump()

◆ SetChecksumEnabled()

◆ SetClientId()

◆ SetExtentPages()

◆ SetExtentSize()

◆ SetHighAvailabilityCoordinators()

◆ SetHighAvailabilityEnabled()

◆ SetHighAvailabilityIP()

◆ SetHighAvailabilityMasterHistory()

◆ SetHighAvailabilitySynchronization()

◆ SetInMemAllocSize()

◆ SetLicense()

◆ SetLicenseId()

◆ SetLicensePreDownloadDays()

◆ SetLogFile()

◆ SetLogLevel()

◆ SetPluginsDir()

◆ SetPoolFrameSize()

◆ SetPoolPartitions()

◆ SetPoolPersistentMaxSize()

◆ SetPoolPersistentMinSize()

◆ SetPoolTemporaryMaxSize()

◆ SetPoolTemporaryMinSize()

◆ SetRecoveryCacheMaxSize()

◆ SetRecoveryCheckpointTime()