PyCharm
 
2022.3
Shortcuts: Windows
Get PyCharm
You are viewing the documentation for an earlier version of PyCharm.
  1. Database tools and SQL
  2. Export and import data
  3. Data extractors

Data extractors

Last modified: 12 October 2022

Available only in PyCharm Professional: download to try or compare editions

Data extractors set rules of how to copy or view your data in the editor (in the Text view mode). You can select a default extractor from the list near the Export Data icon (The Export Data icon), configure the existing extractor, or create a custom extractor by using Groovy or JavaScript.

In PyCharm, the last selected extractor becomes the default one for newly opened editor tabs. For MongoDB, the default extractor is always JSON.

There are several built-in formats. You can export data as a set of INSERT or UPDATE statements, or as a part of the WHERE clause. Also, you can select text formats like CSV, JSON, HTML, or Markdown. For more information about exporting, see the Export section.

https://resources.jetbrains.com/help/img/idea/2022.3/db_data_extractors_json.png
Gif

Configure an extractor for delimiter-separated values

You can extend the default functionality and create your own format that is based on CSV or any DSV format.

Add a custom extractor

You can create your own extractor that you can write on Groovy or JavaScript.

API for custom data extractors

Use the following API to create your custom data extractor.

Binding

Methods

Description

DIALECT

getDbms() followed by either one of the following methods:

  • 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

Database dialect

TABLE

  • getName()

  • getParent().getName()

Database table metadata

ALL_COLUMNS

  • int columnNumber()

  • String name()

A list of all columns in the query result or currently open table editor.

COLUMNS

  • int columnNumber()

  • String name()

A list of selected columns in the query result or currently open table editor.

FORMATTER

  • format(Row, Column)

  • formatValue(Object, Column)

  • getTypeName(Object, Column)

  • isStringLiteral(Object, Column)

Default formatting methods.

OUT

append(String)

Extractor output.

ROWS

  • int rowNumber()

  • boolean first()

  • boolean last()

  • java.util.List<java.lang.Object> data()

  • Object value(Column)

Row data stream.

TRANSPOSED

Boolean value that indicates whether the table editor is in transposed mode.

Example

You can use the following simple CSV data extractor as a base for your custom data extractors. The full version of this data extractor is available in PyCharm. To locate it, in the Project tool window (View | Tool Windows | Project), navigate to Scratches and Consoles | Extensions | Database Tools and SQL | data | extractors

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