Was this page helpful?
Yes No

Extract Upgrade to .hyper Format

In this article

New .hyper extract format

Beginning in version 10.5, when you create a new extract, it uses the .hyper format instead of the .tde format. Extracts in the .hyper format take advantage of the improved data engine, which supports the same fast analytical and query performance as the data engine before it, but for even larger extracts.

Although there are many benefits of using .hyper extracts, the primary benefits include the following:

  • Create larger extracts: You can create extracts with billions of rows of data. Because .hyper extracts can support more data, you can consolidate .tde extracts that you previously had to create separately into a single .hyper extract.

  • Create and refresh extracts faster: While Tableau has always optimized performance for creating and refreshing extracts, version 2018.3 supports faster extract creation and refreshes for even larger data sets.

  • Experience better performance when interacting with views that use extract data sources: Although smaller extracts continue to perform efficiently, larger extracts perform more efficiently.

What causes an extract upgrade?

Although you can continue to open and interact with .tde extracts in version 2018.3, when you perform an extract task on a .tde extract, the .tde extract is upgraded to a .hyper extract. After the extract is upgraded, you should be aware of the following backward limitations:

  • You can't convert the upgraded extract back to a .tde extract.

  • You can't open the upgraded extract in an earlier version of Tableau Desktop. This might affect how you and other users might interact with .tde extracts.

  • You can't use the Export as Version in Tableau Desktop to downgrade a workbook that contains a .hyper extract.

  • You can't publish the extract as an older version from Tableau Desktop to Tableau Server.

  • You can't open a workbook in Tableau Desktop 10.4 and earlier that is downloaded from Tableau Server or Tableau Online using the Download Tableau Workbook option if the workbook contains a .hyper extract.

Tasks that cause an extract upgrade

There are three distinct ways a .tde extract can get upgraded to a .hyper extract: 1.) during an extract refresh (full or incremental), 2.) when appending data to an extract, and 3.) when an extract is upgraded manually. After an extract has been upgraded using Tableau Desktop, it's not automatically removed in case the .tde extract is being referenced by other workbooks.

In addition to the tasks that upgrade an extract, extract tasks performed outside of Tableau Desktop can cause an extract upgrade to the .tde extract you interact with. This includes the following tasks:

  • Manual refresh (Tableau Server and Tableau Online)

  • Incremental refresh on a published extract data source from Tableau Bridge (Tableau Online)

  • A scheduled full or incremental extract refresh data source (Tableau Server and Tableau Online)

  • A scheduled incremental extract refresh from Tableau Bridge (Tableau Online)

Impact of extract upgrade

When you're working in an environment where the version number of Tableau Desktop doesn't match the Tableau Desktop version that others are using, or doesn't match the version of Tableau Server or Tableau Online, you might encounter some extract compatibility issues depending on the task you want to perform.

Review a detailed explanation of the extract compatibility scenarios on the Tableau Support page or a summary explanation below to better understand when extract upgrades can occur and potential compatibility issues you or others might experience.

Note: In the tables below, "10.4" represents Tableau 10.4 and earlier and "10.5" represents Tableau 10.5 and later.

Tasks using Tableau Desktop

You should be aware of the following extract-related compatibility scenarios around tasks performed on different versions of Tableau Desktop.

 

Tasks

10.4 workbook 10.5 workbook
.tde extract .tde extract .hyper extract
Create new in 10.4 Not possible Not possible
in 10.5 Not possible Not possible
Open in 10.4 Can't open workbook; you're asked to open the workbook in 10.5 or later Can't open workbook; you're asked to open the workbook in 10.5 or later
in 10.5
Refresh or append in 10.4 Not possible Not possible
in 10.5 Workbook version remains unchanged, but extract upgrades to .hyper format Workbook version remains unchanged, but extract upgrades to .hyper format
Publish workbook from 10.5 to Tableau Server 10.4 Can't publish; in the Publish dialog, you see a "server is running an older version than your copy of Tableau Desktop" message, then you see a "workbook cannot be downgraded" error message Can't publish; in the Publish dialog, you see a "server is running an older version than your copy of Tableau Desktop" message, then you see a "workbook cannot be downgraded" error message
from 10.5 to Tableau Server 10.5 or Tableau Online
  from 10.4 to Tableau Server 10.5 or Tableau Online    
Publish extract data source from 10.5 to Tableau Server 10.4 Can't publish; you see a "cannot publish, make sure you are connected to a compatible version" error message Can't publish; you see a "cannot publish, make sure you are connected to a compatible version" error message
from 10.5 to Tableau Server 10.5 or Tableau Online
Connect to a published data source from 10.4 to Tableau Sever 10.5 or Tableau Online
from 10.5 to Tableau Server 10.5 or Tableau Online

Tasks on Tableau Server 10.5 or Tableau Online

When working with extracts created in an earlier version of Tableau Desktop, you should be aware of the following extract-related compatibility scenarios around tasks performed on Tableau Server 2018.3 or Tableau Online.

 

Scenario

