PyCharm 2025.3 Help

数据源和驱动程序对话框

启用 数据库工具和 SQL 插件

此功能依赖 数据库工具和 SQL 插件,默认在 PyCharm 中捆绑并启用。 如果相关功能不可用,请确保您未禁用该插件。

  1. Ctrl+Alt+S 打开设置,然后选择 插件

  2. 打开 已安装 选项卡,找到 数据库工具和 SQL 插件,并选中插件名称旁的复选框。

要访问 数据源和驱动程序 对话框,请执行以下任一操作:

  • 数据库 工具窗口中,点击 数据源属性 按钮 数据源属性按钮

  • 数据库 工具窗口中,点击 添加 按钮 添加按钮 ,然后导航到 数据源 | <data_source_vendor>

概述

数据源和驱动程序 对话框中,您可以管理您的 数据源 和数据库驱动程序。

数据源和驱动程序对话框

左侧窗格控件

当您在数据源和驱动程序列表中选择一项时,该项的设置会显示在对话框右侧。

工具栏

项目

快捷键

描述

添加按钮

Alt+Insert

创建数据源或驱动程序。

移除图标

Delete

从列表中移除所选项目。

复制图标

Ctrl+D

创建所选数据源或驱动程序的副本。

转到驱动程序图标

Ctrl+B

跳转到与所选数据源关联的驱动程序设置。

设为全局图标 移动到项目图标

将所选数据源移动到全局级别或项目级别。

有关全局和项目级别的更多信息,请参阅 数据源

后退图标 前进图标

在最近使用的项目之间切换。

上下文菜单

项目

快捷键

描述

添加按钮 添加

Alt+Insert

