1. Contents
  2. Setup your connection
  3. Built-in connections
  4. Third-party connections
  5. Secrets
  6. Deprecated classes

Connections and databases

Setup your connection

screenshot

Create a connection

Connect to a data source or API

Python
conn = st.connection('pets_db', type='sql')
pet_owners = conn.query('select * from pet_owners')
st.dataframe(pet_owners)

Built-in connections

screenshot

SnowflakeConnection

A connection to Snowflake.

Python
conn = st.connection('snowflake')
screenshot

SQLConnection

A connection to a SQL database using SQLAlchemy.

Python
conn = st.connection('sql')

Third-party connections

Connection base class

Build your own connection with BaseConnection.

Python
class MyConnection(BaseConnection[myconn.MyConnection]):
    def _connect(self, **kwargs) -> MyConnection:
        return myconn.connect(**self._secrets, **kwargs)
    def query(self, query):
        return self._instance.query(query)

Secrets

Secrets singleton

Access secrets from a local TOML file.

Python
key = st.secrets["OpenAI_key"]

Secrets file

Save your secrets in a per-project or per-profile TOML file.

Python
OpenAI_key = "<YOUR_SECRET_KEY>"

Deprecated classes

delete

SnowparkConnection

A connection to Snowflake.

Python
conn = st.connection("snowpark")
arrow_backPrevious: Caching and statearrow_forwardNext: st.secrets
forum

Still have questions?

Our forums are full of helpful information and Streamlit experts.