Table of Contents

Class SettingSqlModel

Namespace
OpenSettings.Domains.Sql.Entities
Assembly
OpenSettings.dll
[Table("Settings")]
public class SettingSqlModel : EntityBase<int>
Inheritance
SettingSqlModel
Inherited Members

Properties

App

The app associated with this setting.

[ForeignKey("AppId")]
public virtual AppSqlModel App { get; set; }

Property Value

AppSqlModel

AppId

The app id associated with this setting.

public int AppId { get; set; }

Property Value

int

CompressionLevel

Defines the level of compression used.

public CompressionLevel CompressionLevel { get; set; }

Property Value

CompressionLevel

CompressionType

Specifies the type of compression applied to the data.
Determines which decoding method should be used.

public CompressionType CompressionType { get; set; }

Property Value

CompressionType

ComputedIdentifier

The computed identifier is either provided directly as a GUID or is computed based on the class full name (or other string identifier) using an MD5 hash of the UTF-8 bytes of the string. This allows each setting to have a unique identifier.

public Guid ComputedIdentifier { get; set; }

Property Value

Guid

CopiedFrom

The setting from which this setting was copied or cloned.

[ForeignKey("CopiedFromId")]
public SettingSqlModel CopiedFrom { get; set; }

Property Value

SettingSqlModel

CopiedFromId

The id of the setting from which this setting was copied or cloned.

public int? CopiedFromId { get; set; }

Property Value

int?

CopiedOn

The date and time when the setting was copied or cloned.

public DateTime? CopiedOn { get; set; }

Property Value

DateTime?

Remarks

If the setting was copied or cloned, this value will contain the date and time of the operation. If the setting was not copied or cloned, this property will be null.

CreatedBy

The user who created this setting.

[ForeignKey("CreatedById")]
public virtual UserSqlModel CreatedBy { get; set; }

Property Value

UserSqlModel

CreatedById

The id of the user who created this setting.

public Guid? CreatedById { get; set; }

Property Value

Guid?

Data

The binary data associated with the setting.

public byte[] Data { get; set; }

Property Value

byte[]

DataRestored

Indicates whether the data has been restored, preserving a history record.

public bool DataRestored { get; set; }

Property Value

bool

DataValidationDisabled

Specifies whether data validation is disabled for this setting.

public bool DataValidationDisabled { get; set; }

Property Value

bool

Identifier

The identifier associated with this setting.

[ForeignKey("IdentifierId")]
public virtual IdentifierSqlModel Identifier { get; set; }

Property Value

IdentifierSqlModel

IdentifierId

The identifier associated with this setting.

public int IdentifierId { get; set; }

Property Value

int

IgnoreOnFileChange

Indicates whether changes to the file should be ignored.
This property has a value only if StoreInSeparateFile is set to true.

public bool? IgnoreOnFileChange { get; set; }

Property Value

bool?

IsCopied

A value indicating whether this setting was copied or cloned from another setting.

public bool IsCopied { get; set; }

Property Value

bool

Remarks

This property is used to track whether the setting is a duplicate of another setting, either by being copied or cloned.

IsDraft

Indicates whether the setting is in draft mode.
Multiple settings can be associated with the same Identifier and ComputedIdentifier,
but only one of them can have this property set to false.

public bool IsDraft { get; set; }

Property Value

bool

RegistrationMode

Defines the registration mode used for this setting.

public RegistrationMode RegistrationMode { get; set; }

Property Value

RegistrationMode

RowVersion

A concurrency token used for tracking changes.
Helps prevent conflicts during concurrent updates.

public byte[] RowVersion { get; set; }

Property Value

byte[]

SerializerType

Defines the serialization type used for data serialization and deserialization. Currently, only Json is supported. Future support for other formats may be added.

public SerializerType SerializerType { get; set; }

Property Value

SerializerType

SettingClass

The associated setting class that provides metadata for this setting.

public virtual SettingClassSqlModel SettingClass { get; set; }

Property Value

SettingClassSqlModel

SettingHistories

A collection of historical records for this setting.

public virtual List<SettingHistorySqlModel> SettingHistories { get; set; }

Property Value

List<SettingHistorySqlModel>

StoreInSeparateFile

Determines whether the setting should be stored in a separate file.

public bool StoreInSeparateFile { get; set; }

Property Value

bool

UpdatedBy

The user who last updated this setting.

[ForeignKey("UpdatedById")]
public virtual UserSqlModel UpdatedBy { get; set; }

Property Value

UserSqlModel

UpdatedById

The id of the user who last updated this setting.

public Guid? UpdatedById { get; set; }

Property Value

Guid?

Version

Represents the version of the setting.

public string Version { get; set; }

Property Value

string