文档文档

InfluxQL 参考文档

InfluxQL (Influx 查询语言) 是一种类似 SQL 的查询语言,用于与 InfluxDB 交互并处理时间序列数据。

InfluxQL 功能支持

InfluxQL 正在被重新架构以与 InfluxDB 3 存储引擎一起工作。此过程正在进行中,并且某些 InfluxQL 功能仍在实施中。有关 InfluxQL 功能当前实施状态的信息,请参阅InfluxQL 功能支持

符号

该语法使用扩展巴科斯-瑙尔范式(“EBNF”)指定。 EBNF 与 Go 编程语言规范中使用的符号相同。

Production  = production_name "=" [ Expression ] "." .
Expression  = Alternative { "|" Alternative } .
Alternative = Term { Term } .
Term        = production_name | token [ "…" token ] | Group | Option | Repetition .
Group       = "(" Expression ")" .
Option      = "[" Expression "]" .
Repetition  = "{" Expression "}" .

符号运算符按优先级递增顺序排列

|   alternation
()  grouping
[]  option (0 or 1 times)
{}  repetition (0 to n times)

查询表示

字符

InfluxQL 是以 UTF-8 编码的 Unicode 文本。

newline             = /* the Unicode code point U+000A */ .
unicode_char        = /* an arbitrary Unicode code point except newline */ .

字母和数字

字母是 ASCII 字母集和下划线(_,U+005F)。

仅支持十进制数字。

letter              = ascii_letter | "_" .
ascii_letter        = "A" … "Z" | "a" … "z" .
digit               = "0" … "9" .

标识符

标识符是引用数据库名称、保留策略名称、measurement 名称、标签键字段键的标记。

规则如下

  • 双引号标识符可以包含除换行符之外的任何 Unicode 字符。
  • 双引号标识符还可以包含转义的 " 字符(即,\"
  • 双引号标识符可以包含 InfluxQL 关键字
  • 未加引号的标识符必须以大写或小写 ASCII 字符或“_”开头。
  • 未加引号的标识符可能仅包含 ASCII 字母、十进制数字和“_”。
identifier          = unquoted_identifier | quoted_identifier .
unquoted_identifier = ( letter ) { letter | digit } .
quoted_identifier   = `"` unicode_char { unicode_char } `"` .

示例

cpu
_cpu_stats
"1h"
"anything really"
"1_Crazy-1337.identifier>NAME👍"

关键字

ALL           ALTER         ANY           AS            ASC           BEGIN
BY            CREATE        CONTINUOUS    DATABASE      DATABASES     DEFAULT
DELETE        DESC          DESTINATIONS  DIAGNOSTICS   DISTINCT      DROP
DURATION      END           EVERY         EXPLAIN       FIELD         FOR
FROM          GRANT         GRANTS        GROUP         GROUPS        IN
INF           INSERT        INTO          KEY           KEYS          KILL
LIMIT         SHOW          MEASUREMENT   MEASUREMENTS  NAME          OFFSET
ON            ORDER         PASSWORD      POLICY        POLICIES      PRIVILEGES
QUERIES       QUERY         READ          REPLICATION   RESAMPLE      RETENTION
REVOKE        SELECT        SERIES        SET           SHARD         SHARDS
SLIMIT        SOFFSET       STATS         SUBSCRIPTION  SUBSCRIPTIONS TAG
TO            USER          USERS         VALUES        WHERE         WITH
WRITE

如果您使用 InfluxQL 关键字作为标识符,请在每个查询中用双引号引起来。

time 关键字是一种特殊情况。 time 可以是数据库名称、measurement 名称、保留策略名称和用户名称。

在这些情况下,您无需在查询中用双引号引起来 time

time 不能是字段键标签键; InfluxDB 拒绝将 time 作为字段键或标签键的写入,并返回错误。

字面量

整数

InfluxQL 支持十进制整数文字。当前不支持十六进制和八进制文字。

int_lit             = ( "1" … "9" ) { digit } .

浮点数

InfluxQL 支持浮点文字。当前不支持指数。

float_lit           = int_lit "." int_lit .

字符串

字符串文字必须用单引号括起来。 字符串可以包含 ' 字符,只要它们被转义(即,\'

string_lit          = `'` { unicode_char } `'` .

持续时间

持续时间文字指定一段时间长度。紧跟(没有空格)整数文字的持续时间单位列表之一被解释为持续时间文字。持续时间可以用混合单位指定。

