Skip to content

Commit e7d967e

Browse files
Merge pull request #350 from rustprooflabs/doc-cleanup
Minor doc improvements
2 parents a7d3edc + 76dc9ea commit e7d967e

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/src/custom-indexes.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# Indexes
22

3-
PgOSM Flex allows the indexes on the tables using `.ini` files. The default
3+
PgOSM Flex allows customizing the indexes on the tables using `.ini` files. The default
44
index configuration files are stored under `flex-config/indexes/`.
55
The default indexing strategy is baked into the Docker
66
image, to use the defaults you can follow the instructions throughout the
77
documentation without any adjustments.
88

9+
> Custom indexes added in PgOSM Flex 0.10.0.
10+
911
## Map Volume in `docker run`
1012

1113
To customize indexes, map the path of your custom index definitions folder
@@ -34,6 +36,7 @@ docker run --name pgosm -d --rm \
3436

3537
Each Lua style (`flex-config/style/*.lua`) must have a matching INI file
3638
under `flex-config/indexes/`. Each `.ini` file should have 4 sections defined.
39+
These sections can all be empty.
3740

3841

3942
```ini
@@ -61,6 +64,8 @@ PgOSM Flex database. `<name>` is the name of the column in the database.
6164
* `<name>_where`
6265
* `<name>_method`
6366

67+
> See the section [Most Columns can be Indexed](custom-indexes.md#most-columns-can-be-indexed) for details about which columns can be indexed.
68+
6469
### To index or not to index
6570

6671
The `<name>` variable is the column's name and is set to boolean.

0 commit comments

Comments
 (0)