Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor doc improvements #350

Merged
merged 1 commit into from
Jul 13, 2023
Merged

Minor doc improvements #350

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/src/custom-indexes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -61,6 +64,8 @@ PgOSM Flex database. `<name>` is the name of the column in the database.
* `<name>_where`
* `<name>_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 `<name>` variable is the column's name and is set to boolean.
Expand Down