Sparksee configuration class. More...

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

◆ init() [1/3]

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.

◆ init() [2/3]

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.

◆ init() [3/3]

sparksee.SparkseeConfig.__init__ ( self )

Creates a new instance.

Values are set with default values.

Member Function Documentation

◆ download_license()

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.

◆ get_a_e_s_i_v()

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.

◆ get_a_e_s_key()

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.

◆ get_cache_max_size()

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.

◆ get_cache_statistics_enabled()

sparksee.SparkseeConfig.get_cache_statistics_enabled ( self )

Gets whether cache statistics are enabled or disabled.

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

◆ get_cache_statistics_file()

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.

◆ get_cache_statistics_snapshot_time()

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.

◆ get_call_stack_dump()

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.

◆ get_checksum_enabled()

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.

◆ get_client_id()

sparksee.SparkseeConfig.get_client_id ( self )

Gets the client identifier.

Returns: The client identifier.

◆ get_download_status()

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.

◆ get_encryption_enabled()

sparksee.SparkseeConfig.get_encryption_enabled ( self )

Gets whether the storage encryption is enabled or disabled.

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

◆ get_extent_pages()

sparksee.SparkseeConfig.get_extent_pages ( self )

Gets the number of pages per extent.

Returns: The number of pages per extent.

◆ get_extent_size()

sparksee.SparkseeConfig.get_extent_size ( self )

Gets the size of a extent.

Returns: The size of a extent in KB.

◆ get_high_availability_coordinators()

sparksee.SparkseeConfig.get_high_availability_coordinators ( self )

Gets the coordinators address and port list.

Returns: The coordinators address and port list.

◆ get_high_availability_enabled()

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.

◆ get_high_availability_i_p()

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.

◆ get_high_availability_master_history()

sparksee.SparkseeConfig.get_high_availability_master_history ( self )

Gets the master's history log.

Returns: The master's history log.

◆ get_high_availability_synchronization()

sparksee.SparkseeConfig.get_high_availability_synchronization ( self )

Gets the synchronization polling time.

Returns: The Synchronization polling time.

◆ get_in_mem_alloc_size()

sparksee.SparkseeConfig.get_in_mem_alloc_size ( self )

Gets the in-memory allocator size.

Returns: Returns the in-memory allocator size

◆ get_license()

sparksee.SparkseeConfig.get_license ( self )

Gets the license key.

Returns: The license key.

◆ get_license_id()

sparksee.SparkseeConfig.get_license_id ( self )

Gets the license identifier.

Returns: The license identifier.

◆ get_license_pre_download_days()

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.

◆ get_log_file()

sparksee.SparkseeConfig.get_log_file ( self )

Gets the log file.

Returns: The log file.

◆ get_log_level()

sparksee.SparkseeConfig.get_log_level ( self )

Gets the log level.

Returns: The LogLevel.

◆ get_plugins_dir()

sparksee.SparkseeConfig.get_plugins_dir ( self )

Gets the Plugins directory.

Returns: The pulgins directory.

◆ get_pool_frame_size()

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.

◆ get_pool_partitions()

sparksee.SparkseeConfig.get_pool_partitions ( self )

Gets the number of partitions in each PartitionedPool.

Returns: The number of partitions in each PartitionedPool.

◆ get_pool_persistent_max_size()

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.

◆ get_pool_persistent_min_size()

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.

◆ get_pool_temporary_max_size()

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.

◆ get_pool_temporary_min_size()

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.

◆ get_recovery_cache_max_size()

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.

◆ get_recovery_checkpoint_time()

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.

◆ get_recovery_enabled()

sparksee.SparkseeConfig.get_recovery_enabled ( self )

Gets whether the recovery is enabled or disabled.

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

◆ get_recovery_log_file()

sparksee.SparkseeConfig.get_recovery_log_file ( self )

Gets the recovery log file.

Returns: The recovery log file.

◆ get_rollback_enabled()

sparksee.SparkseeConfig.get_rollback_enabled ( self )

Gets whether the rollback is enabled or disabled.

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

◆ get_sparksee_config_file()

sparksee.SparkseeConfig.get_sparksee_config_file ( self )

Gets the config file path.

Returns: Returns the configured path or an empty string

◆ get_tmp_enabled()

sparksee.SparkseeConfig.get_tmp_enabled ( self )

Gets whether using temporary storage for computations is enabled.

Returns: True if enabled

◆ get_tmp_folder()

sparksee.SparkseeConfig.get_tmp_folder ( self )

Gets the temporary folder used for temporary staging.

Returns: The temporary folder path

◆ save()

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.

◆ save_all()

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.

◆ set_a_e_s_encryption_enabled() [1/2]

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.

◆ set_a_e_s_encryption_enabled() [2/2]

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.

◆ set_cache_max_size()

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.

◆ set_cache_statistics_enabled()

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.

◆ set_cache_statistics_file()

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.

◆ set_cache_statistics_snapshot_time()

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.

◆ set_call_stack_dump()

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.

◆ set_checksum_enabled()

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.

