Skip to content

Conversation

@kbendick
Copy link
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>
*/
public static final String CACHE_EXPIRATION_INTERVAL_MS = "cache.expiration-interval-ms";

@github-actions github-actions bot added the docs label Dec 21, 2021
@kbendick kbendick force-pushed the document-cache-expiration-config branch from 9601361 to f4bb4ef Compare December 21, 2021 20:27
@kbendick
Copy link
Contributor Author

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
Copy link
Contributor Author

kbendick commented Dec 21, 2021

image

| 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
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
Contributor Author

Choose a reason for hiding this comment

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

Sure.

Copy link
Contributor Author

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
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 kbendick force-pushed the document-cache-expiration-config branch from f4bb4ef to 3ea3a09 Compare December 21, 2021 21:11
@rdblue rdblue merged commit 8e16f30 into apache:master Dec 21, 2021
@rdblue
Copy link
Contributor

rdblue commented Dec 21, 2021

Thanks, @kbendick!

Copy link
Contributor

@nastra nastra left a comment

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 free to 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