RavenDBServerResource

Handle

📦 CommunityToolkit.Aspire.Hosting.RavenDB v13.4.0

interface RavenDBServerResource
  extends IComputeResource,
    IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  readonly databases: Dict<string,string>;
  readonly host: EndpointReferenceExpression;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  readonly tcpEndpoint: EndpointReference;
  readonly uriExpression: ReferenceExpression;
  addDatabase(
      name: string,
      databaseName?: string,
      ensureCreated?: boolean): RavenDBDatabaseResource;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): RavenDBServerResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): RavenDBServerResource;
  withLogBindMount(
      source: string,
      isReadOnly?: boolean): RavenDBServerResource;
  withLogVolume(
      name?: string,
      isReadOnly?: boolean): RavenDBServerResource;
}

12 members

Properties

property connectionStringExpression ReferenceExpression get

Gets the connection string expression for the RavenDB server, formatted as "http(s)://{Host}:{Port}" depending on the security setting.

property databases Dict<string,string> get

Gets a read-only dictionary of databases associated with this server resource. The key represents the resource name, and the value represents the database name.

property host EndpointReferenceExpression get

Gets the host endpoint reference for this resource.

property port EndpointReferenceExpression get

Gets the port endpoint reference for this resource.

property primaryEndpoint EndpointReference get

Gets the primary endpoint for the RavenDB server.

property tcpEndpoint EndpointReference get

Gets the TCP endpoint for the RavenDB server.

property uriExpression ReferenceExpression get

Gets the connection URI expression for the RavenDB server.

Methods

method addDatabase builder

Adds a database resource to an existing RavenDB server resource.

addDatabase(
    name: string,
    databaseName?: string,
    ensureCreated?: boolean): RavenDBDatabaseResource

Parameters

name string

databaseName string optional

ensureCreated boolean optional = False

Returns

RavenDBDatabaseResource

method withDataBindMount builder

Adds a bind mount for the data folder to a RavenDB container resource.

withDataBindMount(
    source: string,
    isReadOnly?: boolean): RavenDBServerResource

Parameters

source string

isReadOnly boolean optional = False

Returns

RavenDBServerResource

method withDataVolume builder

Adds a named volume for the data folder to a RavenDB container resource.

withDataVolume(
    name?: string,
    isReadOnly?: boolean): RavenDBServerResource

Parameters

name string optional

isReadOnly boolean optional = False

Returns

RavenDBServerResource

method withLogBindMount builder

Adds a bind mount for the logs folder to a RavenDB container resource.

withLogBindMount(
    source: string,
    isReadOnly?: boolean): RavenDBServerResource

Parameters

source string

isReadOnly boolean optional = False

Returns

RavenDBServerResource

method withLogVolume builder

Adds a named volume for the logs folder to a RavenDB container resource.

withLogVolume(
    name?: string,
    isReadOnly?: boolean): RavenDBServerResource

Parameters

name string optional

isReadOnly boolean optional = False

Returns

RavenDBServerResource