10.4 workbook 10.5 workbook
.tde extract .tde extract .hyper extract
Edit/save in web authoring on Tableau Server 10.4 Not possible Not possible
on Tableau Server 10.5 or Tableau Online Workbook changes to version 10.5, extract remains in .tde format
Edit/save in web authoring then refresh or append on Tableau Server 10.4
on Tableau Server 10.5 or Tableau Online Workbook changes to version 10.5, and extract upgrades to .hyper format Workbook version remains unchanged, but extract upgrades to .hyper format
Download and open in Tableau Desktop 10.4 Can't open workbook; you see a "this workbook uses a .hyper extract and is not compatible with this version; open the workbook in version 10.5 or later" error message, and then asked to locate the extract Can't open workbook; you see a "this file was created by a newer version; upgrade Tableau" error message
in Tableau Desktop 10.5
Export As Version from Tableau Desktop 10.5 Option is greyed out Option is greyed out

Automating extract creation, refresh, and append tasks

When working with extracts created in earlier versions of Tableau, you should be aware of the following extract-related compatibility scenarios when automating extract creation, refresh, and append tasks.

 

Scenario

  .tde extract     .hyper extract
Create new extract using Tableau SDK   Not possible
using Extract API 2.0 Not possible
Refresh or append using 10.4 Tableau Command-Line utility Not possible
using 10.5 Tableau Command-Line utility Workbook version remains unchanged, but extract upgrades to .hyper format  √

Why keep an extract in .tde format?

If you cannot upgrade Tableau Desktop, you'll need to keep your extract in .tde format.

How to keep an extract in .tde format

To keep an extract in the .tde format, do not upgrade the extract. To avoid upgrading the extract, do not perform any of the tasks listed in the Tasks that cause an extract upgrade section to a .tde extract using Tableau Desktop 2018.3. Then, consider the following suggestions if you need to maintain a .tde version of an extract:

  • Perform extract refresh and append data tasks using Tableau Desktop 2018.3, but maintain an earlier version of Tableau Desktop and the ability to connect to the original data in case you need to recreate the .tde extract.

  • Use an earlier version of Tableau Desktop to perform extract tasks, such as extract refresh or append data.

  • If possible, disable existing extract refresh schedules on Tableau Server, Tableau Online, or Tableau Bridge until you can identify which extracts should and shouldn't be upgraded.

What to expect after an extract upgrade

After your extract has been upgraded, you can expect some additional changes when working in version 2018.3.

Changes to opening extracts

After a .tde extract is upgraded to a .hyper extract, you can't open an upgraded extract using an earlier version of Tableau Desktop. Consider some of the suggestions below to help resolve issues you have with opening extracts.

  • Upgrade Tableau Desktop to 2018.3: If possible, consider upgrading Tableau Desktop to 2018.3 so that you can experience the benefits of .hyper extracts. For more information, see Upgrade Tableau Desktop in the Tableau Desktop Deployment Guide.

  • Recreate the extract using an earlier version of Tableau Desktop: To recreate your .tde extract, you must be able to connect to the original data using an earlier version of Tableau Desktop. For more information, see Connect to and Prepare Data and Downloading Previous Versions of Tableau in the Tableau Knowledge Base.

  • Retrieve earlier versions of a published extract data source or workbook: If revision history is enabled on Tableau Server or Tableau Online, you can download an earlier version of a published extract data source or a published workbook that uses an extract data source. Note: Earlier workbooks that you retrieve that use an extract data source are saved in a .twb format and therefore will require you to recreate the extract after you open the workbook in an earlier version of Tableau Desktop. For more information, see Work with Content Revisions.

Changes to sharing extracts

When you need to share the data in the extract data source with someone directly (for example, through email or a file share) be sure to save the extract as a .tdsx file. Alternatively, you can save the workbook with the extract data as a .twbx. If you only share the .hyper file instead of the .tdsx or .twbx, metadata about the .hyper extract like connection information and column name changes will be missing. For more information, see Tableau File Types and Folders.

Potential differences in extract file size

While .tde extract file sizes can vary depending on complexity of your data, after an extract upgrade, corresponding .hyper extract file sizes can also vary for the same reason. There may be some cases when some .hyper extracts become bigger after an extract upgrade and other cases when .hyper extracts become smaller after an extract upgrade.

Changes to the Export as Version option

When your workbook contains a .hyper extract, the Export as Version option in the File menu is not available. If you need to open a workbook that contains a .hyper extract using an earlier version of Tableau, you must first remove the extract from the workbook before you can downgrade it using the Export as Version option. After you've downgraded the workbook, you must recreate the .tde extract.

Other issues

For errors that you see after an extract upgrade, refer to the following articles in the Tableau Knowledge Base:

Changes to your view after an extract upgrade

After an extract has been upgraded, you might notice some changes to a view that uses the extract data source. This is because values in your extract can be computed differently in version 2018.3. Changes can include fewer marks in the view, more null values when you inspect the summary data, or the view itself has a different shape. In some rare cases, the view might even be blank. For more information about the type of changes you might see when interacting with extracts with this version of Tableau, see Changes to values and marks in the view.

Manually upgrade your extract

If you manage extracts locally, you can manually upgrade your .tde extract to a .hyper extract using Tableau Desktop.

  1. In Tableau Desktop, open a workbook that uses a .tde extract.

  2. Select the extract data source from the Data menu and then select Extract > Upgrade

  3. Select File > Save, which saves the workbook and also completes the extract upgrade.