管理密钥并配置 Streamlit 应用程序¶

管理与 Snowflake 的连接¶

要管理与 Snowflake 的连接，可以使用 st.connection("snowflake") (https://docs.streamlit.io/develop/api-reference/connections/st.connections.snowflakeconnection)。这允许您从本地开发环境和部署的应用程序连接到 Snowflake。

import streamlit as st

conn = st.connection("snowflake")
session = conn.session()

session.sql("SELECT 1").collect()

在仓库运行时中，您还可以使用 Snowpark 的 get_active_session() 函数来获取活动会话。

import streamlit as st
from snowflake.snowpark.context import get_active_session

# ONLY IN WAREHOUSE RUNTIMES
session = get_active_session()
session.sql("SELECT 1").collect()

容器运行时中的密钥¶

容器运行时无权访问 _snowflake 模块，因为它们在存储过程环境之外运行。要在容器运行时访问密钥，您必须创建使用 _snowflake 模块的 SQL 函数，然后从 Streamlit 应用程序调用这些函数。对于 Cortex API 调用，必须使用 requests。

如果将较旧的 Streamlit 应用程序升级到容器运行时，则应将以下 _snowflake 函数替换为存储过程。这将在下一部分中介绍。

• get_generic_secret_string

• get_oauth_access_token

• get_username_password

• get_cloud_provider_token

• get_secret_type

此外，以下 _snowflake 函数应替换为使用会话令牌身份验证的手动 API 调用。这将在后面的部分 在容器运行时中调用 Cortex Agent 中介绍。

• send_snow_api_request

# .streamlit/secrets.toml
# ONLY USE FOR NON-SECRET CONFIGURATION VALUES
app_name = "My Streamlit App"
api_endpoint = "https://api.example.com"
max_results = 100

import streamlit as st
import os

app_name = st.secrets["app_name"]
API_ENDPOINT = os.getenv("API_ENDPOINT")

import requests
import json
import os

SNOWFLAKE_HOST = os.getenv("SNOWFLAKE_HOST")
SNOWFLAKE_ACCOUNT = os.getenv("SNOWFLAKE_ACCOUNT")
ANALYST_ENDPOINT = "/api/v2/cortex/analyst/message"
URL = "https://" + SNOWFLAKE_HOST + ANALYST_ENDPOINT

def get_token() -> str:
    """Read the oauth token embedded into SPCS container"""
    return open("/snowflake/session/token", "r").read()

def send_request(semantic_model_file, prompt):
    """Sends the prompt using the semantic model file """
    headers = {
        "Content-Type": "application/json",
        "accept": "application/json",
        "Authorization": f"Bearer {get_token()}",
        "X-Snowflake-Authorization-Token-Type": "OAUTH"
    }
    request_body = {
        "messages": [
            {
                "role": "user",
                "content": [{"type": "text", "text": prompt}],
            }
        ],
        "semantic_model_file": semantic_model_file,
    }
    return requests.post(URL, headers=headers, data=json.dumps(request_body))

仓库运行时中的密钥¶

在仓库运行时中，您可以使用 _snowflake 模块直接在 Streamlit 应用程序代码中访问密钥。仓库运行时继承了存储过程中对 _snowflake 模块的访问权限，这允许您检索在 Streamlit 对象中引用的密钥。

要在仓库运行时中使用密钥，请执行以下操作：

1. 在 Snowflake 中创建密钥对象。有关更多信息，请参阅 CREATE SECRET。

   CREATE OR REPLACE SECRET my_secret
     TYPE = GENERIC_STRING
     SECRET_STRING = 'my_secret_value';
   

   Copy

2. 创建外部访问集成并为其分配密钥。

   CREATE OR REPLACE EXTERNAL ACCESS INTEGRATION my_eai
     ALLOWED_AUTHENTICATION_SECRETS = (my_secret)
     ENABLED = TRUE;
   

   Copy

3. 使用 SECRETS 参数在 Streamlit 对象中引用该密钥：

   ALTER STREAMLIT my_warehouse_app
     SET EXTERNAL_ACCESS_INTEGRATIONS = (my_eai)
     SECRETS = ('my_secret_key' = my_secret);
   

   Copy

   您必须将外部访问集成和密钥同时分配给 Streamlit 对象。您不能单独将密钥分配给 Streamlit 对象。

4. 在 Streamlit 应用程序代码中，导入 _snowflake 模块并检索密钥：

   import streamlit as st
   import _snowflake
   
   # Retrieve an API key from a generic string secret
   my_secret = _snowflake.get_generic_secret_string('my_secret_key')
   

   Copy

有关使用 _snowflake 模块访问密钥的更多信息，请参阅 用于密钥访问的 Python API。

Streamlit 配置¶

Streamlit 应用程序可以包含一个配置文件 (.streamlit/config.toml)。此文件允许您自定义应用程序的各个方面，例如主题、布局和行为。配置文件以 TOML 格式编写。有关可用配置选项的更多信息，请参阅 config.toml (https://docs.streamlit.io/develop/api-reference/configuration/config.toml) 上的 Streamlit 文档。

对配置选项的支持因运行时环境而异。与仓库运行时相比，容器运行时通常为配置选项提供更广泛的支持，特别是在静态服务方面。下表显示了仓库和容器运行时支持哪些配置部分：

有关使用 [snowflake.sleep] 部分在仓库运行时配置睡眠计时器的信息，请参阅 为 Streamlit 应用程序自定义睡眠计时器。

以下目录结构显示了带有配置文件的 Streamlit 应用程序示例：

source_directory/
├── .streamlit/
│   └── config.toml
├── pyproject.toml
├── streamlit_app.py
└── uv.lock