Snowflake Terraform Provider

⚠️ Incoming holidays: The whole team will be absent from the 21st of December to the 7th of January. Our involvement in GitHub issues during this time will be limited. We will look out for the critical issues, though. Merry Christmas and a Happy New Year!

⚠️ Please note: If you believe you have found a security issue, please responsibly disclose by contacting us at triage-terraformprovider-dl@snowflake.com.

⚠️ Disclaimer: The project is in v1 version, but some features are in preview. Such resources and data sources are considered preview features in the provider, regardless of their state in Snowflake. We do not guarantee their stability. They will be reworked and marked as a stable feature in future releases. Breaking changes in these features are expected, even without bumping the major version. They are disabled by default. To use them, add the relevant feature name to preview_features_enabled field in the provider configuration. The list of preview features is available below. Please always refer to the Getting Help section in our Github repo to best determine how to get help for your questions.

Keep in mind that V1 does not mean we have an official Snowflake support. Please follow creating issues guidelines.

---

This is a terraform provider for managing Snowflake resources.

Table of contents

• Snowflake Terraform Provider
  • Table of contents
  • Getting started
  • Migration guide
  • Roadmap
  • Getting Help
  • Would you like to create an issue?
  • Additional debug logs for snowflake_grant_privileges_to_role resource
  • Additional SQL Client configuration
  • Contributing
  • Releases

Getting started

If you're still using the chanzuckerberg/snowflake source, see Upgrading from CZI Provider to upgrade to the current version.

Install the Snowflake Terraform provider by adding a requirement block and a provider block to your Terraform codebase:

terraform {
  required_providers {
    snowflake = {
      source  = "Snowflake-Labs/snowflake"
      version = ">= 1.0.0"
    }
  }
}

provider "snowflake" {
  organization_name = "organization_name"
  account_name      = "account_name"
  user              = "johndoe"
  password          = "v3ry$3cr3t"
  role              = "ACCOUNTADMIN"
}

For more information on provider configuration see the provider docs on the Terraform registry.

Don't forget to run terraform init and you're ready to go! 🚀

Start browsing the registry docs to find resources and data sources to use.

Migration guide

Please check the migration guide when changing the version of the provider.

Roadmap

Check Roadmap.

Getting Help

Some links that might help you:

• The introductory tutorial shows how to set up your Snowflake account for Terraform (service user, role, authentication, etc) and how to create your first resources in Terraform.
• The docs on the Terraform registry are a complete reference of all resources and data sources supported and contain more advanced examples.
• The discussions area of this repo, we use this forum to discuss new features and changes to the provider.
• If you are an enterprise customer, reach out to your account team. This helps us prioritize issues.
• The issues section might already have an issue addressing your question.

Would you like to create an issue?

If you would like to create a GitHub issue, please read our guide first. It contains useful links, FAQ, and commonly known issues with solutions that may already solve your case.

Additional debug logs for snowflake_grant_privileges_to_role resource

Set environment variable SF_TF_ADDITIONAL_DEBUG_LOGGING to a non-empty value. Additional logs will be visible with sf-tf-additional-debug prefix, e.g.:

2023/12/08 12:58:22.497078 sf-tf-additional-debug [DEBUG] Creating new client from db

Additional SQL Client configuration

Currently underlying sql gosnowflake driver is wrapped with instrumentedsql. In order to use raw gosnowflake driver, set environment variable SF_TF_NO_INSTRUMENTED_SQL to a non-empty value.

By default, the underlying driver is set to error level logging. It can be changed by setting driver_tracing field in the configuration to one of (from most to least verbose):

• trace
• debug
• info
• print
• warning
• error
• fatal
• panic

Read more in provider configuration docs.

Contributing

Check Contributing.

Releases

Releases will be performed as needed, typically once every 2 weeks.

Releases are published to the terraform registry. Each change has its own release notes (e.g. https://github.com/Snowflake-Labs/terraform-provider-snowflake/releases/tag/v0.89.0) and migration guide if needed (e.g. https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/MIGRATION_GUIDE.md#v0880--v0890).