Commit 8976902
authored
SNOW-1755655: Add a note in cache_result about table name and temp table cleanup (#2638)
<!---
Please answer these questions before creating your pull request. Thanks!
--->
1. Which Jira issue is this PR addressing? Make sure that there is an
accompanying issue to your PR.
<!---
In this section, please add a Snowflake Jira issue number.
Note that if a corresponding GitHub issue exists, you should still
include
the Snowflake Jira issue number. For example, for GitHub issue
#1400, you should
add "SNOW-1335071" here.
--->
Fixes SNOW-1755655
2. Fill out the following pre-review checklist:
- [ ] I am adding a new automated test(s) to verify correctness of my
new code
- [ ] If this test skips Local Testing mode, I'm requesting review from
@snowflakedb/local-testing
- [ ] I am adding new logging messages
- [ ] I am adding a new telemetry message
- [ ] I am adding new credentials
- [ ] I am adding a new dependency
- [ ] If this is a new feature/behavior, I'm adding the Local Testing
parity changes.
- [x] I acknowledge that I have ensured my changes to be thread-safe.
Follow the link for more information: [Thread-safe Developer
Guidelines](https://docs.google.com/document/d/162d_i4zZ2AfcGRXojj0jByt8EUq-DrSHPPnTa4QvwbA/edit#bookmark=id.e82u4nekq80k)
3. Please describe how your code solves the related issue.
This pull request includes an update to the `cache_result` method in the
`src/snowflake/snowpark/dataframe.py` file to provide additional
documentation and clarity on the behavior of the method. The most
important changes include adding a detailed note about the creation and
lifecycle of the temporary table used to store the cached result.
Documentation improvements:
*
[`src/snowflake/snowpark/dataframe.py`](diffhunk://#diff-9732895e18d0ffe66be3624d2aaefcba56260bcc238a6a0a598ef601512e03e8R4074-R4086):
Added a note explaining that a temporary table is created to store the
cached result, including details on how it may be automatically removed
and how to retain a persistent table using
`DataFrameWriter.save_as_table`.1 parent 5af35c5 commit 8976902
1 file changed
+13
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4071 | 4071 | | |
4072 | 4072 | | |
4073 | 4073 | | |
| 4074 | + | |
| 4075 | + | |
| 4076 | + | |
| 4077 | + | |
| 4078 | + | |
| 4079 | + | |
| 4080 | + | |
| 4081 | + | |
| 4082 | + | |
| 4083 | + | |
| 4084 | + | |
| 4085 | + | |
| 4086 | + | |
4074 | 4087 | | |
4075 | 4088 | | |
4076 | 4089 | | |
| |||
0 commit comments