External file formats

An external file format defines the structure and encoding of files stored in an external data source, such as Azure Blob Storage or Hadoop (HDFS). SQL Server uses it together with external data sources and external tables to query files in external storage.

In Database Explorer, you can perform operations on external file formats by using the shortcut menu. Right-click an external file format to access options such as generating a script or viewing its properties.

View the shortcut menu options of external file format

Create an external file format

You can create external file formats in SQL Editor by using one of these features:

  • Code completion to write a script.
  • SQL snippets to insert predefined or custom code.

View external file format properties

In Database Explorer, right-click the external file format or External File Formats node and select Show Details.

Object Viewer opens, displaying detailed information about the external file format.

Refresh the external file format

In Database Explorer, right-click the external file format or External File Formats node and select Refresh, or press F5.

Open the Properties pane

In Database Explorer, right-click the external file format and select Properties, or press F4.

Filter external file formats

1. In Database Explorer, right-click the External File Formats node and select Filter.

2. In the Filter Settings dialog, configure the filter parameters.

3. Click OK to apply the filter.

Note

When you expand the External File Formats node, the number of objects it contains appears in parentheses next to the node name. This number changes depending on the applied filter settings.

Delete an external file format

1. In Database Explorer, right-click the external file format you want to delete and select Delete, or press Delete.

2. Click Yes to confirm the deletion.

Note

You cannot undo the drop operation, as this action permanently deletes the external file format. To avoid data loss, back up the database before deleting it.

Shortcut menu options for an external file format

The following table describes the shortcut menu options available for an external file format in Database Explorer.

Name Description
Show Details Opens Object Viewer that displays object details.
Delete Drops the selected object from the database.
Shortcut: Delete
Refresh Updates the object list to reflect the latest changes.
Shortcut: F5
Properties Opens the Properties pane that displays the object information.
Shortcut: F4

Shortcut menu options for the External File Formats node

The following table describes the shortcut menu options available for the External File Formats node in Database Explorer.

Name Description
Filter Opens the Filter Settings dialog to control which external file formats should appear in Database Explorer.
Show Details Opens Object Viewer that displays object details.
Refresh Updates the object list to reflect the latest changes.
Shortcut: F5

Bulk operations

In Database Explorer, hold down Ctrl and select multiple external file formats. Then right-click the selection and select the required option.

The following table describes the shortcut menu options available for multiple external file formats.

Name Description
Delete Drops the selected external file formats from the database.
Shortcut: Delete