diff --git a/website/docs/hyper-api/hyper_process.md b/website/docs/hyper-api/hyper_process.md index 9628d01..3c71d82 100644 --- a/website/docs/hyper-api/hyper_process.md +++ b/website/docs/hyper-api/hyper_process.md @@ -169,24 +169,34 @@ These settings control Hyper's database files. #### default_database_version +Specifies the default database file format version that will be used to +create new database files. +Every version builds on the improvements of the previous version(s) and +adds some new functionality, like new data types. + +Default value: `0` + +Accepted values: `0`, `1` (writing this version is deprecated in favor +of version 2 and will be removed in a future Hyper API release), `2`, `3`, and `4`. + :::note 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 +but you cannot open them in older product versions. For example, the database file format version `2` can be opened in Tableau Desktop 2020.4.15 but it cannot be opened in Tableau Desktop 2020.3. The complete compatibility matrix is documented in the version sections below. -::: -Specifies the default database file format version that will be used to -create new database files. +Opening a database file with an unsupported +Tableau product version will produce an error message similar to: -Default value: `0` +"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)" +::: -Accepted values: `0`, `1` (writing this version is deprecated in favor -of version 2 and will be removed in a future Hyper API release), `2` ##### version 0 @@ -219,18 +229,11 @@ and will be removed in a future Hyper API release. 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. -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 1 (max supported version: 0). To open this database, -please update your product. (error code 0AS01)" ::: ##### version 2 -Database file format version `2` includes the improvements of file -format version `1`. Additionally, it supports storing and querying +Database file format version `2` adds support for storing and querying textual data with arbitrary versions of the Unicode collation tables. To create a new Hyper database file with this version, set @@ -240,12 +243,7 @@ To create a new Hyper database file with this version, set The database file format version `2` is supported by Tableau Desktop/Server 2020.4.15, 2021.1.12, 2021.2.9, 2021.3.8, 2021.4.4, 2022.1.2 and newer product versions. It is supported by Tableau Prep -2022.3 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 2 (max supported version: 1). To open this database, -please update your product. (error code 0AS01)" +2022.3 and newer versions. ::: ##### version 3 @@ -260,12 +258,24 @@ To create a new Hyper database file with this version, set :::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: +Tableau Prep 2022.4.1 and newer versions. +::: -"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)" +#### version 4 +Database file format version `4` was introduced to support +persisting and reading the new 32-bit floating point type. + +Starting with release (#TODO), Hyper uses 32-bit floats for +the SQL types `real`, `float4`, and `float(p)` with `p <= 24`. +The types `double precision`, `float`, `float8`, and `float(p)` with `p >= 25` +still use 64-bit doubles. + +To create a new Hyper database file with this version, set +`default_database_version=4`. + +:::note +The database file format version `4` will be supported +in a not-yet-determined future version of Tableau. :::