Skip to content

[SITE] Document cache.expiration-interval-ms in Spark Configuration - #3787

Merged
rdblue merged 5 commits into
apache:masterfrom
kbendick:document-cache-expiration-config
Dec 21, 2021
Merged

[SITE] Document cache.expiration-interval-ms in Spark Configuration#3787
rdblue merged 5 commits into
apache:masterfrom
kbendick:document-cache-expiration-config

Conversation

@kbendick

Copy link
Copy Markdown
Contributor

Adds documentation to the site for the catalog config key cache.expiration-interval-ms for Spark.

This has not been implemented for Flink yet, so I've not added it to the Flink documentation (working on that in a separate PR).

Here's a reference to the JavaDoc for this configuration value:

/**
* Controls the duration for which entries in the catalog are cached.
* <p>
* Behavior of specific values of cache.expiration-interval-ms:
* <ul>
* <li> Zero - Caching and cache expiration are both disabled</li>
* <li> Negative Values - Cache expiration is turned off and entries expire only on refresh etc</li>
* <li> Positive Values - Cache entries expire if not accessed via the cache after this many milliseconds</li>
* </ul>
*/
publicstaticfinalStringCACHE_EXPIRATION_INTERVAL_MS = "cache.expiration-interval-ms";

@kbendick
kbendickforce-pushed the document-cache-expiration-config branch from 9601361 to f4bb4efCompareDecember 21, 2021 20:27
@kbendick

Copy link
Copy Markdown
ContributorAuthor

cc @rdblue@nastra@samredai@jackye1995@RussellSpitzer added some documentation for cache.expiration-interval-ms.

I still need to plumb it through Flink, which I'm working on today and will update the Flink docs afterwards.

@kbendick

kbendick commented Dec 21, 2021

Copy link
Copy Markdown
ContributorAuthor

image

Comment threadsite/docs/spark-configuration.md Outdated
| spark.sql.catalog._catalog-name_.warehouse | hdfs://nn:8020/warehouse/path | Base path for the warehouse directory |
| spark.sql.catalog._catalog-name_.cache-enabled | `true` or `false` | Whether to enable catalog cache, default value is `true` |
| Property | Values | Description |
|---------------------------------------------------------------|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is no need to change all the other lines to have the same size description blocks, the website will format them correctly anyway. Could you remove the unrelated changes?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to just one line change.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thanks for updating this.

@kbendick
kbendickforce-pushed the document-cache-expiration-config branch from f4bb4ef to 3ea3a09CompareDecember 21, 2021 21:11
Comment threadsite/docs/spark-configuration.md Outdated
@rdblue
rdblue merged commit 8e16f30 into apache:masterDec 21, 2021
@rdblue

Copy link
Copy Markdown
Contributor

Thanks, @kbendick!

@nastranastra left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

belated +1

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@kbendick@rdblue@nastra@jackye1995