Positron 教程5 --- 数据库连接

写在前面

Positron 是 Posit 公司开发的新一代数据科学 IDE，为 Python 和 R 语言提供了全方位数据科学支持，同时还提供了 AI 辅助功能。本系列推文为 Positron IDE 官方文档的中文笔记，软件可能随时更新，建议配合官方文档一起阅读。

官网教程：https://positron.posit.co/connections-pane.html

目录

• 1 连接窗格

  • 1.1 探索数据库模式

  • 1.2 创建新连接

  • 1.3 从变量窗格探索连接

• 2 扩展连接窗格

  • 2.1 添加新连接类型

  • 2.2 扩展“新建连接”模态框

• 3 目录浏览器

1 连接窗格

连接窗格（Connections pane）允许您管理和探索数据库连接，以便在 Python 和 R 会话中使用。您可以创建与数据库的连接，探索其模式，并交互式地预览数据库表。

Connections pane

1.1 探索数据库模式

一旦创建了新连接，您就可以使用连接窗格来探索数据库模式。

Connections pane showing database schema, tables, and columns

您可以浏览数据库模式，查看表、列及其数据类型。您还可以选择表图标，在数据资源管理器中预览数据库内容。

1.2 创建新连接

您可以通过 UI 或使用 Python/R 代码创建与数据库的新连接。

1.2.1 通过 UI 创建新连接

要打开新连接，请选择连接窗格中的New connection按钮。这将打开一个模态框，允许您选择连接类型并填写连接详细信息。此模态框会生成在 Python 或 R 会话中打开连接所需的代码。

New connections modal

当您创建新连接时，Positron 会存储并管理连接字符串以供将来使用。

1.2.2 使用 R 创建连接

要在 Positron 连接窗格中创建连接，您需要使用支持连接合约的包连接到数据库，例如 odbc、sparklyr、bigrquery 等。

Positron 连接窗格实现了 RStudio 的连接合约；这意味着任何在 RStudio 连接窗格中工作的包都应在 Positron 连接窗格中工作。

以下是使用 connections 包打开 SQLite 连接的示例：

con <- connections::connection_open(RSQLite::SQLite(), "nycflights13.sqlite")

从变量窗格选择连接对象，或使用connections::connect_view(con)打开连接窗格。

您可以从 Posit Solutions Engineering 找到有关连接到特定数据库的更多信息。

1.2.3 使用 Python 创建连接

可以使用以下方式创建连接：

• sqlite3

• SQLAlchemy

• duckdb

• SQL Server via pymssql or pyodbc

• Databricks SQL Connector

• Snowflake Connector

• Google BigQuery

• AWS Redshift

要在连接窗格中打开连接，请创建一个表示连接/引擎的顶级对象：

import sqlite3 conn = sqlite3.connect("nycflights13.sqlite")

然后您可以使用%connection_show conn在连接窗格中打开连接，或从变量窗格中打开它。

1.3 从变量窗格探索连接

您可以从变量窗格打开从 Python 或 R 创建的现有连接。

Variables pane showing a connection object

选择数据库图标以调出连接窗格，从而允许您浏览数据库。

2 扩展连接窗格

连接窗格可通过以下方式进行扩展：

• 在连接窗格中添加对浏览和管理新连接类型的支持

• 扩展“新建连接”模态框以支持创建新类型的连接

2.1 添加新连接类型

在 R 中，您可以使用 RStudio 连接合约来扩展连接类型。有关如何实现新连接类型的更多信息，请参阅 RStudio 连接合约文档。

对于 Python，Positron 目前不支持外部扩展机制。连接窗格可以通过实现Connection类的子类（在connections.py中定义）并向 Positron 仓库提交 PR 来扩展。请参考SQLite3Connection作为示例。

2.2 扩展“新建连接”模态框

“新建连接”模态框允许用户轻松创建与不同数据库的连接。它通过提供一个表单来帮助用户填写连接详细信息，从而创建连接。

该模态框可以通过为 Positron 创建扩展来扩展；更多信息请参阅扩展开发文档。

为了使扩展支持新的连接类型，它需要实现并注册一个positron.ConnectionsDriver。驱动程序提供有关连接类型的元数据，并实现用于安装创建连接所需依赖项、连接数据库和断开连接的回调函数。

相关定义可以在positron.d.ts中找到，搜索ConnectionsDriver：

export interface ConnectionsDriver { /** * The unique identifier for the driver. */ driverId: string; /** * The metadata for the driver. */ metadata: ConnectionsDriverMetadata; /** * Generates the connection code based on the inputs. */ generateCode?: (inputs: Array<ConnectionsInput>) => string; /** * Connect session. */ connect?: (code: string) => Promise<void>; /** * Checks if the dependencies for the driver are installed * and functioning. */ checkDependencies?: () => Promise<boolean>; /** * Installs the dependencies for the driver. * For instance, R packages would install the required * R packages, and or other dependencies. */ installDependencies?: () => Promise<boolean>; }

要注册驱动程序，扩展需要调用positron.connections.registerConnectionDriver()，并将驱动程序实例作为参数传入。

有关在 Positron Connections 扩展中实现的驱动程序示例，请参阅drivers.ts。

3 目录浏览器

重要提示：
Catalog Explorer 是一个实验性功能。通过 catalogExplorer.enabled 设置选择启用，然后重启 Positron 以应用更改。

目录浏览器（Catalog Explorer）提供了一个用于在数据目录系统中浏览数据的界面。支持 Snowflake Horizon Catalogs 和 Databricks Catalogs。您可以在树形视图中浏览目录、模式和表，并复制 Python 和 R 代码片段以预览数据。

3.1 添加目录提供商

1. 使用Ctrl+Shift+P打开命令面板

2. 运行Catalogs: Add Catalog Provider

3. 选择您的目录类型（例如 Snowflake、Databricks）

4. 输入您的账户凭据

对于 Snowflake 连接，Catalog Explorer 会在connections.toml文件中查找配置。默认路径为$SNOWFLAKE_HOME，但您可以通过设置catalogExplorer.snowflakeConnections来配置此文件的保存位置。

3.2 处理表

Catalog Explorer 与连接窗格的不同之处在于，它提供了一次查看多个仓库和表的视图。在连接到特定表之前，它对于快速浏览许多不同的表特别有用。在 Catalog Explorer 中，右键单击表可以执行以下操作：

• 在活动会话中预览表：使用活动控制台加载数据预览

• 使用 Python 预览表：复制 Python 代码以访问表并打印列名

• 使用 R 预览表：复制 R 代码以访问表并打印列名

3.3 处理文件

除了支持表之外，Catalog Explorer 还支持预览和下载 CSV 等文件。右键单击 CSV 文件可以执行以下操作：

• 打开方式…：在数据资源管理器中预览文件

• 在活动会话中下载文件：使用活动控制台将文件下载到本地计算机

• 复制路径：根据目录中的位置复制文件路径

• 使用 R 下载文件：使用活动的 R 控制台将文件下载到本地计算机

• 使用 Python 下载文件：使用活动的 Python 控制台将文件下载到本地计算机

3.4 移除目录提供商

选择提供商名称旁边的垃圾桶图标将其移除，或从命令面板运行Catalogs: Remove Catalog Provider。

3.5 设置

--------------- 结束 ---------------

注：本文为个人学习笔记，仅供大家参考学习，不得用于任何商业目的。如有侵权，请联系作者删除。