持续时间单位
单位含义
ns纳秒(十亿分之一秒)
u 或 µ微秒(百万分之一秒)
ms毫秒(千分之一秒)
s
m分钟
h小时
d
w
duration_lit        = int_lit duration_unit .
duration_unit       = "ns" | "u" | "µ" | "ms" | "s" | "m" | "h" | "d" | "w" .

日期和时间

与 InfluxQL 中使用的其他符号不同,日期和时间文字格式不是由 EBNF 指定的。 InfluxQL 日期和时间使用 Go 的时间解析格式和 参考日期指定,参考日期以 InfluxQL 要求的格式编写。参考日期时间是

InfluxQL 参考日期时间:2006 年 1 月 2 日下午 3:04:05

time_lit            = "2006-01-02 15:04:05.999999" | "2006-01-02" .

布尔值

bool_lit            = TRUE | FALSE .

正则表达式

regex_lit           = "/" { unicode_char } "/" .

比较器: =~ 匹配 !~ 不匹配

InfluxQL 支持在使用正则表达式时指定

目前,InfluxQL 不支持在 WHERE 子句、数据库保留策略中使用正则表达式来匹配非字符串字段值。

查询

一个查询由一个或多个语句组成,语句之间用分号 (;) 分隔。

query               = statement { ";" statement } .

statement           = explain_stmt |
                      explain_analyze_stmt |
                      select_stmt |
                      show_field_keys_stmt |
                      show_measurements_stmt |
                      show_retention_policies_stmt |
                      show_tag_keys_stmt |
                      show_tag_values_with_key = stmt .

语句

EXPLAIN

解析和计划查询,然后打印估计成本的摘要。

许多 SQL 引擎使用 EXPLAIN 语句来显示连接顺序、连接算法以及谓词和表达式下推。由于 InfluxQL 不支持连接,因此 InfluxQL 查询的成本通常是访问的总序列数、TSM 文件的迭代器访问次数以及需要扫描的 TSM 块数的函数。

EXPLAIN 生成的查询计划包含以下元素

  • 表达式
  • 辅助字段
  • 分片数量
  • 序列数量
  • 缓存值
  • 文件数量
  • 块数量
  • 块大小
explain_stmt = "EXPLAIN" select_stmt .

示例

> explain select sum(pointReq) from "_internal"."monitor"."write" group by hostname;
> QUERY PLAN
------
EXPRESSION: sum(pointReq::integer)
NUMBER OF SHARDS: 2
NUMBER OF SERIES: 2
CACHED VALUES: 110
NUMBER OF FILES: 1
NUMBER OF BLOCKS: 1
SIZE OF BLOCKS: 931

EXPLAIN ANALYZE

执行指定的 SELECT 语句,并返回有关运行时查询性能和存储的数据,以树状结构可视化。 使用此语句分析查询性能和存储,包括执行时间计划时间,以及迭代器类型游标类型

例如,如果您执行以下语句

> explain analyze select mean(usage_steal) from cpu where time >= '2018-02-22T00:00:00Z' and time < '2018-02-22T12:00:00Z'

输出类似于以下内容

