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

propertyconnectionStringExpressionReferenceExpressionget

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

propertydatabasesDict<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.

propertyhostEndpointReferenceExpressionget

Gets the host endpoint reference for this resource.

propertyportEndpointReferenceExpressionget

Gets the port endpoint reference for this resource.

propertyprimaryEndpointEndpointReferenceget

Gets the primary endpoint for the RavenDB server.

propertytcpEndpointEndpointReferenceget

Gets the TCP endpoint for the RavenDB server.

propertyuriExpressionReferenceExpressionget

Gets the connection URI expression for the RavenDB server.

Methods

methodaddDatabasebuilder

Adds a database resource to an existing RavenDB server resource.

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

Parameters

namestring

databaseNamestringoptional

ensureCreatedbooleanoptional= False

Returns

RavenDBDatabaseResource

methodwithDataBindMountbuilder

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

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

Parameters

sourcestring

isReadOnlybooleanoptional= False

Returns

RavenDBServerResource

methodwithDataVolumebuilder

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

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

Parameters

namestringoptional

isReadOnlybooleanoptional= False

Returns

RavenDBServerResource

methodwithLogBindMountbuilder

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

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

Parameters

sourcestring

isReadOnlybooleanoptional= False

Returns

RavenDBServerResource

methodwithLogVolumebuilder

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

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

Parameters

namestringoptional

isReadOnlybooleanoptional= False

Returns

RavenDBServerResource