使用 Python `sqlite3` 显示 SQLite 数据库中所有列

本文介绍了在SQLite数据库中查看表列信息的多种方法及其实现。主要内容包括： SQLite的自描述特性及其三种内省机制： PRAGMA table_info命令（推荐方法） sqlite_master系统表查询 cursor.description属性重点推荐使用PRAGMA table_info，详细说明了其返回的列信息结构和Python实现代码，包括查询单个表和所有表列信息的示例。其他方

weixin_42107409

1268人浏览 · 2025-09-19 07:19:32

weixin_42107409 · 2025-09-19 07:19:32 发布

引言：理解数据库列信息的重要性
- 1.1 为什么需要查看列信息？
- 1.2 SQLite 数据库的自描述特性
SQLite 数据库内省机制
- 2.1 PRAGMA table_info(table_name)
- 2.2 sqlite_master 系统表
- 2.3 cursor.description 属性
方法一：使用 PRAGMA table_info(table_name) (推荐)
- 3.1 原理与优势
- 3.2 PRAGMA table_info 返回的列说明
- 3.3 Python 代码示例：查询单个表的列信息
- 3.4 Python 代码示例：查询所有表的列信息 (结合 sqlite_master)
方法二：查询 sqlite_master 系统表
- 4.1 原理与用途 (查看 CREATE TABLE 语句)
- 4.2 局限性
- 4.3 Python 代码示例
方法三：使用 cursor.description 属性
- 5.1 原理与用途 (执行 SELECT 后获取)
- 5.2 局限性
- 5.3 Python 代码示例
最佳实践与注意事项
- 6.1 使用 with 语句管理连接
- 6.2 错误处理 (try-except)
- 6.3 参数化查询 (针对表名)
- 6.4 性能考量
- 6.5 区分开发与生产环境下的需求
综合代码示例：显示所有表的列信息
总结

1. 引言：理解数据库列信息的重要性

在数据库开发和维护中，了解数据库的结构（即有哪些表，每个表有哪些列，它们的类型是什么）是基本且关键的需求。

1.1 为什么需要查看列信息？

Schema 内省：了解数据库的整体结构，这对于不熟悉数据库的人或需要动态处理数据的程序尤其重要。
调试与开发：在编写 SQL 查询或 ORM 模型时，确认列名和数据类型，避免错误。
动态数据处理：创建可以适应不同表结构的代码，例如通用数据导出工具。
文档生成：自动生成数据库文档。

1.2 SQLite 数据库的自描述特性

SQLite 数据库是“自描述”的，这意味着它的 schema（表、列、索引等定义）本身就存储在数据库文件内部。我们可以通过特殊的 SQL 语句或查询内部表来访问这些元数据。

2. SQLite 数据库内省机制

Python 的 sqlite3 模块提供了多种方式来获取这些元数据：

2.1 `PRAGMA table_info(table_name)`

这是 SQLite 特有的一个命令，用于获取指定表的详细列信息。它是获取列信息最直接、最推荐的方法。

2.2 `sqlite_master` 系统表

sqlite_master (或 sqlite_schema) 是 SQLite 内部的一个特殊表，存储了数据库中所有对象的定义，包括表的 CREATE TABLE 语句。通过解析这些 CREATE TABLE 语句，可以间接获取列信息。

2.3 `cursor.description` 属性

在执行 SELECT 查询后，sqlite3 游标对象会有一个 description 属性，其中包含了查询结果集中各列的元数据。它的局限性在于你需要先执行一个查询。

3. 方法一：使用 `PRAGMA table_info(table_name)` (推荐)

3.1 原理与优势

PRAGMA 语句是 SQLite 专用的扩展 SQL 命令，用于查询和控制数据库引擎的各种运行时参数和配置。PRAGMA table_info(table_name) 会返回一个结果集，每行代表表中的一个列，并包含其详细信息。

优势：

直接、精确：直接返回结构化的列信息，无需解析复杂的 CREATE TABLE 语句。
标准化：是 SQLite 官方提供的内省机制。
性能好：查询速度快。

3.2 `PRAGMA table_info` 返回的列说明

