如何在Django的cursor.execute()中使用\dt获取PostgreSQL数据库表？

问题根源 #

\dt是PostgreSQL命令行客户端psql的专属元命令，并非标准SQL语句。Django的cursor.execute()仅支持执行标准SQL，因此直接调用会触发语法错误。

正确实现方式 #

方法1：查询系统视图（标准SQL兼容方案） #

通过查询PostgreSQL内置的information_schema.tables视图获取表信息，这是跨数据库兼容的通用写法：

from django.http import HttpResponse
from django.db import connection

def test(request):
    cursor = connection.cursor()
    # 查询public schema下的用户自定义表（排除系统表）
    cursor.execute("""
        SELECT table_name 
        FROM information_schema.tables 
        WHERE table_schema = 'public'
        ORDER BY table_name;
    """)
    tables = cursor.fetchall()
    # 遍历打印表名
    for table in tables:
        print(table[0])
    
    return HttpResponse(f"已找到 {len(tables)} 张表")

方法2：使用Django内置数据库内省工具 #

Django提供了封装好的数据库内省API，更贴合Django开发习惯：

from django.http import HttpResponse
from django.db import connection

def test(request):
    # 获取数据库内省实例
    introspection = connection.introspection
    # 直接获取当前数据库的所有表名
    table_names = introspection.table_names()
    print(table_names)
    
    return HttpResponse(f"已找到 {len(table_names)} 张表")

方法3：使用psycopg2原生游标（可选） #

如果一定要模拟psql元命令的效果，可以借助psycopg2的原生游标，但该方法依赖特定驱动，兼容性较差，不推荐生产环境使用：

from django.http import HttpResponse
from django.db import connection

def test(request):
    with connection.cursor() as cursor:
        # 获取psycopg2原生游标
        pg_cursor = cursor.cursor
        # 执行psql元命令
        pg_cursor.execute("\\dt")
        results = pg_cursor.fetchall()
        print(results)
    
    return HttpResponse("执行完成")

内容的提问来源于stack exchange，提问作者Super Kai - Kazuya Ito