EXPLAIN ANALYZE
---------------
.
└── select
    ├── execution_time: 2.25823ms
    ├── planning_time: 18.381616ms
    ├── total_time: 20.639846ms
    └── field_iterators
        ├── labels
           └── statement: SELECT mean(usage_steal::float) FROM telegraf."default".cpu
        └── expression
            ├── labels
               └── expr: mean(usage_steal::float)
            └── create_iterator
                ├── labels
                   ├── measurement: cpu
                   └── shard_id: 608
                ├── cursors_ref: 779
                ├── cursors_aux: 0
                ├── cursors_cond: 0
                ├── float_blocks_decoded: 431
                ├── float_blocks_size_bytes: 1003552
                ├── integer_blocks_decoded: 0
                ├── integer_blocks_size_bytes: 0
                ├── unsigned_blocks_decoded: 0
                ├── unsigned_blocks_size_bytes: 0
                ├── string_blocks_decoded: 0
                ├── string_blocks_size_bytes: 0
                ├── boolean_blocks_decoded: 0
                ├── boolean_blocks_size_bytes: 0
                └── planning_time: 14.805277ms```

EXPLAIN ANALYZE 忽略查询输出,因此不考虑序列化为 JSON 或 CSV 的成本。

execution_time

显示查询执行所花费的时间,包括读取时间序列数据、在数据流经迭代器时执行操作以及从迭代器中耗尽处理后的数据。 执行时间不包括将输出序列化为 JSON 或其他格式所花费的时间。

planning_time

显示查询计划所花费的时间。 在 InfluxDB 中计划查询需要多个步骤。 根据查询的复杂性,计划可能比执行查询需要更多的工作并消耗更多的 CPU 和内存资源。 例如,执行查询所需的序列键的数量会影响查询的计划速度以及计划所需的内存量。

首先,InfluxDB 确定查询的有效时间范围并选择要访问的分片。 接下来,对于每个分片和每个 measurement,InfluxDB 执行以下步骤

  1. 从索引中选择匹配的序列键,并按 WHERE 子句中的标签谓词进行过滤。
  2. 根据 GROUP BY 维度将过滤后的序列键分组到标签集。
  3. 枚举每个标签集,并为每个序列键创建游标和迭代器。
  4. 合并迭代器并将合并后的结果返回给查询执行器。
迭代器类型

EXPLAIN ANALYZE 支持以下迭代器类型

  • create_iterator 节点表示本地 influxd 实例完成的工作——嵌套迭代器的复杂组合,这些迭代器被组合和合并以产生最终的查询输出。
  • (仅限 InfluxDB Enterprise)remote_iterator 节点表示在远程计算机上完成的工作。

有关迭代器的更多信息,请参阅了解迭代器

游标类型

EXPLAIN ANALYZE 区分 3 种游标类型。 虽然游标类型具有相同的数据结构和相等的 CPU 和 I/O 成本,但每种游标类型的构建原因都不同,并且在最终输出中是分开的。 在调整语句时,请考虑以下游标类型

  • cursor_ref:为包含函数的 SELECT 投影创建的引用游标,例如 last()mean()
  • cursor_aux:为简单表达式投影(不是选择器或聚合)创建的辅助游标。 例如,SELECT foo FROM mSELECT foo+bar FROM m,其中 foobar 是字段。
  • cursor_cond:为 WHERE 子句中引用的字段创建的条件游标。

有关游标的更多信息,请参阅了解游标

块类型

EXPLAIN ANALYZE 分隔存储块类型,并报告解码的块总数及其在磁盘上的大小(以字节为单位)。 支持以下块类型

类型描述
float64 位 IEEE-754 浮点数
integer64 位有符号整数
unsigned64 位无符号整数
boolean1 位,LSB 编码
stringUTF-8 字符串

SELECT

select_stmt = "SELECT" fields from_clause [ where_clause ]
              [ group_by_clause ] [ order_by_clause ] [ limit_clause ]
              [ offset_clause ] [ slimit_clause ] [ soffset_clause ] [ timezone_clause ] .

示例

从按天分组并带有时间测量的 measurement 中选择

SELECT mean("value") FROM "cpu" GROUP BY region, time(1d) fill(0) tz('America/Chicago')

SHOW FIELD KEYS

show_field_keys_stmt = "SHOW FIELD KEYS" [on_clause] [ from_clause ] .

示例

-- show field keys and field value data types from all measurements
SHOW FIELD KEYS

-- show field keys and field value data types from specified measurement
SHOW FIELD KEYS FROM "cpu"

SHOW MEASUREMENTS

show_measurements_stmt = "SHOW MEASUREMENTS" [on_clause] [ with_measurement_clause ] [ where_clause ] [ limit_clause ] [ offset_clause ] .

示例

-- show all measurements
SHOW MEASUREMENTS

-- show measurements where region tag = 'uswest' AND host tag = 'serverA'
SHOW MEASUREMENTS WHERE "region" = 'uswest' AND "host" = 'serverA'

-- show measurements that start with 'h2o'
SHOW MEASUREMENTS WITH MEASUREMENT =~ /h2o.*/

SHOW TAG KEYS

show_tag_keys_stmt = "SHOW TAG KEYS" [on_clause] [ from_clause ] [ where_clause ]
                     [ limit_clause ] [ offset_clause ] .

示例

-- show all tag keys
SHOW TAG KEYS

-- show all tag keys from the cpu measurement
SHOW TAG KEYS FROM "cpu"

-- show all tag keys from the cpu measurement where the region key = 'uswest'
SHOW TAG KEYS FROM "cpu" WHERE "region" = 'uswest'

-- show all tag keys where the host key = 'serverA'
SHOW TAG KEYS WHERE "host" = 'serverA'

SHOW TAG VALUES

show_tag_values_stmt = "SHOW TAG VALUES" [on_clause] [ from_clause ] with_tag_clause [ where_clause ]
                       [ limit_clause ] [ offset_clause ] .

示例

-- show all tag values across all measurements for the region tag
SHOW TAG VALUES WITH KEY = "region"

-- show tag values from the cpu measurement for the region tag
SHOW TAG VALUES FROM "cpu" WITH KEY = "region"

-- show tag values across all measurements for all tag keys that do not include the letter c
SHOW TAG VALUES WITH KEY !~ /.*c.*/

-- show tag values from the cpu measurement for region & host tag keys where service = 'redis'
SHOW TAG VALUES FROM "cpu" WITH KEY IN ("region", "host") WHERE "service" = 'redis'

子句

from_clause     = "FROM" measurements .

group_by_clause = "GROUP BY" dimensions fill(fill_option).

limit_clause    = "LIMIT" int_lit .

offset_clause   = "OFFSET" int_lit .

slimit_clause   = "SLIMIT" int_lit .

soffset_clause  = "SOFFSET" int_lit .

timezone_clause = tz(string_lit) .

on_clause       = "ON" db_name .

order_by_clause = "ORDER BY" sort_fields .

where_clause    = "WHERE" expr .

with_measurement_clause = "WITH MEASUREMENT" ( "=" measurement | "=~" regex_lit ) .

with_tag_clause = "WITH KEY" ( "=" tag_key | "!=" tag_key | "=~" regex_lit | "IN (" tag_keys ")"  ) .

表达式

binary_op        = "+" | "-" | "*" | "/" | "%" | "&" | "|" | "^" | "AND" |
                   "OR" | "=" | "!=" | "<>" | "<" | "<=" | ">" | ">=" .

expr             = unary_expr { binary_op unary_expr } .

unary_expr       = "(" expr ")" | var_ref | time_lit | string_lit | int_lit |
                   float_lit | bool_lit | duration_lit | regex_lit .

默认时间范围

默认时间范围是从 Unix 纪元 (1970-01-01T00:00:00Z) 到现在

注释

将注释与 InfluxQL 语句一起使用以描述您的查询。

  • 单行注释以两个连字符 (--) 开头,并在 InfluxDB 检测到换行符时结束。 这种注释类型不能跨越多行。
  • 多行注释以 /* 开头,以 */ 结尾。 这种注释类型可以跨越多行。 多行注释不支持嵌套多行注释。

其他

alias            = "AS" identifier .

back_ref         = ( policy_name ".:MEASUREMENT" ) |
                   ( db_name "." [ policy_name ] ".:MEASUREMENT" ) .

db_name          = identifier .

dimension        = expr .

dimensions       = dimension { "," dimension } .

field_key        = identifier .

field            = expr [ alias ] .

fields           = field { "," field } .

fill_option      = "null" | "none" | "previous" | int_lit | float_lit | "linear" .

host             = string_lit .

measurement      = measurement_name |
                   ( policy_name "." measurement_name ) |
                   ( db_name "." [ policy_name ] "." measurement_name ) .

measurements     = measurement { "," measurement } .

measurement_name = identifier | regex_lit .

policy_name      = identifier .

retention_policy = identifier .

retention_policy_name = "NAME" identifier .

series_id        = int_lit .

sort_field       = field_key [ ASC | DESC ] .

sort_fields      = sort_field { "," sort_field } .

tag_key          = identifier .

tag_keys         = tag_key { "," tag_key } .

var_ref          = measurement .

此页对您有帮助吗?

感谢您的反馈!


Flux 的未来

Flux 即将进入维护模式。 您可以继续像现在这样使用它,而无需对您的代码进行任何更改。

阅读更多

现已全面上市

InfluxDB 3 Core 和 Enterprise

快速启动。 更快扩展。

获取更新

InfluxDB 3 Core 是一个开源、高速、最近数据引擎,可实时收集和处理数据,并将其持久化到本地磁盘或对象存储。 InfluxDB 3 Enterprise 构建在 Core 的基础上,增加了高可用性、读取副本、增强的安全性以及数据压缩,从而实现更快的查询和优化的存储。 InfluxDB 3 Enterprise 的免费层可供非商业家庭或业余爱好者使用。

有关更多信息,请查看