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

dotenv (.env) tweaks #1427

Merged
merged 2 commits into from
Nov 19, 2023
Merged

dotenv (.env) tweaks #1427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0bac248
remove yaml file extension as it was triggering false positive yaml l…
jqnatividad Nov 19, 2023
4ef8985
`docs`: update documentation re name of dotenv.template
jqnatividad Nov 19, 2023
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ It also has Out-of-Memory prevention, with two modes - NORMAL (default) & CONSER

qsv supports an extensive list of environment variables and supports `.env` files to set them.

For details, see [Environment Variables](docs/ENVIRONMENT_VARIABLES.md) and the [`dotenv.template.yaml`](dotenv.template.yaml) file.
For details, see [Environment Variables](docs/ENVIRONMENT_VARIABLES.md) and the [`dotenv.template.yaml`](dotenv.template) file.
## Feature Flags

qsv has several [feature flags](https://doc.rust-lang.org/cargo/reference/features.html) that can be used to enable/disable optional features.
Expand Down
2 changes: 1 addition & 1 deletion docs/ENVIRONMENT_VARIABLES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ When processing `.env` files, qsv will:
* where multiple declarations of the same variable exist, the last one will be used
* ignore any lines that start with `#` (comments)

To facilitate the use of `.env` files, a [`dotenv.template.yaml`](../dotenv.template.yaml) file is included in the qsv distribution. This file contains all the environment variables that qsv recognizes, along with their default values. Copy the template to a file named '.env' and modify it to suit your needs.
To facilitate the use of `.env` files, a [`dotenv.template`](../dotenv.template) file is included in the qsv distribution. This file contains all the environment variables that qsv recognizes, along with their default values. Copy the template to a file named '.env' and modify it to suit your needs.
14 changes: 7 additions & 7 deletions dotenv.template.yaml → dotenv.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ QSV_NO_HEADERS = False
# if set to `1`, toggles header setting - i.e. inverts qsv header behavior,
# with no headers being the default, & setting `--no-headers` will actually
# mean headers will not be ignored.
# QSV_TOGGLE_HEADERS = 1
# QSV_TOGGLE_HEADERS = False

# if set, specifies the minimum file size (in bytes) of a CSV file before an
# index is automatically created. Note that stale indices are automatically
Expand All @@ -48,7 +48,7 @@ QSV_NO_HEADERS = False
# if set, add a BOM (Byte Order Mark) to the beginning of the output.
# Note that this will also set the BOM for qsv's output to stdout.
# This is useful when generating CSV files for Excel on Windows.
# QSV_OUTPUT_BOM = 1
# QSV_OUTPUT_BOM = False

# The directory to use for caching various qsv files.
# Used by the `geocode` command for downloaded geocoding resources.
Expand All @@ -72,7 +72,7 @@ QSV_NO_HEADERS = False
# with this character are ignored. Note that when you want to use the pound sign
# as a comment char, you need to enclose it in single quotes as its a reserved
# character for dotenv files, e.g.
QSV_COMMENT_CHAR = '#'
QSV_COMMENT_CHAR: '#'

# Otherwise, you can just use the character without enclosing it in single quotes
# QSV_COMMENT_CHAR = !
Expand Down Expand Up @@ -100,11 +100,11 @@ QSV_PREFER_DMY = False
# operation is always unicode-aware.
QSV_REGEX_UNICODE = False

# reader buffer size (default (bytes): 16384)
QSV_RDR_BUFFER_CAPACITY = 16384
# reader buffer size (default (bytes): 131,072 - 128k)
QSV_RDR_BUFFER_CAPACITY = 131072

# writer buffer size (default (bytes): 65536)
QSV_WTR_BUFFER_CAPACITY = 65536
# writer buffer size (default (bytes): 524,288 - 512k)
QSV_WTR_BUFFER_CAPACITY = 524288

# the percentage of free available memory required when running qsv in
# "non-streaming" mode (i.e. the entire file needs to be loaded into memory).
Expand Down
Loading