Data export
Table of contents
Overview
CloudBeaver supports exporting data from database tables in various formats. Users can initiate data exports from the Database Navigator, Metadata Editor, Data Editor, or directly from the SQL Editor's ResultSet.
Supported formats
CloudBeaver supports multiple output formats for data export:
- CSV.
- DBUnit.
- JSON.
- Markdown.
- Source Code.
- SQL.
- TXT.
- XML.
- Parquet.
- XLSX.
HTML.
Steps to export data
To export data from CloudBeaver, follow these steps:
Choose the table you wish to export.
You can initiate an export also from the Database Navigator, Data Editor after querying data, or directly from the ResultSet in the SQL Editor.
Select your desired format from the available options.
Set the necessary configuration options based on the format you have selected. Each format may have specific configuration settings that can be adjusted to meet your needs.
Once you have set the necessary configuration options for your selected format, move to the "Output" tab to configure the additional settings.
Setting name Description Encoding Set the character encoding for the exported file. Insert BOM Choose whether to include a Byte Order Mark in the file. Compression Specifies if the export file should be compressed into a .ziparchive.After configuring the settings, click on Export to initiate the export process.
Once you click the Export button, a pop-up dialog titled "File is Ready to Download" will appear. You can cancel the process by clicking Cancel or proceed with the download by clicking Download. Selecting Download will initiate the file download to your local system.
Tip: It is advisable not to make changes to the data while the export is in progress to prevent any potential data integrity issues.
Specific configuration settings
In this section, you will find specific configuration settings for each supported export format. These settings allow you to customize the export process according to the requirements of the data format you choose.
CSV
| Setting name | Description | Available options |
|---|---|---|
| Characters escape | Bad characters escaping model (surrounded with quotes or escaped with '\' character). | quotes/escape |
| Delimiter | Column delimiter. | You can use special characters like `\t, \n, and \r`. |
| File extension | The default file extension for the exported file. | csv |
| Format numbers | Format numeric values using locale settings. | true/false |
| Header | CSV header settings. | none/top/bottom |
| Header case | You can choose lower or upper case for column names or descriptions in the header. | as is/upper/lower |
| Header format | Defines the formatting of the header. | label/description/both |
| NULL string | String which will be used instead of NULL values. | |
| Quote always | Quote all cell values. Cannot be used with "Quote Never". | disabled/all/strings/all but numbers/all but nulls |
| Quote character | Character which will be used to quote strings (space means no quote). | |
| Quote never | Do not quote cell values. Cannot be used with "Quote Always". | true/false |
| Row delimiter | Row delimiter. Default is system-specific line feed delimiter. | default/\n/\r/\r\n/\n\r |
DBUnit
| Setting name | Description | Available options |
|---|---|---|
| File extension | The default file extension for the exported file. | xml |
| Force upper case column names | Convert all column names to upper case. | true/false |
| Force upper case table name | Convert the table name to upper case. | true/false |
| Include NULL values in export | Include NULL values in the exported data. | true/false |
| Replace NULL values with | Specify a string to replace NULL values in the export. |
JSON
| Setting name | Description | Available options |
|---|---|---|
| File extension | The default file extension for the exported file. | json |
| Format dates in ISO 8601 | Convert all date values to ISO 8601 format. | true/false |
| Print table name | Include the table name in the exported file. | true/false |
| Export JSON values as | Export values as text or as JSON objects. | string/JSON |
Markdown
| Setting name | Description | Available Options |
|---|---|---|
| Confluence format | Enable Confluence-specific Markdown formatting. | true/false |
| File extension | The default file extension for the exported file. | md |
| Format numbers | Format numeric values using locale settings. | true/false |
| NULL string | String to represent NULL values in the export. | |
| Show header separator | Include a separator line below the header. | true/false |
Source code
| Setting name | Description | Available options |
|---|---|---|
| File extension | The default file extension for the exported file. | php |
| Format dates in ISO 8601 | Convert all date values to ISO 8601 format. | true/false |
| Language | Specifies the PHP version compatibility for the generated code. | PHP < 5.4, PHP 5.4+ |
| Quote character | Character which will be used to quote strings. | ", ' |
| Row delimiter | Row delimiter. Default is system-specific line feed delimiter. | default, \n, \r, \r\n, \n\r |
SQL
| Setting name | Description | Available options |
|---|---|---|
| Data rows per statement | Specifies the number of data rows in a single insert statement. | integer |
| File extension | The default file extension for the exported file. | sql |
| Identifier case | Allows selection of lower or upper keyword case for table and column names. | as is/upper/lower |
| Include generated columns | Specifies whether to include auto-generated columns (e.g., auto-increment) in SQL INSERT statements. | true/false |
| Insert line before rows | Specifies inserting a line feed before values in multi-row inserts. | true/false |
| Keyword case | Allows selection of lower or upper keyword case. | upper/lower |
| Native date/time format | Specifies using native date/time format in INSERT statements. | true/false |
| Omit schema name | Specifies omitting schema/catalog name in INSERT statements. | true/false |
| On conflict expression | Provides an expression for the end of the statement. This setting is specific to the database. | |
| Target table name | Allows specification of the target table name to generate an INSERT statement. | |
| Upsert keyword | Allows selection of different upsert keywords. | INSERT/INSERT ALL/UPDATE OR/UPSERT INTO/REPLACE INTO/ON DUPLICATE KEY UPDATE/ON CONFLICT |
TXT
| Setting name | Description | Available options |
|---|---|---|
| Batch size | Specifies the number of records per batch. | integer |
| File extension | Specifies the file type for output. | txt |
| In-between delimiter | Adds a custom character between data values. | |
| Max column length | Specifies the maximum length of data in a column; longer values will be cropped. | integer |
| Min column length | Specifies the minimum length of data in a column; shorter values will be padded with spaces. | integer |
| Print header | Specifies whether to print column names at the top of the file. | true/false |
| Show header delimiter | Adds hyphen characters either in the first row without a header or between the header and data. | true/false |
| Show leading delimiter | Adds a pipe character at the start of the row. | true/false |
| Show NULLs | Controls the display of NULL values in the output. | true/false |
| Show trailing delimiter | Adds a pipe character at the end of the row. | true/false |
XML
| Setting name | Description | Available options |
|---|---|---|
| File extension | Specifies the file type for output. | xml |
| Include DOCTYPE declaration | Specifies whether to include the DOCTYPE declaration in the XML file export. | true/false |
XLSX
| Setting name | Description | Available options |
|---|---|---|
| Append strategy | Strategy used when appending data to an existing file. | create new sheets/use existing sheets |
| Boolean string FALSE | String that replaces FALSE boolean values in the exported file. | true/false |
| Boolean string TRUE | String that replaces TRUE boolean values in the exported file. | true/false |
| Border style | Style of cell borders in the exported file. | NONE/THIN/THICK |
| Excel date format | Date and time format used in the Excel file (modifiable in Excel application). | m/d/yy / d-mmm-yy / d-mmm / mmm-yy / h:mm AM/PM / h:mm:ss AM/PM / h:mm / h:mm:ss / m/d/yy h:mm |
| Column group | Column number used for grouping rows on a sheet by column value. | integer |
| Export SQL | Specifies whether to export SQL to a second sheet in the Excel file. | true/false |
| File extension | File extension for the exported document. | xlsx |
| Header format | Format of the header in the exported file. | label/description/both/none |
| Header row font | Font styling for the first row in the exported file. | NONE/BOLD/ITALIC/STRIKEOUT/UNDERLINE |
| Max row on sheet | Maximum number of rows allowed on a single sheet, after which data will split into another sheet. | integer |
| NULL string | String used instead of displaying NULL values in the exported file. | |
| Row number(s) | Includes the row index as the first column in the exported file. | true/false |
| Split SQL Text | Splits exported SQL into rows by CR (Carriage Return) in the exported file. | true/false |
| Trim strings | Removes extra leading and trailing spaces from all string values in the exported file. | true/false |
HTML
| Setting name | Description | Available options |
|---|---|---|
| File extension | File extension for the exported document. | html |
| Images | Extracts images to graphic files. | true/false |
| Output column headers | Outputs column names as an additional row in the generated table. | true/false |
| Output table header | Outputs the query or table name as the first row in the generated table. | true/false |