Cassandra 查询语言 (CQL) v3.4.3

<select-clause> 确定需要在结果集中查询和返回哪些列。它由逗号分隔的列表或通配符 (*) 组成，以选择为表定义的所有列。请注意，对于通配符 SELECT 查询，返回的列的顺序未指定，并且不能保证在 Cassandra 版本之间保持稳定。

<selector> 是要检索的列名或一个或多个 <term> 的 <function>。允许的函数与 <term> 相同，并在 函数部分 中进行了描述。除了这些通用函数之外，WRITETIME 和 MAXWRITETIME（分别为 TTL）函数允许选择列插入的时间戳（分别为列的生存时间（以秒为单位）（或如果列没有设置过期时间，则为 null））和 CAST 函数可用于将一种数据类型转换为另一种数据类型。WRITETIME 和 TTL 函数不能用于多单元格列，例如非冻结集合或非冻结用户定义类型。

此外，可以使用 [ <term> ] 选择映射和集合的各个值。对于映射，如果存在这样的条目，这将返回与键对应的值。对于集合，如果存在，这将返回所选的键，因此主要是一种检查元素是否存在的方法。还可以使用 `[ <term> …​ <term> `] 选择集合或映射的切片，其中可以省略两个边界。

可以使用 AS 关键字对任何 <selector> 进行别名处理（请参见示例）。请注意，<where-clause> 和 <order-by> 子句应按其原始名称引用列，而不是按其别名引用列。

COUNT 关键字可以与括在 * 中的括号一起使用。如果是这样，查询将返回单个结果：与查询匹配的行数。请注意，COUNT(1) 受支持作为别名。

<where-clause> 指定必须查询哪些行。它由 PRIMARY KEY 的一部分的列上的关系组成，和/或在它们上定义了 辅助索引。

并非所有关系都允许在查询中。例如，分区键上的非相等关系（其中 IN 被视为相等关系）不受支持（但请参见下面使用 TOKEN 方法对分区键执行非相等查询）。此外，对于给定的分区键，群集列会引起行的排序，并且对它们的限制关系只能选择一组连续的（对于排序）行。例如，给定

bc(sample).
CREATE TABLE posts (
userid text,
blog_title text,
posted_at timestamp,
entry_title text,
content text,
category int,
PRIMARY KEY (userid, blog_title, posted_at)
)

允许以下查询

bc(sample).
SELECT entry_title, content FROM posts WHERE userid=`john doe' AND blog_title=`John'`s Blog' AND posted_at >= `2012-01-01' AND posted_at < `2012-01-31'

但以下查询不允许，因为它没有选择一组连续的行（并且我们假设没有设置辅助索引）

bc(sample).
SELECT entry_title, content FROM posts WHERE userid=`john doe' AND posted_at >= `2012-01-01' AND posted_at < `2012-01-31'

在指定关系时，可以在 PARTITION KEY 列上使用 TOKEN 函数进行查询。在这种情况下，将根据其 PARTITION_KEY 的令牌而不是值来选择行。请注意，键的令牌取决于所使用的分区器，特别是 RandomPartitioner 不会产生有意义的顺序。还要注意，排序分区器始终按字节对令牌值进行排序（因此，即使分区键的类型为 int，token(-1) > token(0)）。示例

