Skip to content

Commit

Permalink
docs: cleanup value_string reference (#409)
Browse files Browse the repository at this point in the history
## Short description of the changes
Updates the note about `in` and `not-in` to reference `value` instead of
`value_string` (which is deprecated) as well as a couple other cleanups
related to the move to `value`
  • Loading branch information
brookesargent authored Dec 13, 2023
1 parent 58f54fc commit 24f9781
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
6 changes: 2 additions & 4 deletions docs/data-sources/query_specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,15 +65,13 @@ Each query configuration may have zero or more `filter` blocks, which each accep

* `column` - (Required) The column to apply the filter to.
* `op` - (Required) The operator to apply, see the supported list of filter operators at [Filter Operators](https://docs.honeycomb.io/api/query-specification/#filter-operators). Not all operators require a value.
* `value` - (Optional) The value used for the filter. Not needed if op is `exists`, `not-exists`, `in` or `not-in`. Mutually exclusive with the other `value_*` options.
* `value` - (Optional) The value used for the filter. Not needed if op is `exists` or `not-exists`. Mutually exclusive with the other `value_*` options.
* `value_string` - (Optional) Deprecated: use 'value' instead. The value used for the filter when the column is a string. Mutually exclusive with `value` and the other `value_*` options.
* `value_integer` - (Optional) Deprecated: use 'value' instead. The value used for the filter when the column is an integer. Mutually exclusive with `value` and the other `value_*` options.
* `value_float` - (Optional) Deprecated: use 'value' instead. The value used for the filter when the column is a float. Mutually exclusive with `value` and the other `value_*` options.
* `value_boolean` - (Optional) Deprecated: use 'value' instead. The value used for the filter when the column is a boolean. Mutually exclusive with `value` and the other `value_*` options.

-> **NOTE** The type of the filter value should match with the type of the column. To determine the type of a column visit the dataset settings page, all the columns and their type are listed under _Schema_. This provider will not be able to detect invalid combinations.

-> **NOTE** Filter op `in` and `not-in` expect an array of strings as value. Use the `value_string` attribute and pass the values in single string separated by `,` without additional spaces (similar to the query builder in the UI). For example: the list `foo`, `bar` becomes `foo,bar`.
* -> **NOTE** Filter op `in` and `not-in` expect an array of strings as value. Use the `value` attribute and pass the values in single string separated by `,` without additional spaces (similar to the query builder in the UI). For example: the list `foo`, `bar` becomes `foo,bar`.

Each query configuration may have zero or more `order` blocks, which each accept the following arguments. An order term can refer to a `calculation` or a column set in `breakdowns`. When referring to a `calculation`, `op` and `column` must be the same as the calculation.

Expand Down
2 changes: 1 addition & 1 deletion honeycombio/data_source_query_specification.go
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ func dataSourceHoneycombioQuerySpec() *schema.Resource {
},
"value": {
Type: schema.TypeString,
Description: "The value used for the filter. Not needed if op is `exists`, `not-exists`, `in` or `not-in`. Mutually exclusive with the other `value_*` options.",
Description: "The value used for the filter. Not needed if op is `exists` or `not-exists`. Mutually exclusive with the other `value_*` options.",
Optional: true,
},
"value_string": {
Expand Down

0 comments on commit 24f9781

Please sign in to comment.