diff --git a/docs/src/custom-indexes.md b/docs/src/custom-indexes.md index 3fb2c3a..0fe2824 100644 --- a/docs/src/custom-indexes.md +++ b/docs/src/custom-indexes.md @@ -1,11 +1,13 @@ # Indexes -PgOSM Flex allows the indexes on the tables using `.ini` files. The default +PgOSM Flex allows customizing the indexes on the tables using `.ini` files. The default index configuration files are stored under `flex-config/indexes/`. The default indexing strategy is baked into the Docker image, to use the defaults you can follow the instructions throughout the documentation without any adjustments. +> Custom indexes added in PgOSM Flex 0.10.0. + ## Map Volume in `docker run` To customize indexes, map the path of your custom index definitions folder @@ -34,6 +36,7 @@ docker run --name pgosm -d --rm \ Each Lua style (`flex-config/style/*.lua`) must have a matching INI file under `flex-config/indexes/`. Each `.ini` file should have 4 sections defined. +These sections can all be empty. ```ini @@ -61,6 +64,8 @@ PgOSM Flex database. `` is the name of the column in the database. * `_where` * `_method` +> See the section [Most Columns can be Indexed](custom-indexes.md#most-columns-can-be-indexed) for details about which columns can be indexed. + ### To index or not to index The `` variable is the column's name and is set to boolean.