Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

MilvusServerResource

Handle
📦 Aspire.Hosting.Milvus v17.0.0

A resource that represents a Milvus database.

type MilvusServerResource interface {
ExpressionValue
IComputeResource
Resource
ResourceWithArgs
ResourceWithConnectionString
ResourceWithEndpoints
ResourceWithEnvironment
ResourceWithWaitSupport
}

Properties

propertyApiKeyParameterParameterResourceget
Gets the parameter that contains the Milvus API key.
ApiKeyParameter() ParameterResource
propertyConnectionStringExpression*ReferenceExpressionget
Gets the connection string expression for the Milvus gRPC endpoint.
ConnectionStringExpression() *ReferenceExpression
propertyDatabasesmap[string]stringget
A dictionary where the key is the resource name and the value is the database name.
Databases() (map[string]string, error)
propertyHostEndpointReferenceExpressionget
Gets the host endpoint reference for this resource.
Host() EndpointReferenceExpression
propertyPortEndpointReferenceExpressionget
Gets the port endpoint reference for this resource.
Port() EndpointReferenceExpression
propertyPrimaryEndpointEndpointReferenceget
Gets the gRPC endpoint for the Milvus database.
PrimaryEndpoint() EndpointReference
propertyResourceTypeDisplayNamestringget
Gets the ResourceTypeDisplayName property
ResourceTypeDisplayName() (string, error)
propertyToken*ReferenceExpressionget
Gets a valid access token to access the Milvus instance.
Token() *ReferenceExpression
propertyUriExpression*ReferenceExpressionget
Gets URI expression for the Milvus instance.
UriExpression() *ReferenceExpression

Methods

methodAddDatabasebuilder
Adds a Milvus database to the application model.
AddDatabase(
name string,
options ...*AddDatabaseOptions,
) MilvusDatabaseResource
namestringThe name of the resource. This name will be used as the connection string name when referenced in a dependency.
options...*AddDatabaseOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*AddDatabaseOptions argument.

DatabaseName*stringThe name of the database. If not provided, this defaults to the same value as name.
MilvusDatabaseResource

The resource builder.

Returns a handle; failures surface later via Err().

methodWithAttubuilder
Adds an administration and development platform for Milvus to the application model using Attu.
WithAttu(options ...*WithAttuOptions) MilvusServerResource
options...*WithAttuOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithAttuOptions argument.

ConfigureContainerfunc(obj AttuResource)callbackConfiguration callback for Attu container resource.
ContainerName*stringThe name of the container (Optional).
MilvusServerResource

The resource builder.

Returns a handle; failures surface later via Err().

Copies a configuration file into a Milvus container resource.
WithConfigurationFile(configurationFilePath string) MilvusServerResource
configurationFilePathstringThe configuration file on the host to copy into the container.
MilvusServerResource

The resource builder.

Returns a handle; failures surface later via Err().

methodWithDataBindMountbuilder
Adds a bind mount for the data folder to a Milvus container resource.
WithDataBindMount(
source string,
options ...*WithDataBindMountOptions,
) MilvusServerResource
sourcestringThe source directory on the host to mount into the container.
options...*WithDataBindMountOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithDataBindMountOptions argument.

IsReadOnly*boolA flag that indicates if this is a read-only mount.
MilvusServerResource

The resource builder.

Returns a handle; failures surface later via Err().

methodWithDataVolumebuilder
Adds a named volume for the data folder to a Milvus container resource.
WithDataVolume(options ...*WithDataVolumeOptions) MilvusServerResource
options...*WithDataVolumeOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithDataVolumeOptions argument.

Name*stringThe name of the volume. Defaults to an auto-generated name based on the resource name.
IsReadOnly*boolA flag that indicates if this is a read-only volume.
MilvusServerResource

The resource builder.

Returns a handle; failures surface later via Err().