Column definition

Struct tag defines something for column as basic SQL concepts, such as :

type User struct {
    Id   int64
    Name string  `xorm:"varchar(25) not null unique 'usr_name' comment('NickName')"`
}

Data types are different in different DBMS. So xorm makes own data types definition to keep compatible. Details is in document Column Types.

The following table is field mapping rules, the keyword is not case sensitive except column name：

name or ‘name’	Column Name, optional
pk	If column is Primary Key
support over 30 kinds of column types, details in Column Types	column type
autoincr	If autoincrement column
[not ]null \| notnull	if column could be blank
unique/unique(uniquename)	column is Unique index; if add (uniquename), the column is used for combined unique index with the field that defining same uniquename.
index/index(indexname)	column is index. if add (indexname), the column is used for combined index with the field that defining same indexname.
extends	use for anonymous field, map the struct in anonymous field to database
-	This field will not be mapping
->	only write into database
<-	only read from database
created	This field will be filled in current time on insert
updated	This field will be filled in current time on insert or update
version	This field will be filled 1 on insert and autoincrement on update
default 0 \| default ‘name’	column default value
comment	set field comment (currently only supports mysql)

Some default mapping rules：

1. If field is name of Id and type of int64, xorm makes it as auto increment primary key. If another field, use struct tag xorm:"pk".
1. String is corresponding to varchar(255).
1. Support custom type as type MyString string，slice, map as field type. They are saving as Text column type and json-encode string. Support Blob column type with field type []byte or []uint8.
1. You can implement Conversion interface to define your custom mapping rule between field and database data.

type Conversion interface {
    FromDB([]byte) error
    ToDB() ([]byte, error)
}

1. If one struct has a Conversion field, so we need set an implementation to the field before get data from database. We can implement BeforeSet(name string, cell xorm.Cell) on struct to do this.