如何从 SQLAlchemy 结果中获取列名（声明性语法）

Question

我正在一个金字塔项目中工作，并且我在 SQLAlchemy 中以声明性语法列出了表，

"""models.py"""
class Projects(Base):
    __tablename__ = 'projects'
    __table_args__ = {'autoload': True}

来获取结果

""""views.py"""
session = DBSession()
row_data = session.query(Projects).filter_by(id=1).one()

我通过使用如何从该结果中获取列名

。 PS：我无法使用此方法，因为我正在使用声明性语法。

Answer 1

您可以执行类似于 Foo Stack 的答案的操作，而无需诉诸私有字段，方法是：

conn.execute(query).keys()

Answer 2

from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import (Column, Index, Date, DateTime, Numeric, BigInteger, String, ForeignKey, Boolean)

Base = declarative_base()

class Project(Base):
    """sqlalchemy ORM for my table."""
    __tablename__ = "table1"
    id = Column("id", BigIntegerID, primary_key=True, autoincrement=True)
    date = Column("date", Date, nullable=False)
    value = Column("value", Numeric(20, 8))
    ...
    ...

然后这将返回列名称 ['id', 'date', 'value', ...]:

Project.__table__.columns.keys()

或者这个

Project.metadata.tables['table1'].columns.keys()

Answer 3

ORM和非ORM的区别，不是声明式的，它只是ORM的一个助手。

查询有一个为此目的添加的属性column_descriptions：

https://docs.sqlalchemy.org/en/20/orm/queryguide/query.html#sqlalchemy.orm.Query.column_descriptions

Answer 4

只是玩玩，这种语法将为您提供所有列（因此为了解决您的问题，请将查询设置为仅查看一个表/对象）：

conn.execute(query)._metadata.keys

Answer 5

简短的回答是我最终得到了以下解决方案：

column_names = query.statement.columns.keys()

为什么？

我有一个类似的用例，我需要知道查询返回的显式列（即查询不一定包含表类的所有列）。由于该表的大小也很大（数百万个条目），prolibertas 答案在性能方面并不令人满意。下面是我的 94 列表的性能比较：

# First create a query with 100.000 entries
query = (
            session.query(myTable)
            .limit(100000)
        )

# Then get the column names .. 

column_names = session.execute(query).keys()
# ---> ~ 5.730 seconds

column_names = query.statement.columns.keys()
# ---> ~ 0.003 seconds

Answer 6

此链接展示了如何获取您可能需要的有关表、列等的所有元数据。

SQLAlchemy 元数据

上面的许多答案都基于此页面上的信息。
假设我们声明了一个表。

employees = Table('employees', metadata,
    Column('employee_id', Integer, primary_key=True),
    Column('employee_name', String(60), nullable=False),
    Column('employee_dept', Integer, ForeignKey("departments.department_id"))
)

以下是获取有关表的元数据的一些示例。

# access the column "EMPLOYEE_ID":
employees.columns.employee_id

# or just
employees.c.employee_id

# via string
employees.c['employee_id']

# iterate through all columns
for c in employees.c:
    print(c)

# get the table's primary key columns
for primary_key in employees.primary_key:
    print(primary_key)

# get the table's foreign key objects:
for fkey in employees.foreign_keys:
    print(fkey)

# access the table's MetaData:
employees.metadata

# access the table's bound Engine or Connection, if its MetaData is bound:
employees.bind

# access a column's name, type, nullable, primary key, foreign key
employees.c.employee_id.name
employees.c.employee_id.type
employees.c.employee_id.nullable
employees.c.employee_id.primary_key
employees.c.employee_dept.foreign_keys

# get the "key" of a column, which defaults to its name, but can
# be any user-defined string:
employees.c.employee_name.key

# access a column's table:
employees.c.employee_id.table is employees

# get the table related by a foreign key
list(employees.c.employee_dept.foreign_keys)[0].column.table

Answer 7

就

>>> q[0].keys()

在

row_data = session.query(Projects).filter_by(id=1).one()

示例之后：

>>> q = session.query(users_user.phone,users_user.first_name).filter(users_user.phone=='79267548577').limit(1).all()
>>> columns_names = q[0].keys

结果：

>>> q[0].keys()
['phone', 'first_name']
>>> 

Answer 8

在 2023 年手册中建议使用以下行：

colnames = query.statement.subquery().columns.keys()

或者如果您使用“执行”语句：

result = session.execute(text("SELECT * from my_table_name"))
print(result.keys()) 

Answer 9

想扩展@zzzeek的答案。事实上，Query 有 column_descriptions 属性，但并非所有方法都可用。

考虑以下两个查询：

1. query = session.query(Projects).filter_by(<filter_condition>)
2. query = session.query(Projects).all() <-- This query does not have column_descriptions.

因此，如果您遇到这种情况，您需要使用 column_descriptions 属性，但使用 ...query(...).all() 那么您可以将其更改为 ...query(...).filter_by() ，即 filter_by() ，无需任何过滤条件。