From c5a9455959f3c07e4fc1dc750db07e40f1326fef Mon Sep 17 00:00:00 2001 From: Christophe Eymard Date: Sun, 1 Dec 2024 20:41:39 +0100 Subject: [PATCH] docs: Add an example for PGRST_APP_SETTINGS_* (#3804) --- docs/references/configuration.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/references/configuration.rst b/docs/references/configuration.rst index 5159283ac3..4237d55bcc 100644 --- a/docs/references/configuration.rst +++ b/docs/references/configuration.rst @@ -191,6 +191,10 @@ app.settings.* Arbitrary settings that can be used to pass in secret keys directly as strings, or via OS environment variables. For instance: :code:`app.settings.jwt_secret = "$(MYAPP_JWT_SECRET)"` will take :code:`MYAPP_JWT_SECRET` from the environment and make it available to PostgreSQL functions as :code:`current_setting('app.settings.jwt_secret')`. + When using the environment variable `PGRST_APP_SETTINGS_*` form, the remainder of the variable is used as the new name. Case is not important : :code:`PGRST_APP_SETTINGS_MY_ENV_VARIABLE=some_value` can be accessed in postgres as :code:`current_setting('app.settings.my_env_variable')`. + + The :code:`current_setting` function has `an optional boolean second `_ argument to avoid it from raising an error if the value was not defined. Default values to :code:`app.settings` can then be given by combining this argument with :code:`coalesce` and :code:`nullif` : :code:`coalesce(nullif(current_setting('app.settings.my_custom_variable', true), ''), 'default value')`. The use of :code:`nullif` is necessary because if set in a transaction, the setting is sometimes not "rolled back" to :code:`null`. See also :ref:`this section ` for more information on this behaviour. + .. _db-aggregates-enabled: db-aggregates-enabled