eXtremeDB SQL .NET 6.0 API
Parameters for the database open method. More...
Public Types | |
| enum class | Compression { ObjHead = 1 , ObjNode = 2 , BlobHead = 64 , BlobTail = 128 , FixedrecSet = 4096 , All = ObjHead | ObjNode | FixedrecSet | BlobHead | BlobTail } |
Public Member Functions | |
| Parameters () | |
| Constructor with default values More... | |
| void | Convert (ref mco_db_params_t outp) |
Public Attributes | |
| int | MemPageSize |
| Memory page size (default: 256). When using a disk database, this should be a power of two and at least 8 times smaller than disk page size. More... | |
| int | DiskPageSize |
| Disk page size (default: 0). Typically 4096 bytes; zero for all-in-memory databases. More... | |
| int | MaxConnections |
| The maximum number of database connections (default: 100). More... | |
| int | ConnectionContextSize |
| Recovery connection context (default: 0 - no recovery connection context) More... | |
| long | MaxDiskDatabaseSize |
| The maximum size for a disk database (default: 0 - unlimited). More... | |
| long | DiskFileExtensionQuantum |
| Quantum of increasing size of database file (can help to reduce file fragmentation) More... | |
| long | RedoLogLimit |
| The REDO transaction log threshold. After reaching this a checkpoint is performed and the log is truncated. Note that the checkpoint can be performed only after a transaction commit, so the size of the log file can become larger than the specified limit. A zero value means to use the implementation specific default value. More... | |
| long | DelayedCommitThreshold |
| The maximum size of uncommitted changes (delayed transaction commits) when using the CommitPolicy.Delayed policy (default: 0 - 1/3 of the available disk cache). More... | |
| int | MaxDelayedTransactions |
| The maximum number of delayed transaction commits when using the CommitPolicy.Delayed policy (default: 0 - unlimited). More... | |
| Database.CommitPolicy | DefaultCommitPolicy |
| Default commit policy for new connections (default : CommitPolicy.SyncFlush) More... | |
| Database.LogType | LogType |
| The transaction log type (default: LogType.RedoLog). More... | |
| int | HashLoadFactor |
| The hash table load factor (default: 100%). This is a criterion for hash table extension. More... | |
| int | IndexOptimisticLockThreshold |
| The maximum number of active write transactions when using optimistic locking of B-Tree indexes (default: 0 - unlimited). More... | |
| int | Mode |
| A combination of DB_MODE_/// bits (default: 0). More... | |
| String? | DatabaseSnapshotFilePath |
| The path to the file from which a database snapshot will be loaded at open time (default: null - no snapshot to load). More... | |
| String | StringEncoding |
| The default string encoding (string encoding can be specified using the Encoding attribute for each field separately) (default: UTF-8). More... | |
| bool | DiskClassesByDefault |
Whether the classes specified in classes will be stored on disk. Also disk classes may be marked explicitly using the disk() attribute of the Persistent attribute. More... | |
| bool | CompactClassesByDefault |
Whether classes specified in classes will be implicitly marked as compact. Also compact classes may be marked explicitly using the compact() attribute of Persistent attribute. More... | |
| bool | NonAtomicClassesByDefault |
Whether classes specified in classes will be implicitly marked as nonatomic. Also nonatomic classes may be marked explicitly using the compact() attribute of Persistent attribute. More... | |
| bool | DictionaryNoSort |
| Make dictionary compatible with mcocomp utility called with -nosort option More... | |
| int | MaxClasses |
| Maximal number of classes in database. Is need for dynamic schema evolution More... | |
| int | MaxIndexes |
| Maximal number of indexes in database. Is need for dynamic schema evolution More... | |
| int | MaxDictionarySize |
| Maximal size of database dictionary Is need for dynamic schema evolution More... | |
| bool | TerminateOnFatalError |
| Whether eXtremeDB runtime terminates current process in case of fatal error appeared. More... | |
| TransSchedPolicy | SchedPolicy |
| Scheduling policy for transactions with the same priority More... | |
| bool | IgnoreTtl |
| Ignore all TTL policies (can be changed at runtime) More... | |
| long | sqlWorkspaceLimit |
| SQL workspace quota. Default is 0 - unlimited More... | |
| int | CompressionLevel |
| compression level: 0..9, 0 - no compression, -1: default compression level More... | |
| Compression | CompressionMask |
| bitmap of page kinds which should be compressed More... | |
| int | ExpectedCompressionRatio |
| use to allocate page map: virtual database space can not be larger than physical size compression ratio More... | |
| String? | CipherKey |
| database encryption key More... | |
| long | BackupMapSize |
| size of backup counters array, bytes, power of two, ignored if disk_max_database_size set. Default is 0 - disable backup feature More... | |
| int | BackupMinPages |
| number of pages for last exclusive pass of backup procedure, set to zero to disable treshold. Default is 0 More... | |
| int | BackupMaxPasses |
| Max number of passes before exclusive pass of backup procedure. Default is 10 More... | |
| String? | BackupMapFile |
| Name of a file will be used to store backup temporary data on mco_db_close() call. Optional, set to null for default "<persistent-storage>.bmap" file locate at the same location as persistent storage file More... | |
| int | FileBackupDelay |
| Delay in milliseconds between writing backup blocks to minimize backup impact on performance More... | |
| long | EstimatedNumberOfObjects |
| Estimated total number of objects in the database (used for global system hash table size estimation) More... | |
Parameters for the database open method.
|
strong |
| eXtremeDB.Database.Parameters.Parameters | ( | ) |
Constructor with default values
| void eXtremeDB.Database.Parameters.Convert | ( | ref mco_db_params_t | outp | ) |
| String? eXtremeDB.Database.Parameters.BackupMapFile |
Name of a file will be used to store backup temporary data on mco_db_close() call. Optional, set to null for default "<persistent-storage>.bmap" file locate at the same location as persistent storage file
| long eXtremeDB.Database.Parameters.BackupMapSize |
size of backup counters array, bytes, power of two, ignored if disk_max_database_size set. Default is 0 - disable backup feature
| int eXtremeDB.Database.Parameters.BackupMaxPasses |
Max number of passes before exclusive pass of backup procedure. Default is 10
| int eXtremeDB.Database.Parameters.BackupMinPages |
number of pages for last exclusive pass of backup procedure, set to zero to disable treshold. Default is 0
| String? eXtremeDB.Database.Parameters.CipherKey |
database encryption key
| bool eXtremeDB.Database.Parameters.CompactClassesByDefault |
Whether classes specified in classes will be implicitly marked as compact. Also compact classes may be marked explicitly using the compact() attribute of Persistent attribute.
| int eXtremeDB.Database.Parameters.CompressionLevel |
compression level: 0..9, 0 - no compression, -1: default compression level
| Compression eXtremeDB.Database.Parameters.CompressionMask |
bitmap of page kinds which should be compressed
| int eXtremeDB.Database.Parameters.ConnectionContextSize |
Recovery connection context (default: 0 - no recovery connection context)
| String? eXtremeDB.Database.Parameters.DatabaseSnapshotFilePath |
The path to the file from which a database snapshot will be loaded at open time (default: null - no snapshot to load).
| Database.CommitPolicy eXtremeDB.Database.Parameters.DefaultCommitPolicy |
Default commit policy for new connections (default : CommitPolicy.SyncFlush)
| long eXtremeDB.Database.Parameters.DelayedCommitThreshold |
The maximum size of uncommitted changes (delayed transaction commits) when using the CommitPolicy.Delayed policy (default: 0 - 1/3 of the available disk cache).
| bool eXtremeDB.Database.Parameters.DictionaryNoSort |
Make dictionary compatible with mcocomp utility called with -nosort option
| bool eXtremeDB.Database.Parameters.DiskClassesByDefault |
Whether the classes specified in classes will be stored on disk. Also disk classes may be marked explicitly using the disk() attribute of the Persistent attribute.
| long eXtremeDB.Database.Parameters.DiskFileExtensionQuantum |
Quantum of increasing size of database file (can help to reduce file fragmentation)
| int eXtremeDB.Database.Parameters.DiskPageSize |
Disk page size (default: 0). Typically 4096 bytes; zero for all-in-memory databases.
| long eXtremeDB.Database.Parameters.EstimatedNumberOfObjects |
Estimated total number of objects in the database (used for global system hash table size estimation)
| int eXtremeDB.Database.Parameters.ExpectedCompressionRatio |
use to allocate page map: virtual database space can not be larger than physical size compression ratio
| int eXtremeDB.Database.Parameters.FileBackupDelay |
Delay in milliseconds between writing backup blocks to minimize backup impact on performance
| int eXtremeDB.Database.Parameters.HashLoadFactor |
The hash table load factor (default: 100%). This is a criterion for hash table extension.
| bool eXtremeDB.Database.Parameters.IgnoreTtl |
Ignore all TTL policies (can be changed at runtime)
| int eXtremeDB.Database.Parameters.IndexOptimisticLockThreshold |
The maximum number of active write transactions when using optimistic locking of B-Tree indexes (default: 0 - unlimited).
| Database.LogType eXtremeDB.Database.Parameters.LogType |
The transaction log type (default: LogType.RedoLog).
| int eXtremeDB.Database.Parameters.MaxClasses |
Maximal number of classes in database. Is need for dynamic schema evolution
| int eXtremeDB.Database.Parameters.MaxConnections |
The maximum number of database connections (default: 100).
| int eXtremeDB.Database.Parameters.MaxDelayedTransactions |
The maximum number of delayed transaction commits when using the CommitPolicy.Delayed policy (default: 0 - unlimited).
| int eXtremeDB.Database.Parameters.MaxDictionarySize |
Maximal size of database dictionary Is need for dynamic schema evolution
| long eXtremeDB.Database.Parameters.MaxDiskDatabaseSize |
The maximum size for a disk database (default: 0 - unlimited).
| int eXtremeDB.Database.Parameters.MaxIndexes |
Maximal number of indexes in database. Is need for dynamic schema evolution
| int eXtremeDB.Database.Parameters.MemPageSize |
Memory page size (default: 256). When using a disk database, this should be a power of two and at least 8 times smaller than disk page size.
| int eXtremeDB.Database.Parameters.Mode |
A combination of DB_MODE_/// bits (default: 0).
| bool eXtremeDB.Database.Parameters.NonAtomicClassesByDefault |
Whether classes specified in classes will be implicitly marked as nonatomic. Also nonatomic classes may be marked explicitly using the compact() attribute of Persistent attribute.
| long eXtremeDB.Database.Parameters.RedoLogLimit |
The REDO transaction log threshold. After reaching this a checkpoint is performed and the log is truncated. Note that the checkpoint can be performed only after a transaction commit, so the size of the log file can become larger than the specified limit. A zero value means to use the implementation specific default value.
| TransSchedPolicy eXtremeDB.Database.Parameters.SchedPolicy |
Scheduling policy for transactions with the same priority
| long eXtremeDB.Database.Parameters.sqlWorkspaceLimit |
SQL workspace quota. Default is 0 - unlimited
| String eXtremeDB.Database.Parameters.StringEncoding |
The default string encoding (string encoding can be specified using the Encoding attribute for each field separately) (default: UTF-8).
| bool eXtremeDB.Database.Parameters.TerminateOnFatalError |
Whether eXtremeDB runtime terminates current process in case of fatal error appeared.