Always set Doctrine server version & platform #258
Conversation
| # this is useful to allow you to run cache:warmup | ||
| # even when your environment variables don't yet exist | ||
| # you should not need to change this value | ||
| env(DATABASE_URL): '%doctrine.database_server%://' |
There was a problem hiding this comment.
Is it possible to specify a default value for the DATABASE_URL environment value in some other way (i.e. not below parameters)? I could move this to services.yaml as @symfony-flex-server suggests, but it's really better here, as the user should not really configure this.
We can do this by using the driver and server_version config. Then, we can just set DATABASE_URL to blank, to supress the error that it does not exist. If it *is* set, it overrides the driver option, but they should match anyways.
|
I've just simplified this a bunch: A) Things like B) Thanks to this, |
| @@ -10,6 +10,6 @@ | |||
| "#1": "Format described at http://docs.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url", | |||
| "#2": "For an SQLite database, use: \"sqlite:///%kernel.project_dir%/var/data.db\"", | |||
| "#3": "Set \"serverVersion\" to your server version to avoid edge-case exceptions and extra database calls", | |||
| "DATABASE_URL": "mysql://db_user:[email protected]:3306/db_name?charset=utf8mb4&serverVersion=5.7" | |||
| "DATABASE_URL": "mysql://db_user:[email protected]:3306/db_name" | |||
There was a problem hiding this comment.
Would it make sense to mention that one should also not forget to change the doctrine.yaml file? And vice-versa?
There was a problem hiding this comment.
Good idea. I just changed the #3 comment line to mention doctrine.yaml. But I didn't add a note in doctrine.yaml about .env: it seemed weird, because DATABASE_URL is an env variable, so saying "edit it in .env" is only true in dev mode.... I wasn't convinced if it should be added there or not.
| @@ -1,5 +1,17 @@ | |||
| parameters: | |||
There was a problem hiding this comment.
"parameters" should be defined via the "container" configurator instead
|
Note to self: if this is merged, https://github.com/symfony/symfony-docs/pull/8705/files#diff-d796577eeafc4ece119cf5df3492e5dbR124 can be simplified slightly. |
|
I'm not sure if the pros outweigh the cons here. The use case also looks a bit too specific. Maybe it's better to add this to the docs as an example. WDYT? |
|
The use-case is a little bit specific, but I think it'll be more and more common (it's standard practice on a PAAS like platform.sh or Heroku to warm up the cache during a build stage where no env parameters are added). This would make it work for everyone automatically instead of PAAS users needing to do extra. I don't think there's much downside:
|
ghost
merged commit 
In order to run
cache:warmup, you need to set the server platform and server version. I believe this can be accomplished by using some fake string likeDATABASE_URL: 'mysql://?server_version=5.7In this PR, I attempt to make the
DATABASE_URLtruly optional duringcache:warmup. I do this by committing the server (e.g. mysql) and version (e.g. 5.7) into a config file. This allows us to create a fallback when needed.On the downside,
doctrine.yamllooks a little strange. Also, I suppose it might be less obvious if you forget to specifyDATABASE_URLon production (because your connection will fail vs aMissing DATABASE_URL environment variableerror).On the upside, you can once again run
cache:warmupwith no environment variables at all (very nice for PAAS).