Class DbClientSettings

Namespace

TimeCockpit.Data.Database

Assembly

TimeCockpit.Data.dll

Represents settings used to create new instances of the DbClient class.

public class DbClientSettings

Inheritance

Object

DbClientSettings

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Constructors

DbClientSettings()

Initializes a new instance of the DbClientSettings class

public DbClientSettings()

Properties

AzureBlobStorageAccountName

Gets or sets the account name used to connect to azure blob storage service.

public string AzureBlobStorageAccountName { get; set; }

Property Value

String

Remarks

The default value for this property is an empty string. You have to explicitly set this property before creating a new DbClient instance if you use BlobStorageType.Azure (see BlobStorageType and property BlobStorageType).

AzureBlobStorageKey

Gets or sets the account key used to connect to azure blob storage service

public string AzureBlobStorageKey { get; set; }

Property Value

String

Remarks

The default value for this property is an empty string. You have to explicitly set this property before creating a new DbClient instance if you use BlobStorageType.Azure (see BlobStorageType and property BlobStorageType).

AzureSharedAccessKey

Gets or sets the shared access key for accessing a blob container

public string AzureSharedAccessKey { get; set; }

Property Value

String

BlobEncryptionKey

Gets or sets the blob encryption key of a user

public byte[] BlobEncryptionKey { get; set; }

Property Value

Byte[]

BlobStorageType

Gets or sets the location of the blob storage.

public BlobStorageType BlobStorageType { get; set; }

Property Value

BlobStorageType

Remarks

The default value for this property is BlobStorageType.Default (see BlobStorageType).

ConnectionString

Gets or sets the connection string used to establish the initial connection.

public string ConnectionString { get; set; }

Property Value

String

Remarks

The exact contents of the connection string depend on the specific data source for this connection.

The default value for this property is an empty string. You have to explicitly set this property before creating a new DbClient instance.

EnsureBlobContainerExists

Gets or sets a value indicating whether blob storage may be lazy initialized.

public bool EnsureBlobContainerExists { get; set; }

Property Value

Boolean

InstallMissingSystemObjects

Gets or sets a value indicating whether missing system objects should be automatically installed or updated when the connection to the underlying database is established.

public bool InstallMissingSystemObjects { get; set; }

Property Value

Boolean

Remarks

The default value for this property is false.

PerformVersionCheck

Gets or sets a value indicating whether the system should check if the system objects in the underlying database match the system objects for this program version.

public bool PerformVersionCheck { get; set; }

Property Value

Boolean

Remarks

Note that this property is only evaluated if InstallMissingSystemObjects is false because otherwise system objects are automatically installed or updated.

ProviderName

Gets or sets the invariant name of a provider

public string ProviderName { get; set; }

Property Value

String

Remarks

The system currently supports System.Data.SqlClient and System.Data.SqlServerCe.4.0.

The default value for this property is System.Data.SqlServerCe.4.0.

ReplicaId

Gets or sets the replica id.

public Guid? ReplicaId { get; set; }

Property Value

Nullable<Guid>

TenantSchema

Gets or sets the database schema to work with.

public string TenantSchema { get; set; }

Property Value

String

Remarks

The default value for this property is an empty string.

UserAccountId

Gets or sets the it of the user.

public Guid UserAccountId { get; set; }

Property Value

Guid