From c0704515a061826b2f5338912c93a94b1c63a892 Mon Sep 17 00:00:00 2001 From: Mark Keller Date: Thu, 13 Jul 2023 11:33:12 -0700 Subject: [PATCH] WIP --- DESCRIPTION.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/DESCRIPTION.md b/DESCRIPTION.md index f44fca648..2a45e7367 100644 --- a/DESCRIPTION.md +++ b/DESCRIPTION.md @@ -9,10 +9,29 @@ Source code is also available at: https://github.com/snowflakedb/snowflake-conne # Release Notes - v3.0.5(TBD) + - The Python connector lets you add connection definitions to the `config.toml` configuration file. A connection definition refers to a collection of connection parameters. The connection configuration name must begin with **connections**, similar to the following that defines the parameters for the `prod` connection: + + ```toml + [connections.prod] + account = "my_account" + user = "my_user" + password = "my_password" + ``` + By default, the Python connector looks for the `config.toml` file in the location specified in the `SNOWFLAKE_HOME` environment variable (default: `~/.snowflake`). If the file does not exist in that location, the Python connector looks for the file in the `platformdirs` location, as follows: + + - On Linux: `~/.config/snowflake/`, but follows XDG settings + - On Mac: `~/Library/Application Support/snowflake/` + - On Windows: `%USERPROFILE%\AppData\Local\snowflake\` + + You can determine which file is used by running the following command: + + ``` + python -c "from snowflake.connector.constants import CONFIG_FILE; print(str(CONFIG_FILE))" + ``` - Added the ability to read Snowflake's central configuration file. - The configuration file (`config.toml`) location gets resolved the following way: - If the folder defined by the environmental variable `SNOWFLAKE_HOME` (defaults to `~/.snowflake`) exists then we look for the configuration file in there. - - We fall back to `platformdirs` defaults. Which means: + - Otherwise, we fall back to `platformdirs` defaults. Which means: - On Linux: `~/.config/snowflake/`, but follows XDG settings. - On Mac: `~/Library/Application Support/snowflake/` - On Windows: `%USERPROFILE%\AppData\Local\snowflake\`