bc(sample).
SELECT * FROM posts WHERE token(userid) > token(`tom') AND token(userid) < token(`bob')

此外，IN 关系仅允许在分区键的最后一列和完整主键的最后一列上使用。

还可以使用元组表示法将关系中的`group'' `CLUSTERING COLUMNS`组合在一起。例如

bc(sample).
SELECT * FROM posts WHERE userid=`john doe' AND (blog_title, posted_at) > (`John'`s Blog', `2012-01-01')

将请求在群集顺序中将`John’s Blog'' 作为 `blog_tile`和2012-01-01' 作为 `posted_at`的记录之后排序的所有行。特别是，只要它们的blog_title > 'John''s Blog'，就会返回post_at ⇐ '2012-01-01'的记录，而对于

bc(sample).
SELECT * FROM posts WHERE userid=`john doe' AND blog_title > `John'`s Blog' AND posted_at > `2012-01-01'

元组表示法还可以用于CLUSTERING COLUMNS上的IN子句

bc(sample).
SELECT * FROM posts WHERE userid=`john doe' AND (blog_title, posted_at) IN `John'`s Blog', `2012-01-01), (’Extreme Chess', `2014-06-01'

CONTAINS运算符只能用于集合列（列表、集合和映射）。对于映射，CONTAINS适用于映射值。CONTAINS KEY运算符只能用于映射列，并适用于映射键。

ORDER BY选项允许选择返回结果的顺序。它以列名列表作为参数，以及列的顺序（ASC表示升序，DESC表示降序，省略顺序等同于ASC）。当前可能的顺序是有限的（取决于表CLUSTERING ORDER）

GROUP BY选项允许将所有对于一组列共享相同值的选择行浓缩到一行中。

使用GROUP BY选项，只能在分区键级别或群集列级别对行进行分组。因此，GROUP BY选项只接受主键顺序中的主键列名作为参数。如果主键列受到相等性限制，则不需要它出现在GROUP BY子句中。

聚合函数将为每个组生成一个单独的值。如果没有指定GROUP BY子句，聚合函数将为所有行生成一个值。

如果在包含GROUP BY的语句中选择列而没有聚合函数，则将返回每个组中遇到的第一个值。

SELECT语句的LIMIT选项限制查询返回的行数，而PER PARTITION LIMIT选项限制查询为给定分区返回的行数。请注意，两种类型的限制都可以在同一个语句中使用。

默认情况下，CQL只允许不涉及filtering'' 服务器端的select查询，即我们知道所有（实时）读取的记录将（部分）返回在结果集中。其原因是这些非过滤''查询具有可预测的性能，因为它们将在与查询返回的数据量成正比的时间内执行（可以通过LIMIT控制）。

ALLOW FILTERING 选项允许明确允许（一些）需要过滤的查询。请注意，使用 ALLOW FILTERING 的查询可能因此具有不可预测的性能（对于上述定义），即，即使是选择少量记录的查询也可能表现出取决于集群中存储的数据总量的性能。

例如，考虑以下包含用户个人资料及其出生年份（带有辅助索引）和居住国家的表

bc(sample)..
CREATE TABLE users (
username text PRIMARY KEY,
firstname text,
lastname text,
birth_year int,
country text
)

CREATE INDEX ON users(birth_year);
p.

那么以下查询有效

bc(sample).
SELECT * FROM users;
SELECT firstname, lastname FROM users WHERE birth_year = 1981;

因为在这两种情况下，Cassandra 保证这些查询的性能将与返回的数据量成正比。特别是，如果没有用户出生于 1981 年，则第二个查询的性能将不取决于数据库中存储的用户个人资料的数量（至少不是直接取决于：由于辅助索引实现考虑因素，此查询可能仍然取决于集群中的节点数，而节点数间接取决于存储的数据量。然而，节点数将始终比存储的用户个人资料的数量低多个数量级）。当然，这两个查询实际上都可能返回非常大的结果集，但始终可以通过添加 LIMIT 来控制返回的数据量。

但是，将拒绝以下查询

bc(sample).
SELECT firstname, lastname FROM users WHERE birth_year = 1981 AND country = `FR';

因为 Cassandra 无法保证即使查询结果很小，它也不必扫描大量数据。通常，它将扫描所有出生于 1981 年的用户索引条目，即使实际上只有少数用户来自法国。但是，如果您`知道自己在做什么''，您可以使用 `ALLOW FILTERING 强制执行此查询，因此以下查询有效

bc(sample).
SELECT firstname, lastname FROM users WHERE birth_year = 1981 AND country = `FR' ALLOW FILTERING;

使用 WITH PASSWORD 子句为内部身份验证设置密码，并将密码用单引号括起来。
如果尚未设置内部身份验证或角色没有LOGIN 权限，则 WITH PASSWORD 子句不是必需的。

尝试创建现有角色会导致无效的查询条件，除非使用 IF NOT EXISTS 选项。如果使用该选项且角色存在，则该语句将为 no-op。

bc(sample).
CREATE ROLE other_role;
CREATE ROLE IF NOT EXISTS other_role;

语法

bc(syntax)。
::= LIST ROLES ( OF )? ( NORECURSIVE )?

样本

bc(sample).
LIST ROLES;

返回系统中所有已知角色，这需要对数据库角色资源具有 DESCRIBE 权限。

bc(sample).
LIST ROLES OF alice;

枚举授予 alice 的所有角色，包括通过传递获取的角色。

bc(sample).
LIST ROLES OF bob NORECURSIVE

列出直接授予 bob 的所有角色。

除非使用 如果不存在 选项，否则尝试添加现有标识会导致无效的查询条件。如果使用该选项且标识存在，则该语句为无操作。

bc(sample).
如果不存在，则添加标识 'id1' 到角色 'role1'；

当使用 GRANT ALL 表单时，将根据目标资源自动确定适当的权限集。

当通过 CREATE KEYSPACE、CREATE TABLE、CREATE FUNCTION、CREATE AGGREGATE 或 CREATE ROLE 语句创建资源时，创建者（即标识发出该语句的数据库用户的角色）将自动获得对新资源的所有适用权限。

语法

bc(syntax)..
::= LIST ( ALL ( PERMISSIONS )? | )
( ON )?
( OF ( NORECURSIVE )? )?

::= ALL KEYSPACES
| KEYSPACE
| ( TABLE )?
| ALL ROLES
| ROLE
| ALL FUNCTIONS ( IN KEYSPACE )?
| FUNCTION
| ALL MBEANS
| ( MBEAN | MBEANS )
p.

样本

bc(sample).
LIST ALL PERMISSIONS OF alice;

显示授予 alice 的所有权限，包括从任何其他角色间接获得的权限。

bc(sample).
LIST ALL PERMISSIONS ON keyspace1.table1 OF bob;

显示授予 bob 的 keyspace1.table1 上的所有权限，包括从任何其他角色间接获得的权限。这也包括可以应用于 keyspace1.table1 的资源层次结构中的任何权限。例如，如果 bob 对 keyspace1 拥有 ALTER 权限，则该权限将包含在此查询的结果中。添加 NORECURSIVE 开关会将结果限制为仅直接授予 bob 或 bob 的角色的权限。

bc(sample).
LIST SELECT PERMISSIONS OF carlos;

显示授予 carlos 或 carlos 的任何角色的任何权限，仅限于对任何资源的 SELECT 权限。

集合用于存储/反规范化相对较少的数据量。它们适用于诸如给定用户的电话号码''、应用于电子邮件的标签''等事物。但是，当预计项目会无限增长（给定用户发送的所有消息''、传感器注册的事件''，…）时，集合就不再合适，而应该使用特定表（带群集列）。具体来说，集合具有以下限制

请注意，虽然将来可能会放松其中一些限制，但集合用于反规范化少量数据的总体规则将保持不变。

map 是一个 类型化 的键值对集合，其中键是唯一的。此外，请注意，映射在内部按其键排序，因此总是按该顺序返回。要创建 map 类型的列，请使用 map 关键字，后跟用尖括号括起来的逗号分隔的键和值类型。例如

bc(sample).
CREATE TABLE users (
id text PRIMARY KEY,
given text,
surname text,
favs map<text, text> // 文本键和文本值的映射
)

使用受 JSON 启发的语法编写 map 数据。要使用 INSERT 编写记录，请将整个映射指定为 JSON 样式关联数组。注意：此表单将始终替换整个映射。

bc(sample).
INSERT INTO users (id, given, surname, favs)
VALUES (`jsmith', `John', `Smith', \{ `fruit' : `apple', `band' : `Beatles' })

可以通过在UPDATE语句中对映射列进行标注或添加新的映射文本来添加或更新（可能）存在的映射的键值

bc(sample).
UPDATE users SET favs[`author'] = `Ed Poe' WHERE id = `jsmith'
UPDATE users SET favs = favs + \{ `movie' : `Cassablanca' } WHERE id = `jsmith'

请注意，INSERT和UPDATE都允许使用TTL，但在两种情况下，TTL设置仅适用于新插入/更新的值。换句话说，

bc(sample).
UPDATE users USING TTL 10 SET favs[`color'] = `green' WHERE id = `jsmith'

只会将TTL应用于{ 'color' : 'green' }记录，映射的其余部分不受影响。

使用以下方法删除映射记录

bc(sample).
DELETE favs[`author'] FROM users WHERE id = `jsmith'

set是唯一值的类型化集合。集合按其值排序。要创建类型为set的列，请使用set关键字，后跟用尖括号括起来的类型值。例如

bc(sample).
CREATE TABLE images (
name text PRIMARY KEY,
owner text,
date timestamp,
tags set
);

通过用逗号分隔集合值并在花括号中括起来来编写set。注意：INSERT始终会替换整个集合。

bc(sample).
INSERT INTO images (name, owner, date, tags)
VALUES (`cat.jpg', `jsmith', `now', \{ `kitten', `cat', `pet' });

可以通过向现有set列添加/移除新集合值，使用UPDATE来添加和移除集合的值。

bc(sample).
UPDATE images SET tags = tags + \{ `cute', `cuddly' } WHERE name = `cat.jpg';
UPDATE images SET tags = tags - \{ `lame' } WHERE name = `cat.jpg';

与映射一样，如果使用TTL，则仅适用于新插入/更新的值。

list是无唯一值的类型化集合，其中元素按其在列表中的位置排序。要创建类型为list的列，请使用list关键字，后跟用尖括号括起来的类型值。例如

bc(sample).
CREATE TABLE plays (
id text PRIMARY KEY,
game text,
players int,
scores list
)

请注意，如下所述，列表有一些限制和性能考虑因素需要考虑，并且建议在可能的情况下优先使用集合而不是列表。

使用JSON样式语法编写list数据。要使用INSERT编写记录，请将整个列表指定为JSON数组。注意：INSERT始终会替换整个列表。

bc(sample).
INSERT INTO plays (id, game, players, scores)
VALUES (`123-afde', `quake', 3, [17, 4, 2]);

可以通过向现有list列添加新的JSON样式数组，将值添加到列表（追加或前置）中。

bc(sample).
UPDATE plays SET players = 5, scores = scores + [ 14, 21 ] WHERE id = `123-afde';
UPDATE plays SET players = 5, scores = [ 12 ] + scores WHERE id = `123-afde';

需要注意的是，追加和前置不是幂等操作。这意味着如果在追加或前置期间操作超时，则并不总是可以安全地重试操作（因为这可能导致记录被追加或前置两次）。

列表还提供了以下操作：按列表中的位置设置元素、按列表中的位置删除元素以及删除列表中给定值的所有出现。但是，与所有其他集合操作相反，这三个操作在更新之前会引起内部读取，因此通常具有较慢的性能特征。这些操作具有以下语法

bc(sample).
UPDATE plays SET scores[1] = 7 WHERE id = `123-afde'; // 将 scores 的第 2 个元素设置为 7（如果 scores 少于 2 个元素，则会引发错误）
DELETE scores[1] FROM plays WHERE id = `123-afde'; // 删除 scores 的第 2 个元素（如果 scores 少于 2 个元素，则会引发错误）
UPDATE plays SET scores = scores - [ 12, 21 ] WHERE id = `123-afde'; // 从 scores 中删除所有 12 和 21 的出现

与映射一样，如果使用TTL，则仅适用于新插入/更新的值。