Sparksee configuration class. More...

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

	SparkseeConfig (const std::wstring &path)
	Creates a new instance with a specific config file. More...

	SparkseeConfig (const std::wstring &path, const std::wstring &clientId, const std::wstring &licenseId)
	Creates a new instance with a specific config file and IDs. More...

virtual	~SparkseeConfig ()
	Destructor.

int32_t	GetExtentSize () const
	Gets the size of a extent. More...

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

int32_t	GetExtentPages () const
	Gets the number of pages per extent. More...

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

int32_t	GetPoolFrameSize () const
	Gets the size of a pool frame in number of extents. More...

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

int32_t	GetPoolPersistentMinSize () const
	Gets the minimum size for the persistent pool in number of frames. More...

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

int32_t	GetPoolPersistentMaxSize () const
	Gets the maximum size for the persistent pool in number of frames. More...

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

int32_t	GetPoolTemporaryMinSize () const
	Gets the minimum size for the temporary pool in number of frames. More...

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

int32_t	GetPoolTemporaryMaxSize () const
	Gets the maximum size for the temporary pool in number of frames. More...

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

int32_t	GetPoolPartitions () const
	Gets the number of partitions in each PartitionedPool. More...

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

int32_t	GetCacheMaxSize () const
	Gets the maximum size for the cache (all pools) in MB. More...

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

const std::wstring &	GetLicense () const
	Gets the license key. More...

int32_t	SetLicense (const std::wstring &key)
	Sets the license key. More...

const std::wstring &	GetLogFile () const
	Gets the log file. More...

void	SetLogFile (const std::wstring &filePath)
	Sets the log file. More...

LogLevel	GetLogLevel () const
	Gets the log level. More...

void	SetLogLevel (LogLevel level)
	Sets the log level. More...

bool_t	GetCacheStatisticsEnabled () const
	Gets whether cache statistics are enabled or disabled. More...

void	SetCacheStatisticsEnabled (bool_t status)
	Enables or disables cache statistics. More...

const std::wstring &	GetCacheStatisticsFile () const
	Gets the cache statistics log file. More...

void	SetCacheStatisticsFile (const std::wstring &filePath)
	Sets the cache statistics log file. More...

int64_t	GetCacheStatisticsSnapshotTime () const
	Gets the cache statistics snapshot time in microseconds. More...

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

bool_t	GetRollbackEnabled () const
	Gets whether the rollback is enabled or disabled. More...

void	SetRollbackEnabled (bool_t status)
	Enables or disables the rollback. More...

bool_t	GetRecoveryEnabled () const
	Gets whether the recovery is enabled or disabled. More...

void	SetRecoveryEnabled (bool_t status)
	Enables or disables the recovery. More...

const std::wstring &	GetRecoveryLogFile () const
	Gets the recovery log file. More...

void	SetRecoveryLogFile (const std::wstring &filePath)
	Sets the recovery log file. More...

int32_t	GetRecoveryCacheMaxSize () const
	Gets the maximum size for the recovery log cache in extents. More...

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

int64_t	GetRecoveryCheckpointTime () const
	Gets the delay time (in microseconds) between automatic checkpoints. More...

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

bool_t	GetChecksumEnabled () const
	Gets whether the storage checksum usage is enabled or disabled. More...

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

bool_t	GetHighAvailabilityEnabled () const
	Gets whether high availability mode is enabled or disabled. More...

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

const std::wstring &	GetHighAvailabilityIP () const
	Gets the IP address and port of the instance. More...

void	SetHighAvailabilityIP (const std::wstring &ip)
	Sets the IP address and port of the instance. More...

const std::wstring &	GetHighAvailabilityCoordinators () const
	Gets the coordinators address and port list. More...

void	SetHighAvailabilityCoordinators (const std::wstring &ip)
	Sets the coordinators address and port list. More...

int64_t	GetHighAvailabilitySynchronization () const
	Gets the synchronization polling time. More...

