Skip to content

Commit 7fa66bd

Browse files
committed
Add a note about select indexes
1 parent 7101380 commit 7fa66bd

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ across the cluster.
1515
**Notes:**
1616

1717
* A space should have a format.
18-
* All non-TREE indexes will be ignored.
1918
* `bucket_id` is computed as `vshard.router.bucket_id_mpcrc32(key)`,
2019
where `key` is the primary key value.
2120

@@ -132,6 +131,14 @@ crud.delete('customers', 1)
132131

133132
### Select
134133

134+
`CRUD` performs select across a distributed space with a conditions.
135+
Condition can use field names, field numbers or index name as an operand.
136+
The first condition that uses index name or matches first parts of any index is
137+
used to select an index to iterate over.
138+
If no such index found, the primary index is used.
139+
140+
**Note**, that non-TREE indexes are ignored!
141+
135142
```lua
136143
local objects, err = crud.select(space_name, conditions, opts)
137144
```

0 commit comments

Comments
 (0)