创建数据源或驱动程序。

    移除图标 移除

    Delete

    从列表中移除所选项目。

    复制图标 复制

    Ctrl+D

    创建所选数据源或驱动程序的副本。

    转到驱动程序图标 转到驱动程序

    Ctrl+B

    跳转到与所选数据源关联的驱动程序设置。

    设为全局图标 设为全局

    移动到项目图标 移至项目

    将所选数据源移动到全局级别或项目级别。

    有关全局和项目级别的更多信息,请参阅

    数据源

    更改驱动程序

    将数据源与驱动程序关联。

    重置更改图标 重置更改

    Ctrl+Alt+Z

    还原所选项目的更改。

    加载源

    为所选架构类别加载数据库对象的源代码。

    显示驱动程序用法图标 显示驱动程序使用情况

    Alt+F7

    显示使用所选驱动程序的数据源。

    数据源

    数据源 部分包含常规数据源和 DDL 数据源的设置。

    常规

    常规数据源的设置窗格包含以下选项卡: 常规选项SSH/SSL架构高级

    数据源和驱动程序对话框的常规选项卡

    有关管理和创建常规数据源的更多信息,请参阅 数据源。 要了解特定数据库的连接设置,请参阅相应主题。

    创建并配置不同数据库的数据源

    常规

    常规 选项卡包含您需要为数据库连接指定的设置。

    该选项卡中的字段和控件取决于 连接类型 列表中选定的选项。

    数据源和驱动程序对话框:数据源设置的常规选项卡

    项目

    描述

    连接类型

    用于数据库连接的连接类型。

    • 仅 URL

      此选项通常用于直接编辑数据库连接 URL。

      选择此选项时,仅以下字段可用: 用户密码URL

      您应直接在该字段中编辑 URL。 如有必要,您的用户名和密码应在相应字段中指定,或以适用于您正在使用的 JDBC 驱动程序的格式包含在 URL 中。

    • 其他连接类型

      使用其他任一选项(这些选项特定于数据库管理系统(DBMS))时,PyCharm 会使用 URL 字段上方字段中的信息自动生成数据库连接 URL。 在所有此类情况下,通常无需编辑 URL(当然,您也可以根据需要进行编辑)。

    驱动程序

    驱动程序 列表中指定用于该连接的驱动程序。

    文件

    数据库文件的路径。

    使用 打开 图标(打开图标 )选择现有数据库文件。

    保存 图标(保存按钮 )会创建数据库文件的副本,并将路径更改为副本位置。

    路径

    数据库文件或文件夹的路径。

    使用 打开 图标(打开图标 )选择现有数据库文件或文件夹。

    主机

    数据库所在计算机的主机名(域名)或 IP 地址(IPv4 或 IPv6)。 如果数据库位于您的本机,请指定 localhost 127.0.0.1

    如果您使用 SSH,数据库主机必须能从运行 SSH 代理的计算机通过指定的域名或 IP 地址访问。 请参阅 SSH/SSL 选项卡

    端口

    数据库端口号。

    数据库

    目标数据库或架构的名称。

    用户

    您的数据库用户帐户名称。

    密码

    用于 数据库用户 的密码。

    保存

    为密码字段保存设置。 您可以为密码存储选择以下选项:

    • 从不 :每次与数据库建立连接时都会提示输入密码。

    • 直到重启 :仅在当前 PyCharm 运行期间保存密码。 如果您退出 PyCharm 并重新打开,则需要再次提供密码。

    • 对于会话 :仅对当前与数据库的连接会话保存密码(直到您断开连接)。 您可以按 停用 图标(终止图标 )或 Ctrl+F2 来终止连接。

    • 永久 :密码保存在 PyCharm 存储中。 下次打开 PyCharm 时,您无需再次提供密码。

    • IDE 密码设置 :点击以访问 IDE 密码存储设置。 您也可以通过打开 外观与行为 | 系统设置 | 密码 设置页面&#xa0; Ctrl+Alt+S 来访问它们。 有关 IDE 密码设置的详细信息,请参阅 密码 主题。

    创建数据库

    向 URL 添加一个参数以创建数据库。 此选项仅在某些数据库管理系统中可用(例如 Apache Derby(嵌入式))。

    URL

    PyCharm 用于连接到数据库的 URL。 用于指定 URL 的用户界面取决于 连接类型 列表中所选的选项。

    测试连接

    验证数据库连接设置是否正确,以及 PyCharm 是否可以与数据库通信。 要复制通信信息,请点击 复制

    选项

    选项 选项卡包含数据库连接的设置。

    该选项卡上的字段和控件集取决于 连接类型 列表中选定的选项。

    数据源和驱动程序对话框:数据源设置的选项选项卡

    项目

    描述

    连接

    Read-only

    设置只读状态。 选中复选框以保护数据源,防止意外的数据修改。

    如果选中该复选框,您无法在 数据编辑器 中修改数据。

    如果驱动程序不支持只读状态,则可能可以在 查询文件 中进行数据修改。

    事务控制

    设置数据库事务的 隔离级别 以及事务的提交方式。

    • 自动 :当您将本地更改提交到数据库服务器时,当前事务会自动提交。

    • 手动 :提交到数据库服务器的更改会累积到一个事务中,该事务可以提交或回滚。

    切换架构

    定义 PyCharm 用于切换架构的模式。

    • 自动 :自动或手动切换架构。 启用此选项后,在 IDE 重启之间,先前配置的搜索路径或当前架构会自动恢复。

    • 手动 :仅手动切换架构。

    • 禁用 :不切换架构。

    时区

    选择与该数据源一起使用的时区。 例如,选择您的数据源所连接主机的时区。

    单会话模式

    启用 单会话模式。 单会话模式 表示该数据源和所有 查询文件 使用同一会话。 此模式允许您在数据库树中查看临时对象,或在不同的 查询文件 中使用同一事务。 有关 查询文件 的详细信息,请参阅 查询文件

    保持活动查询的运行间隔

    运行保活查询以保持连接活动。 对于不受支持的数据库,您可以在驱动程序设置中定义自定义查询。

    此时间后自动断开

    在指定的秒数后与数据库断开连接。

    单数据库模式(S)

    在数据库树视图中,仅显示并启用您在连接设置中指定的数据库。

    当您连接到数据源时,PyCharm 可以检索并显示该数据源拥有的所有数据库。 但在某些情况下(例如 PgBouncer 的某些设置),您只能或仅被允许使用某个特定数据库。 在启用 单数据库模式(S) 的数据库树视图中,您只能看到在连接设置中指定的数据库。

    建议在 PostgreSQL、Azure SQL Database、Greenplum、Amazon Redshift 中使用此设置。

    启动脚本

    每次建立连接时运行一条 SQL 查询。

    要在启动脚本中使用 内置 IDE 宏 ,请点击 插入宏

    注意 :如果清除 单会话模式 复选框,则每个新的 查询文件 都会创建一个新的连接。

    自省

    自动同步

    自动同步数据库的实际状态。 数据库的状态指的是您在 数据库 工具窗口中看到的数据库树视图。

    如果选中 自动同步 复选框,则会自动更新数据源的视图:

    • 当您在 数据源和驱动程序 对话框中点击 确定 时。

    • 当您在与该数据源关联的 查询文件 中运行 DDL SQL 语句时。

      从 2024.2 版本开始,对于 Oracle 和 Microsoft SQL Server,PyCharm 会分析查询可能修改的对象,并仅刷新这些对象的集合。

    如果清除了 自动同步 复选框,则仅当您在工具栏中点击 刷新 按钮 刷新按钮 或按下 Ctrl+F5) 时, 数据库 工具窗口中的数据源视图才会与数据库的实际状态同步。

    加载以下对象的源

    为所选架构类别加载视图、过程、包及其他数据库对象的源代码:所有架构(所有架构 )、除系统架构外的所有架构(除系统架构之外的所有架构 ),或禁用该功能()。

    要同时更改多个数据源的此设置,请选择相应的数据源。 右键点击所选项,转到 加载源 并选择一个选项。

    默认级别

    数据库对象的默认自省级别。

    使用会话模板

    选择一个用于您的会话的 模板

    编辑过时的DDL 时发出警告

    当缓存的 DDL 与数据库中的实际 DDL 不同时显示通知。

    每次打开源代码时,PyCharm 都会显示在索引过程中加载的一个版本。 但如果有人在另一台工作站上更改了源代码,已索引的版本就会过时。

    如果您的版本早于数据库中的版本,您将看到以下通知: Cached object differs from the object in the database

    跟踪数据库/架构创建和删除

    当您创建、删除或重命名架构时,PyCharm 会更新自省范围窗口中可用架构的列表。 要查看自省范围,请点击 数据库 工具窗口中数据源名称附近的按钮。

    自省范围窗口

    为没有内省的系统目录使用预内省的对象

    切换是否对系统目录使用预先自省的对象。

    有关自省和系统目录的更多信息,请参阅 来自系统目录的预先内省对象

    自动自省间隔 N 分钟

    按指定的分钟数间隔为该数据源运行一次自省。

    虚拟对象和特性

    定义 external-data.xml 的路径,它存储虚拟外键的关系、虚拟列的表达式及虚拟视图的语句。

    有关虚拟数据库对象的更多信息,请参阅 虚拟对象部分主题

    其他

    代码样式

    选择要用于架构的代码样式。 有关代码样式自定义的更多信息,请参阅 Code styles for SQL

    连接前

    选择 PyCharm 在首次连接之前将执行的任务(在启动 JDBC 驱动程序工作的进程时)。 任务按顺序运行。

    会话模板

    为您的会话创建模板。 模板设置将覆盖数据源的常规连接设置。 在模板中,您可以设置以下选项: 身份验证只读启动脚本驱动程序

    SSH/SSL

    SSH/SSL 选项卡包含用于 SSHSSL 连接的设置。

    数据源和驱动程序对话框:数据源设置的 SSH/SSL 选项卡
    SSH

    项目

    描述

    使用SSH 隧道(H)

    选中此复选框以启用通过 SSH 进行连接。 然后从列表中选择一个已创建的 SSH 配置,或点击 浏览按钮 并按照 创建 SSH 配置 中所述创建新配置。

    SSH 配置

    选择用于该连接的 SSH 配置。

    要创建新的 SSH 配置,请点击 添加 SSH 配置 按钮(浏览按钮)。 或者按 Shift+Enter

    要复制现有 SSH 配置,请点击 复制 按钮(复制配置按钮按钮)。

    SSL

    项目

    描述

    使用 SSL 隧道

    启用用于配置 SSL 连接的设置。

    复制自

    从现有数据源复制 SSH 设置。

    点击该链接并选择相应的数据源。

    CA 文件(A)

    指定 SSL 证书颁发机构(CA)证书文件的路径。 证书文件必须与服务器使用的证书相同。

    使用信任库

    选择信任库以使用其中包含的证书。

    • IDE :使用 IDE 信任的证书。 您可以在 设置 | 外观与行为 | 系统设置 | 服务器证书 中添加新的受信任的证书。

    • JAVA :使用 JAVA 信任库证书。

    • 系统 :使用系统信任库证书。

    JAVA系统 证书可能需要更新。

    客户端证书文件

    指定您的(客户端)公钥证书文件的路径。

    客户端密钥文件(K)

    指定您的(客户端)私钥文件的路径。

    架构

    选择要在 数据库 工具窗口中显示的数据库和 架构

    数据源和驱动程序对话框:数据源设置的架构选项卡

    项目

    描述

    刷新按钮

    刷新数据库和架构的列表。

    全部展开按钮

    展开所有树中的所有节点。

    全部折叠按钮

    折叠所有树中的所有节点。

    筛选字段

    筛选树中的内容。 仅显示名称包含指定文本的数据库和架构。

    架构模式(P)

    定义一个模式以选择所需的数据库和架构。 要获取可用语法的信息,请将插入符放入该字段并按 Ctrl+Q

    • @ :当前数据库或架构。

    • * :每个数据库或架构。 您可以在 *: 之后列出架构。

    请考虑以下示例:

    • *:* :所有数据库中的所有架构。

    • @:* :当前数据库中的所有架构。

    • @:@ :仅当前架构。

    • *:dbo|@:@|db1:s1,s2,s3 :所有数据库中的 dbo 架构、当前架构、 db1 数据库中的架构 s1,s2,s3

    对象筛选器(F)

    为每个数据源限制在 数据库 工具窗口中显示的表及其他数据库对象的集合。

    例如,如果将解析范围限制为 table:actor.* ,则只有 actor 表可在 数据库 工具窗口中访问(视图(V) | 工具窗口 | 数据库)。

    所有其他表都将不在解析范围内。 PyCharm 不会解析未在 数据库 工具窗口中显示的对象。

    对象未解析

    对象筛选器(F) 字段编写表达式时,请使用以下模式。

    <type>:[-]<pattern> ,其中:

    • <type> 可以是 aggregate、collation、event、fdw、ftable、mview、operator、package、role、routine、sequence、synonym、table、user、view、vtable。

    • <pattern> 是正则表达式。 要排除某个项,请在前面加上 - (减号)。 有关正则表达式的更多信息,请参阅 Class Patterns at JavaTM 2 Platform Standard Edition 5.0 API Specification。

    显示内部系统架构

    显示或隐藏内部系统架构(例如, pg_toastpg_temp)。 该选项仅适用于 PostgreSQL。

    显示模板数据库

    显示或隐藏模板数据库(例如, template1template0)。 该选项仅适用于 PostgreSQL。

    高级

    数据源和驱动程序对话框:数据源设置的高级选项卡

    高级 选项卡包含 JVM 数据库驱动程序的数据库连接属性、选项和环境变量。

    高级 选项卡上的表格显示一组连接选项,这些选项以键值对的形式传递给数据库驱动程序。

    当您选择 名称 列中的单元格时,相应选项的说明会显示在表格下方。

    要添加一行,请开始编辑最后一行中的值,其中 <user defined> 和 <value> 显示。 新行会自动添加到表中。

    项目

    描述

    虚拟机选项

    数据库驱动程序的 JVM 选项。

    对于某些 Oracle Database 版本(例如 Oracle 版本 9),当您与数据库服务器处于不同时区时,可能会出现连接问题。 您可以在 VM 选项 字段中指定您时区的时间偏移量(例如, -Duser.timezone=UTC+03:00)。 或者,在 高级 选项卡的表格中将变量 oracle.jdbc.timezoneAsRegion 设置为 false

    虚拟机环境

    数据库驱动程序 JVM 的环境变量。

    例如,可以通过设置 NLS_LANG 变量(如 NLS_LANG=Russian_CIS.CL8MSWIN1251 )来解决 Oracle 数据库中的编码相关问题。 有关更多信息,请参阅 Oracle NLS_LANG FAQ

    工作目录

    处理与数据源交互的进程的工作目录。 此外,所有相对路径都相对于此目录进行解析(例如,驱动程序属性中的路径)。

    例如,如果您创建类似 SQLite 的基于文件的数据库且未为 SQLITE 文件设置路径,则该文件将在此工作目录中创建。

    有关更多信息,请参阅您的 DBMS 文档。

    DDL 数据源

    DDL 数据源由其名称定义,并且可以引用一个或多个 DDL 文件以及另一个数据源(父数据源)。

    项目

    描述

    名称

    数据源名称。

    包含所需 DDL 定义的文件列表。

    • 添加按钮 Alt+Insert。 向数据源定义添加一个或多个 DDL SQL 文件。 在打开的对话框中,选择所需的文件。

    • 移除按钮Alt+Delete)。 从列表中移除所选文件。

    • 上移按钮Alt+Up)。 将所选文件在列表中上移一行。

    • 下移按钮Alt+Down)。 将所选文件在列表中下移一行。

    扩展

    您可以在 扩展 列表中选择另一个数据源作为父级。 这样,您正在编辑的数据源将继承其父级的所有 DDL 定义。

    如果您不想使用父数据源,请选择 <无>

    数据源和驱动程序对话框中的云选项卡

    配置

    连接设置取决于云提供商。 有关这些设置的更多信息,请参阅 部分中该提供商的主题。

    项目

    描述

    测试连接

    验证云提供商的连接设置是否正确,以及 PyCharm 是否可以与其中的帐户建立连接。

    下一步:选择数据库

    切换到 数据库 选项卡,PyCharm 会在其中显示云提供商帐户中可用的数据库。

    数据库

    在该选项卡的数据库窗格中,PyCharm 会显示云提供商帐户中可用的数据库。

    项目

    描述

    搜索数据库图标 搜索数据库

    筛选数据库列表。 仅显示名称包含指定文本的数据库和架构。

    刷新数据库图标

    刷新云提供商中存储的数据库列表。

    创建数据源

    为数据库窗格中选定的数据库创建数据源,并自动填充其连接设置。

    驱动程序

    驱动程序的设置窗格包含以下选项卡: 常规选项高级

    常规

    常规 选项卡包含驱动程序文件、URL 模板和驱动程序类的设置。

    数据源和驱动程序对话框:驱动程序设置的常规选项卡

    项目

    描述

    要使用的驱动程序类的完全限定名。

    驱动程序文件

    PyCharm 使用 JDBC 驱动程序 与数据库交互。 您可以从 PyCharm 驱动程序存储库下载并使用驱动程序,或指定存储在您计算机上的驱动程序。

    要下载并使用最新的驱动程序版本,请点击 下载版本 N 链接。

    您也可以指定并使用具有特定版本号的驱动程序。 点击 版本 <version_number> 链接并选择您要使用的驱动程序版本。 所选版本将自动下载并应用。

    您可以使用计算机上已可用的驱动程序。 在这种情况下,请点击 添加 按钮(添加按钮 ),并选择驱动程序文件(JAR 扩展名)。

    URL 模板

    用于构建数据库 URL 的模板。 花括号中的文本表示变量。 请考虑以下示例:

    • {host} :数据库主机的域名或 IP 地址。

    • {port} :数据库端口号。

    • {database} :数据库或架构的名称。

    可选片段位于方括号中,例如, [:{port}]

    模板名称与 URL 选项列表 中选项的名称相对应。

    选项

    数据源和驱动程序对话框:驱动程序设置的选项选项卡

    项目

    描述

    连接

    事务控制

    设置数据库事务的 隔离级别 以及事务的提交方式。

    • 自动 :当您将本地更改提交到数据库服务器时,当前事务会自动提交。

    • 手动 :提交到数据库服务器的更改会累积到一个事务中,该事务可以提交或回滚。

    切换架构

    定义 PyCharm 用于切换架构的模式。

    • 自动 :自动或手动切换架构。

    • 手动 :仅手动切换架构。

    • 禁用 :不切换架构。

    启动脚本

    每次建立连接时运行一条 SQL 查询。

    注意 :如果清除 单会话模式 复选框,则每个新的 查询文件 都会创建一个新的连接。

    保持活动查询

    用于保持连接活动的保活查询。

    自省

    自动同步

    自动同步选项 的默认设置。

    加载以下对象的源

    为所选架构类别加载数据库对象的源代码。

    发送应用程序信息

    连接到数据库服务器时,若选中此复选框,PyCharm 会发送有关自身的信息。

    连接

    方言

    与相应数据源关联的 SQL 方言。

    代码样式

    选择要用于使用此驱动程序的数据源的代码样式。 有关代码样式自定义的更多信息,请参阅 Code styles for SQL

    设置同步源的格式

    同步后将代码样式应用于数据库对象的源代码。

    高级

    高级 选项卡包含 JVM 选项、环境变量,以及可以作为键值对传递给数据库驱动程序的选项。

    要开始编辑表中的值,请双击相应的 字段。

    要添加一行,请开始编辑最后一行中的值,其中 <user&#xa0;defined> 和 <value> 显示。 新行会自动添加到表中。

    数据源和驱动程序对话框:驱动程序设置的高级选项卡

    项目

    描述

    VM 选项

    数据库驱动程序所运行的 JVM 的默认选项。 驱动程序作为 JVM 中的单独进程启动。

    VM 环境

    数据库驱动程序 JVM 的环境变量。

    例如,可以通过设置 NLS_LANG 变量(如 NLS_LANG=Russian_CIS.CL8MSWIN1251 )来解决 Oracle 数据库中的编码相关问题。 有关更多信息,请参阅 Oracle NLS_LANG FAQ

    专家选项

    项目

    描述

    禁用增量内省

    不执行增量自省。 此选项适用于 Oracle、Microsoft SQL Server、PostgreSQL 等类似数据库。

    使用增量自省时,自省器会检测上一次自省后数据库中发生变化的对象,并仅加载这些对象。 启用此选项后,自省器将始终加载所有对象。 这可能会大幅增加自省时间。

    不在对pgdatabase 的查询中使用 xmin

    在对 pg_database 表的查询中不要使用 xmin 属性。 当 pg_database 中缺少 xmin 时,请使用此变通方法。 请注意,您的数据库可能已损坏。 此选项仅适用于 PostgreSQL。

    使用JDBC 元数据内省(M)

    切换到基于 JDBC 的自省器。 适用于所有数据库。

    为检索数据库对象(DB 元数据)信息,PyCharm 使用以下自省器:

    • 原生自省器(对于某些 DBMS 可能不可用)。 原生自省器使用特定于 DBMS 的表和视图作为元数据来源。 它可以检索特定于 DBMS 的详细信息,并提供更精确的数据库对象信息。

    • 基于 JDBC 的自省器(适用于所有 DBMS)。 基于 JDBC 的自省器使用 JDBC 驱动程序提供的元数据。 它只能检索有关数据库对象及其属性的标准信息。

    当原生自省器失败或不可用时,请考虑使用基于 JDBC 的自省器。

    当您的数据库服务器版本早于 PyCharm 支持的最低版本时,原生自省器可能会失败。

    您可以尝试切换到基于 JDBC 的自省器,以修复从数据库检索数据库结构信息时出现的问题。 例如,当数据库中存在的架构或架构级以下的数据库对象未在 数据库 工具窗口中显示时。

    隔离类路径

    隔离 JDBC 驱动程序使用的类路径。

    使用 IDE 代理设置

    将 IDE 代理设置传递给 JDBC 进程。

    Kubernetes

    使用 PyCharm,您可以连接到在 Kubernetes 集群中运行的数据库。

    对于不具有专用端口的嵌入式数据库(例如, SQLite、Apache&#xa0;Derby 或 HSQLDB), Kubernetes 选项卡不可用。

    项目

    描述

    使用Kubernetes 端口转发

    启用端口转发。

    集群

    选择要使用的 Kubernetes 集群。

    命名空间

    选择命名空间,该命名空间决定可用的资源集合。

    资源类型

    选择资源类型。

    资源

    选择要连接的资源。

    主机端口

    输入用于转发数据的本地端口。

    容器端口

    输入集群资源的远程端口。

    DDL 映射

    数据源和驱动程序对话框:DDL 映射设置列表

    项目

    描述

    名称

    DDL 映射的名称。

    数据源

    设置常规数据源。

    DDL 数据源

    设置 DDL 数据源。

    范围

    设置将映射到 DDL 数据源 SQL 文件的常规数据源数据库对象的范围。

    问题

    数据源与驱动程序 对话框中,如果检测到您的数据源存在潜在问题, 问题 菜单选项旁会显示一个数字。 点击 问题 将显示问题列表以及解决这些问题的选项。

    检测到问题
    最后修改日期: 2025年 12月 2日