void	SetHighAvailabilitySynchronization (int64_t microSeconds)
	Sets the synchronization polling time. More...

int64_t	GetHighAvailabilityMasterHistory () const
	Gets the master's history log. More...

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

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

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

const std::wstring &	GetClientId () const
	Gets the client identifier. More...

void	SetClientId (const std::wstring &clientId)
	Set the client identifier. More...

const std::wstring &	GetLicenseId () const
	Gets the license identifier. More...

void	SetLicenseId (const std::wstring &licenseId)
	Set the license identifier. More...

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

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

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

const std::wstring &	GetDownloadStatus () const
	Gets a message with the license download result. More...

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

std::wstring	GetLicenseRequest ()
	Get information useful to manually request a license.

const std::wstring &	GetTmpFolder () const
	Gets the temporary folder used for temporary staging. More...

void	SetTmpFolder (const std::wstring &tmpFolder)
	Sets the temporary folder used for temporary staging. More...

bool_t	GetTmpEnabled () const
	Gets whether using temporary storage for computations is enabled. More...

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

int64_t	GetInMemAllocSize () const
	Gets the in-memory allocator size. More...

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

bool_t	Save ()
	Save the current configuration in the specified config file. More...

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

bool_t	GetEncryptionEnabled () const
	Gets whether the storage encryption is enabled or disabled. More...

bool_t	SetAESEncryptionEnabled (const std::wstring &keyInHex, const std::wstring &ivInHex)
	Enables storage encryption using AES with the given key and iv. More...

bool_t	SetAESEncryptionEnabled (int32_t keySize)
	Enables storage encryption using AES and GENARATES a key and an iv. More...

const std::wstring &	GetAESKey () const
	Get the AES encryption key in a hexadecimal encoded string. More...

const std::wstring &	GetAESIV () const
	Get the AES initialization vector in a hexadecimal encoded string. More...

void	SetEncryptionDisabled ()
	Disables storage encryption.

void	SetSparkseeConfigFile (const std::wstring &path)
	Sets the config file path. More...

const std::wstring &	GetSparkseeConfigFile () const
	Gets the config file path. More...

Friends
class	Sparksee

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::SparkseeConfig ( )

Creates a new instance.

Values are set with default values.

