Conversation
Sweep of the user guide against everything merged since 1.0.0 branched (af534e0), per the release preparation step in the release process. Correct statements that no longer match the code: the CI coverage table (only Spark 4.1 is gated before merge since the non-default profiles moved to the nightly run), the Spark 3.x Parquet limitations Comet has long since closed, cast/JSON/regex/array notes that say "falls back" where Comet now routes through the codegen dispatcher, S3 region auto-detection, Iceberg NOT IN pushdown, tokio thread defaults, shuffle and scan metric names, and a Kubernetes example that pointed at a Java 11 / Spark 3.5 image and left Comet disabled for lack of off-heap memory. Remove known-divergence entries that 1.1.0 fixed (boolean to decimal cast, explicit positive timestamp years, the ABFS object store cache key, most of the ANSI error-message items), and document new 1.1.0 behaviour: the experimental in-memory cache, the native Iceberg writer and the WRITE credential access mode, nested hash shuffle keys, BINARY sort-merge join keys, aggregate spill and memory metrics, native TIME functions, Variant-bearing tables whose Variant columns are not read, and the missing expression and plan-node rows. Add an "Upgrading to Comet 1.1.0" section to the upgrade guide, and drop the release-process notes about tag pushes publishing a Docker image, since that workflow was removed in apache#4241.
mbutrovich
left a comment
There was a problem hiding this comment.
First pass, thanks @andygrove!
| With `spark.kryo.registrationRequired=true`, also set | ||
| `spark.kryo.registrator=org.apache.comet.CometKryoRegistrator` before creating the | ||
| `SparkContext`. Otherwise caching fails as soon as a block is serialized, including the disk | ||
| half of the default `MEMORY_AND_DISK` storage level. |
There was a problem hiding this comment.
The Kryo requirement also applies to native broadcast, which is on by default, so it isn't specific to the in-memory cache. CometKryoRegistrator registers Utils.arrowBytesKryoClasses (the Array[ChunkedByteBuffer] that a native broadcast ships) along with the cache classes (CometKryoRegistrator.scala). The startup warning in Plugins.scala#L141-L148 names both. A user with spark.serializer=KryoSerializer and spark.kryo.registrationRequired=true who never enables the cache will hit "Class is not registered" on the first broadcast join, and this is the only page that mentions the registrator. Could you document it somewhere every user reads, such as "Additional Configuration" in installation.md, and have this section link to it? The condition is also narrower than written here: it applies only when spark.serializer is org.apache.spark.serializer.KryoSerializer.
| ``` | ||
|
|
||
| These `s3.*` storage properties are not specific to the Hive catalog shown here. When `s3.access-key-id` / `s3.secret-access-key` are omitted, credentials come from the standard AWS chain (environment variables, instance profiles, and so on). `client.region` is auto-detected for AWS but should be set for non-AWS endpoints. If your REST catalog vends temporary credentials, the native reader does not consume them automatically, and wiring that requires the credential provider bridge. See Iceberg's [S3 FileIO](https://iceberg.apache.org/docs/latest/aws/#s3-fileio) docs for the full property list, and [S3 Credential Providers](s3-credential-providers.md) for vended or per-request credentials. | ||
| These `s3.*` storage properties are not specific to the Hive catalog shown here. When `s3.access-key-id` / `s3.secret-access-key` are omitted, credentials come from the standard AWS chain (environment variables, instance profiles, and so on). `client.region` is not auto-detected: when neither it nor `AWS_REGION` is set, Comet uses `us-east-1`, so set it for AWS buckets in any other region. If your REST catalog vends temporary credentials, the native reader does not consume them automatically, and wiring that requires the credential provider bridge. See Iceberg's [S3 FileIO](https://iceberg.apache.org/docs/latest/aws/#s3-fileio) docs for the full property list, and [S3 Credential Providers](s3-credential-providers.md) for vended or per-request credentials. |
There was a problem hiding this comment.
This describes the region default as depending only on client.region and AWS_REGION. The check in iceberg_common.rs#L139-L145 also accepts s3.region and AWS_DEFAULT_REGION. A reader who has set s3.region could take this sentence to mean Comet ignores it. s3-credential-providers.md in this PR already lists all four sources. How about matching that wording here?
| These `s3.*` storage properties are not specific to the Hive catalog shown here. When `s3.access-key-id` / `s3.secret-access-key` are omitted, credentials come from the standard AWS chain (environment variables, instance profiles, and so on). `client.region` is not auto-detected: when neither it nor `AWS_REGION` is set, Comet uses `us-east-1`, so set it for AWS buckets in any other region. If your REST catalog vends temporary credentials, the native reader does not consume them automatically, and wiring that requires the credential provider bridge. See Iceberg's [S3 FileIO](https://iceberg.apache.org/docs/latest/aws/#s3-fileio) docs for the full property list, and [S3 Credential Providers](s3-credential-providers.md) for vended or per-request credentials. | |
| These `s3.*` storage properties are not specific to the Hive catalog shown here. When `s3.access-key-id` / `s3.secret-access-key` are omitted, credentials come from the standard AWS chain (environment variables, instance profiles, and so on). The region is not auto-detected: when neither the catalog (`client.region` or `s3.region`) nor the executor environment (`AWS_REGION` or `AWS_DEFAULT_REGION`) supplies one, Comet uses `us-east-1`, so set it for AWS buckets in any other region. If your REST catalog vends temporary credentials, the native reader does not consume them automatically, and wiring that requires the credential provider bridge. See Iceberg's [S3 FileIO](https://iceberg.apache.org/docs/latest/aws/#s3-fileio) docs for the full property list, and [S3 Credential Providers](s3-credential-providers.md) for vended or per-request credentials. |
| - Byte / Short `Add`, `Subtract`, and `Multiply` overflow raises `ARITHMETIC_OVERFLOW` (for | ||
| example `byte overflow`) where Spark raises `BINARY_ARITHMETIC_OVERFLOW`, and integral | ||
| `ARITHMETIC_OVERFLOW` messages omit Spark's `try_` suggestion. |
There was a problem hiding this comment.
This is now the only bullet in the section without an issue link, since #5071 was closed by #5162 with these two items still open. #6169 already asks for a follow-up issue so this entry can link to it. Could you file that issue now and add the link in this PR? The text ships with 1.1.0, and a reader who hits the divergence has nowhere to follow it otherwise.
Which issue does this PR close?
Part of #5327.
Rationale for this change
The release process asks for a review of the user guide before the release branch is cut. I went through every page under
docs/source/user-guide/latest/against the changes merged since 1.0.0 branched (af534e0), and checked each statement I touched against the code.What changes are included in this PR?
Most of the diff corrects statements that stopped being true. The CI table in the installation guide still said every Spark version is tested on every change, but since #5963 only Spark 4.1 is gated before merge and the other profiles run nightly. The Spark 3.4/3.5 "known limitations" described Parquet reads that Comet has rejected, like Spark does, since before 1.0. A number of expression notes, and the cast legend, said "falls back" where Comet now routes the case through the codegen dispatcher by default. The S3 region and Iceberg
NOT INpushdown descriptions were wrong, as were the tokio thread defaults and several shuffle and scan metric names. The Kubernetes example pointed at a Java 11 / Spark 3.5 image and set no off-heap memory, which leaves Comet disabled.The compatibility guide listed divergences that 1.1.0 fixed: the boolean to decimal cast, explicit positive timestamp years, the ABFS object store cache key, and most of the ANSI error-message items. Those entries are removed.
It also documents 1.1.0 behaviour that had no coverage. That includes the experimental in-memory cache, the native Iceberg writer (including the credential provider's
WRITEaccess mode), nested hash shuffle keys,BINARYsort-merge join keys, and the aggregate spill and memory metrics. It also covers native TIME functions, scans of tables whose Variant columns aren't read, and missing expression and plan-node rows. The upgrade guide gets an "Upgrading to Comet 1.1.0" section. Diffing the generated config reference against 1.0.0 shows no removed keys, no changed defaults, and nospark.comet.legacy.*keys, so the section says no behavior change needs a legacy key, and notes that JDK 17 is now required. The release process also loses its two notes about tag pushes publishing a Docker image, since that workflow was removed in #4241.A few things are deliberately left alone:
expressions.mdtocompatibility/expressions/<category>.mddon't resolve on the published site, because those pages only exist underspark-<ver>/at build time. 1.0.0 has the same problem. Should they point at the Spark 4.1 pages or at the index?from_unixtimeexample inunderstanding-comet-plans.mdno longer falls back, and a replacement needs real plan output.scalaUDF.codegen.enabledandmemoryOverheadconfig descriptions, and theTruncTimestampfallback reason. Those are code changes, so a follow-up.How are these changes tested?
This is documentation only. Each corrected or added statement was checked against the code at dd68a53: serde support levels, config definitions and defaults, operator node names, and metric names. Prettier passes. I haven't run the full docs build, but a script checked the relative links and anchors in the changed pages. The only targets that don't resolve are the pre-existing category links mentioned above.