sparksee.SparkseeConfig Class Reference

Sparksee configuration class. More...

Public Member Functions
def	set_recovery_enabled (self, status)
	Enables or disables the recovery. More...
def	set_license_pre_download_days (self, days)
	Start trying to automatically download a new license at the specified number of days before expiration. More...
def	get_extent_pages (self)
	Gets the number of pages per extent. More...
def	save_all (self)
	Save all the current configuration settings in the specified config file. More...
def	get_a_e_s_key (self)
	Get the AES encryption key in a hexadecimal encoded string. More...
def	get_pool_persistent_max_size (self)
	Gets the maximum size for the persistent pool in number of frames. More...
def	get_pool_temporary_min_size (self)
	Gets the minimum size for the temporary pool in number of frames. More...
def	get_call_stack_dump (self)
	Gets whether the signals will be captured to dump the call stack or not. More...
def	set_recovery_cache_max_size (self, extents)
	Sets the maximum size for the recovery log cache in extents. More...
def	set_a_e_s_encryption_enabled (self, key_in_hex, iv_in_hex)
	Enables storage encryption using AES with the given key and iv. More...
def	get_high_availability_enabled (self)
	Gets whether high availability mode is enabled or disabled. More...
def	get_pool_persistent_min_size (self)
	Gets the minimum size for the persistent pool in number of frames. More...
def	set_checksum_enabled (self, status)
	Enables or disables the storage checksum usage. More...
def	set_pool_persistent_min_size (self, frames)
	Sets the minimum size for the persistent pool in number of frames. More...
def	set_cache_statistics_enabled (self, status)
	Enables or disables cache statistics. More...
def	set_recovery_checkpoint_time (self, micro_seconds)
	Sets the delay time (in microseconds) between automatic checkpoints. More...
def	set_encryption_disabled (self)
	Disables storage encryption.
def	set_recovery_log_file (self, file_path)
	Sets the recovery log file. More...
def	set_pool_frame_size (self, extents)
	Sets the size of a pool frame in number of extents. More...
def	get_recovery_log_file (self)
	Gets the recovery log file. More...
def	set_high_availability_enabled (self, status)
	Enables or disables high availability mode. More...
def	get_cache_statistics_snapshot_time (self)
	Gets the cache statistics snapshot time in microseconds. More...
def	get_extent_size (self)
	Gets the size of a extent. More...
def	get_sparksee_config_file (self)
	Gets the config file path. More...
def	set_extent_size (self, k_bytes)
	Sets the size of the extents in KB. More...
def	set_high_availability_i_p (self, ip)
	Sets the IP address and port of the instance. More...
def	get_pool_temporary_max_size (self)
	Gets the maximum size for the temporary pool in number of frames. More...
def	set_in_mem_alloc_size (self, size)
	Sets the in-memory allocator size. More...
def	__init__ (self, path)
	Creates a new instance with a specific config file. More...
def	set_high_availability_master_history (self, file_path)
	Sets the master's history log. More...
def	set_tmp_enabled (self, enabled)
	Sets whether to use temporary storage for computations or not. More...
def	get_log_file (self)
	Gets the log file. More...
def	get_tmp_enabled (self)
	Gets whether using temporary storage for computations is enabled. More...
def	get_pool_frame_size (self)
	Gets the size of a pool frame in number of extents. More...
def	get_cache_statistics_enabled (self)
	Gets whether cache statistics are enabled or disabled. More...
def	set_high_availability_coordinators (self, ip)
	Sets the coordinators address and port list. More...
def	set_high_availability_synchronization (self, micro_seconds)
	Sets the synchronization polling time. More...
def	get_client_id (self)
	Gets the client identifier. More...
def	get_cache_statistics_file (self)
	Gets the cache statistics log file. More...
def	set_sparksee_config_file (self, path)
	Sets the config file path. More...
def	save (self)
	Save the current configuration in the specified config file. More...
def	set_pool_persistent_max_size (self, frames)
	Sets the maximum size for the persistent pool in number of frames. More...