SparkseeConfig::SparkseeConfig ( const std::wstring & 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::SparkseeConfig	(	const std::wstring &	path,
		const std::wstring &	clientId,
		const std::wstring &	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.

Member Function Documentation

int32_t 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.

const std::wstring& SparkseeConfig::GetAESIV ( ) const

Get the AES initialization vector in a hexadecimal encoded string.

Returns: The AES initialization vector as an hexadecimal string.

const std::wstring& SparkseeConfig::GetAESKey ( ) const

Get the AES encryption key in a hexadecimal encoded string.

Returns: The AES encryption Key as an hexadecimal string.

int32_t SparkseeConfig::GetCacheMaxSize ( ) const

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

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

bool_t SparkseeConfig::GetCacheStatisticsEnabled ( ) const

Gets whether cache statistics are enabled or disabled.

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

const std::wstring& SparkseeConfig::GetCacheStatisticsFile ( ) const

Gets the cache statistics log file.

Useless if cache statistics are disabled.

Returns: The cache statistics log file.

int64_t SparkseeConfig::GetCacheStatisticsSnapshotTime ( ) const

Gets the cache statistics snapshot time in microseconds.

Useless if cache statistics are disabled.

Returns: The cache statistics snapshot time in microseconds.

bool_t SparkseeConfig::GetCallStackDump ( ) const

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

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

bool_t SparkseeConfig::GetChecksumEnabled ( ) const

Gets whether the storage checksum usage is enabled or disabled.

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

const std::wstring& SparkseeConfig::GetClientId ( ) const

Gets the client identifier.

Returns: The client identifier.

const std::wstring& SparkseeConfig::GetDownloadStatus ( ) const

Gets a message with the license download result.

It can be used when the DownloadLicense call failed.

Returns: The log download result.

bool_t SparkseeConfig::GetEncryptionEnabled ( ) const

Gets whether the storage encryption is enabled or disabled.

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

int32_t SparkseeConfig::GetExtentPages ( ) const

Gets the number of pages per extent.

Returns: The number of pages per extent.

int32_t SparkseeConfig::GetExtentSize ( ) const

Gets the size of a extent.

Returns: The size of a extent in KB.

const std::wstring& SparkseeConfig::GetHighAvailabilityCoordinators ( ) const

Gets the coordinators address and port list.

Returns: The coordinators address and port list.

bool_t SparkseeConfig::GetHighAvailabilityEnabled ( ) const

Gets whether high availability mode is enabled or disabled.

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

const std::wstring& SparkseeConfig::GetHighAvailabilityIP ( ) const

Gets the IP address and port of the instance.

Returns: The IP address and port of the instance.

int64_t SparkseeConfig::GetHighAvailabilityMasterHistory ( ) const

Gets the master's history log.

Returns: The master's history log.

int64_t SparkseeConfig::GetHighAvailabilitySynchronization ( ) const

Gets the synchronization polling time.

Returns: The Synchronization polling time.

int64_t SparkseeConfig::GetInMemAllocSize ( ) const

Gets the in-memory allocator size.

Returns: Returns the in-memory allocator size

const std::wstring& SparkseeConfig::GetLicense ( ) const

Gets the license key.

Returns: The license key.

const std::wstring& SparkseeConfig::GetLicenseId ( ) const

Gets the license identifier.

Returns: The license identifier.

int32_t SparkseeConfig::GetLicensePreDownloadDays ( ) const

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.

const std::wstring& SparkseeConfig::GetLogFile ( ) const

Gets the log file.

Returns: The log file.

LogLevel SparkseeConfig::GetLogLevel ( ) const

Gets the log level.

Returns: The LogLevel.

int32_t SparkseeConfig::GetPoolFrameSize ( ) const

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

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

int32_t SparkseeConfig::GetPoolPartitions ( ) const

Gets the number of partitions in each PartitionedPool.

Returns: The number of partitions in each PartitionedPool.

int32_t SparkseeConfig::GetPoolPersistentMaxSize ( ) const

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

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

int32_t SparkseeConfig::GetPoolPersistentMinSize ( ) const

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

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

int32_t SparkseeConfig::GetPoolTemporaryMaxSize ( ) const

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

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

int32_t SparkseeConfig::GetPoolTemporaryMinSize ( ) const

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

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

int32_t SparkseeConfig::GetRecoveryCacheMaxSize ( ) const

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

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

int64_t SparkseeConfig::GetRecoveryCheckpointTime ( ) const

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

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

bool_t SparkseeConfig::GetRecoveryEnabled ( ) const

Gets whether the recovery is enabled or disabled.

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

const std::wstring& SparkseeConfig::GetRecoveryLogFile ( ) const

Gets the recovery log file.

Returns: The recovery log file.

bool_t SparkseeConfig::GetRollbackEnabled ( ) const

Gets whether the rollback is enabled or disabled.

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

const std::wstring& SparkseeConfig::GetSparkseeConfigFile ( ) const

Gets the config file path.

Returns: Returns the configured path or an empty string

bool_t SparkseeConfig::GetTmpEnabled ( ) const

Gets whether using temporary storage for computations is enabled.

Returns: True if enabled

const std::wstring& SparkseeConfig::GetTmpFolder ( ) const

Gets the temporary folder used for temporary staging.

Returns: The temporary folder path

bool_t 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.

bool_t 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.

bool_t SparkseeConfig::SetAESEncryptionEnabled	(	const std::wstring &	keyInHex,
		const std::wstring &	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.

bool_t SparkseeConfig::SetAESEncryptionEnabled ( int32_t 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.

void SparkseeConfig::SetCacheMaxSize ( int32_t 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.

void SparkseeConfig::SetCacheStatisticsEnabled ( bool_t status )

Enables or disables cache statistics.

Parameters

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

void SparkseeConfig::SetCacheStatisticsFile ( const std::wstring & filePath )

Sets the cache statistics log file.

Useless if cache statistics are disabled.

Parameters

filePath [in] The cache statistics log file.

void SparkseeConfig::SetCacheStatisticsSnapshotTime ( int64_t microSeconds )

Sets the cache statistics snapshot time.

Useless if cache statistics are disabled.

Parameters

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

void SparkseeConfig::SetCallStackDump ( bool_t status )

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

Parameters

status [in] If TRUE signals must be captured.

void SparkseeConfig::SetChecksumEnabled ( bool_t status )

Enables or disables the storage checksum usage.

Parameters

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

void SparkseeConfig::SetClientId ( const std::wstring & 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.

void SparkseeConfig::SetExtentPages ( int32_t 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.

void SparkseeConfig::SetExtentSize ( int32_t 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.

void SparkseeConfig::SetHighAvailabilityCoordinators ( const std::wstring & ip )

Sets the coordinators address and port list.

Parameters

ip	[in] The coordinators address and port list.

void SparkseeConfig::SetHighAvailabilityEnabled ( bool_t status )

Enables or disables high availability mode.

Parameters

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

void SparkseeConfig::SetHighAvailabilityIP ( const std::wstring & ip )

Sets the IP address and port of the instance.

Parameters

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

void SparkseeConfig::SetHighAvailabilityMasterHistory ( int64_t filePath )

Sets the master's history log.

Parameters

filePath [in] The master's history log.

void SparkseeConfig::SetHighAvailabilitySynchronization ( int64_t microSeconds )

Sets the synchronization polling time.

Parameters

microSeconds [in] The synchronization polling time.

void SparkseeConfig::SetInMemAllocSize ( int64_t size )

Sets the in-memory allocator size.

Parameters

size	The size to set the in-memory allocator to

int32_t SparkseeConfig::SetLicense ( const std::wstring & 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.

void SparkseeConfig::SetLicenseId ( const std::wstring & 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.

void SparkseeConfig::SetLicensePreDownloadDays ( int32_t 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.

void SparkseeConfig::SetLogFile ( const std::wstring & filePath )

Sets the log file.

Parameters

filePath [in] The log file.

void SparkseeConfig::SetLogLevel ( LogLevel level )

Sets the log level.

Parameters

level [in] The LogLevel.

void SparkseeConfig::SetPoolFrameSize ( int32_t 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.

void SparkseeConfig::SetPoolPartitions ( int32_t pools )

Sets the number of pools in each PartitionedPool.

Parameters

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

void SparkseeConfig::SetPoolPersistentMaxSize ( int32_t 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.

void SparkseeConfig::SetPoolPersistentMinSize ( int32_t 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.

void SparkseeConfig::SetPoolTemporaryMaxSize ( int32_t 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.

void SparkseeConfig::SetPoolTemporaryMinSize ( int32_t 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.

void SparkseeConfig::SetRecoveryCacheMaxSize ( int32_t 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).

void SparkseeConfig::SetRecoveryCheckpointTime ( int64_t 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.

void SparkseeConfig::SetRecoveryEnabled ( bool_t status )

Enables or disables the recovery.

Parameters

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

void SparkseeConfig::SetRecoveryLogFile ( const std::wstring & 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)

void SparkseeConfig::SetRollbackEnabled ( bool_t status )

Enables or disables the rollback.

Parameters

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

void SparkseeConfig::SetSparkseeConfigFile ( const std::wstring & 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.

void SparkseeConfig::SetTmpEnabled ( bool_t enabled )

Sets whether to use temporary storage for computations or not.

Parameters

enabled True to use temporary storage for computation

void SparkseeConfig::SetTmpFolder ( const std::wstring & tmpFolder )

Sets the temporary folder used for temporary staging.

Parameters

tmpFolder The temporary folder to set

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

SparkseeConfig.h

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation