PrimaryEndpoint EndpointReference getPrimaryEndpoint() EndpointReferenceAPI references are intentionally omitted from this search. To find API references, please search these dedicated API pages instead:
A resource that represents a ClickHouse container.
type ClickHouseServerResource interface { ExpressionValue IComputeResource Resource ResourceWithArgs ResourceWithConnectionString ResourceWithEndpoints ResourceWithEnvironment ResourceWithWaitSupport}ConnectionStringExpression *ReferenceExpression getConnectionStringExpression() *ReferenceExpressionDatabasesmap[string]string getDatabases() (map[string]string, error)HostEndpointReferenceExpression getHost() EndpointReferenceExpressionPasswordParameter ParameterResource getPasswordParameter() ParameterResourcePortEndpointReferenceExpression getPort() EndpointReferenceExpressionPrimaryEndpoint EndpointReference getPrimaryEndpoint() EndpointReferenceUserNameParameter ParameterResource getUserNameParameter() ParameterResourceUserNameReference *ReferenceExpression getUserNameReference() *ReferenceExpressionAddDatabase( name string, options ...*AddDatabaseOptions,) ClickHouseDatabaseResourceParameters
namestringThe name of the resource. This name will be used as the connection string name when referenced in a dependency.options...*AddDatabaseOptions Optional settings, described under Options.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.Returns
ClickHouseDatabaseResource The ClickHouse database resource.
Returns a handle; failures surface later via Err().
WithDataBindMount( source string, options ...*WithDataBindMountOptions,) ClickHouseServerResourceParameters
sourcestringThe source directory on the host to mount into the container.options...*WithDataBindMountOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithDataBindMountOptions argument.
IsReadOnly *boolA flag that indicates if this is a read-only mount.Returns
ClickHouseServerResource The resource builder.
Returns a handle; failures surface later via Err().
WithDataVolume(options ...*WithDataVolumeOptions) ClickHouseServerResourceParameters
options...*WithDataVolumeOptions Optional settings, described under Options.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 application and resource names.IsReadOnly *boolA flag that indicates if this is a read-only volume.Returns
ClickHouseServerResource The resource builder.
Returns a handle; failures surface later via Err().