Skip to content

Commit

Permalink
docs: update env variables listing (#6007)
Browse files Browse the repository at this point in the history
Some of listed variables are not used anymore, some were are missing.
List is extracted from src/connection/options-reader/ConnectionOptionsEnvReader.ts
  • Loading branch information
Andreyco committed May 16, 2020
1 parent 52a5619 commit 0acedda
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 40 deletions.
45 changes: 22 additions & 23 deletions docs/using-ormconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,37 +101,36 @@ TYPEORM_ENTITIES = entity/*.js,modules/**/entity/*.js

List of available env variables you can set:

* TYPEORM_CACHE
* TYPEORM_CACHE_ALWAYS_ENABLED
* TYPEORM_CACHE_DURATION
* TYPEORM_CACHE_OPTIONS
* TYPEORM_CONNECTION
* TYPEORM_HOST
* TYPEORM_USERNAME
* TYPEORM_PASSWORD
* TYPEORM_DATABASE
* TYPEORM_PORT
* TYPEORM_URL
* TYPEORM_SID
* TYPEORM_SCHEMA
* TYPEORM_SYNCHRONIZE
* TYPEORM_DEBUG
* TYPEORM_DRIVER_EXTRA
* TYPEORM_DROP_SCHEMA
* TYPEORM_MIGRATIONS_RUN
* TYPEORM_MIGRATIONS_TRANSACTION_MODE
* TYPEORM_ENTITIES
* TYPEORM_MIGRATIONS
* TYPEORM_MIGRATIONS_TABLE_NAME
* TYPEORM_SUBSCRIBERS
* TYPEORM_ENTITY_SCHEMAS
* TYPEORM_LOGGING
* TYPEORM_LOGGER
* TYPEORM_ENTITIES_DIR
* TYPEORM_ENTITY_PREFIX
* TYPEORM_HOST
* TYPEORM_LOGGER
* TYPEORM_LOGGING
* TYPEORM_MAX_QUERY_EXECUTION_TIME
* TYPEORM_ENTITIES_DIR
* TYPEORM_MIGRATIONS
* TYPEORM_MIGRATIONS_DIR
* TYPEORM_MIGRATIONS_RUN
* TYPEORM_MIGRATIONS_TABLE_NAME
* TYPEORM_PASSWORD
* TYPEORM_PORT
* TYPEORM_SCHEMA
* TYPEORM_SID
* TYPEORM_SUBSCRIBERS
* TYPEORM_SUBSCRIBERS_DIR
* TYPEORM_DRIVER_EXTRA
* TYPEORM_DEBUG
* TYPEORM_CACHE
* TYPEORM_CACHE_OPTIONS
* TYPEORM_CACHE_ALWAYS_ENABLED
* TYPEORM_CACHE_DURATION
* TYPEORM_SYNCHRONIZE
* TYPEORM_URL
* TYPEORM_USERNAME
* TYPEORM_UUID_EXTENSION

`TYPEORM_CACHE` should be boolean or string of cache type

Expand Down
39 changes: 22 additions & 17 deletions docs/zh_CN/using-ormconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,31 +100,36 @@ TYPEORM_ENTITIES = entity/.*js,modules/**/entity/.*js

可以设置的可用 env 变量列表:

- TYPEORM_CACHE
- TYPEORM_CACHE_ALWAYS_ENABLED
- TYPEORM_CACHE_DURATION
- TYPEORM_CACHE_OPTIONS
- TYPEORM_CONNECTION
- TYPEORM_HOST
- TYPEORM_USERNAME
- TYPEORM_PASSWORD
- TYPEORM_DATABASE
- TYPEORM_PORT
- TYPEORM_URL
- TYPEORM_SID
- TYPEORM_SCHEMA
- TYPEORM_SYNCHRONIZE
- TYPEORM_DEBUG
- TYPEORM_DRIVER_EXTRA
- TYPEORM_DROP_SCHEMA
- TYPEORM_MIGRATIONS_RUN
- TYPEORM_MIGRATIONS_TRANSACTION_MODE
- TYPEORM_ENTITIES
- TYPEORM_MIGRATIONS
- TYPEORM_SUBSCRIBERS
- TYPEORM_ENTITY_SCHEMAS
- TYPEORM_LOGGING
- TYPEORM_LOGGER
- TYPEORM_ENTITIES_DIR
- TYPEORM_ENTITY_PREFIX
- TYPEORM_HOST
- TYPEORM_LOGGER
- TYPEORM_LOGGING
- TYPEORM_MAX_QUERY_EXECUTION_TIME
- TYPEORM_ENTITIES_DIR
- TYPEORM_MIGRATIONS
- TYPEORM_MIGRATIONS_DIR
- TYPEORM_MIGRATIONS_RUN
- TYPEORM_MIGRATIONS_TABLE_NAME
- TYPEORM_PASSWORD
- TYPEORM_PORT
- TYPEORM_SCHEMA
- TYPEORM_SID
- TYPEORM_SUBSCRIBERS
- TYPEORM_SUBSCRIBERS_DIR
- TYPEORM_DRIVER_EXTRA
- TYPEORM_SYNCHRONIZE
- TYPEORM_URL
- TYPEORM_USERNAME
- TYPEORM_UUID_EXTENSION

`ormconfig.env`只能在开发期间使用。在生产环境中,你可以在 ENVIRONMENT VARIABLES 中设置所有这些值。

Expand Down

0 comments on commit 0acedda

Please sign in to comment.