文档文档

使用 InfluxQL 的参数化查询

InfluxDB Clustered 中的参数化查询允许您动态且安全地更改查询中的值。如果您的应用程序代码允许用户输入自定义查询中的值或表达式,请使用参数化查询,以确保不受信任的输入严格作为数据处理,而不是作为代码执行。

参数化查询

  • 帮助防止注入攻击,如果输入作为代码执行,则可能发生注入攻击
  • 帮助使查询更具可重用性

防止注入攻击

有关安全性和查询参数化的更多信息,请参阅 OWASP SQL 注入预防备忘单

在 InfluxDB 3 中,参数化查询是 InfluxQL 或 SQL 查询,其中包含一个或多个命名参数占位符——表示输入数据的变量。

参数仅在 WHERE 表达式中受支持

InfluxDB 3 在 WHERE 子句 **谓词表达式** 中支持参数。参数值必须是允许的参数数据类型之一。

如果您在其他表达式或子句中使用参数,例如函数参数、SELECTGROUP BY,则您的查询可能无法按预期工作。

WHERE 表达式中使用参数

您可以在 WHERE 子句 **谓词表达式** 中使用参数——例如,以下查询包含 $temp 参数

SELECT * FROM measurement WHERE temp > $temp

执行查询时,您需要指定参数名称-值对。您分配给参数的值必须是参数数据类型之一。

{"temp": 22.0}

InfluxDB Querier 解析带有参数占位符的查询文本,然后生成查询计划,将占位符替换为您提供的值。这种查询结构与输入数据的分离确保输入被视为允许的数据类型之一,而不是可执行代码。

参数数据类型

参数值可以是以下数据类型之一

  • Null
  • Boolean
  • 无符号整数 (u_int64)
  • 整数 (int64)
  • 双精度浮点数 (float64)
  • 字符串

数据类型示例

{
  "string": "Living Room",
  "double": 3.14,
  "unsigned_integer": 1234,
  "integer": -1234,
  "boolean": false,
  "null": Null,
}

时间表达式

要参数化时间范围,请将参数替换为时间戳字面量——例如

SELECT *
FROM home
WHERE time >= $min_time

对于参数值,请将时间戳字面量指定为字符串——例如

// Assign a timestamp string literal to the min_time parameter.
parameters := influxdb3.QueryParameters{
    "min_time": "2022-01-01 00:00:00.00",
}

InfluxDB 将执行以下查询

SELECT *
FROM home
WHERE time >= '2022-01-01 00:00:00.00'

与参数不兼容

如果您将参数用于以下用途,则您的查询可能无法按预期工作

  • WHERE 以外的子句中,例如 SELECTGROUP BY
  • 作为函数参数,例如 avg($temp)
  • 代替标识符,例如列名或表名
  • 代替持续时间字面量,例如 time > now() - $min_duration

参数化 SQL 查询

示例数据

以下示例使用入门家庭传感器数据。要运行示例查询并返回结果,请在运行示例查询之前,将示例数据写入您的 InfluxDB Clustered 数据库

要使用参数化查询,请执行以下操作

  1. 在您的查询文本中,使用 $parameter 语法引用参数名称——例如,以下查询包含 $room$min_temp 参数占位符

    SELECT *
    FROM home
    WHERE time > now() - 7d
    AND temp >= $min_temp
    AND room = $room
    
  2. 为每个参数名称提供一个值。如果您没有为参数分配值,InfluxDB 将返回错误。用于提供参数值的语法取决于您使用的客户端——例如

    // Define a QueryParameters struct--a map of parameters to input values.
    parameters := influxdb3.QueryParameters{
        "room": "Kitchen",
        "min_temp": 20.0,
    }
    

在 InfluxDB 收到您的请求并解析查询后,它将执行查询,如下所示

SELECT *
FROM home
WHERE time > now() - 7d
AND temp >= 20.0
AND room = 'Kitchen'

执行参数化 InfluxQL 查询

示例数据

以下示例使用入门家庭传感器数据。要运行示例查询并返回结果,请在运行示例查询之前,将示例数据写入您的 InfluxDB Clustered 数据库

使用 InfluxDB Flight RPC 客户端

