SQLAlchemy ORM 转换为 pandas DataFrame

Question

是否有将 SQLAlchemy

<Query object>

转换为 pandas DataFrame 的解决方案？

Pandas 能够使用

pandas.read_sql

，但这需要使用原始 SQL。我想避免它有两个原因：

我已经拥有了使用 ORM 的一切（这本身就是一个很好的理由）并且
我使用 python 列表作为查询的一部分，例如：

db.session.query(Item).filter(Item.symbol.in_(add_symbols)
，其中
Item
是我的模型类，
add_symbols
是一个列表）。这相当于 SQL
SELECT ... from ... WHERE ... IN
。

有什么可能吗？

Answer 1

以下应该适用于大多数情况：

df = pd.read_sql(query.statement, query.session.bind)

有关参数的更多信息，请参阅

pandas.read_sql

文档。

Answer 2

为了让 pandas 程序员新手更清楚这一点，这里有一个具体的例子，

pd.read_sql(session.query(Complaint).filter(Complaint.id == 2).statement,session.bind)

这里我们从投诉表中选择一个投诉（sqlalchemy模型是Complaint），id = 2

Answer 3

为了完整起见：作为 Pandas 函数

read_sql_query()

的替代方案，您还可以使用 Pandas-DataFrame 函数

from_records()

来转换

structured or record ndarray to DataFrame

。
如果您例如，这会派上用场。已经在 SQLAlchemy 中执行查询并且结果已经可用：

import pandas as pd 
from sqlalchemy import Column, Integer, String, create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import scoped_session, sessionmaker


SQLALCHEMY_DATABASE_URI = 'postgresql://postgres:postgres@localhost:5432/my_database'
engine = create_engine(SQLALCHEMY_DATABASE_URI, pool_pre_ping=True, echo=False)
db = scoped_session(sessionmaker(autocommit=False, autoflush=False, bind=engine))
Base = declarative_base(bind=engine)


class Currency(Base):
    """The `Currency`-table"""
    __tablename__ = "currency"
    __table_args__ = {"schema": "data"}

    id = Column(Integer, primary_key=True, nullable=False)
    name = Column(String(64), nullable=False)


# Defining the SQLAlchemy-query
currency_query = db.query(Currency).with_entities(Currency.id, Currency.name)

# Getting all the entries via SQLAlchemy
currencies = currency_query.all()

# We provide also the (alternate) column names and set the index here,
# renaming the column `id` to `currency__id`
df_from_records = pd.DataFrame.from_records(currencies
    , index='currency__id'
    , columns=['currency__id', 'name'])
print(df_from_records.head(5))

# Or getting the entries via Pandas instead of SQLAlchemy using the
# aforementioned function `read_sql_query()`. We can set the index-columns here as well
df_from_query = pd.read_sql_query(currency_query.statement, db.bind, index_col='id')
# Renaming the index-column(s) from `id` to `currency__id` needs another statement
df_from_query.index.rename(name='currency__id', inplace=True)
print(df_from_query.head(5))

Answer 4

所选的解决方案对我不起作用，因为我不断收到错误

AttributeError：“AnnotatedSelect”对象没有属性“lower”

我发现以下方法有效：

df = pd.read_sql_query(query.statement, engine)

Answer 5

如果您想编译带有参数和方言特定参数的查询，请使用如下内容：

c = query.statement.compile(query.session.bind)
df = pandas.read_sql(c.string, query.session.bind, params=c.params)

Answer 6

from sqlalchemy import Column, Integer, String, create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

engine = create_engine('postgresql://postgres:postgres@localhost:5432/DB', echo=False)
Base = declarative_base(bind=engine)
Session = sessionmaker(bind=engine)
session = Session()

conn = session.bind

class DailyTrendsTable(Base):

    __tablename__ = 'trends'
    __table_args__ = ({"schema": 'mf_analysis'})

    company_code = Column(DOUBLE_PRECISION, primary_key=True)
    rt_bullish_trending = Column(Integer)
    rt_bearish_trending = Column(Integer)
    rt_bullish_non_trending = Column(Integer)
    rt_bearish_non_trending = Column(Integer)
    gen_date = Column(Date, primary_key=True)

df_query = select([DailyTrendsTable])

df_data = pd.read_sql(rt_daily_query, con = conn)

Answer 7

使用

2.0 SQLalchemy

语法（也可在 1.4 中使用标志

future=True

），看起来

pd.read_sql

尚未实现，并且会引发：

NotImplementedError: This method is not implemented for SQLAlchemy 2.0.

这是一个悬而未决的问题，直到 pandas 2.0 才会得到解决，您可以在 here 和 here 找到有关此问题的一些信息。

我没有找到任何令人满意的解决方案，但有些人似乎使用两种配置的引擎，其中一种带有未来标志：False：

engine2 = create_engine(URL_string, echo=False, future=False)

如果你查询字符串，这个解决方案就可以了，但是使用 ORM，我能做的最好的就是一个尚未优化的自定义函数，但它有效：

Conditions = session.query(ExampleTable)
def df_from_sql(query):
    return pd.DataFrame([i.__dict__ for i in query]).drop(columns='_sa_instance_state')
df = df_from_sql(ExampleTable)

在任何情况下，这个解决方案都是临时的，直到 pd.read_sql 实现新语法为止。

Answer 8

当你使用 ORM 时，就这么简单：

pd.DataFrame([r._asdict() for r in query.all()])

当您不想将 sql 和会话暴露给业务逻辑代码时，这是

pd.read_sql

的良好替代方案。

在这里找到它：https://stackoverflow.com/a/52208023/1635525

Answer 9

使用

Result.keys()

方法获取列名称的简单示例。

import sqlalchemy as sa
import pandas as pd

engine = sa.create_engine(...)
with engine.connect() as conn:
   result = conn.execute("SELECT * FROM foo;")
   df = pd.DataFrame(result.all(), columns=result.keys())

https://docs.sqlalchemy.org/en/20/core/connections.html#sqlalchemy.engine.Result.keys

Answer 10

这个答案提供了一个使用 SQL Alchemy

select

语句并返回 pandas 数据框的可重现示例。它基于内存 SQLite 数据库，因此任何人都可以在不安装数据库引擎的情况下重现它。

import pandas
from sqlalchemy import create_engine
from sqlalchemy import MetaData, Table, Column, Text
from sqlalchemy.orm import Session

定义表元数据并创建表

engine = create_engine('sqlite://')
meta = MetaData()
meta.bind = engine
user_table = Table('user', meta,
                   Column("name", Text),
                   Column("full_name", Text))
user_table.create()

插入一些数据到

user

表

stmt = user_table.insert().values(name='Bob', full_name='Sponge Bob')
with Session(engine) as session:
    result = session.execute(stmt)
    session.commit()

将 select 语句的结果读入 pandas 数据框

# Select data into a pandas data frame
stmt = user_table.select().where(user_table.c.name == 'Bob')
df = pandas.read_sql_query(stmt, engine)
df
Out:
  name   full_name
0  Bob  Sponge Bob

Answer 11

如果使用SQL查询

def generate_df_from_sqlquery(query):
   from pandas import DataFrame
   query = db.session.execute(query)
   df = DataFrame(query.fetchall())
   if len(df) > 0:
      df.columns = query.keys()
   else:
      columns = query.keys()
      df = pd.DataFrame(columns=columns)
return df

profile_df = generate_df_from_sqlquery(profile_query)

Answer 12

像@van一样使用

read_sql

添加答案，当我的查询涉及连接时，sqlalchemy似乎隐式地从连接表中添加别名列，例如id_1、id_2，以防连接表和主表都有一个id列。使用 .all() 会在返回结果之前删除这些隐式列，但

read_sql

将包含这些列。

对于我来说，这种情况的解决方案是明确我的选择。所以我换了

query = session.query(model)

与

query = session.query(model.col_1, model.col_2)

或选择全部

query = session.query(*model.__table__.columns.values())

然后

df = pd.read_sql(query.statement, query.session.bind)

Answer 13

如果您在 sqalchemy 过滤后已经收到数据，则可以使用另一种方法来实现此目的此处接下来是this答案，使用这个功能：

from collections import defaultdict
from sqlalchemy import inspect
import pandas as pd
def query_to_dict(rest):
    result = defaultdict(list)
    for obj in rest:
        instance = inspect(obj)
        for key, x in instance.attrs.items():
            result[key].append(x.value)
    return result
# Getting all the entries via SQLAlchemy
currencies = currency_query.all()
df = pd.DataFrame(query_to_dict(rset))

Answer 14

对于 2023 年的我来说，这对我有用：首先创建一个引擎和会话，将查询字符串转换为 SQLalchemy 文本

from sqlalchemy import text

    engine = create_engine(path, echo=True)

    Session = sessionmaker(bind=engine)
    session = Session()

    # generates suitble text for SQLalchemy
    sql = text(query_string)

    session.execute(sql)

    df = pd.read_sql_query(sql=sql, con=engine.connect())

Answer 15

import pandas as pd

users = Users.query.all()

df = pd.DataFrame(users)

print(df)

SQLAlchemy ORM 转换为 pandas DataFrame

问题描述投票：0回答：15

15个回答

最新问题

SQLAlchemy ORM 转换为 pandas DataFrame

问题描述 投票：0回答：15

15个回答

最新问题

问题描述投票：0回答：15