def	get_log_level (self)
	Gets the log level. More...
def	set_license (self, key)
	Sets the license key. More...
def	get_download_status (self)
	Gets a message with the license download result. More...
def	set_license_id (self, license_id)
	Set the license identifier. More...
def	get_license (self)
	Gets the license key. More...
def	get_high_availability_i_p (self)
	Gets the IP address and port of the instance. More...
def	set_a_e_s_encryption_enabled (self, key_size)
	Enables storage encryption using AES and GENARATES a key and an iv. More...
def	get_in_mem_alloc_size (self)
	Gets the in-memory allocator size. More...
def	get_license_pre_download_days (self)
	Get the number of days before expiration when a new license will be downloaded. More...
def	set_call_stack_dump (self, status)
	Sets whether the signals will be captured to dump the call stack or not. More...
def	download_license (self)
	Try to download a license key Can be used to explicitly download a license when the autodownload is disabled (LicensePreDownloadDays == -1). More...
def	get_recovery_enabled (self)
	Gets whether the recovery is enabled or disabled. More...
def	get_license_request (self)
	Get information useful to manually request a license.
def	set_cache_statistics_file (self, file_path)
	Sets the cache statistics log file. More...
def	get_tmp_folder (self)
	Gets the temporary folder used for temporary staging. More...
def	get_pool_partitions (self)
	Gets the number of partitions in each PartitionedPool. More...
def	get_high_availability_coordinators (self)
	Gets the coordinators address and port list. More...
def	get_recovery_checkpoint_time (self)
	Gets the delay time (in microseconds) between automatic checkpoints. More...
def	set_log_file (self, file_path)
	Sets the log file. More...
def	set_extent_pages (self, pages)
	Sets the number of pages per extent. More...
def	set_client_id (self, client_id)
	Set the client identifier. More...
def	set_log_level (self, level)
	Sets the log level. More...
def	get_recovery_cache_max_size (self)
	Gets the maximum size for the recovery log cache in extents. More...
def	get_checksum_enabled (self)
	Gets whether the storage checksum usage is enabled or disabled. More...
def	get_high_availability_synchronization (self)
	Gets the synchronization polling time. More...
def	get_high_availability_master_history (self)
	Gets the master's history log. More...
def	get_license_id (self)
	Gets the license identifier. More...
def	__init__ (self, path, client_id, license_id)
	Creates a new instance with a specific config file and IDs. More...
def	get_a_e_s_i_v (self)
	Get the AES initialization vector in a hexadecimal encoded string. More...
def	get_encryption_enabled (self)
	Gets whether the storage encryption is enabled or disabled. More...
def	set_pool_partitions (self, pools)
	Sets the number of pools in each PartitionedPool. More...
def	get_rollback_enabled (self)
	Gets whether the rollback is enabled or disabled. More...
def	set_pool_temporary_max_size (self, frames)
	Sets the maximum size for the temporary pool in number of frames. More...
def	get_cache_max_size (self)
	Gets the maximum size for the cache (all pools) in MB. More...
def	set_rollback_enabled (self, status)
	Enables or disables the rollback. More...
def	set_tmp_folder (self, tmp_folder)
	Sets the temporary folder used for temporary staging. More...
def	set_cache_statistics_snapshot_time (self, micro_seconds)
	Sets the cache statistics snapshot time. More...
def	set_cache_max_size (self, mega_bytes)
	Sets the maximum size for the cache (all pools) in MB. More...
def	__init__ (self)
	Creates a new instance. More...
def	set_pool_temporary_min_size (self, frames)
	Sets the minimum size for the temporary pool in number of frames. More...
def	download_expected (self)
	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

