EngineSettings Class

All engine settings used to starts new engine

Inheritance Hierarchy

SystemObject
Internal.LiteDB.EngineEngineSettings

Namespace: Internal.LiteDB.Engine
Assembly: NeoAxis.Core (in NeoAxis.Core.dll) Version: 2026.1.1.0 (2026.1.1.0)

Syntax

public class EngineSettings

The EngineSettings type exposes the following members.

Constructors

	Name	Description
	EngineSettings	Initializes a new instance of the EngineSettings class

Properties

	Name	Description
	AutoRebuild	After a Close with exception do a database rebuild on next open
	Collation	Create database with custom string collection (used only to create database) (default: Collation.Default)
	DataStream	Get/Set custom stream to be used as datafile (can be MemoryStream or TempStream). Do not use FileStream - to use physical file, use "filename" attribute (and keep DataStream/WalStream null)
	Filename	Full path or relative path from DLL directory. Can use ':temp:' for temp database or ':memory:' for in-memory database. (default: null)
	InitialSize	If database is new, initialize with allocated space (in bytes) (default: 0)
	LogStream	Get/Set custom stream to be used as log file. If is null, use a new TempStream (for TempStream datafile) or MemoryStream (for MemoryStream datafile)
	Password	Get database password to decrypt pages
	ReadOnly	Indicate that engine will open files in readonly mode (and will not support any database change)
	ReadTransform	Is used to transform a BsonValue from the database on read. This can be used to upgrade data from older versions.
	TempStream	Get/Set custom stream to be used as temp file. If is null, will create new FileStreamFactory with "-tmp" on name
	Upgrade	If detect it's a older version (v4) do upgrade in datafile to new v5. A backup file will be keeped in same directory

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Extension Methods

	Name	Description
	MethodInvoke	Calls the object method by name. (Defined by ObjectEx)
	PropertyGet	Gets the value of the object property by name. (Defined by ObjectEx)
	PropertyGetT	Gets the value of the object property by name. (Defined by ObjectEx)
	PropertySet	Sets the value of the object property by name. (Defined by ObjectEx)