当你执行 PRAGMA table_info(your_table_name) 时，结果集通常包含以下列：

cid：Column ID，列的索引（从 0 开始）。
name：列的名称。
type：列的数据类型（如 TEXT, INTEGER, REAL, BLOB, NUMERIC）。
notnull：如果列不允许 NULL 值，则为 1，否则为 0。
dflt_value：列的默认值（如果有）。
pk：如果列是主键的一部分，则为 1，否则为 0。

3.3 Python 代码示例：查询单个表的列信息

import sqlite3
import os

DB_FILE = "example_db.db"

def setup_db_for_single_table_info():
    """创建一个示例数据库和表。"""
    if os.path.exists(DB_FILE):
        os.remove(DB_FILE)
    
    with sqlite3.connect(DB_FILE) as conn:
        cursor = conn.cursor()
        cursor.execute('''
            CREATE TABLE users (
                id INTEGER PRIMARY KEY AUTOINCREMENT,
                username TEXT NOT NULL UNIQUE,
                email TEXT,
                age INTEGER DEFAULT 18,
                is_active BOOLEAN NOT NULL DEFAULT 1
            );
        ''')
        cursor.execute("INSERT INTO users (username, email) VALUES ('alice', 'alice@example.com')")
        cursor.execute("INSERT INTO users (username, email, age) VALUES ('bob', 'bob@example.com', 25)")
        conn.commit()
    print(f"Database '{DB_FILE}' created with 'users' table.")

def get_table_columns_pragma(table_name, db_file=DB_FILE):
    """
    使用 PRAGMA table_info 查询指定表的列信息。
    """
    print(f"\n--- Columns for table '{table_name}' using PRAGMA table_info ---")
    try:
        with sqlite3.connect(db_file) as conn:
            cursor = conn.cursor()
            cursor.execute(f"PRAGMA table_info({table_name});") # 注意：表名可以直接格式化，因为它不是用户输入
            columns = cursor.fetchall()
            
            if not columns:
                print(f"  No columns found for table '{table_name}' (or table does not exist).")
                return
            
            # 打印表头
            print(f"{'CID':<5} {'Name':<15} {'Type':<10} {'NotNull':<8} {'Dflt_Value':<12} {'PK':<3}")
            print(f"{'-'*5:<5} {'-'*15:<15} {'-'*10:<10} {'-'*8:<8} {'-'*12:<12} {'-'*3:<3}")

            for col in columns:
                print(f"{col[0]:<5} {col[1]:<15} {col[2]:<10} {col[3]:<8} {str(col[4]):<12} {col[5]:<3}")
    except sqlite3.Error as e:
        print(f"  Error querying table info for '{table_name}': {e}")

# Call the function:
# setup_db_for_single_table_info()
# get_table_columns_pragma('users')

3.4 Python 代码示例：查询所有表的列信息 (结合 `sqlite_master`)

要查询所有表的列信息，我们首先需要获取数据库中所有表的名称。这可以通过查询 sqlite_master 系统表来实现。

def get_all_table_names(db_file=DB_FILE):
    """获取数据库中所有表的名称。"""
    table_names = []
    try:
        with sqlite3.connect(db_file) as conn:
            cursor = conn.cursor()
            # 查询 sqlite_master 表，获取所有 type 为 'table' 且 name 不以 'sqlite_' 开头的对象
            cursor.execute("SELECT name FROM sqlite_master WHERE type='table' AND name NOT LIKE 'sqlite_%';")
            tables = cursor.fetchall()
            for table in tables:
                table_names.append(table[0])
    except sqlite3.Error as e:
        print(f"Error getting table names: {e}")
    return table_names

def get_all_columns_for_all_tables_pragma(db_file=DB_FILE):
    """
    遍历数据库中所有表的名称，并使用 PRAGMA table_info 查询它们的列信息。
    """
    print("\n--- Getting all columns for all tables using PRAGMA table_info ---")
    table_names = get_all_table_names(db_file)
    if not table_names:
        print("  No user-defined tables found in the database.")
        return

    for table_name in table_names:
        get_table_columns_pragma(table_name, db_file)
        print("-" * 50) # 分隔线

