MilvusServerResource

Handle

📦 Aspire.Hosting.Milvus v13.6.0

interface MilvusServerResource
  extends IComputeResource,
    IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly apiKeyParameter: ParameterResource;
  readonly connectionStringExpression: ReferenceExpression;
  readonly databases: Dict<string,string>;
  readonly host: EndpointReferenceExpression;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  readonly token: ReferenceExpression;
  readonly uriExpression: ReferenceExpression;
  addDatabase(
      name: string,
      databaseName?: string): MilvusDatabaseResource;
  withAttu(configureContainer?: (obj: AttuResource) => Promise<void>, containerName?: string): MilvusServerResource;
  withConfigurationFile(configurationFilePath: string): MilvusServerResource;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): MilvusServerResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): MilvusServerResource;
}

13 members

Properties

propertyapiKeyParameterParameterResourceget

Gets the parameter that contains the Milvus API key.

propertyconnectionStringExpressionReferenceExpressionget

Gets the connection string expression for the Milvus gRPC endpoint.

propertydatabasesDict<string,string>get

A dictionary where the key is the resource name and the value is the database name.

propertyhostEndpointReferenceExpressionget

Gets the host endpoint reference for this resource.

propertyportEndpointReferenceExpressionget

Gets the port endpoint reference for this resource.

propertyprimaryEndpointEndpointReferenceget

Gets the gRPC endpoint for the Milvus database.

propertytokenReferenceExpressionget

Gets a valid access token to access the Milvus instance.

propertyuriExpressionReferenceExpressionget

Gets URI expression for the Milvus instance.

Methods

methodaddDatabasebuilder

Adds a Milvus database to the application model.

addDatabase(
    name: string,
    databaseName?: string): MilvusDatabaseResource

Parameters

namestring

databaseNamestringoptional

Returns

MilvusDatabaseResource

methodwithAttubuilder

Adds an administration and development platform for Milvus to the application model using Attu.

withAttu(configureContainer?: (obj: AttuResource) => Promise<void>, containerName?: string): MilvusServerResource

Parameters

configureContainer(obj: AttuResource) => Promise<void>optional

containerNamestringoptional

Returns

MilvusServerResource

methodwithConfigurationFilebuilder

Copies a configuration file into a Milvus container resource.

withConfigurationFile(configurationFilePath: string): MilvusServerResource

Parameters

configurationFilePathstring

Returns

MilvusServerResource

methodwithDataBindMountbuilder

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

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

Parameters

sourcestring

isReadOnlybooleanoptional= False

Returns

MilvusServerResource

methodwithDataVolumebuilder

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

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

Parameters

namestringoptional

isReadOnlybooleanoptional= False

Returns

MilvusServerResource