|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
namespace Aspire.Hosting.ApplicationModel;
/// <summary>
/// A resource that represents a PostgreSQL container.
/// </summary>
public class PostgresServerResource : ContainerResource, IResourceWithConnectionString
{
internal const string PrimaryEndpointName = "tcp";
private const string DefaultUserName = "postgres";
/// <summary>
/// Initializes a new instance of the <see cref="PostgresServerResource"/> class.
/// </summary>
/// <param name="name">The name of the resource.</param>
/// <param name="userName">A parameter that contains the PostgreSQL server user name, or <see langword="null"/> to use a default value.</param>
/// <param name="password">A parameter that contains the PostgreSQL server password.</param>
public PostgresServerResource(string name, ParameterResource? userName, ParameterResource password) : base(name)
{
ArgumentNullException.ThrowIfNull(password);
PrimaryEndpoint = new(this, PrimaryEndpointName);
UserNameParameter = userName;
PasswordParameter = password;
}
/// <summary>
/// Gets the primary endpoint for the PostgreSQL server.
/// </summary>
public EndpointReference PrimaryEndpoint { get; }
/// <summary>
/// Gets or sets the parameter that contains the PostgreSQL server user name.
/// </summary>
public ParameterResource? UserNameParameter { get; set; }
/// <summary>
/// Gets a reference to the user name for the PostgreSQL server.
/// </summary>
/// <remarks>
/// Returns the user name parameter if specified, otherwise returns the default user name "postgres".
/// </remarks>
public ReferenceExpression UserNameReference =>
UserNameParameter is not null ?
ReferenceExpression.Create($"{UserNameParameter}") :
ReferenceExpression.Create($"{DefaultUserName}");
/// <summary>
/// Gets or sets the parameter that contains the PostgreSQL server password.
/// </summary>
public ParameterResource PasswordParameter { get; set; }
private ReferenceExpression ConnectionString =>
ReferenceExpression.Create(
$"Host={PrimaryEndpoint.Property(EndpointProperty.Host)};Port={PrimaryEndpoint.Property(EndpointProperty.Port)};Username={UserNameReference};Password={PasswordParameter}");
/// <summary>
/// Gets the connection string expression for the PostgreSQL server.
/// </summary>
public ReferenceExpression ConnectionStringExpression
{
get
{
if (this.TryGetLastAnnotation<ConnectionStringRedirectAnnotation>(out var connectionStringAnnotation))
{
return connectionStringAnnotation.Resource.ConnectionStringExpression;
}
return ConnectionString;
}
}
/// <summary>
/// Gets the connection string for the PostgreSQL server.
/// </summary>
/// <param name="cancellationToken"> A <see cref="CancellationToken"/> to observe while waiting for the task to complete.</param>
/// <returns>A connection string for the PostgreSQL server in the form "Host=host;Port=port;Username=postgres;Password=password".</returns>
public ValueTask<string?> GetConnectionStringAsync(CancellationToken cancellationToken = default)
{
if (this.TryGetLastAnnotation<ConnectionStringRedirectAnnotation>(out var connectionStringAnnotation))
{
return connectionStringAnnotation.Resource.GetConnectionStringAsync(cancellationToken);
}
return ConnectionStringExpression.GetValueAsync(cancellationToken);
}
private readonly Dictionary<string, string> _databases = new Dictionary<string, string>(StringComparers.ResourceName);
/// <summary>
/// A dictionary where the key is the resource name and the value is the database name.
/// </summary>
public IReadOnlyDictionary<string, string> Databases => _databases;
internal void AddDatabase(string name, string databaseName)
{
_databases.TryAdd(name, databaseName);
}
// Expose Host and Port properties for convenience,
// maybe removing the need for IResourceWithConnectionProperties<T> in some cases.
/// <summary>
/// Gets the host endpoint reference for this service.
/// </summary>
public EndpointReferenceExpression Host => PrimaryEndpoint.Property(EndpointProperty.Host);
/// <summary>
/// Gets the endpoint reference expression that identifies the port for this endpoint.
/// </summary>
public EndpointReferenceExpression Port => PrimaryEndpoint.Property(EndpointProperty.Port);
/// <summary>
/// Gets the connection URI expression for the PostgreSQL server.
/// </summary>
/// <remarks>
/// Format: <c>postgresql://{user}:{password}@{host}:{port}</c>.
/// </remarks>
public ReferenceExpression UriExpression =>
ReferenceExpression.Create($"postgresql://{UserNameReference:uri}:{PasswordParameter:uri}@{Host}:{Port}");
internal ReferenceExpression BuildJdbcConnectionString(string? databaseName = null)
{
var builder = new ReferenceExpressionBuilder();
builder.AppendLiteral("jdbc:postgresql://");
builder.Append($"{Host}");
builder.AppendLiteral(":");
builder.Append($"{Port}");
if (databaseName is not null)
{
builder.AppendLiteral("/");
var databaseNameExpression = ReferenceExpression.Create($"{databaseName}");
builder.Append($"{databaseNameExpression:uri}");
}
return builder.Build();
}
/// <summary>
/// Gets the JDBC connection string for the PostgreSQL server.
/// </summary>
/// <remarks>
/// Format: <c>jdbc:postgresql://{host}:{port}</c>.
/// </remarks>
public ReferenceExpression JdbcConnectionString => BuildJdbcConnectionString();
IEnumerable<KeyValuePair<string, ReferenceExpression>> IResourceWithConnectionString.GetConnectionProperties() =>
[
new ("Host", ReferenceExpression.Create($"{Host}")),
new ("Port", ReferenceExpression.Create($"{Port}")),
new ("Username", ReferenceExpression.Create($"{UserNameReference}")),
new ("Password", ReferenceExpression.Create($"{PasswordParameter}")),
new ("Uri", UriExpression),
new ("JdbcConnectionString", JdbcConnectionString),
];
}
|