绑定参数
AQL支持使用绑定参数,从而允许将查询文本与查询中使用的文字值分开。将查询文本与文字值分开是一种很好的做法,因为这会阻止(恶意)将关键字和其他集合名称注入到现有查询中。这种注入会很危险,因为它可能会改变现有查询的含义。
使用绑定参数,现有查询的含义无法更改。绑定参数可以在可以使用文字的查询中的任何地方使用。
绑定参数的语法是@name,其中@表示这是一个绑定参数,name是实际的参数名称。参数名称必须以字母a到z(大写或小写)或数字(0到9)中的任何一个字符开头,后面可以跟任何字母,数字或下划线符号。
FOR u IN users
FILTER u.id == @id && u.name == @name
RETURN u
绑定参数值在执行时需要与查询一起传递,但不作为查询文本本身的一部分。在Web界面中,可以输入绑定参数的查询编辑器旁边有一个窗格。当使用db._query()(例如在arangosh中)时,可以为参数传递一个键值对的对象。这样的对象也可以_api/cursor作为键绑定变量的属性值传递给HTTP API端点:
{
"query": "FOR u IN users FILTER u.id == @id && u.name == @name RETURN u",
"bindVars": {
"id": 123,
"name": "John Smith"
}
}
在查询中声明的绑定参数也必须传递参数值,否则查询将失败。指定查询中未声明的参数也会导致错误。
绑定变量表示一个类似于字符串的值,并且不得放入AQL代码中的引号中:
FILTER u.name == "@name" // wrong
FILTER u.name == @name // correct
如果您需要在查询中执行字符串处理(连接等),则需要使用字符串函数来执行此操作:
FOR u IN users
FILTER u.id == CONCAT('prefix', @id, 'suffix') && u.name == @name
RETURN u
绑定参数可以用于点符号以及用于子属性访问的方括号符号。他们也可以被链接:
LET doc = { foo: { bar: "baz" } }
RETURN doc.@attr.@subattr
// or
RETURN doc[@attr][@subattr]
{
"attr": "foo",
"subattr": "bar"
}
上述示例中的两个变体均是将[ "baz" ]作为查询结果返回。
通过传递一个字符串数组作为参数值,也可以使用点表示法和单个绑定参数来指定整个属性路径,特别是高度嵌套的数据。数组的元素表示路径的属性键:
LET doc = { a: { b: { c: 1 } } }
RETURN doc.@attr
{ "attr": [ "a", "b", "c" ] }
示例查询返回[ 1 ]结果。请注意,{ "attr": "a.b.c" } 会返回一个名为abc的属性的值,而不会像父项a和b那样返回属性c的值。[ "a", "b", "c" ]
用于注入集合名称的特殊类型的绑定参数。这种类型的绑定参数的名称前面带有一个附加的@符号(因此,在查询中使用绑定参数时,必须使用两个@符号)。
FOR u IN @@collection
FILTER u.active == true
RETURN u
{ "@collection": "myCollection" }
关键字不能被bind-values取代; 即FOR,FILTER,IN,INBOUND或函数调用。
访问集合中的数据
通过在查询中指定集合名称可以访问集合数据。一个集合可以理解为一系列文档,这就是它们在AQL中的存储方式。通常使用FOR关键字访问来自集合的文档 。请注意,在迭代集合中的文档时,文档的顺序是未定义的。为了以明确和确定的顺序遍历文档,还应该使用SORT关键字。
集合中的数据存储在文档中,每个文档可能具有与其他文档不同的属性。即使是同一collection文件也是如此。
因此遇到没有在AQL查询中查询的某些或全部属性的文档是非常正常的。在这种情况下,文档中的不存在的属性将被视为存在的值为null。这意味着,如果文档具有特定属性并且属性的值为null,或者文档根本没有特定属性,则将文档属性与null进行比较 将返回true 。
例如,以下查询将返回集合 用户中属性名称中值为null的所有文档,以及根本没有name属性的用户的所有文档:
FOR u IN users
FILTER u.name == null
RETURN u
此外,null小于任何其他值(不包括null本身)。这意味着在比较属性值与少于或少于等于运算符时,具有不存在属性的文档可能会包含在结果中。
例如,以下查询将返回集合 用户中属性年龄值小于39的所有文档,并且还返回集合中根本没有属性年龄的所有文档。
FOR u IN users
FILTER u.age < 39
RETURN u
编写查询时应始终考虑这种行为。需要加上条件
FOR u IN users
FILTER u.age < 39 and u.age!=null
RETURN u
或者
FOR u IN users
FILTER u.age
FILTER u.age < 39
RETURN u
查询结果
结果集
AQL查询的结果是一组值。根据实际查询的内容,结果数组中的各个值可能有也可能不具有均匀结构。
例如,当从具有非均质文档的集合返回数据(集合中的单个文档具有不同的属性名称)而不进行修改时,结果值也将具有非均匀结构。每个结果值本身都是一个文档:
FOR u IN users
RETURN u
[ { "id": 1, "name": "John", "active": false },
{ "age": 32, "id": 2, "name": "Vanessa" },
{ "friends": [ "John", "Vanessa" ], "id": 3, "name": "Amy" } ]
但是,如果查询集合中是一组固定属性,则查询结果值将具有同构结构。每个结果值仍然是一个文档:
FOR u IN users
RETURN { "id": u.id, "name": u.name }
[ { "id": 1, "name": "John" },
{ "id": 2, "name": "Vanessa" },
{ "id": 3, "name": "Amy" } ]
也可以只查询标量值。在这种情况下,结果集是一个标量数组,每个结果值都是一个标量值:
FOR u IN users
RETURN u.id
[ 1, 2, 3 ]
如果查询没有产生任何结果,因为找不到匹配的数据,它将产生一个空的结果数组:
[ ]
查询错误
如果查询语法无效,向服务器发出无效查询将导致解析错误。ArangoDB将在查询检查期间检测到这些错误并中止进一步的处理。并返回错误号和错误消息,以便纠正错误。
如果查询通过解析阶段,则将打开查询中引用的所有集合。如果任何引用的集合不存在,则查询执行将再次中止,并返回相应的错误消息。
在某些情况下,执行查询也可能产生运行时错误,这些错误无法通过单独检查查询文本来预测。这是因为查询可能会使用不均匀的集合中的数据。一些会导致运行时错误的例子是:
除以零:当尝试在算术除法或模数运算中使用值0作为除数时将触发
算术运算的无效操作数:当尝试在算术运算中使用任何非数字值作为操作数时将触发。这包括一元(一元减,一元加)和二元运算(加,减,乘,除和模)
逻辑操作的无效操作数:尝试在逻辑操作中使用任何非布尔值作为操作数时触发。这包括一元(逻辑非/否定),二元(逻辑和,逻辑或)和三元运算符