Public Member Functions | |
def | get_high_availability_synchronization |
Gets the synchronization polling time. | |
def | set_recovery_cache_max_size |
Sets the maximum size for the recovery log cache in extents. | |
def | set_high_availability_i_p |
Sets the IP address and port of the instance. | |
def | set_pool_persistent_min_size |
Sets the minimum size for the persistent pool in number of frames. | |
def | get_extent_size |
Gets the size of a extent. | |
def | set_high_availability_enabled |
Enables or disables high availability mode. | |
def | set_high_availability_coordinators |
Sets the coordinators address and port list. | |
def | get_log_file |
Gets the log file. | |
def | get_recovery_checkpoint_time |
Gets the delay time (in microseconds) between automatic checkpoints. | |
def | set_cache_statistics_snapshot_time |
Sets the cache statistics snapshot time. | |
def | get_cache_statistics_enabled |
Gets whether cache statistics are enabled or disabled. | |
def | get_pool_persistent_max_size |
Gets the maximum size for the persistent pool in number of frames. | |
def | set_log_level |
Sets the log level. | |
def | set_extent_size |
Sets the size of a pool frame in number of extents. | |
def | get_recovery_log_file |
Gets the recovery log file. | |
def | get_extent_pages |
Gets the number of pages per extent. | |
def | set_pool_persistent_max_size |
Sets the maximum size for the persistent pool in number of frames. | |
def | set_cache_max_size |
Sets the maximum size for the cache (all pools) in MB. | |
def | get_high_availability_enabled |
Gets whether high availability mode is enabled or disabled. | |
def | set_recovery_log_file |
Sets the recovery log file. | |
def | get_recovery_enabled |
Gets whether the recovery is enabled or disabled. | |
def | __init__ |
Creates a new instance. | |
def | get_high_availability_coordinators |
Gets the coordinators address and port list. | |
def | set_license |
Sets the license code. | |
def | set_recovery_enabled |
Enables or disables the recovery. | |
def | set_pool_temporary_max_size |
Sets the maximum size for the temporary pool in number of frames. | |
def | set_high_availability_synchronization |
Sets the synchronization polling time. | |
def | set_pool_frame_size |
Sets the size of a pool frame in number of extents. | |
def | get_cache_statistics_file |
Gets the cache statistics log file. | |
def | set_cache_statistics_file |
Sets the cache statistics log file. | |
def | get_pool_frame_size |
Gets the size of a pool frame in number of extents. | |
def | get_cache_max_size |
Gets the maximum size for the cache (all pools) in MB. | |
def | get_cache_statistics_snapshot_time |
Gets the cache statistics snapshot time in microseconds. | |
def | get_pool_temporary_max_size |
Gets the maximum size for the temporary pool in number of frames. | |
def | set_extent_pages |
Sets the number of pages per extent. | |
def | set_pool_temporary_min_size |
Sets the minimum size for the temporary pool in number of frames. | |
def | get_license |
Gets the license code. | |
def | get_pool_temporary_min_size |
Gets the minimum size for the temporary pool in number of frames. | |
def | set_high_availability_master_history |
Sets the master's history log. | |
def | set_cache_statistics_enabled |
Enables or disables cache statistics. | |
def | get_recovery_cache_max_size |
Gets the maximum size for the recovery log cache in extents. | |
def | get_high_availability_master_history |
Gets the master's history log. | |
def | get_high_availability_i_p |
Gets the IP address and port of the instance. | |
def | get_log_level |
Gets the log level. | |
def | set_recovery_checkpoint_time |
Sets the delay time (in microseconds) between automatic checkpoints. | |
def | set_log_file |
Sets the log file. | |
def | get_pool_persistent_min_size |
Gets the minimum size for the persistent pool in number of frames. |
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).
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).
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.
def sparksee.SparkseeConfig.get_high_availability_synchronization | ( | self | ) |
Gets the synchronization polling time.
def sparksee.SparkseeConfig.set_recovery_cache_max_size | ( | self, | ||
v | ||||
) |
Sets the maximum size for the recovery log cache in extents.
v | [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_high_availability_i_p | ( | self, | ||
v | ||||
) |
Sets the IP address and port of the instance.
v | [in] The IP address and port of the instance. |
def sparksee.SparkseeConfig.set_pool_persistent_min_size | ( | self, | ||
v | ||||
) |
Sets the minimum size for the persistent pool in number of frames.
v | [in] The minimum size for the persistent pool in number of frames. It must be non-negative. |
def sparksee.SparkseeConfig.get_extent_size | ( | self | ) |
Gets the size of a extent.
def sparksee.SparkseeConfig.set_high_availability_enabled | ( | self, | ||
v | ||||
) |
Enables or disables high availability mode.
v | [in] If TRUE this enables high availability mode, if FALSE this disables high availability mode. |
def sparksee.SparkseeConfig.set_high_availability_coordinators | ( | self, | ||
v | ||||
) |
Sets the coordinators address and port list.
v | [in] The coordinators address and port list. |
def sparksee.SparkseeConfig.get_log_file | ( | self | ) |
Gets the log file.
def sparksee.SparkseeConfig.get_recovery_checkpoint_time | ( | self | ) |
Gets the delay time (in microseconds) between automatic checkpoints.
def sparksee.SparkseeConfig.set_cache_statistics_snapshot_time | ( | self, | ||
v | ||||
) |
Sets the cache statistics snapshot time.
Useless if cache statistics are disabled.
v | [in] The cache statistics snapshot time in microseconds. |
def sparksee.SparkseeConfig.get_cache_statistics_enabled | ( | self | ) |
Gets whether cache statistics are enabled or disabled.
def sparksee.SparkseeConfig.get_pool_persistent_max_size | ( | self | ) |
Gets the maximum size for the persistent pool in number of frames.
def sparksee.SparkseeConfig.set_log_level | ( | self, | ||
v | ||||
) |
def sparksee.SparkseeConfig.set_extent_size | ( | self, | ||
v | ||||
) |
Sets the size of a pool frame in number of extents.
v | [in] The size of a extent size in KB. An extent can have a size between 4KB and 64KB, and it must be a power of 2. |
def sparksee.SparkseeConfig.get_recovery_log_file | ( | self | ) |
Gets the recovery log file.
def sparksee.SparkseeConfig.get_extent_pages | ( | self | ) |
Gets the number of pages per extent.
def sparksee.SparkseeConfig.set_pool_persistent_max_size | ( | self, | ||
v | ||||
) |
Sets the maximum size for the persistent pool in number of frames.
v | [in] The maximum size for the persistent pool in number of frames. It must be non-negative. |
def sparksee.SparkseeConfig.set_cache_max_size | ( | self, | ||
v | ||||
) |
Sets the maximum size for the cache (all pools) in MB.
v | [in] The maximum size for the cache (all pools) in MB. It must be non-negative. |
def sparksee.SparkseeConfig.get_high_availability_enabled | ( | self | ) |
Gets whether high availability mode is enabled or disabled.
def sparksee.SparkseeConfig.set_recovery_log_file | ( | self, | ||
v | ||||
) |
Sets the recovery log file.
v | [in] The recovery log file. Left it empty for the default log file (same as <database_file_name>.log) |
def sparksee.SparkseeConfig.get_recovery_enabled | ( | self | ) |
Gets whether the recovery is enabled or disabled.
def sparksee.SparkseeConfig.__init__ | ( | self | ) |
Creates a new instance.
Values are set with default values.
def sparksee.SparkseeConfig.get_high_availability_coordinators | ( | self | ) |
Gets the coordinators address and port list.
def sparksee.SparkseeConfig.set_license | ( | self, | ||
v | ||||
) |
Sets the license code.
v | [in] The license code. |
def sparksee.SparkseeConfig.set_recovery_enabled | ( | self, | ||
v | ||||
) |
Enables or disables the recovery.
v | [in] If TRUE this enables the recovery, if FALSE then disables it. |
def sparksee.SparkseeConfig.set_pool_temporary_max_size | ( | self, | ||
v | ||||
) |
Sets the maximum size for the temporary pool in number of frames.
v | [in] The maximum size for the temporary pool in number of frames. It must be non-negative. |
def sparksee.SparkseeConfig.set_high_availability_synchronization | ( | self, | ||
v | ||||
) |
Sets the synchronization polling time.
v | [in] The synchronization polling time. |
def sparksee.SparkseeConfig.set_pool_frame_size | ( | self, | ||
v | ||||
) |
Sets the size of a pool frame in number of extents.
v | [in] The size of a pool frame in number of extents. It must be non-negative. |
def sparksee.SparkseeConfig.get_cache_statistics_file | ( | self | ) |
Gets the cache statistics log file.
Useless if cache statistics are disabled.
def sparksee.SparkseeConfig.set_cache_statistics_file | ( | self, | ||
v | ||||
) |
Sets the cache statistics log file.
Useless if cache statistics are disabled.
v | [in] The cache statistics log file. |
def sparksee.SparkseeConfig.get_pool_frame_size | ( | self | ) |
Gets the size of a pool frame in number of extents.
def sparksee.SparkseeConfig.get_cache_max_size | ( | self | ) |
Gets the maximum size for the cache (all pools) in MB.
def sparksee.SparkseeConfig.get_cache_statistics_snapshot_time | ( | self | ) |
Gets the cache statistics snapshot time in microseconds.
Useless if cache statistics are disabled.
def sparksee.SparkseeConfig.get_pool_temporary_max_size | ( | self | ) |
Gets the maximum size for the temporary pool in number of frames.
def sparksee.SparkseeConfig.set_extent_pages | ( | self, | ||
v | ||||
) |
Sets the number of pages per extent.
v | [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_pool_temporary_min_size | ( | self, | ||
v | ||||
) |
Sets the minimum size for the temporary pool in number of frames.
v | [in] The minimum size for the temporary pool in number of frames. It must be non-negative. |
def sparksee.SparkseeConfig.get_license | ( | self | ) |
Gets the license code.
def sparksee.SparkseeConfig.get_pool_temporary_min_size | ( | self | ) |
Gets the minimum size for the temporary pool in number of frames.
def sparksee.SparkseeConfig.set_high_availability_master_history | ( | self, | ||
v | ||||
) |
Sets the master's history log.
v | [in] The master's history log. |
def sparksee.SparkseeConfig.set_cache_statistics_enabled | ( | self, | ||
v | ||||
) |
Enables or disables cache statistics.
v | [in] If TRUE this enables cache statistics, if FALSE this disables cache statistics. |
def sparksee.SparkseeConfig.get_recovery_cache_max_size | ( | self | ) |
Gets the maximum size for the recovery log cache in extents.
def sparksee.SparkseeConfig.get_high_availability_master_history | ( | self | ) |
Gets the master's history log.
def sparksee.SparkseeConfig.get_high_availability_i_p | ( | self | ) |
Gets the IP address and port of the instance.
def sparksee.SparkseeConfig.get_log_level | ( | self | ) |
def sparksee.SparkseeConfig.set_recovery_checkpoint_time | ( | self, | ||
v | ||||
) |
Sets the delay time (in microseconds) between automatic checkpoints.
v | [in] The delay time (in microseconds) between automatic checkpoints. A 0 forces a checkpoint after each commited transaction. |
def sparksee.SparkseeConfig.set_log_file | ( | self, | ||
v | ||||
) |
Sets the log file.
v | [in] The log file. |
def sparksee.SparkseeConfig.get_pool_persistent_min_size | ( | self | ) |
Gets the minimum size for the persistent pool in number of frames.