Skip to content

Commit

Permalink
moving example for file_format to a place before autogenerated part
Browse files Browse the repository at this point in the history
  • Loading branch information
sfc-gh-dszmolka committed Dec 26, 2024
1 parent a3dcd9c commit 8551c97
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/resources/stage.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@ resource "snowflake_stage" "example_stage" {

-> **Note** Instead of using fully_qualified_name, you can reference objects managed outside Terraform by constructing a correct ID, consult [identifiers guide](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/guides/identifiers#new-computed-fully-qualified-name-field-in-resources).
<!-- TODO(SNOW-1634854): include an example showing both methods-->
-> ** Examples of usage for `file_format`:**
* with hardcoding value: `file_format="FORMAT_NAME = DB.SCHEMA.FORMATNAME"`
* from dynamic value: `file_format = "FORMAT_NAME = ${snowflake_database.mydb.name}.${snowflake_schema.myschema.name}.${snowflake_file_format.myfileformat.name}"`
* from expression: `file_format = format("FORMAT_NAME =%s.%s.MYFILEFORMAT", var.db_name, each.value.schema_name)`
(Reference: [#265](https://github.com/Snowflake-Labs/terraform-provider-snowflake/issues/265))

<!-- schema generated by tfplugindocs -->
## Schema
Expand All @@ -43,11 +48,7 @@ resource "snowflake_stage" "example_stage" {
- `credentials` (String, Sensitive) Specifies the credentials for the stage.
- `directory` (String) Specifies the directory settings for the stage.
- `encryption` (String) Specifies the encryption settings for the stage.
- `file_format` (String) Specifies the file format for the stage. Specifying the default Snowflake value (e.g. TYPE = CSV) will currently result in a permadiff (check [#2679](https://github.com/Snowflake-Labs/terraform-provider-snowflake/issues/2679)). For now, omit the default values; it will be fixed in the upcoming provider versions. Examples of usage:
* with hardcoding value: `file_format="FORMAT_NAME = DB.SCHEMA.FORMATNAME"`
* from dynamic value: `file_format = "FORMAT_NAME = ${snowflake_database.mydb.name}.${snowflake_schema.myschema.name}.${snowflake_file_format.myfileformat.name}"`
* from expression: `file_format = format("FORMAT_NAME =%s.%s.MYFILEFORMAT", var.db_name, each.value.schema_name)`
(Reference: [#265](https://github.com/Snowflake-Labs/terraform-provider-snowflake/issues/265))
- `file_format` (String) Specifies the file format for the stage. Specifying the default Snowflake value (e.g. TYPE = CSV) will currently result in a permadiff (check [#2679](https://github.com/Snowflake-Labs/terraform-provider-snowflake/issues/2679)). For now, omit the default values; it will be fixed in the upcoming provider versions.
- `snowflake_iam_user` (String) An AWS IAM user created for your Snowflake account. This user is the same for every external S3 stage created in your account.
- `storage_integration` (String) Specifies the name of the storage integration used to delegate authentication responsibility for external cloud storage to a Snowflake identity and access management (IAM) entity.
- `tag` (Block List, Deprecated) Definitions of a tag to associate with the resource. (see [below for nested schema](#nestedblock--tag))
Expand Down

0 comments on commit 8551c97

Please sign in to comment.