Import

Enable the Database Tools and SQL plugin

This functionality relies on the Database Tools and SQL plugin, which is bundled and enabled in JetBrains Rider by default. If the relevant features aren't available, make sure that you didn't disable the plugin.

Press Control+Alt+S to open the IDE settings and then select Plugins.
Open the Installed tab, find the Database Tools and SQL plugin, and select the checkbox next to the plugin name.

To import data from a script file, run the file as it is described in the Run SQL files page. In addition to script files, you can import data from a CSV, TSV, or any other text files that contain delimiter-separated values.

Import data

In the Database tool window ( View | Tool Windows | Database) , right-click a data source, or a schema and select SQL Scripts | Run SQL Script….
In the file browser window that opens, navigate to the SQL file that you want to run and click Open.
Select the settings for your run configuration.
- Target data source / schema: databases or schemas against which you want to run your database scripts. This setting is dialect-dependent.
  If you select a data source as a target, JetBrains Rider displays a schema in which the script will be run. It is the default schema.
- Script files: SQL files that you want to run. To add files, click the Add button () and navigate to files that you want to run. If a script contains schema switching, you will see a warning ().
Click Run.

Import delimiter-separated values

In the Database tool window ( View | Tool Windows | Database) , right-click a schema or a table and select Import/Export | Import Data from File(s).
Navigate to the file that contains delimiter-separated values and double-click it.
In the Import "file_name" File dialog, specify the data conversion settings and click Import.
You can select in what schema to create a table and whether to import data to a new table or an existing one. To select a schema or a table, use Table and Target schema lists.
To mark the first row as a header, right-click the row in the Data Preview pane and select First Row Is Header.

Import multiple CSV files

In the Database tool window ( View | Tool Windows | Database) , right-click a schema or a table and select Import/Export | Import Data from File(s).
Navigate to the files that contain delimiter-separated values, select them, and click Open.
In the Import "file_name" File dialog, specify the data conversion settings for every file. You can go through the files in the Sources pane. Click Import to import the files.
You can select in what schema to create a table and whether to import data to a new table or an existing one. To select a schema or a table, use Table and Target schema for all sources lists.
To mark the first row as a header, right-click the row in the Data Preview pane and select First Row Is Header.
For more information about data conversion settings, refer to Import File dialog.

Import multiple tables

Select tables that you want to copy to a different schema, database, or existing table.
Open the Import 'table_name' Table dialog. To open the Import 'table_name' Table dialog, you can use the following actions:
- Right-click the selection and navigate to Import/Export | Copy Tables to.
- Drag the selection to a schema or a database.
- Press Control+Shift+A, type copy tables to and press Enter.
From the Target schema for all sources list, select a schema in which you want to create a table. In case of a single table, this menu item is called Target schema.
In the Table list, type a name of a new table or select an existing table to add data to the selected table.
In the Sources list, click tables that you want to configure.
(Optional) Click the Add icon () to add columns, keys, and indexes.
(Optional) Select Insert inconvertible values as null if you want to insert NULL when the IDE meets an inconvertible value.
Select Disable indexes and triggers, lock table (may be faster) if you want to disable indexes and triggers during the import. Note that if you selected this option, it might lead to a situation when a trigger does not fire and fails to pass its results. Though it might improve the performance of the importing process. The option is available only when the target table (to which you copy values) has indexes or triggers.
Click Import.

Restore a full data dump for MySQL and PostgreSQL

You can restore data dumps by using the mysql client utility for MySQL, or pg_restore or psql for PostgreSQL. The pg_restore option is used for custom-format pg_dump -Fc or directory-format pg_dump -Fd dumps. The psql option is used for SQL-format dumps.

If you see no restore options in the context menu, verify that you use a correct JDBC URL for the data source.

