FdbConnectionResource

Namespace: Aspire.Hosting.ApplicationModel · class

Implements: Resource, IResource, IFdbResource, IResourceWithConnectionString, IExpressionValue, IValueProvider, IManifestExpressionProvider, IValueWithReferences, IResourceWithEndpoints

Represents an externally hosted FoundationDB Cluster in a distributed application.

Constructors

FdbConnectionResource

FdbConnectionResource(string name)

Creates a resource for an externally hosted FoundationDB Cluster

  • name — The name of the resource.

Properties

ApiVersion

int ApiVersion { get; set; }

The minimum API version that must be supported by the cluster

See for more information.

ClusterContents

string ClusterContents { get; set; }

Connection string to the cluster

See ConnectionString for more information.

This property and ClusterFile are mutually exclusive.

ClusterFile

string ClusterFile { get; set; }

Full path to a specific 'fdb.cluster' file

See ClusterFile for more information.

This property and ClusterContents are mutually exclusive.

ClusterVersion

Version ClusterVersion { get; set; }

If specified, the minimum version of the cluster to be deployed.

The actual version of the cluster may be different, depending on the versioning policy used during deployment

ConnectionStringExpression

ReferenceExpression ConnectionStringExpression { get; }

DisableNativePreloading

bool DisableNativePreloading { get; set; }

Specifies if native preloading should be enabled or disabled

If true, the value of NativeLibraryPath will be ignored.

See DisableNativeLibraryPreloading for more information.

NativeLibraryPath

string NativeLibraryPath { get; set; }

Path to the local native client library ('fdb_c.dll' or 'libfdb_c.so')

This value if ignored when DisableNativePreloading is set to true.

See SetNativeLibPath for more information.

Root

FdbPath Root { get; set; }

Default root location used by the database

See for more information.

Methods

GetConnectionString

string GetConnectionString()

Returns the corresponding connection string for this resource