◆ set_client_id()

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.

◆ set_extent_pages()

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.

◆ set_extent_size()

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.

◆ set_high_availability_coordinators()

sparksee.SparkseeConfig.set_high_availability_coordinators	(		self,
			ip )

Sets the coordinators address and port list.

Parameters

ip	[in] The coordinators address and port list.

◆ set_high_availability_enabled()

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.

◆ set_high_availability_i_p()

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.

◆ set_high_availability_master_history()

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.

◆ set_high_availability_synchronization()

sparksee.SparkseeConfig.set_high_availability_synchronization	(		self,
			micro_seconds )

Sets the synchronization polling time.

Parameters

micro_seconds [in] The synchronization polling time.

◆ set_in_mem_alloc_size()

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

◆ set_license()

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.

◆ set_license_id()

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.

◆ set_license_pre_download_days()

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.

◆ set_log_file()

sparksee.SparkseeConfig.set_log_file	(		self,
			file_path )

Sets the log file.

Parameters

file_path [in] The log file.

◆ set_log_level()

sparksee.SparkseeConfig.set_log_level	(		self,
			level )

Sets the log level.

Parameters

level [in] The LogLevel.

◆ set_plugins_dir()

sparksee.SparkseeConfig.set_plugins_dir	(		self,
			dir_path )

Sets the Plugins directory.

Parameters

dir_path [in] The plugins directory path.

◆ set_pool_frame_size()

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.

◆ set_pool_partitions()

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.

◆ set_pool_persistent_max_size()

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.

◆ set_pool_persistent_min_size()

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.

◆ set_pool_temporary_max_size()

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.

◆ set_pool_temporary_min_size()

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.

◆ set_recovery_cache_max_size()

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

◆ set_recovery_checkpoint_time()

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.

◆ set_recovery_enabled()

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.

◆ set_recovery_log_file()

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)

◆ set_rollback_enabled()

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.

◆ set_sparksee_config_file()

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.

◆ set_tmp_enabled()

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

◆ set_tmp_folder()

sparksee.SparkseeConfig.set_tmp_folder	(		self,
			tmp_folder )

Sets the temporary folder used for temporary staging.

Parameters

tmp_folder The temporary folder to set

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/3]

◆ __init__() [2/3]

◆ __init__() [3/3]

Member Function Documentation

◆ download_license()

◆ get_a_e_s_i_v()

◆ get_a_e_s_key()

◆ get_cache_max_size()

◆ get_cache_statistics_enabled()

◆ get_cache_statistics_file()

◆ get_cache_statistics_snapshot_time()

◆ get_call_stack_dump()

◆ get_checksum_enabled()

◆ get_client_id()

◆ get_download_status()

◆ get_encryption_enabled()

◆ get_extent_pages()

◆ get_extent_size()

◆ get_high_availability_coordinators()

◆ get_high_availability_enabled()

◆ get_high_availability_i_p()

◆ get_high_availability_master_history()

◆ get_high_availability_synchronization()

◆ get_in_mem_alloc_size()

◆ get_license()

◆ get_license_id()

◆ get_license_pre_download_days()

◆ get_log_file()

◆ get_log_level()

◆ get_plugins_dir()

◆ get_pool_frame_size()

◆ get_pool_partitions()

◆ get_pool_persistent_max_size()

◆ get_pool_persistent_min_size()

◆ get_pool_temporary_max_size()

◆ get_pool_temporary_min_size()

◆ get_recovery_cache_max_size()

◆ get_recovery_checkpoint_time()

◆ get_recovery_enabled()

◆ get_recovery_log_file()

◆ get_rollback_enabled()

◆ get_sparksee_config_file()

◆ get_tmp_enabled()

◆ get_tmp_folder()

◆ save()

◆ save_all()

◆ set_a_e_s_encryption_enabled() [1/2]

◆ set_a_e_s_encryption_enabled() [2/2]

◆ set_cache_max_size()

◆ set_cache_statistics_enabled()

◆ set_cache_statistics_file()

◆ set_cache_statistics_snapshot_time()

◆ set_call_stack_dump()

◆ set_checksum_enabled()

◆ set_client_id()

◆ set_extent_pages()

◆ set_extent_size()

◆ set_high_availability_coordinators()

◆ set_high_availability_enabled()

◆ set_high_availability_i_p()

◆ set_high_availability_master_history()

◆ set_high_availability_synchronization()

◆ set_in_mem_alloc_size()

◆ set_license()

◆ set_license_id()

◆ set_license_pre_download_days()

◆ set_log_file()

◆ set_log_level()

◆ set_plugins_dir()

◆ set_pool_frame_size()

◆ set_pool_partitions()

◆ set_pool_persistent_max_size()

◆ set_pool_persistent_min_size()

◆ set_pool_temporary_max_size()

◆ set_pool_temporary_min_size()

◆ set_recovery_cache_max_size()

◆ set_recovery_checkpoint_time()

◆ init() [1/3]

◆ init() [2/3]

◆ init() [3/3]