-
Notifications
You must be signed in to change notification settings - Fork 478
chore: Adjust task documentation #4226
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
Integration tests cancelled for e0a35b2d33dfbbd69bbbf366342b598f21879e1b |
|
Integration tests cancelled for ec8010f8877d994cbe559e49f0493570964abcc8 |
MIGRATION_GUIDE.md
Outdated
|
|
||
| ``` | ||
| Deprecated parameter 'AUTOCOMMIT' cannot be set on a task | ||
| Deprecated parameter 'SEARCH_PATH' cannot be set on a task |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Is autocommit officially deprecated? Because it's okay to set the value to true still.
- We deprecate SEARCH_PATH with a warning, but not in the schema? I think it's entirely deprecated in SF, no?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's for sure deprecated in tasks, but I'm not sure about the deprecation as a whole parameter. In this case, we mostly wanted to address tasks.
- Yes, but setting it to true doesn't really change anything as it's the default
- It can still be set on different levels, it just didn't make sense in the task context
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not default when it's set as FALSE on schema, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why schema? It can be set on account or session level
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As checked when creating a new task without those parameters, when:
- Parameter is set on session level, nothing happens
- Parameter is set on account level, the value is propagated to the task (even the bad ones)
docs/resources/task.md
Outdated
|
|
||
| !> **Sensitive values** This resource's `config`, `show_output.config` and `show_output.definition` fields are not marked as sensitive in the provider. Ensure that no personal data, sensitive data, export-controlled data, or other regulated data is entered as metadata when using the provider. For more information, see [Sensitive values limitations](../#sensitive-values-limitations) and [Metadata fields in Snowflake](https://docs.snowflake.com/en/sql-reference/metadata). | ||
|
|
||
| !> **Warning** The `AUTOCOMMIT` and `SEARCH_PATH` are deprecated session parameters for tasks in Snowflake. It is not possible to set them in Snowflake, thus it's recommended to not configure them within the resource. The parameters may be removed in the next major version of the provider. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AUTOCOMMIT can be set to TRUE
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well yes, but only because it's the default value. I was wondering if it makes sense to return warnings on non-allowed values or whenever someone is setting a value. In the end, decided to go with the latter as they're deprecated for a reason, setting values for them (other than defaults) on tasks doesn't make sense, so they should be unset.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This warning still shows they are deprecated (and AUTOCOMMIT still can be set - I dunno about the search path but let's nto use the deprecated word)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, adjusted
MIGRATION_GUIDE.md
Outdated
|
|
||
| ### Task deprecated parameter handling | ||
|
|
||
| Recently, Snowflake deprecated both [`AUTOCOMMIT`](https://docs.snowflake.com/en/sql-reference/parameters#autocommit) and [`SEARCH_PATH`](https://docs.snowflake.com/en/sql-reference/parameters#search-path) parameters for tasks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not deprecated, the validation was moved from runtime to creation alrteration. Please mention that setting these values previously on tasks was resulting in tasks that fail to start.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
True, adjusted
# Conflicts: # docs/resources/task.md # templates/resources/task.md.tmpl
|
Integration tests cancelled for aec03acdb2cc85076628859c341f07fe35e4fec4 |
docs/resources/task.md
Outdated
|
|
||
| !> **Sensitive values** This resource's `config`, `show_output.config` and `show_output.definition` fields are not marked as sensitive in the provider. Ensure that no personal data, sensitive data, export-controlled data, or other regulated data is entered as metadata when using the provider. For more information, see [Sensitive values limitations](../#sensitive-values-limitations) and [Metadata fields in Snowflake](https://docs.snowflake.com/en/sql-reference/metadata). | ||
|
|
||
| !> **Warning** The `AUTOCOMMIT` and `SEARCH_PATH` are deprecated session parameters for tasks in Snowflake. It is not possible to set them in Snowflake, thus it's recommended to not configure them within the resource. The parameters may be removed in the next major version of the provider. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This warning still shows they are deprecated (and AUTOCOMMIT still can be set - I dunno about the search path but let's nto use the deprecated word)
MIGRATION_GUIDE.md
Outdated
|
|
||
| ### Task deprecated parameter handling | ||
|
|
||
| Recently, Snowflake moved validation from runtime to CREATE/ALTER operations. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's be clear that this validation move was only for these two parameters (it's not e.g. for dag creation), let's be precise
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adjusted
| ``` | ||
|
|
||
| If you have any of these parameters set in your configuration, | ||
| please remove them to avoid the Terraform warnings and potential errors from the Snowflake side. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TRUE on AUTOCOMMIT is available so let's not advise to remove it (as it maybe needed in cases where AUTOCOMMIT is FALSE on account level param)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adjusted
MIGRATION_GUIDE.md
Outdated
|
|
||
| ``` | ||
| Deprecated parameter 'AUTOCOMMIT' cannot be set on a task | ||
| Deprecated parameter 'SEARCH_PATH' cannot be set on a task |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not default when it's set as FALSE on schema, right?
|
Integration tests cancelled for 1c906ead0c9074863815cb804f30c98d212d4572 |
|
Integration tests cancelled for 4bd4ff7ead9881818e0a8a8c5ee08eb2f68a4526 |
|
Account-level tests success for 1c906ead0c9074863815cb804f30c98d212d4572 |
|
Account-level tests success for 8cc4f1336947182a7720ac02bb1e7f0faf6f802e |
|
Integration tests cancelled for 8cc4f1336947182a7720ac02bb1e7f0faf6f802e |
🤖 I have created a release *beep* *boop* --- ## [2.11.0](v2.10.1...v2.11.0) (2025-11-21) ### 🎉 **What's new:** * Add notebook datasource ([#4209](#4209)) ([5599cfe](5599cfe)) * Add notebook resource ([#4195](#4195)) ([407dfa2](407dfa2)) * Add support for semantic views in grant ownership ([#4210](#4210)) ([5d2b961](5d2b961)) * Add task seconds and hours scheduling ([#4207](#4207)) ([ec623ed](ec623ed)) * Enable semantic views ([#4221](#4221)) ([2398a93](2398a93)) ### 🔧 **Misc** * Add protected security integrations in sweepers ([#4193](#4193)) ([94260ce](94260ce)) * Add small provider adjustments ([#4208](#4208)) ([34b1d6d](34b1d6d)) * Adjust data source tests follow up 1 ([#4163](#4163)) ([8e1d20a](8e1d20a)) * Adjust data source tests follow up 2 ([#4165](#4165)) ([23725df](23725df)) * Adjust data source tests follow up 3 ([#4166](#4166)) ([20ee0eb](20ee0eb)) * Adjust migration guide after grant ownership pr ([#4190](#4190)) ([c061a4e](c061a4e)) * Adjust task documentation ([#4226](#4226)) ([85ddbb9](85ddbb9)) * Adjust task tests ([#4216](#4216)) ([1e80581](1e80581)) * Adjust to 2025_07 BCR part 1 ([#4171](#4171)) ([df00c22](df00c22)) * Adjust to 2025_07 BCR part 2 ([#4174](#4174)) ([ec84372](ec84372)) * Bump the driver version to 1.18.0 ([#4220](#4220)) ([7f22a80](7f22a80)) * Change migration guide ([#4229](#4229)) ([8507769](8507769)) * Fix data source tests ([#4203](#4203)) ([c59e35d](c59e35d)) * Fix failing tests in ci ([#4194](#4194)) ([945aa69](945aa69)) * Fix references to objects used in the SDK generator templates ([#4200](#4200)) ([2b13800](2b13800)) * Regenerate SDK without package problems ([#4183](#4183)) ([ae7cb43](ae7cb43)) * Remove database roles from bulk ownership grants ([#4185](#4185)) ([8229934](8229934)) * Remove legacy columns from managed accounts SDK ([#4175](#4175)) ([3832a34](3832a34)) * Upgrade golangci-lint to v2.6.1 ([#4182](#4182)) ([ce1f354](ce1f354)) ### 🐛 **Bug fixes:** * Do not panic in parsing identifiers with arguments ([#4191](#4191)) ([f8a97f0](f8a97f0)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: terraform-provider-release[bot] <205196624+terraform-provider-release[bot]@users.noreply.github.com>
### Changes - Adjust update handling for deprecated parameters and return errors on `set` "events" - Add migration guide entry to inform users
🤖 I have created a release *beep* *boop* --- ## [2.11.0](snowflakedb/terraform-provider-snowflake@v2.10.1...v2.11.0) (2025-11-21) ### 🎉 **What's new:** * Add notebook datasource ([snowflakedb#4209](snowflakedb#4209)) ([5599cfe](snowflakedb@5599cfe)) * Add notebook resource ([snowflakedb#4195](snowflakedb#4195)) ([407dfa2](snowflakedb@407dfa2)) * Add support for semantic views in grant ownership ([snowflakedb#4210](snowflakedb#4210)) ([5d2b961](snowflakedb@5d2b961)) * Add task seconds and hours scheduling ([snowflakedb#4207](snowflakedb#4207)) ([ec623ed](snowflakedb@ec623ed)) * Enable semantic views ([snowflakedb#4221](snowflakedb#4221)) ([2398a93](snowflakedb@2398a93)) ### 🔧 **Misc** * Add protected security integrations in sweepers ([snowflakedb#4193](snowflakedb#4193)) ([94260ce](snowflakedb@94260ce)) * Add small provider adjustments ([snowflakedb#4208](snowflakedb#4208)) ([34b1d6d](snowflakedb@34b1d6d)) * Adjust data source tests follow up 1 ([snowflakedb#4163](snowflakedb#4163)) ([8e1d20a](snowflakedb@8e1d20a)) * Adjust data source tests follow up 2 ([snowflakedb#4165](snowflakedb#4165)) ([23725df](snowflakedb@23725df)) * Adjust data source tests follow up 3 ([snowflakedb#4166](snowflakedb#4166)) ([20ee0eb](snowflakedb@20ee0eb)) * Adjust migration guide after grant ownership pr ([snowflakedb#4190](snowflakedb#4190)) ([c061a4e](snowflakedb@c061a4e)) * Adjust task documentation ([snowflakedb#4226](snowflakedb#4226)) ([85ddbb9](snowflakedb@85ddbb9)) * Adjust task tests ([snowflakedb#4216](snowflakedb#4216)) ([1e80581](snowflakedb@1e80581)) * Adjust to 2025_07 BCR part 1 ([snowflakedb#4171](snowflakedb#4171)) ([df00c22](snowflakedb@df00c22)) * Adjust to 2025_07 BCR part 2 ([snowflakedb#4174](snowflakedb#4174)) ([ec84372](snowflakedb@ec84372)) * Bump the driver version to 1.18.0 ([snowflakedb#4220](snowflakedb#4220)) ([7f22a80](snowflakedb@7f22a80)) * Change migration guide ([snowflakedb#4229](snowflakedb#4229)) ([8507769](snowflakedb@8507769)) * Fix data source tests ([snowflakedb#4203](snowflakedb#4203)) ([c59e35d](snowflakedb@c59e35d)) * Fix failing tests in ci ([snowflakedb#4194](snowflakedb#4194)) ([945aa69](snowflakedb@945aa69)) * Fix references to objects used in the SDK generator templates ([snowflakedb#4200](snowflakedb#4200)) ([2b13800](snowflakedb@2b13800)) * Regenerate SDK without package problems ([snowflakedb#4183](snowflakedb#4183)) ([ae7cb43](snowflakedb@ae7cb43)) * Remove database roles from bulk ownership grants ([snowflakedb#4185](snowflakedb#4185)) ([8229934](snowflakedb@8229934)) * Remove legacy columns from managed accounts SDK ([snowflakedb#4175](snowflakedb#4175)) ([3832a34](snowflakedb@3832a34)) * Upgrade golangci-lint to v2.6.1 ([snowflakedb#4182](snowflakedb#4182)) ([ce1f354](snowflakedb@ce1f354)) ### 🐛 **Bug fixes:** * Do not panic in parsing identifiers with arguments ([snowflakedb#4191](snowflakedb#4191)) ([f8a97f0](snowflakedb@f8a97f0)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: terraform-provider-release[bot] <205196624+terraform-provider-release[bot]@users.noreply.github.com>
### Changes - Adjust update handling for deprecated parameters and return errors on `set` "events" - Add migration guide entry to inform users
🤖 I have created a release *beep* *boop* --- ## [2.11.0](snowflakedb/terraform-provider-snowflake@v2.10.1...v2.11.0) (2025-11-21) ### 🎉 **What's new:** * Add notebook datasource ([snowflakedb#4209](snowflakedb#4209)) ([5599cfe](snowflakedb@5599cfe)) * Add notebook resource ([snowflakedb#4195](snowflakedb#4195)) ([407dfa2](snowflakedb@407dfa2)) * Add support for semantic views in grant ownership ([snowflakedb#4210](snowflakedb#4210)) ([5d2b961](snowflakedb@5d2b961)) * Add task seconds and hours scheduling ([snowflakedb#4207](snowflakedb#4207)) ([ec623ed](snowflakedb@ec623ed)) * Enable semantic views ([snowflakedb#4221](snowflakedb#4221)) ([2398a93](snowflakedb@2398a93)) ### 🔧 **Misc** * Add protected security integrations in sweepers ([snowflakedb#4193](snowflakedb#4193)) ([94260ce](snowflakedb@94260ce)) * Add small provider adjustments ([snowflakedb#4208](snowflakedb#4208)) ([34b1d6d](snowflakedb@34b1d6d)) * Adjust data source tests follow up 1 ([snowflakedb#4163](snowflakedb#4163)) ([8e1d20a](snowflakedb@8e1d20a)) * Adjust data source tests follow up 2 ([snowflakedb#4165](snowflakedb#4165)) ([23725df](snowflakedb@23725df)) * Adjust data source tests follow up 3 ([snowflakedb#4166](snowflakedb#4166)) ([20ee0eb](snowflakedb@20ee0eb)) * Adjust migration guide after grant ownership pr ([snowflakedb#4190](snowflakedb#4190)) ([c061a4e](snowflakedb@c061a4e)) * Adjust task documentation ([snowflakedb#4226](snowflakedb#4226)) ([85ddbb9](snowflakedb@85ddbb9)) * Adjust task tests ([snowflakedb#4216](snowflakedb#4216)) ([1e80581](snowflakedb@1e80581)) * Adjust to 2025_07 BCR part 1 ([snowflakedb#4171](snowflakedb#4171)) ([df00c22](snowflakedb@df00c22)) * Adjust to 2025_07 BCR part 2 ([snowflakedb#4174](snowflakedb#4174)) ([ec84372](snowflakedb@ec84372)) * Bump the driver version to 1.18.0 ([snowflakedb#4220](snowflakedb#4220)) ([7f22a80](snowflakedb@7f22a80)) * Change migration guide ([snowflakedb#4229](snowflakedb#4229)) ([8507769](snowflakedb@8507769)) * Fix data source tests ([snowflakedb#4203](snowflakedb#4203)) ([c59e35d](snowflakedb@c59e35d)) * Fix failing tests in ci ([snowflakedb#4194](snowflakedb#4194)) ([945aa69](snowflakedb@945aa69)) * Fix references to objects used in the SDK generator templates ([snowflakedb#4200](snowflakedb#4200)) ([2b13800](snowflakedb@2b13800)) * Regenerate SDK without package problems ([snowflakedb#4183](snowflakedb#4183)) ([ae7cb43](snowflakedb@ae7cb43)) * Remove database roles from bulk ownership grants ([snowflakedb#4185](snowflakedb#4185)) ([8229934](snowflakedb@8229934)) * Remove legacy columns from managed accounts SDK ([snowflakedb#4175](snowflakedb#4175)) ([3832a34](snowflakedb@3832a34)) * Upgrade golangci-lint to v2.6.1 ([snowflakedb#4182](snowflakedb#4182)) ([ce1f354](snowflakedb@ce1f354)) ### 🐛 **Bug fixes:** * Do not panic in parsing identifiers with arguments ([snowflakedb#4191](snowflakedb#4191)) ([f8a97f0](snowflakedb@f8a97f0)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: terraform-provider-release[bot] <205196624+terraform-provider-release[bot]@users.noreply.github.com>
Changes
set"events"