Skip to content

Commit 26e1058

Browse files
authored
Merge pull request #252 from HarperDB/update/search-by-value-properties
Make search-by-value properties consistent with search-by-conditions
2 parents 7d4777f + 6a69d4e commit 26e1058

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

docs/developers/operations-api/nosql-operations.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -218,8 +218,10 @@ Returns data from a table for a matching value.
218218
- `operation` _(required)_ - must always be `search_by_value`
219219
- `database` _(optional)_ - database where the table you are searching lives. The default is `data`
220220
- `table` _(required)_ - table you wish to search
221-
- `search_attribute` _(required)_ - attribute you wish to search can be any attribute
222-
- `search_value` _(required)_ - value you wish to search - wild cards are allowed
221+
- `attribute` _(required)_ - attribute you wish to search can be any attribute
222+
- `search_attribute` - deprecated in favor of `attribute`
223+
- `value` _(required)_ - value you wish to search - wild cards are allowed
224+
- `search_value` - deprecated in favor of `value`
223225
- `get_attributes` _(required)_ - define which attributes you want returned. Use `['*']` to return all attributes
224226

225227
### Body
@@ -229,8 +231,8 @@ Returns data from a table for a matching value.
229231
"operation": "search_by_value",
230232
"database": "dev",
231233
"table": "dog",
232-
"search_attribute": "owner_name",
233-
"search_value": "Ky*",
234+
"attribute": "owner_name",
235+
"value": "Ky*",
234236
"get_attributes": ["id", "dog_name"]
235237
}
236238
```

versioned_docs/version-4.6/developers/operations-api/nosql-operations.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -218,8 +218,10 @@ Returns data from a table for a matching value.
218218
- `operation` _(required)_ - must always be `search_by_value`
219219
- `database` _(optional)_ - database where the table you are searching lives. The default is `data`
220220
- `table` _(required)_ - table you wish to search
221-
- `search_attribute` _(required)_ - attribute you wish to search can be any attribute
222-
- `search_value` _(required)_ - value you wish to search - wild cards are allowed
221+
- `attribute` _(required)_ - attribute you wish to search can be any attribute
222+
- `search_attribute` - deprecated in favor of `attribute`
223+
- `value` _(required)_ - value you wish to search - wild cards are allowed
224+
- `search_value` - deprecated in favor of `value`
223225
- `get_attributes` _(required)_ - define which attributes you want returned. Use `['*']` to return all attributes
224226

225227
### Body
@@ -229,8 +231,8 @@ Returns data from a table for a matching value.
229231
"operation": "search_by_value",
230232
"database": "dev",
231233
"table": "dog",
232-
"search_attribute": "owner_name",
233-
"search_value": "Ky*",
234+
"attribute": "owner_name",
235+
"value": "Ky*",
234236
"get_attributes": ["id", "dog_name"]
235237
}
236238
```

0 commit comments

Comments
 (0)