Skip to content

Commit dd5f1e6

Browse files
committed
doc: add ToC into select/pairs examples
1 parent 97dd40f commit dd5f1e6

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

doc/pairs.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,20 @@ The arguments are the same as [``crud.select``](https://github.com/tarantool/cru
55
Below are examples that may help you.
66
Examples schema is similar to the [select documentation](select.md/#examples-space-format)
77

8+
## Table of Contents
9+
10+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
11+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
12+
13+
- [Getting space](#getting-space)
14+
- [``use_tomap`` parameter](#use_tomap-parameter)
15+
- [Pagination](#pagination)
16+
- [Lua Fun](#lua-fun)
17+
- [`fields` parameter](#fields-parameter)
18+
19+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
20+
21+
822
## Getting space
923

1024
Let's check ``developers`` space contents to make other examples more clear. Just select first 4 values without conditions.

doc/select.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
11
# Select examples
22

3+
## Table of Contents
4+
5+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
6+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
7+
8+
- [Filtering](#filtering)
9+
- [Examples schema](#examples-schema)
10+
- [Getting space](#getting-space)
11+
- [Select using index](#select-using-index)
12+
- [Select using composite index](#select-using-composite-index)
13+
- [Select using partial key](#select-using-partial-key)
14+
- [Select using non-indexed field](#select-using-non-indexed-field)
15+
- [Avoiding full scan](#avoiding-full-scan)
16+
- [Pagination](#pagination)
17+
- [``first`` parameter](#first-parameter)
18+
- [``after`` parameter](#after-parameter)
19+
- [Combine ``first`` and ``after``](#combine-first-and-after)
20+
- [Reverse pagination](#reverse-pagination)
21+
- [`fields` parameter](#fields-parameter)
22+
23+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
24+
325
## Filtering
426

527
``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.

0 commit comments

Comments
 (0)