Skip to content

Class ColumnAttribute

Namespace: Momentum.Extensions.Abstractions.Dapper.MetadataAttributes
Assembly: Momentum.Extensions.Abstractions.dll

Specifies the database column name for a parameter in a database command.

csharp
[AttributeUsage(AttributeTargets.Parameter)]
public sealed class ColumnAttribute : Attribute

Inheritance

objectAttributeColumnAttribute

Inherited Members

Attribute.GetCustomAttributes(MemberInfo, Type), Attribute.GetCustomAttributes(MemberInfo, Type, bool), Attribute.GetCustomAttributes(MemberInfo), Attribute.GetCustomAttributes(MemberInfo, bool), Attribute.IsDefined(MemberInfo, Type), Attribute.IsDefined(MemberInfo, Type, bool), Attribute.GetCustomAttribute(MemberInfo, Type), Attribute.GetCustomAttribute(MemberInfo, Type, bool), Attribute.GetCustomAttributes(ParameterInfo), Attribute.GetCustomAttributes(ParameterInfo, Type), Attribute.GetCustomAttributes(ParameterInfo, Type, bool), Attribute.GetCustomAttributes(ParameterInfo, bool), Attribute.IsDefined(ParameterInfo, Type), Attribute.IsDefined(ParameterInfo, Type, bool), Attribute.GetCustomAttribute(ParameterInfo, Type), Attribute.GetCustomAttribute(ParameterInfo, Type, bool), Attribute.GetCustomAttributes(Module, Type), Attribute.GetCustomAttributes(Module), Attribute.GetCustomAttributes(Module, bool), Attribute.GetCustomAttributes(Module, Type, bool), Attribute.IsDefined(Module, Type), Attribute.IsDefined(Module, Type, bool), Attribute.GetCustomAttribute(Module, Type), Attribute.GetCustomAttribute(Module, Type, bool), Attribute.GetCustomAttributes(Assembly, Type), Attribute.GetCustomAttributes(Assembly, Type, bool), Attribute.GetCustomAttributes(Assembly), Attribute.GetCustomAttributes(Assembly, bool), Attribute.IsDefined(Assembly, Type), Attribute.IsDefined(Assembly, Type, bool), Attribute.GetCustomAttribute(Assembly, Type), Attribute.GetCustomAttribute(Assembly, Type, bool), Attribute.Equals(object?), Attribute.GetHashCode(), Attribute.Match(object?), Attribute.IsDefaultAttribute(), Attribute.TypeId, object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Examples

public Task<User> GetUserAsync([Column("user_id")] int id, [Column("is_active")] bool active);

Remarks

Use this attribute on method parameters to map them to specific database column names when the parameter name doesn't match the column name. This is particularly useful when working with database commands generated by source generators.

Constructors

ColumnAttribute(string)

Specifies the database column name for a parameter in a database command.

csharp
public ColumnAttribute(string name)

Parameters

name string

Examples

public Task<User> GetUserAsync([Column("user_id")] int id, [Column("is_active")] bool active);

Remarks

Use this attribute on method parameters to map them to specific database column names when the parameter name doesn't match the column name. This is particularly useful when working with database commands generated by source generators.

Properties

Name

Gets the database column name.

csharp
public string Name { get; }

Property Value

string