/// <summary>
/// Retrieves comments for a database synonym.
/// </summary>
/// <param name="synonymName">A synonym name.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>A comments object result in the some state, if found, none otherwise.</returns>
/// <exception cref="ArgumentNullException"><paramref name="synonymName"/> is <c>null</c>.</exception>
public OptionAsync <IDatabaseSynonymComments> GetSynonymComments(Identifier synonymName, CancellationToken cancellationToken = default)
{
if (synonymName == null)
{
throw new ArgumentNullException(nameof(synonymName));
}
return(SynonymCommentProvider.GetSynonymComments(synonymName, cancellationToken));
}
/// <summary>
/// Retrieves comments for all database synonyms.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>A collection of database synonyms comments.</returns>
public IAsyncEnumerable <IDatabaseSynonymComments> GetAllSynonymComments(CancellationToken cancellationToken = default)
{
return(SynonymCommentProvider.GetAllSynonymComments(cancellationToken));
}