def sparksee.SparkseeConfig.__init__	(		self,
			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.

Referenced by sparksee.SparkseeConfig.__init__().

def sparksee.SparkseeConfig.__init__	(		self,
			path,
			client_id,
			license_id
	)

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.
client_id	[in] The client identifier.
license_id	[in] The license identifier.

References sparksee.SparkseeConfig.__init__().

def sparksee.SparkseeConfig.__init__

(

self

)

Creates a new instance.

Values are set with default values.

References sparksee.SparkseeConfig.__init__().

Member Function Documentation

def sparksee.SparkseeConfig.download_license

(

self

)

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.

def sparksee.SparkseeConfig.get_a_e_s_i_v

(

self

)

Get the AES initialization vector in a hexadecimal encoded string.

Returns

The AES initialization vector as an hexadecimal string.

def sparksee.SparkseeConfig.get_a_e_s_key

(

self

)

Get the AES encryption key in a hexadecimal encoded string.

Returns

The AES encryption Key as an hexadecimal string.

def sparksee.SparkseeConfig.get_cache_max_size

(

self

)

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

Returns

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

def sparksee.SparkseeConfig.get_cache_statistics_enabled

(

self

)

Gets whether cache statistics are enabled or disabled.

Returns

TRUE if cache statistics are enabled, FALSE otherwise.

def sparksee.SparkseeConfig.get_cache_statistics_file

(

self

)

Gets the cache statistics log file.

Useless if cache statistics are disabled.

Returns

The cache statistics log file.

def sparksee.SparkseeConfig.get_cache_statistics_snapshot_time

(

self

)

Gets the cache statistics snapshot time in microseconds.

Useless if cache statistics are disabled.

Returns

The cache statistics snapshot time in microseconds.

def sparksee.SparkseeConfig.get_call_stack_dump

(

self

)

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

Returns

TRUE if the signals must be captured, FALSE otherwise.

def sparksee.SparkseeConfig.get_checksum_enabled

(

self

)

Gets whether the storage checksum usage is enabled or disabled.

Returns

TRUE if the checksum is enabled, FALSE otherwise.

def sparksee.SparkseeConfig.get_client_id

(

self

)

Gets the client identifier.

Returns

The client identifier.

def sparksee.SparkseeConfig.get_download_status

(

self

)

Gets a message with the license download result.

It can be used when the DownloadLicense call failed.

Returns

The log download result.

def sparksee.SparkseeConfig.get_encryption_enabled

(

self

)

Gets whether the storage encryption is enabled or disabled.

Returns

TRUE if the encryption is enabled, FALSE otherwise.

def sparksee.SparkseeConfig.get_extent_pages

(

self

)

Gets the number of pages per extent.

Returns

The number of pages per extent.

def sparksee.SparkseeConfig.get_extent_size

(

self

)

Gets the size of a extent.

Returns

The size of a extent in KB.

def sparksee.SparkseeConfig.get_high_availability_coordinators

(

self

)

Gets the coordinators address and port list.

Returns

The coordinators address and port list.

def sparksee.SparkseeConfig.get_high_availability_enabled

(

self

)

Gets whether high availability mode is enabled or disabled.

Returns

TRUE if high availability mode is enabled, FALSE otherwise.

def sparksee.SparkseeConfig.get_high_availability_i_p

(

self

)

Gets the IP address and port of the instance.

Returns

The IP address and port of the instance.

def sparksee.SparkseeConfig.get_high_availability_master_history

(

self

)

Gets the master's history log.

Returns

The master's history log.

def sparksee.SparkseeConfig.get_high_availability_synchronization

(

self

)

Gets the synchronization polling time.

Returns

The Synchronization polling time.

def sparksee.SparkseeConfig.get_in_mem_alloc_size

(

self

)

Gets the in-memory allocator size.

Returns

Returns the in-memory allocator size

def sparksee.SparkseeConfig.get_license

(

self

)

Gets the license key.

Returns

The license key.

def sparksee.SparkseeConfig.get_license_id

(

self

)

Gets the license identifier.

Returns

The license identifier.

def sparksee.SparkseeConfig.get_license_pre_download_days

(

self

)

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.

def sparksee.SparkseeConfig.get_log_file

(

self

)

Gets the log file.

Returns

The log file.

def sparksee.SparkseeConfig.get_log_level

(

self

)

Gets the log level.

Returns

The LogLevel.

def sparksee.SparkseeConfig.get_pool_frame_size

(

self

)

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

Returns

The size of a pool frame in number of extents.

def sparksee.SparkseeConfig.get_pool_partitions

(

self

)

Gets the number of partitions in each PartitionedPool.

Returns

The number of partitions in each PartitionedPool.

def sparksee.SparkseeConfig.get_pool_persistent_max_size

(

self

)

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

Returns

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

def sparksee.SparkseeConfig.get_pool_persistent_min_size

(

self

)

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

Returns

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

def sparksee.SparkseeConfig.get_pool_temporary_max_size

(

self

)

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

Returns

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

def sparksee.SparkseeConfig.get_pool_temporary_min_size

(

self

)

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

Returns

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

def sparksee.SparkseeConfig.get_recovery_cache_max_size

(

self

)

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

Returns

The maximum size for the recovery log cache in extents.

def sparksee.SparkseeConfig.get_recovery_checkpoint_time

(

self

)

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

Returns

The delay time (in microseconds) between automatic checkpoints.

def sparksee.SparkseeConfig.get_recovery_enabled

(

self

)

Gets whether the recovery is enabled or disabled.

Returns

TRUE if the recovery is enabled, FALSE otherwise.

def sparksee.SparkseeConfig.get_recovery_log_file

(

self

)

Gets the recovery log file.

Returns

The recovery log file.

def sparksee.SparkseeConfig.get_rollback_enabled

(

self

)

Gets whether the rollback is enabled or disabled.

Returns

TRUE if the rollback is enabled, FALSE otherwise.

def sparksee.SparkseeConfig.get_sparksee_config_file

(

self

)

Gets the config file path.

Returns

Returns the configured path or an empty string

def sparksee.SparkseeConfig.get_tmp_enabled

(

self

)

Gets whether using temporary storage for computations is enabled.

Returns

True if enabled

def sparksee.SparkseeConfig.get_tmp_folder

(

self

)

Gets the temporary folder used for temporary staging.

Returns

The temporary folder path

def sparksee.SparkseeConfig.save

(

self

)

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.

def sparksee.SparkseeConfig.save_all

(

self

)

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.

def sparksee.SparkseeConfig.set_a_e_s_encryption_enabled	(		self,
			key_in_hex,
			iv_in_hex
	)

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

key_in_hex	[In] The AES encryption Key as an hexadecimal string (8, 16 or 32 bytes).
iv_in_hex	[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.

Referenced by sparksee.SparkseeConfig.set_a_e_s_encryption_enabled().

def sparksee.SparkseeConfig.set_a_e_s_encryption_enabled	(		self,
			key_size
	)

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

key_size

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

Returns

Returns true if the encryption had been enabled.

References sparksee.SparkseeConfig.set_a_e_s_encryption_enabled().

def sparksee.SparkseeConfig.set_cache_max_size	(		self,
			mega_bytes
	)

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

Parameters

mega_bytes

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

def sparksee.SparkseeConfig.set_cache_statistics_enabled	(		self,
			status
	)

Enables or disables cache statistics.

Parameters

status

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

def sparksee.SparkseeConfig.set_cache_statistics_file	(		self,
			file_path
	)

Sets the cache statistics log file.

Useless if cache statistics are disabled.

Parameters

file_path

[in] The cache statistics log file.

def sparksee.SparkseeConfig.set_cache_statistics_snapshot_time	(		self,
			micro_seconds
	)

Sets the cache statistics snapshot time.

Useless if cache statistics are disabled.

Parameters

micro_seconds

[in] The cache statistics snapshot time in microseconds.

def sparksee.SparkseeConfig.set_call_stack_dump	(		self,
			status
	)

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

Parameters

status

[in] If TRUE signals must be captured.

def sparksee.SparkseeConfig.set_checksum_enabled	(		self,
			status
	)

Enables or disables the storage checksum usage.

Parameters

status

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

def sparksee.SparkseeConfig.set_client_id	(		self,
			client_id
	)

Set the client identifier.

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

Parameters

client_id

[in] The client identifier.

def sparksee.SparkseeConfig.set_extent_pages	(		self,
			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.

def sparksee.SparkseeConfig.set_extent_size	(		self,
			k_bytes
	)

Sets the size of the extents in KB.

Parameters

k_bytes

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

def sparksee.SparkseeConfig.set_high_availability_coordinators	(		self,
			ip
	)

Sets the coordinators address and port list.

Parameters

ip	[in] The coordinators address and port list.

def sparksee.SparkseeConfig.set_high_availability_enabled	(		self,
			status
	)

Enables or disables high availability mode.

Parameters

status

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

def sparksee.SparkseeConfig.set_high_availability_i_p	(		self,
			ip
	)

Sets the IP address and port of the instance.

Parameters

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

def sparksee.SparkseeConfig.set_high_availability_master_history	(		self,
			file_path
	)

Sets the master's history log.

Parameters

file_path

[in] The master's history log.

def sparksee.SparkseeConfig.set_high_availability_synchronization	(		self,
			micro_seconds
	)

Sets the synchronization polling time.

Parameters

micro_seconds

[in] The synchronization polling time.

def sparksee.SparkseeConfig.set_in_mem_alloc_size	(		self,
			size
	)

Sets the in-memory allocator size.

Parameters

size	The size to set the in-memory allocator to

def sparksee.SparkseeConfig.set_license	(		self,
			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.

def sparksee.SparkseeConfig.set_license_id	(		self,
			license_id
	)

Set the license identifier.

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

Parameters

license_id

[in] The license identifier.

def sparksee.SparkseeConfig.set_license_pre_download_days	(		self,
			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.

def sparksee.SparkseeConfig.set_log_file	(		self,
			file_path
	)

Sets the log file.

Parameters

file_path

[in] The log file.

def sparksee.SparkseeConfig.set_log_level	(		self,
			level
	)

Sets the log level.

Parameters

level

[in] The LogLevel.

def sparksee.SparkseeConfig.set_pool_frame_size	(		self,
			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.

def sparksee.SparkseeConfig.set_pool_partitions	(		self,
			pools
	)

Sets the number of pools in each PartitionedPool.

Parameters

pools

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

def sparksee.SparkseeConfig.set_pool_persistent_max_size	(		self,
			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.

def sparksee.SparkseeConfig.set_pool_persistent_min_size	(		self,
			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.

def sparksee.SparkseeConfig.set_pool_temporary_max_size	(		self,
			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.

def sparksee.SparkseeConfig.set_pool_temporary_min_size	(		self,
			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.

def sparksee.SparkseeConfig.set_recovery_cache_max_size	(		self,
			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).

def sparksee.SparkseeConfig.set_recovery_checkpoint_time	(		self,
			micro_seconds
	)

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

Parameters

micro_seconds

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

def sparksee.SparkseeConfig.set_recovery_enabled	(		self,
			status
	)

Enables or disables the recovery.

Parameters

status

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

def sparksee.SparkseeConfig.set_recovery_log_file	(		self,
			file_path
	)

Sets the recovery log file.

Parameters

file_path

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

def sparksee.SparkseeConfig.set_rollback_enabled	(		self,
			status
	)

Enables or disables the rollback.

Parameters

status

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

def sparksee.SparkseeConfig.set_sparksee_config_file	(		self,
			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.

def sparksee.SparkseeConfig.set_tmp_enabled	(		self,
			enabled
	)

Sets whether to use temporary storage for computations or not.

Parameters

enabled

True to use temporary storage for computation

def sparksee.SparkseeConfig.set_tmp_folder	(		self,
			tmp_folder
	)

Sets the temporary folder used for temporary staging.

Parameters

tmp_folder

The temporary folder to set