In the Database tool window ( View | Tool Windows | Database) , right-click a schema or a database and navigate to the Import/Export group:
- Restore with "mysql": for MySQL data sources. In the Path to mysql field, specify the path to the MySQL executable (for example, C:\Soft\mysql-8.0.19-winx64\bin\mysql.exe).
- Restore with "pg_restore": for PostgreSQL data sources. The pg_restore option is available for the most database objects except for the data source level.
- Restore with "psql": for PostgreSQL data sources. The psql option is available for the most database objects except for table and schema levels.
- Restore: for PostgreSQL data sources. Includes two tabs: pg_restore and psql.
In the Restore with <dump_tool> dialog, specify the path to the restore tool executable in the Path to <dump_tool> field.
Specify the full explicit path to the dump tool executable.
(Optional) Edit the command-line options in the lower part of the dialog.
Click Run.

Reference: Import dialogs

The Import "file_name" File dialog appears when you import CSV, TSV, or any other text files that contain delimiter-separated values.

Import delimiter-separated values into a database

Settings for files with delimiter-separated values

These setting are available in the Import File dialog only.

Item	Description
Formats	Select a template that successfully converts the file data into a table. You can change settings of predefined templates or add a new template. To add a template, click Add Format button (). Use the Add Format (), Remove Format (), Up () and Down () buttons to create, delete and reorder the formats; Copy Format () to create a copy of the selected format.
Value separator	Select or type the character that you want to use as a separator for values.
Row separator	Select or type the character that you want to use as a separator for rows.
Null value text	Select or type the text that you want to use if a cell contains the `NULL` value.
Add row prefix/suffix	Click the link and type a row prefix and suffix. Prefix and suffix are character sequences which in addition to the row separator indicate the beginning and end of a row.
Quotation	Each line in the area under Quotation is a quotation pattern. A quotation pattern includes: Left: a quotation character that is inserted before a value. Right: a quotation character that is inserted after a value. Escape: an escape method or character for the cases when the quotation character is part of a value. The <duplicate> value means that if a quotation character occurs within a value, it is doubled. You can specify your own escape character. If there is more than one pattern, the first pattern is used. Use the Add (), Remove (), Up () and Down () buttons to create, delete and reorder the patterns.
Quote values	Select when you want to enclose values within quotation characters. Never: do not quote values. When needed: quote a value if it contains the value or the row separator. Always: quote all the values.
Trim whitespaces	Ignore or remove whitespace characters. If this checkbox is cleared, the whitespace characters are treated as parts of the corresponding values.
First row is header	Treat the first row as a row that contains column names.
First column is header	Treat the first column as a column that contains row names.

The Import 'table_name' Table dialog appears when you import a table into an existing one, or to another database or schema.

In this dialog, specify the data mapping info and the settings for the destination table.

Table name, structure and data mappings

Item	Description
Target schema	Schema in which you want to create or to copy a table. You can select schemas in another data source.
Table	Name of a new table or an existing table in case you want to add data to the existing table.
Comment	Comment to a table.
Columns \| Keys \| Indexes \| Foreign Keys	Data mappings and definitions of columns, keys, and indexes. Double-click the line to start editing. The Mapped to field specifies relation of a data column from the file and the corresponding column in the database. If you clear this field, no data is added to the target column in the database. To remove a column, select the corresponding line and click the Remove button .

Data and DDL previews

Item	Description
Data Preview	The generated preview of how your data will be imported to the database.
DDL Preview	A statement or statements that JetBrains Rider will run to create a table. You can edit the statements in the DDL preview field.

Encoding, errors, and logs

Item	Description
Encoding	(Import File dialog only) Select the character encoding for your data in the source file.
Write errors to file	Write errors that occur during the import in a text file.
Insert inconvertible values as null	Insert the `NULL` value into the table instead of the data that cannot be converted.
Disable indexes and triggers, lock table (may be faster)	Disable indexes and triggers during the import. Note that if you selected this option, it might lead to a situation when a trigger does not fire and fails to pass its results. Though it might improve the performance of the importing process. The option is available only when the target table (to which you copy values) has indexes or triggers.

Last modified: 20 September 2023