Dapper SimpleCRUD Data Annotation

Data annotation adds some extra meaning to the classes and properties by adding attribute tags. It is used to configure the classes, which will highlight the most commonly needed configurations.

The Dapper.SimpleCRUD library provides some optional attributes which are very helpful.

Key

The Key attribute specifies the property that is a primary key column in the database.

class Author
{
    [Key]
    public int AuthorId { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public List<Book> Books { get; set; }
}

Table

By default, the database table name will match the class name. You can use another table name by specifying the Table attribute.

[Table("tbl_Authors")]
class Author
{
    public int Id { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public List<Book> Books { get; set; }
}

Column

By default, the column name will match the property name. You can use another property name by specifying the Column attribute.

class Author
{
    public int Id { get; set; }

    [Column("FirstName")]
    public string FName { get; set; }

    [Column("FirstName")]
    public string LName { get; set; }
    public List<Book> Books { get; set; }
}

Editable

The Editable attribute specifies that the property is editable or not to the database.

class Author
{
    public int Id { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }

    [Editable(false)]
    public string FullName 
    { 
        get
        {
            return FirstName + " " + LastName;
        } 
    }

    [Editable(false)]
    public List<Book> Books { get; set; }
}

Required

The Required attribute specifies that a data field value is required.

class Author
{
    [Key]
    [Required]
    public int AuthorId { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public List<Book> Books { get; set; }
}

ReadOnly

Properties decorated with ReadOnly(true) are only used for selects and are excluded from inserts and updates.

class Author
{
    public int Id { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }

    [ReadOnly(true)]
    public string FullName 
    { 
        get
        {
            return FirstName + " " + LastName;
        } 
    }

    [Write(false)]
    public List<Book> Books { get; set; }
}