# Call the function:
# setup_db_for_single_table_info() # Make sure a database exists
# get_all_columns_for_all_tables_pragma()

4. 方法二：查询 `sqlite_master` 系统表

4.1 原理与用途 (查看 `CREATE TABLE` 语句)

sqlite_master (在较新的 SQLite 版本中也称为 sqlite_schema) 是一个内置表，它包含数据库中所有表、索引、视图和触发器的元数据。其 sql 列存储了创建这些对象的原始 SQL 语句。

用途：主要用于获取表或视图的完整 CREATE 语句，了解原始定义。

4.2 局限性

需要解析：要从中提取列名和类型，你需要对 CREATE TABLE 字符串进行解析，这比直接使用 PRAGMA table_info 更复杂且容易出错。
信息不完整：它不提供 notnull, dflt_value, pk 等详细信息，这些信息通常需要从解析 SQL 字符串中提取，或者通过 PRAGMA 获得。

4.3 Python 代码示例

def get_table_create_statements(db_file=DB_FILE):
    """
    查询 sqlite_master 表，显示所有表的 CREATE TABLE 语句。
    """
    print("\n--- CREATE TABLE statements from sqlite_master ---")
    try:
        with sqlite3.connect(db_file) as conn:
            cursor = conn.cursor()
            cursor.execute("SELECT name, sql FROM sqlite_master WHERE type='table' AND name NOT LIKE 'sqlite_%';")
            tables_info = cursor.fetchall()

            if not tables_info:
                print("  No user-defined tables found.")
                return
            
            for table_name, create_sql in tables_info:
                print(f"\nTable: {table_name}")
                print(f"  CREATE SQL: {create_sql}")
    except sqlite3.Error as e:
        print(f"  Error querying sqlite_master: {e}")

# Call the function:
# setup_db_for_single_table_info()
# get_table_create_statements()

5. 方法三：使用 `cursor.description` 属性

5.1 原理与用途 (执行 `SELECT` 后获取)

当你执行一个 SELECT 语句后，cursor 对象的 description 属性会包含一个元组列表，每个元组描述了结果集中的一列。每个内部元组包含 7 项，但最常用的是前两项：

[0]：列名。
[1]：列的类型代码（在 sqlite3 中，通常为 None 或底层数据库驱动的类型）。

用途：适用于已经执行了 SELECT 查询，需要获取查询结果列的运行时元数据。

5.2 局限性

需要实际查询：必须执行一个 SELECT 语句才能填充 description 属性。
不全面：它只包含查询结果中的列信息，不包含 PRIMARY KEY, NOT NULL, DEFAULT 等完整的表结构信息。
类型信息有限：返回的类型信息通常不够具体，可能只是 None 或 str 等 Python 类型。

5.3 Python 代码示例

def get_columns_from_select_description(table_name, db_file=DB_FILE):
    """
    通过执行 SELECT 语句并使用 cursor.description 获取列信息。
    """
    print(f"\n--- Columns for table '{table_name}' using cursor.description ---")
    try:
        with sqlite3.connect(db_file) as conn:
            cursor = conn.cursor()
            # 执行一个 SELECT * 语句，即使结果为空也可以获取 description
            cursor.execute(f"SELECT * FROM {table_name} LIMIT 0;") # LIMIT 0 避免读取数据
            
            if cursor.description:
                print(f"{'Column Name':<20} {'Type (from description)':<25}")
                print(f"{'-'*20:<20} {'-'*25:<25}")
                for column in cursor.description:
                    print(f"{column[0]:<20} {str(column[1]):<25}") # column[0]是列名，column[1]是类型
            else:
                print(f"  No columns found for table '{table_name}' via SELECT description (or table does not exist).")
    except sqlite3.Error as e:
        print(f"  Error querying table '{table_name}' for description: {e}")

# Call the function:
# setup_db_for_single_table_info()
# get_columns_from_select_description('users')

6. 最佳实践与注意事项

6.1 使用 `with` 语句管理连接

sqlite3.connect() 对象是一个上下文管理器。使用 with 语句可以确保数据库连接在操作完成后自动关闭，即使发生错误也能正确释放资源。

