Skip to content

Commit

Permalink
Document file format 3 (#93)
Browse files Browse the repository at this point in the history
  • Loading branch information
wolfroediger authored Apr 18, 2024
1 parent 589fb4c commit c8609cb
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
20 changes: 20 additions & 0 deletions website/docs/hyper-api/hyper_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,26 @@ unsupported version 2 (max supported version: 1). To open this database,
please update your product. (error code 0AS01)"
:::

##### version 3

Database file format version `3` supports storing and querying 128-bit
numerics. 128-bit numerics support a precision of up to 38 places.
Additionally, file format `3` improves compression of all 128-bit data types.

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

:::note
The database file format version `3` is supported by Tableau Desktop
2022.4.1 and Server 2023.1 and newer product versions. It is supported by
Tableau Prep 2022.4.1 and newer versions. Opening a database file with an
unsupported Tableau product version will produce an error message similar to:

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

<!-- ### Experimental Settings {#experimentalsettings}
:::warning
Expand Down
2 changes: 1 addition & 1 deletion website/docs/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ In case you are wondering why all our releases start with `0.0`, read [this FAQ

### Upcoming Release


* Document the new and improved database file format version 3 that was introduced in version 0.0.16123. The new format supports 128-bit numerics. Refer to [Hyper Database Settings](/docs/hyper-api/hyper_process#default_database_version) for more information.

### 0.0.18825 [March 6, 2024]

Expand Down

0 comments on commit c8609cb

Please sign in to comment.