Skip to content

Commit

Permalink
docs: add missing graphs_data_access property info (#1758)
Browse files Browse the repository at this point in the history
  • Loading branch information
@jhaeu
jhaeu authored Mar 21, 2024
2 parents 10d268d + 6e45ed0 commit 8854519
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions docs/run-instance/configuration/ors/engine/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@

Engine properties are required at graph-build time during startup.

| key | type | description | default value |
|------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
| init_threads | number | The number of threads used to initialize (build/load) graphs. Higher numbers requires more RAM | `1` |
| preparation_mode | boolean | If set, graphs and preparations will be build, but the application will shut down immediately afterwards without starting up any services | `false` |
| source_file | string | The OSM file to be used, supported formats are `.osm`, `.osm.gz`, `.osm.zip` and `.pbf` | `ors-api/src/test/files/heidelberg.osm.gz` |
| graphs_root_path | string | The root path to a directory for storing graphs | `./graphs` |
| elevation | object | See [elevation properties](elevation.md) | |
| profile_default | object | Described in [profile properties](profiles.md) | |
| profiles | object | Described in [profile properties](profiles.md) | |
| key | type | description | default value |
|--------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
| init_threads | number | The number of threads used to initialize (build/load) graphs. Higher numbers requires more RAM | `1` |
| preparation_mode | boolean | If set, graphs and preparations will be build, but the application will shut down immediately afterwards without starting up any services | `false` |
| source_file | string | The OSM file to be used, supported formats are `.osm`, `.osm.gz`, `.osm.zip` and `.pbf` | `ors-api/src/test/files/heidelberg.osm.gz` |
| graphs_root_path | string | The root path to a directory for storing graphs | `./graphs` |
| graphs_data_access | string | Defines how a DataAccess object is created. <br> - `MMAP`: memory mapped storage <br> - `RAM_STORE`: in-memory storage with a safe/flush option.<br> Further info in the [source code](https://github.com/GIScience/graphhopper/blob/ors_4.0/core/src/main/java/com/graphhopper/storage/DAType.java) | `RAM_STORE` |
| elevation | object | See [elevation properties](elevation.md) | |
| profile_default | object | Described in [profile properties](profiles.md) | |
| profiles | object | Described in [profile properties](profiles.md) | |

0 comments on commit 8854519

Please sign in to comment.