Beego/orm/docs/zh/Query.md

## Query

orm 以 **QuerySeter** 来组织查询，每个返回 **QuerySeter** 的方法都会获得一个新的 **QuerySeter** 对象。

基本使用方法:

	o := orm.NewOrm()
	
	// 获取 QuerySeter 对象，user 为表名
	qs := o.QueryTable("user")
	
	// 也可以直接使用对象作为表名
	user := NewUser()
	qs = o.QueryTable(user) // 返回 QuerySeter

### expr

QuerySeter 中用于描述字段和 sql 操作符使用简单的 expr 查询方法

字段组合的前后顺序依照表的关系，比如 User 表拥有 Profile 的外键，那么对 User 表查询对应的 Profile.Age 为条件，则使用 `Profile__Age` 注意，字段的分隔符号使用双下划线 `__`，除了描述字段， expr 的尾部可以增加操作符以执行对应的 sql 操作。比如 `Profile__Age__gt` 代表 Profile.Age > 18 的条件查询。

注释后面将描述对应的 sql 语句，仅仅是描述 expr 的类似结果，并不代表实际生成的语句。

	qs.Filter("id", 1) // WHERE id = 1
	qs.Filter("profile__age", 18) // WHERE profile.age = 18
	qs.Filter("Profile__Age", 18) // 使用字段名和Field名都是允许的
	qs.Filter("profile__age", 18) // WHERE profile.age = 18
	qs.Filter("profile__age__gt", 18) // WHERE profile.age > 18
	qs.Filter("profile__age__gte", 18) // WHERE profile.age >= 18
	qs.Filter("profile__age__in", 18, 20) // WHERE profile.age IN (18, 20)
	
	qs.Filter("profile__age__in", 18, 20).Exclude("profile__money__lt", 1000)
	// WHERE profile.age IN (18, 20) AND NOT profile.money < 1000

### Operators

当前支持的操作符号

#### exact

Filter / Exclude / Condition expr 的默认值

	qs.Filter("user_name", "slene") // WHERE user_name = 'slene'
	qs.Filter("user_name__exact", "slene") // WHERE user_name = 'slene'
	qs.Filter("profile", nil) // WHERE profile_id IS NULL

#### iexact

	qs.Filter("user_name__iexact", "slene")
	// WHERE user_name LIKE 'slene'
	// 大小写不敏感，匹配任意 'Slene' 'sLENE'

#### contains

	qs.Filter("user_name__contains", "slene")
	// WHERE user_name LIKE BINARY '%slene%'
	// 大小写敏感, 匹配包含 slene 的字符

#### icontains

	qs.Filter("user_name__icontains", "slene")
	// WHERE user_name LIKE '%slene%'
	// 大小写不敏感, 匹配任意 'im Slene', 'im sLENE'

#### in

	qs.Filter("profile__age__in", 17, 18, 19, 20)
	// WHERE profile.age IN (17, 18, 19, 20)

#### gt / gte

	qs.Filter("profile__age__gt", 17)
	// WHERE profile.age > 17
	
	qs.Filter("profile__age__gte", 18)
	// WHERE profile.age >= 18

#### lt / lte

	qs.Filter("profile__age__lt", 17)
	// WHERE profile.age < 17
	
	qs.Filter("profile__age__lte", 18)
	// WHERE profile.age <= 18

#### startswith

	qs.Filter("user_name__startswith", "slene")
	// WHERE user_name LIKE BINARY 'slene%'
	// 大小写敏感, 匹配以 'slene' 起始的字符串

#### istartswith

	qs.Filter("user_name__istartswith", "slene")
	// WHERE user_name LIKE 'slene%'
	// 大小写不敏感, 匹配任意以 'slene', 'Slene' 起始的字符串


#### endswith

	qs.Filter("user_name__endswith", "slene")
	// WHERE user_name LIKE BINARY '%slene'
	// 大小写敏感, 匹配以 'slene' 结束的字符串

#### iendswith

	qs.Filter("user_name__startswith", "slene")
	// WHERE user_name LIKE '%slene'
	// 大小写不敏感, 匹配任意以 'slene', 'Slene' 结束的字符串

#### isnull

	qs.Filter("profile__isnull", true)
	qs.Filter("profile_id__isnull", true)
	// WHERE profile_id IS NULL
	
	qs.Filter("profile__isnull", false)
	// WHERE profile_id IS NOT NULL

## QuerySeter

#### Filter

多个 Filter 之间使用 `AND` 连接

	qs.Filter("profile__isnull", true).Filter("user_name", "slene")
	// WHERE profile_id IS NULL AND user_name = 'slene'

#### Exclude

使用 `NOT` 排除条件

多个 Exclude 之间使用 `AND` 连接

	qs.Exclude("profile__isnull", true).Filter("user_name", "slene")
	// WHERE NOT profile_id IS NULL AND user_name = 'slene'

#### Limit

限制最大返回数据行数，第二个参数可以设置 `Offset`

	var DefaultRowsLimit = 1000 // orm 默认的 limit 值为 1000
	
	// 默认情况下 select 查询的最大行数为 1000
	// LIMIT 1000
	
	qs.Limit(10)
	// LIMIT 10
	
	qs.Limit(10, 20)
	// LIMIT 10 OFFSET 20
	
	qs.Limit(-1)
	// no limit
	
	qs.Limit(-1, 100)
	// LIMIT 18446744073709551615 OFFSET 100
	// 18446744073709551615 是 1<<64 - 1 用来指定无 limit 限制 但有 offset 偏移的情况

#### Offset
	
设置 偏移行数

	qs.OFFSET(20)
	// LIMIT 1000 OFFSET 20

#### OrderBy

参数使用 **expr**

在 expr 前使用减号 `-` 表示 `DESC` 的排列

	qs.OrderBy("id", "-profile__age")
	// ORDER BY id ASC, profile.age DESC
	
	qs.OrderBy("-profile__money", "profile")
	// ORDER BY profile.money DESC, profile_id ASC

#### RelatedSel

关系查询，参数使用 **expr**

	var DefaultRelsDepth = 5 // 默认情况下直接调用 RelatedSel 将进行最大 5 层的关系查询

	qs := o.QueryTable("post")
	
	qs.RelateSel()
	// INNER JOIN user ... LEFT OUTER JOIN profile ...
	
	qs.RelateSel("user")
	// INNER JOIN user ... 
	// 设置 expr 只对设置的字段进行关系查询
	
	// 对设置 null 属性的 Field 将使用 LEFT OUTER JOIN