| File: SqlServerDatabaseResource.cs | Web Access |
| Project: src\src\Aspire.Hosting.SqlServer\Aspire.Hosting.SqlServer.csproj (Aspire.Hosting.SqlServer) |
// Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Runtime.CompilerServices; using Microsoft.Data.SqlClient; namespace Aspire.Hosting.ApplicationModel; /// <summary> /// A resource that represents a SQL Server database that is a child of a SQL Server container resource. /// </summary> /// <param name="name">The name of the resource.</param> /// <param name="databaseName">The database name.</param> /// <param name="parent">The parent SQL Server server resource.</param> [DebuggerDisplay("Type = {GetType().Name,nq}, Name = {Name}, Database = {DatabaseName}")] [AspireExport(ExposeProperties = true)] public class SqlServerDatabaseResource(string name, string databaseName, SqlServerServerResource parent) : Resource(name), IResourceWithParent<SqlServerServerResource>, IResourceWithConnectionString { /// <summary> /// Gets the parent SQL Server container resource. /// </summary> public SqlServerServerResource Parent { get; } = parent ?? throw new ArgumentNullException(nameof(parent)); /// <summary> /// Gets the connection string expression for the SQL Server database. /// </summary> public ReferenceExpression ConnectionStringExpression { get { var connectionStringBuilder = new SqlConnectionStringBuilder { ["Database"] = DatabaseName }; return ReferenceExpression.Create($"{Parent};{connectionStringBuilder.ToString()}"); } } /// <summary> /// Gets the connection URI expression for the SQL Server database. /// </summary> /// <remarks> /// Format: <c>mssql://{Username}:{Password}@{Host}:{Port}</c>. /// </remarks> public ReferenceExpression UriExpression => ReferenceExpression.Create($"{Parent.UriExpression}/{DatabaseName:uri}"); /// <summary> /// Gets the JDBC connection string for the SQL Server database. /// </summary> /// <remarks> /// <para>Format: <c>jdbc:sqlserver://{host}:{port};trustServerCertificate=true;databaseName={database}</c>.</para> /// <para>User and password credentials are not included in the JDBC connection string. Use the <c>Username</c> and <c>Password</c> connection properties to access credentials.</para> /// </remarks> public ReferenceExpression JdbcConnectionString => Parent.BuildJdbcConnectionString(DatabaseName); /// <summary> /// Gets the database name. /// </summary> public string DatabaseName { get; } = ThrowIfNullOrEmpty(databaseName); private static string ThrowIfNullOrEmpty([NotNull] string? argument, [CallerArgumentExpression(nameof(argument))] string? paramName = null) { ArgumentException.ThrowIfNullOrEmpty(argument, paramName); return argument; } IEnumerable<KeyValuePair<string, ReferenceExpression>> IResourceWithConnectionString.GetConnectionProperties() => Parent.CombineProperties([ new("DatabaseName", ReferenceExpression.Create($"{DatabaseName}")), new("Uri", UriExpression), new("JdbcConnectionString", JdbcConnectionString), ]); }