Class DbClientSettings

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

Inheritance

System.Object

DbClientSettings

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: TimeCockpit.Data.Database

Assembly: TimeCockpit.Data.dll

Syntax

public class DbClientSettings

Constructors

DbClientSettings()

Initializes a new instance of the DbClientSettings class

Declaration

public DbClientSettings()

Properties

AzureBlobStorageAccountName

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

Declaration

public string AzureBlobStorageAccountName { get; set; }

Property Value

Type	Description
System.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

Declaration

public string AzureBlobStorageKey { get; set; }

Property Value

Type	Description
System.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

Declaration

public string AzureSharedAccessKey { get; set; }

Property Value

Type	Description
System.String

BlobEncryptionKey

Gets or sets the blob encryption key of a user

Declaration

public byte[] BlobEncryptionKey { get; set; }

Property Value

Type	Description
System.Byte[]

BlobStorageType

Gets or sets the location of the blob storage.

Declaration

public BlobStorageType BlobStorageType { get; set; }

Property Value

Type	Description
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.

Declaration

public string ConnectionString { get; set; }

Property Value

Type	Description
System.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.

Declaration

public bool EnsureBlobContainerExists { get; set; }

Property Value

Type	Description
System.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.

Declaration

public bool InstallMissingSystemObjects { get; set; }

Property Value

Type	Description
System.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.

Declaration

public bool PerformVersionCheck { get; set; }

Property Value

Type	Description
System.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

Declaration

public string ProviderName { get; set; }

Property Value

Type	Description
System.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.

Declaration

public Guid? ReplicaId { get; set; }

Property Value

Type	Description
System.Nullable<System.Guid>

TenantSchema

Gets or sets the database schema to work with.

Declaration

public string TenantSchema { get; set; }

Property Value

Type	Description
System.String

Remarks

The default value for this property is an empty string.

UserAccountId

Gets or sets the it of the user.

Declaration

public Guid UserAccountId { get; set; }

Property Value

Type	Description
System.Guid