使用 InfluxDB 3 原生 Flight RPC 协议和受支持的客户端,您可以发送参数化查询和参数名称-值对列表。支持参数化查询的 InfluxDB Flight 客户端在 Flight ticket params 字段中传递参数名称-值对。

以下示例展示了如何使用客户端库执行参数化 InfluxQL 查询

import (
    "context"
    "fmt"
    "io"
    "os"
    "text/tabwriter"
    "time"
    "github.com/InfluxCommunity/influxdb3-go/v2/influxdb3"
)

func Query(query string, parameters influxdb3.QueryParameters,
 options influxdb3.QueryOptions) error {
    url := os.Getenv("INFLUX_HOST")
    token := os.Getenv("INFLUX_TOKEN")
    database := os.Getenv("INFLUX_DATABASE")

    // Instantiate the influxdb3 client.
    client, err := influxdb3.New(influxdb3.ClientConfig{
        Host:     url,
        Token:    token,
        Database: database,
    })

    if err != nil {
        panic(err)
    }

    // Ensure the client is closed after the Query function finishes.
    defer func(client *influxdb3.Client) {
        err := client.Close()
        if err != nil {
            panic(err)
        }
    }(client)

    // Call the client's QueryWithParameters function.
    // Provide the query, parameters, and the InfluxQL QueryType option.
    iterator, err := client.QueryWithParameters(context.Background(), query,
    parameters, influxdb3.WithQueryType(options.QueryType))

    // Create a buffer for storing rows as you process them.
    w := tabwriter.NewWriter(io.Discard, 4, 4, 1, ' ', 0)
    w.Init(os.Stdout, 0, 8, 0, '\t', 0)

    fmt.Fprintf(w, "time\troom\tco\thum\ttemp\n")

    // Format and write each row to the buffer.
    // Process each row as key-value pairs.
    for iterator.Next() {
        row := iterator.Value()
        // Use Go time package to format unix timestamp
        // as a time with timezone layout (RFC3339 format)
        time := (row["time"].(time.Time)).
                Format(time.RFC3339)

        fmt.Fprintf(w, "%s\t%s\t%d\t%.1f\t%.1f\n",
            time, row["room"], row["co"], row["hum"], row["temp"])
    }
    w.Flush()

    return nil
}

func main() {
    // Use the $placeholder syntax in a query to reference parameter placeholders
    // for input data.
    // The following InfluxQL query contains the placeholders $room and $min_temp.
    query := `
        SELECT *
        FROM home
        WHERE time > now() - 7d
        AND temp >= $min_temp
        AND room = $room`

    // Define a QueryParameters struct--a map of placeholder names to input values.
    parameters := influxdb3.QueryParameters{
        "room": "Kitchen",
        "min_temp": 20.0,
    }

    Query(query, parameters, influxdb3.QueryOptions{
        QueryType: influxdb3.InfluxQL,
    })
}

客户端对参数化查询的支持

  • 并非所有InfluxDB 3 Flight 客户端都支持参数化查询。
  • InfluxDB 目前不支持 Flight SQL 或 Flight SQL 客户端的参数化查询或 DataFusion 预处理语句。
  • InfluxDB 3 SQL 和 InfluxQL 参数化查询在 InfluxDB v1 和 v2 客户端中不受支持。

不支持

目前,InfluxDB Clustered 中的参数化查询不提供以下功能

  • 对 DataFusion 预处理语句的支持
  • 查询缓存、优化或性能优势

此页内容是否对您有帮助?

感谢您的反馈!


Flux 的未来

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

阅读更多

InfluxDB 3 开源版本现已发布公开 Alpha 版

InfluxDB 3 开源版本现已可用于 Alpha 测试,根据 MIT 或 Apache 2 许可获得许可。

我们正在发布两个作为 Alpha 版本一部分的产品。

InfluxDB 3 Core 是我们新的开源产品。它是一个用于时间序列和事件数据的最新数据引擎。InfluxDB 3 Enterprise 是一个商业版本,它建立在 Core 的基础上,增加了历史查询能力、读取副本、高可用性、可扩展性和细粒度的安全性。

有关如何开始使用的更多信息,请查看