MySqlServerResource

Docs / Reference / TypeScript APIs / Aspire.Hosting.MySql / MySqlServerResource

MySqlServerResource

Docs Reference TypeScript APIs Aspire.Hosting.MySql MySqlServerResource

Handle TypeScript

📦 Aspire.Hosting.MySql v13.2.0-preview.1.26159.1

interface MySqlServerResource
  extends IComputeResource,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  readonly databases: Dict<string,string>;
  entrypoint: string;
  readonly host: EndpointReferenceExpression;
  readonly jdbcConnectionString: ReferenceExpression;
  readonly name: string;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  shellExecution: boolean;
  readonly uriExpression: ReferenceExpression;
  addDatabase(
      name: string,
      databaseName?: string): MySqlDatabaseResource;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): MySqlServerResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): MySqlServerResource;
  withInitFiles(source: string): MySqlServerResource;
  withPassword(password: ParameterResource): MySqlServerResource;
  withPhpMyAdmin(configureContainer?: (obj: PhpMyAdminContainerResource) => void, containerName?: string): MySqlServerResource;
}

Implements

• IComputeResource
• IManifestExpressionProvider
• IResource
• IResourceWithArgs
• IResourceWithConnectionString
• IResourceWithEndpoints
• IResourceWithEnvironment
• IResourceWithProbes
• IResourceWithWaitSupport
• IValueProvider
• IValueWithReferences

Search members of MySqlServerResource…

method property

18 members Clear filters

Properties

property connectionStringExpression ReferenceExpression get

Gets the ConnectionStringExpression property

property databases Dict<string,string> get

Gets the Databases property

property entrypoint string get · set

Gets the Entrypoint property

property host EndpointReferenceExpression get

Gets the Host property

property jdbcConnectionString ReferenceExpression get

Gets the JdbcConnectionString property

property name string get

Gets the Name property

property port EndpointReferenceExpression get

Gets the Port property

property primaryEndpoint EndpointReference get

Gets the PrimaryEndpoint property

property shellExecution boolean get · set

Gets the ShellExecution property

property uriExpression ReferenceExpression get

Gets the UriExpression property

Methods

method addDatabase builder

Adds a MySQL database

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

Parameters

name string

databaseName string optional

Returns

MySqlDatabaseResource

method withDataBindMount builder

Adds a data bind mount for MySQL

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

Parameters

source string

isReadOnly boolean optional = False

Returns

MySqlServerResource

method withDataVolume builder

Adds a data volume for MySQL

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

Parameters

name string optional

isReadOnly boolean optional = False

Returns

MySqlServerResource

method withInitFiles builder

Copies init files to MySQL

withInitFiles(source: string): MySqlServerResource

Parameters

source string

Returns

MySqlServerResource

method withPassword builder

Configures the MySQL password

withPassword(password: ParameterResource): MySqlServerResource

Parameters

password ParameterResource

Returns

MySqlServerResource

method withPhpMyAdmin builder

Adds phpMyAdmin management UI

withPhpMyAdmin(configureContainer?: (obj: PhpMyAdminContainerResource) => void, containerName?: string): MySqlServerResource

Parameters

configureContainer (obj: PhpMyAdminContainerResource) => void optional

containerName string optional

Returns

MySqlServerResource