docs: add session and environment variables to README #669
Conversation
|
@erizocosmico you can rebase with master now |
Signed-off-by: Miguel Molina <miguel@erizocosmi.co>
5bd391e to
4a09621
Compare
|
Done |
README.md
Outdated
|
|
||
| ### Index creation threads | ||
|
|
||
| - `PILOSA_INDEX_THREADS`: this environment variable sets the number of threads used in index creation. |
There was a problem hiding this comment.
shall we say that the default is min(threads, partitions) ?
There was a problem hiding this comment.
In the end is just runtime.NumCPU() from the index there's no way to access the number of partitions.
README.md
Outdated
|
|
||
| ### Maximum inner join memory | ||
|
|
||
| - `MAX_MEMORY_INNER_JOIN`: this environment variable controls in bytes the maximum number of memory that can be consumed by go-mysql-server before switching to multipass mode in inner joins. |
There was a problem hiding this comment.
should we document default values too?
There was a problem hiding this comment.
also, should we use MB as unit instead of bytes?
README.md
Outdated
|
|
||
| ### Memory joins | ||
|
|
||
| - `EXPERIMENTAL_IN_MEMORY_JOIN`: if this environment variable is set it will perform all joins in memory. |
There was a problem hiding this comment.
maybe this has less sense having MAX_MEMORY_INNER_JOIN. Shall we remove them?
There was a problem hiding this comment.
This ensures all of them are performed in memory without having to worry about which number to set. I would remove the EXPERIMENTAL_ though
Signed-off-by: Miguel Molina <miguel@erizocosmi.co>
Signed-off-by: Miguel Molina <miguel@erizocosmi.co>
|
Done |
Closes #668
Depends on #644