6.2 错误处理 (`try-except`)

始终使用 try...except sqlite3.Error 来捕获可能发生的数据库错误，并进行适当的处理，而不是让程序崩溃。

6.3 参数化查询 (针对表名)

虽然 PRAGMA table_info 语句中的表名通常是安全的，但如果表名来自用户输入，直接字符串格式化可能会导致 SQL 注入风险。然而，PRAGMA 语句不支持将表名作为绑定参数传入，你需要确保表名是受信任的或经过严格验证的。对于本例中的 schema 内省，表名通常是从 sqlite_master 内部获取的，因此是安全的。

6.4 性能考量

对于 schema 内省，PRAGMA table_info 是最有效率且提供信息最完整的方法。它在处理少量表时性能差异不明显，但在需要大规模或频繁查询 schema 时，它的优势会更加突出。

6.5 区分开发与生产环境下的需求

开发环境/调试：可以使用任何方法，PRAGMA table_info 提供的信息最全面，cursor.description 用于特定查询。
生产环境：通常不建议在生产环境中频繁进行 schema 内省。如果需要，应谨慎使用，并确保表名安全，避免潜在的注入风险。对于动态 ORM 或数据迁移工具，内省是必要的，但通常由框架层处理。

7. 综合代码示例：显示所有表的列信息

这个综合示例将使用推荐的方法（PRAGMA table_info 结合 sqlite_master）来显示数据库中所有表的列信息。

import sqlite3
import os
import shutil # 用于清理文件夹

# --- 配置 ---
DB_FILE_FULL = "full_schema_example.db"

# --- 辅助函数：创建示例数据库和表 ---
def setup_full_example_db():
    """
    创建一个包含多个表的示例数据库。
    """
    if os.path.exists(DB_FILE_FULL):
        os.remove(DB_FILE_FULL)
    
    print(f"Setting up database: '{DB_FILE_FULL}'")
    with sqlite3.connect(DB_FILE_FULL) as conn:
        cursor = conn.cursor()
        
        # Table 1: users
        cursor.execute('''
            CREATE TABLE IF NOT EXISTS users (
                id INTEGER PRIMARY KEY AUTOINCREMENT,
                username TEXT NOT NULL UNIQUE,
                email TEXT,
                joined_date DATE DEFAULT CURRENT_DATE
            );
        ''')
        cursor.execute("INSERT INTO users (username, email) VALUES ('alice', 'alice@example.com')")
        cursor.execute("INSERT INTO users (username, email) VALUES ('bob', 'bob@example.com')")

        # Table 2: products
        cursor.execute('''
            CREATE TABLE IF NOT EXISTS products (
                product_id INTEGER PRIMARY KEY AUTOINCREMENT,
                name TEXT NOT NULL,
                price REAL NOT NULL,
                stock INTEGER DEFAULT 0
            );
        ''')
        cursor.execute("INSERT INTO products (name, price, stock) VALUES ('Laptop', 1200.50, 50)")
        cursor.execute("INSERT INTO products (name, price, stock) VALUES ('Mouse', 25.00, 200)")
        
        # Table 3: orders (with foreign key)
        cursor.execute('''
            CREATE TABLE IF NOT EXISTS orders (
                order_id INTEGER PRIMARY KEY AUTOINCREMENT,
                user_id INTEGER NOT NULL,
                order_date DATETIME DEFAULT CURRENT_TIMESTAMP,
                total_amount REAL,
                FOREIGN KEY (user_id) REFERENCES users(id)
            );
        ''')
        cursor.execute("INSERT INTO orders (user_id, total_amount) VALUES (1, 1225.50)")
        cursor.execute("INSERT INTO orders (user_id, total_amount) VALUES (2, 25.00)")

        # Empty Table (to test empty table schema)
        cursor.execute('''
            CREATE TABLE IF NOT EXISTS empty_table (
                item_id INTEGER PRIMARY KEY,
                description TEXT
            );
        ''')

        conn.commit()
    print("Database setup complete.")

