4.4. Database Settings

These settings control Hyper's database files.

4.4.1. default_database_version

Warning

Newer database file format versions than the initial version 0 are unsupported in older product versions. This means that you can use newer database versions with the latest Hyper API and newer product versions but you cannot open them in older product versions. For example, the new database file format version 1 can be opened in Tableau Desktop 2019.2.10 but it cannot be opened in Tableau Desktop 2019.1. The complete compatiblility matrix is documented in the version sections below.

Specifies the default database file format version that will be used to create new database files.

Default value: 0

Accepted values: 0, 1

4.4.1.1. version 0

The default and initial database file format version is version 0. It is supported and will always be supported by all product versions. To create a new Hyper database file with this version, set default_database_version=0.

4.4.1.2. version 1

Database file format version 1 improves Hyper's file format significantly. It contains a collection of improvements from the years since Hyper's initial release:

  • Hyper will compress database files more efficiently after rows have been deleted. The initial file format was not able to compress data blocks with deleted rows, so the file size increased significantly when rows were deleted.
  • Hyper will process queries on textual data with collations more efficiently.
  • Hyper will detect database files that have been corrupted externally more reliably.

To create a new Hyper database file with this version, set default_database_version=1.

Note

The database file format version 1 is supported by Tableau Desktop/Server 2019.2.10, 2019.3.6, 2019.4.5, 2020.1.1 and newer product versions. It is supported by Tableau Prep 2020.2 and newer versions. If a database file format is unsupported, the error message will be similar to:

"There was an error during loading database '[...]\file.hyper': unsupported version 1 (max supported version: 0). To open this database, please update your product. (error code 0AS01)"