# 数据提取工具

> For the complete documentation index, see [llms.txt](https://www.jetbrains.com.cn/help/idea/llms.txt).

Procedure: 启用 数据库工具和 SQL 插件

此功能依赖于 数据库工具和 SQL 插件，该插件默认情况下在 IntelliJ IDEA 中绑定并启用。 如果相关功能不可用，请确保您没有禁用插件。

> **Note:**
> 没有 Ultimate 订阅时，数据库工具和 SQL 的功能支持在 IntelliJ IDEA 中受限。

1. 按 `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS)) 打开设置，然后选择  `插件` 。

2. 找到  数据库工具和 SQL  插件并点击   启用  。

数据提取器  设置复制或查看编辑器中的数据显示规则（在   文本  编辑器视图模式下）。 您可以从   数据提取器   列表中选择默认 extractor，该列表位于   导出数据   图标附近 ( ![导出数据图标](https://resources.jetbrains.com.cn/help/img/idea/2026.3/app-client.expui.general.download.svg))，配置现有的 extractor，或者使用 Groovy 或 JavaScript 创建自定义 extractor。

![数据编辑器工具栏上的 Data extractor 列表](https://resources.jetbrains.com.cn/help/img/idea/2026.3/db_toolbar_data_extractors_list.png)

最后选择的提取器将成为新打开编辑器选项卡的默认提取器。 对于 MongoDB 来说，默认的提取器总是 JSON。

在以下视频中，数据使用   逗号分隔值   数据提取器复制，并通过   文本   编辑器视图模式使用   SQL 更新   和   管道符分隔   数据提取器查看。

[Video](https://resources.jetbrains.com.cn/help/img/idea/2026.3/db_data_extractors_to_copy_and_view_data.mp4)

使用数据提取工具，您可以以 SQL 语句和不同格式导出数据库数据。 导出到文件时，会为每个表或视图创建一个单独的文件。 有关导出详情，请参阅 [导出部分](export-data.html)。

## 支持的文件格式

可用脚本和支持的文件格式列表如下：

* 预定义脚本。 使用它们将数据导出为一组 `INSERT` 或 `UPDATE` 语句、 [TSV 和 CSV](https://en.wikipedia.org/wiki/Delimiter-separated_values) 文件、 [Excel XLSX](https://en.wikipedia.org/wiki/Microsoft_Excel) 文件、 [Markdown](https://en.wikipedia.org/wiki/Markdown)、HTML 表格以及 [JSON](https://en.wikipedia.org/wiki/JSON) 格式。 1. 内置 | 脚本 | 文件格式 | | --- | --- | | SQL 插入 | `.sql` | | SQL 更新 | | Where 子句 | 2. 逗号分隔值 | 脚本 | 文件格式 | | --- | --- | | 逗号分隔值 | `.csv` | | 制表符分隔值 | `.tsv` | | 管道符分隔 | `.txt` | 您可以使用 [CSV format configurations](#creating-a-dsv-based-extractor)来创建基于 CSV 或任何 DSV 格式的自定义格式。 3. 脚本化 | 脚本 | 文件格式 | | --- | --- | | 逗号分隔值 | `.csv` | | 制表符分隔值 | `.tsv` | | Excel | `.xlsx` ， `.xls` | | HTML (groovy) | `.html` | | HTML（js） | | JSON | `.json` | | Markdown | `.md` | | 单行 | `.sql` | | SQL-Insert-Multirow | | SQL-Insert-Statements | | 漂亮 | `.txt` | | XML | `.xml` |

* [自定义数据提取器。](#add-a-custom-extractor) 使用 Groovy 或 JavaScript 以及提供的 API 创建它们。

## 配置分隔符分隔值的提取器

可以扩展默认功能性，并基于 CSV 或任何 DSV 格式创建自己的格式。 在其设置中，您可以为行和标题设置分隔符，定义 NULL 值的文本，指定引号，为带分隔符的格式创建新的提取器。

Procedure:

1. 从数据提取器列表中选择   配置 CSV 格式  。

2. 在   CSV 格式  对话框中，点击   添加格式设置  图标 ![添加格式图标](https://resources.jetbrains.com.cn/help/img/idea/2026.3/app.expui.general.add.svg)。

3. 指定新格式的名称（例如，  `Confluence Wiki 标记` ）。

4. 定义格式设置：设置行和头部的分隔符，定义 NULL 值的文本，指定引用。 点击   OK  。

创建格式后，您可以在   导出数据   图标（ ![导出数据图标](https://resources.jetbrains.com.cn/help/img/idea/2026.3/app-client.expui.general.download.svg)）附近的下拉列表中选择它。

[Video](https://resources.jetbrains.com.cn/help/img/idea/2026.3/db_configure_extractors_for_dsv.mp4)

有关   CSV 格式   对话框的更多信息，请参见 [参考](#csv_formats_dialog)。

## 添加自定义提取器

您可以创建在 Groovy 或 JavaScript 上编写的您自己的 extractor。

在 [GitHub 仓库](https://github.com/DataGrip/dg-scripted-extensions-environment) 中找到一个用于脚本化扩展开发的预配置项目。

Procedure:

1. 在   项目   工具窗口中，导航到  `Scratches and Consoles | Extensions | 数据库工具和 SQL | data | extractors` 。

2. 右键点击   提取器  节点并选择  `新建 | 文件` 。

3. 输入文件名称（例如，  `PHP.array.groovy` ），其中：

* `PHP` ：用于提取器菜单中的名称。

* `数组` ：提取器的输出。

* `groovy` ：脚本的扩展名。

4. 在新文件中键入或粘贴提取器的代码。 您可以使用  `提取器`  文件夹中其他提取器的代码来编写您的提取器。 此外，您可以尝试以下提取器：

* [TSV-Icelandic-Groovy.tsv.groovy on GitHub](https://gist.github.com/siggibjarna/ca15688a319771a309078fdd4577deee)：复制制表符分隔的查询结果并将其粘贴到 Excel 中作为逗号分隔的内容。

* [Dbunit Dataset Export in Groovy on GitHub](https://gist.github.com/ssmusoke/ca4c55b4e52de97acb99a590644a677f)：用于 Dbunit 导出的提取器。

* [Table-Text-Groovy.txt.groovy](https://gist.github.com/mvitaly/106347c5edfa6614d5311b228b4446c9) 和 [Fixed-length-fields.txt.groovy](https://github.com/aukevanleeuwen/intellij-extractors/blob/master/Table-Text-Groovy.txt.groovy)：生成具有定长列的 txt 文件的提取器。

* [PHP-Array.groovy](https://gist.github.com/pthiers/6afa65b68947770e5b7ec07bec2117f2)：提取到 PHP 数组。

* [Markdown-JavaScript.markdown.js](https://gist.github.com/jimschubert/a9dc46dafc891227f25d82a934a7df72)：一个提取到 Markdown 的工具。

5. 请从提取器列表中选择提取器。

请考虑以下在 IntelliJ IDEA 中添加 PHP 数组提取器的示例。

## 自定义数据提取器的 API

使用以下 API 创建自定义数据提取器。

|     绑定     |     方法（Groovy 和 JavaScript）     |     描述     |
| --- | --- | --- |
|   `DIALECT`   |      `getDbms()`  然后是以下方法之一：        * `isOracle`    * `isMysql`    * `isPostgres`    * `isBigQuery`    * `isRedshift`    * `isGreenplum`    * `isVertica`    * `isMicrosoft`    * `isSybase`    * `isDb2`    * `isHsqldb`    * `isH2`    * `isDerby`    * `isSqlite`    * `isExasol`    * `isClickHouse`    * `isCassandra`    * `isHive`    * `isSpark`    * `isSnowflake`    * `isMongo`    * `isCouchbase`    * `isCockroach`    * `isTransactSql`    * `isDocumentOriented`    |     数据库方言     |
|   `TABLE`   |      * `getName()`    * `getParent().getName()`    |     数据库表元数据     |
|   `ALL_COLUMNS`   |      * `int columnNumber()`    * `String name()`    |     查询结果或当前打开的表编辑器中所有列的列表。     |
|   `列`   |      * `int columnNumber()`    * `String name()`    |     查询结果或当前打开的表编辑器中的选定列列表。     |
|   `格式化器`   |      * `format(Row, Column)`    * `formatValue(Object, Column)`    * `getTypeName(Object, Column)`    * `isStringLiteral(Object, Column)`    |     默认格式化方法。     |
|   `OUT`   |      `append(String)`      |     提取器输出。     |
|   `行`   |      * `int rowNumber()`    * `boolean first()`    * `boolean last()`    * `java.util.List<java.lang.Object> data()`    * `Object value(Column)`    |   `行数据流。`   |
|     转置     |  |     指示表格编辑器是否处于转置模式的布尔值。     |

### 示例

您可以使用以下简单的 CSV 数据提取器作为自定义数据提取器的基础。 此数据提取器的完整版可在 IntelliJ IDEA 中使用。 要定位它，请在   项目  工具窗口中导航到  `Scratches and Consoles | Extensions | 数据库工具和 SQL | data | extractors` 。

```
ROWS.each {
    row -> COLUMNS.eachWithIndex { column, i ->
        if (i > 0) OUT.append(",")
        OUT.append(FORMATTER.format(row, column))
    }
        OUT.append("\n")
}

```

## 参考

### CSV 格式对话框

要访问此对话框，请点击工具栏上的   数据提取器  列表并选择   配置 CSV 格式  。

此对话框包含用于将表格数据转换为分隔符分隔值格式（例如，CSV、TSV）以及反向转换的设置。

预览限制为 10 条记录，以防止加载其余数据。 当您更改设置时，预览会相应地变化。

|  条目  |  描述  |
| --- | --- |
|  格式设置其他  |     选择可将文件数据成功转换为表格的模板。 您可以更改预定义模板的设置或添加新模板。 要添加模板，请点击   添加格式设置   按钮 ( ![添加格式图标](https://resources.jetbrains.com.cn/help/img/idea/2026.3/app-client.expui.general.add.svg))。       使用   添加格式设置   ( ![](https://resources.jetbrains.com.cn/help/img/idea/2026.3/app-client.expui.general.add.svg))、   移除格式设置   ( ![](https://resources.jetbrains.com.cn/help/img/idea/2026.3/app.expui.general.remove.svg))、   向上   ( ![](https://resources.jetbrains.com.cn/help/img/idea/2026.3/app.expui.general.up.svg)) 和   向下   ( ![](https://resources.jetbrains.com.cn/help/img/idea/2026.3/app.expui.general.down.svg)) 按钮来创建、删除和重新排序格式；   复制格式设置   ( ![复制格式图标](https://resources.jetbrains.com.cn/help/img/idea/2026.3/app-client.expui.general.copy.svg)) 来创建所选格式的副本。     |
|  值分隔符  |  选择或输入要用作值分隔符的字符。  |
|  行分隔符  |  选择或输入要用作行分隔符的字符。  |
|  Null 值文本  |  选择或输入当单元格包含  `NULL`  值时要使用的文本。  |
|  添加行前缀/后缀  |  点击链接并输入行前缀和后缀。 前缀和后缀是字符序列，除了行分隔符之外，还用于指示行的开始和结束。  |
|  引用  |     每行在   引用   下方的区域中都是一个引号模式。 引号模式包括：        * 左 ：插入在值之前的引号字符。    * 右 ：插入在值之后的引号字符。    * Esc ：当引号字符是值的一部分时使用的转义方法或字符。 <duplicate> 值表示，如果值内出现引号字符，则将其加倍。 您可以指定自己的转义字符。      如果有多个模式，则使用第一个模式。       使用   添加   ( ![](https://resources.jetbrains.com.cn/help/img/idea/2026.3/app-client.expui.general.add.svg))、   移除   ( ![](https://resources.jetbrains.com.cn/help/img/idea/2026.3/app.expui.general.remove.svg))、   向上   ( ![](https://resources.jetbrains.com.cn/help/img/idea/2026.3/app.expui.general.up.svg)) 和   向下   ( ![](https://resources.jetbrains.com.cn/help/img/idea/2026.3/app.expui.general.down.svg)) 按钮来创建、删除和重新排序模式。     |
|  引用值  |     选择何时用引号字符括起值。        * 从不 ：不要引用值。    * 按需 ：如果值包含值分隔符或行分隔符，则为其加引号。    * 始终 ：为所有值加引号。    |
|  修整空白  |  忽略或移除空白字符。 如果取消选中此复选框，空白字符将被视为相应值的一部分。  |
|  第一行是页眉  |  将第一行视为包含列名的行。  |
|  第一列为标题  |  将第一列视为包含行名的列。  |