# --- 核心函数：获取所有表的列信息 ---
def get_all_table_column_details(db_file=DB_FILE_FULL):
    """
    获取数据库中所有表的列详细信息。
    """
    print(f"\n--- Retrieving ALL column details for database '{db_file}' ---")
    try:
        with sqlite3.connect(db_file) as conn:
            cursor = conn.cursor()
            
            # 1. 获取所有用户定义的表名
            cursor.execute("SELECT name FROM sqlite_master WHERE type='table' AND name NOT LIKE 'sqlite_%' ORDER BY name;")
            table_names = [row[0] for row in cursor.fetchall()]

            if not table_names:
                print("  No user-defined tables found in the database.")
                return

            print(f"Found {len(table_names)} tables: {', '.join(table_names)}")
            
            # 2. 遍历每个表，使用 PRAGMA table_info 获取列信息
            for table_name in table_names:
                print(f"\nTABLE: {table_name}")
                print(f"{'CID':<5} {'Name':<20} {'Type':<10} {'NotNull':<8} {'Dflt_Value':<15} {'PK':<3}")
                print(f"{'-'*5:<5} {'-'*20:<20} {'-'*10:<10} {'-'*8:<8} {'-'*15:<15} {'-'*3:<3}")

                cursor.execute(f"PRAGMA table_info('{table_name}');") # 使用 '?' 占位符可能不支持PRAGMA语句的表名，直接格式化但确保表名来源安全
                columns = cursor.fetchall()
                
                if not columns:
                    print("  (No columns found for this table)")
                else:
                    for col in columns:
                        # col: (cid, name, type, notnull, dflt_value, pk)
                        default_value = str(col[4]) if col[4] is not None else "NULL"
                        print(f"{col[0]:<5} {col[1]:<20} {col[2]:<10} {col[3]:<8} {default_value:<15} {col[5]:<3}")
                print("=" * 70) # 表之间的分隔线

    except sqlite3.Error as e:
        print(f"An SQLite error occurred: {e}")
    except Exception as e:
        print(f"An unexpected error occurred: {e}")

def cleanup_full_example():
    """清理生成的数据库文件。"""
    print("\n--- Cleaning up ---")
    if os.path.exists(DB_FILE_FULL):
        os.remove(DB_FILE_FULL)
        print(f"Deleted database file: {DB_FILE_FULL}")

# --- 主执行逻辑 ---
def main():
    cleanup_full_example() # 每次运行前清理
    setup_full_example_db()
    get_all_table_column_details()
    print("\n--- Program finished ---")
    # cleanup_full_example() # 如果需要保留文件以供检查，可以注释掉此行

if __name__ == "__main__":
    main()

8. 总结

为您详尽解析了在 Python 中使用 sqlite3 模块来显示 SQLite 数据库中所有表的列信息的方法。

核心要点回顾:

PRAGMA table_info(table_name)：这是最推荐和最强大的方法，能够返回包括列名、数据类型、是否允许 NULL、默认值和是否为主键在内的完整列结构信息。
sqlite_master (或 sqlite_schema)：这个系统表主要用于获取表的 CREATE TABLE 语句，了解原始定义，但要提取列信息需要额外解析。
cursor.description：在执行 SELECT 查询后使用，可以获取查询结果集的列名和基本的类型信息，但信息不如 PRAGMA 全面，且需要先执行查询。
遍历所有表: 结合 SELECT name FROM sqlite_master WHERE type='table' 来获取所有表的名称，然后循环对每个表使用 PRAGMA table_info，可以实现查询整个数据库的列信息。
最佳实践: 始终使用 with 语句管理数据库连接，实现 try-except 进行错误处理，并对表名进行适当的安全考虑（尽管在 schema 内省场景中通常风险较低）。

通过掌握这些方法，您将能够有效地在 Python 应用程序中查询和理解 SQLite 数据库的结构，从而更好地进行开发、调试和数据管理。

火山引擎 ADG 社区

火山引擎开发者社区是火山引擎打造的AI技术生态平台，聚焦Agent与大模型开发，提供豆包系列模型（图像/视频/视觉）、智能分析与会话工具，并配套评测集、动手实验室及行业案例库。社区通过技术沙龙、挑战赛等活动促进开发者成长，新用户可领50万Tokens权益，助力构建智能应用。

