How to access local.setting.json db connection string with python

Question

I have this local.settings.json in my local Azure function (Http triggered)

{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "",
    "FUNCTIONS_WORKER_RUNTIME": "python"
  },
  "ConnectionStrings": {
    "SQLConnectionString": "valid connection string "
  }
}

I want to access variable "SQLConnectionString" and use in my Python3.6 code. I have found many guides for accessing this variable with C#, but I wasn't lucky to find how to do it via python.

Do you mind set the properties(such as username, password, port....) separately in the connect operation instead of connection string ? — Hury Shen
– Hury Shen, Commented Oct 24, 2019 at 6:36
Connection string will be hidden in Azure key Vault and accessed via azure env variables in future. But for testing purposes and developement I would like to have connection string in local.settings.json. — Michal Štěpán
– Michal Štěpán, Commented Oct 24, 2019 at 6:46

Hury Shen · Accepted Answer · 2019-10-24 07:30:56Z

7

I test it just now and met the same error. You should modify your local.setting.json as below:

{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "",
    "FUNCTIONS_WORKER_RUNTIME": "python",
    "SQLConnectionString": "cnx = mysql.connector.connect(user=\"test@hurytestmysqlserver\", password=\"Password123\", host=\"testmysqlserver.mysql.database.azure.com\", port=3306, database=\"xxx\", .....)"
  }
}

but not

{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "",
    "FUNCTIONS_WORKER_RUNTIME": "python"
  },
  "ConnectionStrings": {
    "SQLConnectionString": "xxxxxxxx"
  }
}

Please have a try.

Just as a supplement~(I wanted to provide the solution "os.environ[xxx]" but saw the solution provided by HariHaran, haha~)

edited Oct 24, 2019 at 7:30

answered Oct 24, 2019 at 7:24

Hury Shen

15.8k1 gold badge11 silver badges20 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Michal Štěpán Over a year ago

yup modifying the local.setting.json without having nested "ConnectionStrings": { "SQLConnectionString": "xxxxxxxx" } helped. Thanks a lot!

bau Over a year ago

Warning: in your sentence I think you missed the "s" in the word "settingS" to have really a filename named as "local.settings.json" instead of "local.setting.json". In my case once well named and with your right syntax all is running well.

HariHaran · Accepted Answer · 2019-10-24 07:03:09Z

7

You can access these settings by declaring import os and then using

setting = os.environ["setting-name"].

More information - Developer Reference

answered Oct 24, 2019 at 7:03

HariHaran

4,4592 gold badges26 silver badges39 bronze badges

1 Comment

Michal Štěpán Over a year ago

Tried: import os .... print(os.environ["SQLConnectionString"]) or print(os.environ["ConnectionStrings"]) With the same result: System.Private.CoreLib: Exception while executing function: Functions.HttpTrigger. System.Private.CoreLib: Result: Failure Exception: KeyError: 'SQLConnectionString'

fcdt · Accepted Answer · 2020-08-04 12:12:16Z

7

In Python you need to do following:

import os
conn = os.environ["ConnectionStrings:SQLConnectionString"]

edited Aug 4, 2020 at 12:12

fcdt

2,5215 gold badges17 silver badges27 bronze badges

answered Aug 4, 2020 at 10:13

Borz_no

711 silver badge3 bronze badges

1 Comment

jack.py Over a year ago

This is the best answer

NDM · Accepted Answer · 2022-10-05 11:50:08Z

2

Hi you can also try this:

local.settings.json:

{
  "IsEncrypted": false,
  "Values": {
  "AzureWebJobsStorage": "",
  "FUNCTIONS_WORKER_RUNTIME": "python",
  "SQLConnectionString": "cnx = mysql.connector.connect(user=\"test@hurytestmysqlserver\", password=\"Password123\", host=\"testmysqlserver.mysql.database.azure.com\", port=3306, database=\"xxx\", .....)"
  }
}

python:

import os
SQLConnectionString = os.getenv("SQLConnectionString")

Remember to configure the azure function environment aswell otherwise the function will fail on deployment.

edited Oct 5, 2022 at 11:50

answered Oct 5, 2022 at 11:10

NDM

5795 silver badges6 bronze badges

Collectives™ on Stack Overflow

How to access local.setting.json db connection string with python

4 Answers 4

2 Comments

1 Comment

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

2 Comments

1 Comment

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related