ClickHouseServerResource

Handle

📦 Aspire.Hosting.ClickHouse v13.5.3

interface ClickHouseServerResource
  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 passwordParameter: ParameterResource;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  readonly userNameParameter: ParameterResource;
  readonly userNameReference: ReferenceExpression;
  addDatabase(
      name: string,
      databaseName?: string): ClickHouseDatabaseResource;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): ClickHouseServerResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): ClickHouseServerResource;
}

11 members

Properties

propertyconnectionStringExpressionReferenceExpressionget

Gets the connection string expression for the ClickHouse server.

propertydatabasesDict<string,string>get

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

propertyhostEndpointReferenceExpressionget

Gets the host expression for this resource.

propertypasswordParameterParameterResourceget

Gets the parameter that contains the ClickHouse server password.

propertyportEndpointReferenceExpressionget

Gets the port expression for this resource.

propertyprimaryEndpointEndpointReferenceget

Gets the primary endpoint for the ClickHouse server.

propertyuserNameParameterParameterResourceget

Gets the parameter that contains the ClickHouse server username.

propertyuserNameReferenceReferenceExpressionget

Gets a reference to the user name for the ClickHouse server.

Methods

methodaddDatabasebuilder

Adds a ClickHouse database to the application model.

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

Parameters

namestring

databaseNamestringoptional

Returns

ClickHouseDatabaseResource

methodwithDataBindMountbuilder

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

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

Parameters

sourcestring

isReadOnlybooleanoptional= False

Returns

ClickHouseServerResource

methodwithDataVolumebuilder

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

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

Parameters

namestringoptional

isReadOnlybooleanoptional= False

Returns

ClickHouseServerResource