Skip to content

Update bind parameters information in API documentation #2710

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 11, 2020
Merged

Update bind parameters information in API documentation #2710

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions content/influxdb/v1.8/tools/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,10 +423,11 @@ Note that when the request includes `-H "Accept: application/csv"`, the system r

##### Bind parameters

The API supports binding parameters to particular field values or tag values in
the [`WHERE` clause](/influxdb/v1.8/query_language/data_exploration/#the-where-clause).
The API supports binding parameters to particular field values or tag values.
Use the syntax `$<placeholder_key>` as a placeholder in the query, and URL
encode the map of placeholder keys to placeholder values in the request body:
encode the map of placeholder keys to placeholder values in the request body.
This allows all InfluxQL queries where the value is customizable---such as field
values, function names, or intervals---to be represented using bind parameters.

Query syntax:

Expand Down