Skip to content

Commit

Permalink
doc: remove misleading info
Browse files Browse the repository at this point in the history
Closes #241
  • Loading branch information
DifferentialOrange committed Mar 22, 2023
1 parent 3f2db88 commit c1aa8b9
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -924,7 +924,8 @@ errs[4].tuple -- {92, 2040, "Artur", 29}
### Select

`CRUD` supports multi-conditional selects, treating a cluster as a single space.
The conditions may include field names or numbers, as well as index names.
The conditions may include field names, as well as index names.
(Refer to [#352](https://github.com/tarantool/crud/issues/352) for field number.)
The recommended first condition is a TREE index; this helps reducing the number
of tuples to scan. Otherwise a full scan is performed.

Expand Down Expand Up @@ -970,7 +971,7 @@ Select conditions are very similar to Tarantool update
Each condition is a table `{operator, field-identifier, value}`:

* Supported operators are: `=` (or `==`), `>`, `>=`, `<`, `<=`.
* Field identifier can be field name, field number, or index name.
* Field identifier can be field name or index name. (Refer to [#352](https://github.com/tarantool/crud/issues/352) for field number.)

**Example:**

Expand Down
2 changes: 1 addition & 1 deletion doc/select.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

## Filtering

``CRUD`` allows to filter tuples by conditions. Each condition can use field name (or number) or index name. The first condition that uses index name is used to iterate over space. If there is no conditions that match index names, full scan is performed. Other conditions are used as additional filters. Search condition for the indexed field must be placed first to avoid a full scan. In additional, don't forget to limit amount of results with ``first`` parameter. This will help to avoid too long selects in production.
``CRUD`` allows to filter tuples by conditions. Each condition can use field name or index name. (Refer to [#352](https://github.com/tarantool/crud/issues/352) for field number.) The first condition that uses index name is used to iterate over space. If there is no conditions that match index names, full scan is performed. Other conditions are used as additional filters. Search condition for the indexed field must be placed first to avoid a full scan. In additional, don't forget to limit amount of results with ``first`` parameter. This will help to avoid too long selects in production.

**Note:** If you specify sharding key or ``bucket_id`` select will be performed on single node. Otherwise Map-Reduce over all nodes will be occurred.

Expand Down

0 comments on commit c1aa8b9

Please sign in to comment.