更多推荐

Chess用户界面设计：Tailwind CSS样式系统和组件库

GitHub推荐项目精选中的ch/chess是一个类似chess.com的多人在线象棋平台，它采用现代化的前端技术栈构建，尤其在用户界面设计上通过Tailwind CSS样式系统和组件库实现了优雅且功能丰富的交互体验。本文将深入探讨该项目如何利用Tailwind CSS打造一致的设计语言和高效的组件系统，为象棋爱好者提供沉浸式的游戏界面。## 🎨 Tailwind CSS样式系统：构建统一视

火山引擎 ADG 社区

终极指南：GPT-Engineer如何通过AI自动发现代码问题并提升质量

GPT-Engineer是一款强大的AI驱动代码工具，它能帮助开发者自动检测潜在代码问题、优化代码质量，让编程效率提升3倍以上。无论是新手还是资深开发者，都能通过这款工具轻松发现代码中的隐藏缺陷，减少调试时间，释放更多精力在创造性工作上。## 一键发现代码问题：GPT-Engineer的AI审查魔力GPT-Engineer的核心能力在于其内置的智能代码分析系统。通过集成Python代码格式

火山引擎 ADG 社区

SatDump中的纠错编码技术：从RS码到Turbo码的完整实现指南

在卫星数据传输过程中，信号往往会受到各种干扰，导致数据错误。SatDump作为一款通用卫星数据处理软件，集成了多种先进的纠错编码技术，确保从卫星接收到的数据能够准确解码。本文将深入解析SatDump中从Reed-Solomon（RS）码到Turbo码的实现细节，帮助读者理解这些技术如何保障卫星通信的可靠性。## 为什么纠错编码对卫星数据至关重要？卫星与地面站之间的通信链路面临着空间辐射、大

火山引擎 ADG 社区

所有评论(0)

查看更多评论

weixin_42107409

@weixin_42107409

已为社区贡献9条内容

使用 Python `sqlite3` 显示 SQLite 数据库中所有列

weixin_42107409

目录

1. 引言：理解数据库列信息的重要性

1.1 为什么需要查看列信息？

1.2 SQLite 数据库的自描述特性

2. SQLite 数据库内省机制

2.1 PRAGMA table_info(table_name)

2.2 sqlite_master 系统表

2.3 cursor.description 属性

3. 方法一：使用 PRAGMA table_info(table_name) (推荐)

3.1 原理与优势

3.2 PRAGMA table_info 返回的列说明

3.3 Python 代码示例：查询单个表的列信息

3.4 Python 代码示例：查询所有表的列信息 (结合 sqlite_master)

4. 方法二：查询 sqlite_master 系统表

4.1 原理与用途 (查看 CREATE TABLE 语句)

4.2 局限性

4.3 Python 代码示例

5. 方法三：使用 cursor.description 属性

5.1 原理与用途 (执行 SELECT 后获取)

5.2 局限性

5.3 Python 代码示例

6. 最佳实践与注意事项

6.1 使用 with 语句管理连接

6.2 错误处理 (try-except)

6.3 参数化查询 (针对表名)

6.4 性能考量

6.5 区分开发与生产环境下的需求

7. 综合代码示例：显示所有表的列信息

8. 总结

所有评论(0)

weixin_42107409

2.1 `PRAGMA table_info(table_name)`

2.2 `sqlite_master` 系统表

2.3 `cursor.description` 属性

3. 方法一：使用 `PRAGMA table_info(table_name)` (推荐)

3.2 `PRAGMA table_info` 返回的列说明

3.4 Python 代码示例：查询所有表的列信息 (结合 `sqlite_master`)

4. 方法二：查询 `sqlite_master` 系统表

4.1 原理与用途 (查看 `CREATE TABLE` 语句)

5. 方法三：使用 `cursor.description` 属性

5.1 原理与用途 (执行 `SELECT` 后获取)

6.1 使用 `with` 语句管理连接

6.2 错误处理 (`try-except`)