Skip to content

Commit

Permalink
Add sdk migration in readme (#2056)
Browse files Browse the repository at this point in the history
  • Loading branch information
@sfc-gh-jcieslak
sfc-gh-jcieslak authored Sep 19, 2023
1 parent 1d15355 commit 0913292
Showing 1 changed file with 85 additions and 0 deletions.
85 changes: 85 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@

This is a terraform provider for managing [Snowflake](https://www.snowflake.com/) resources.

## Table of contents
- [Snowflake Terraform Provider](#snowflake-terraform-provider)
- [Table of contents](#table-of-contents)
- [Getting started](#getting-started)
- [SDK migration table](#sdk-migration-table)
- [Getting Help](#getting-help)
- [Contributing](#contributing)


## Getting started

> If you're still using the `chanzuckerberg/snowflake` source, see [Upgrading from CZI Provider](./CZI_UPGRADE.md) to upgrade to the current version.
Expand Down Expand Up @@ -37,6 +46,82 @@ Don't forget to run `terraform init` and you're ready to go! 🚀

Start browsing the [registry docs](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs) to find resources and data sources to use.

## SDK migration table

This table represents the current state of SDK migration from pkg/snowflake to pkg/sdk package.
The goal of migration is to support every Snowflake feature with more type safe API and use it in every resource / datasource.

SDK migration status - indicates if given resource has been migrated into new SDK.

Integration status - indicates if given resource / datasource is using new SDK.

✅ - done<br>
❌ - not started<br>
👨‍💻 - in progress<br>
🟨 - partially done<br>


| Object Type | SDK migration status | Resource name | Datasource name | Integration status |
|-------------------------------------|----------------------|------------------------------------------------|-------------------------------|--------------------|
| Account | ✅ | snowflake_account | snowflake_account | ✅ |
| Managed Account | ❌ | snowflake_managed_account | snowflake_managed_account | ❌ |
| User | ✅ | snowflake_user | snowflake_user | ✅ |
| Database Role | ✅ | snowflake_database_role | snowflake_database_role | ✅ |
| Role | 👨‍💻 | snowflake_role | snowflake_role | 👨‍💻 |
| Grant Privilege to Application Role | ❌ | snowflake_grant_privileges_to_application_role | snowflake_grants | ❌ |
| Grant Privilege to Database Role | 👨‍💻 | snowflake_grant_privileges_to_database_role | snowflake_grants | 👨‍💻 |
| Grant Privilege to Role | ❌ | snowflake_grant_privileges_to_role | snowflake_grants | ✅ |
| Grant Role | ❌ | snowflake_grant_role | snowflake_grants | ❌ |
| Grant Database Role | ✅ | snowflake_grant_database_role | snowflake_grants | ❌ |
| Grant Application Role | ❌ | snowflake_grant_application_role | snowflake_grants | ❌ |
| Grant Privilege to Share | ✅ | snowflake_grant_privileges_to_share | snowflake_grants | ❌ |
| Grant Ownership | ❌ | snowflake_grant_ownership | snowflake_grants | ❌ |
| API Integration | ❌ | snowflake_api_integration | snowflake_integrations | ❌ |
| Notification Integration | ❌ | snowflake_notification_integration | snowflake_integrations | ❌ |
| Security Integration | ❌ | snowflake_security_integration | snowflake_integrations | ❌ |
| Storage Integration | ❌ | snowflake_storage_integration | snowflake_integrations | ❌ |
| Network Policy | ❌ | snowflake_network_policy | snowflake_network_policy | ❌ |
| Password Policy | ✅ | snowflake_password_policy | snowflake_password_policy | ✅ |
| Session Policy | ❌ | snowflake_session_policy | snowflake_session_policy | ❌ |
| Replication Group | ❌ | snowflake_replication_group | snowflake_replication_group | ❌ |
| Failover Group | ✅ | snowflake_failover_group | snowflake_failover_group | ✅ |
| Connection | ❌ | snowflake_connection | snowflake_connection | ❌ |
| Account Parameters | 🟨 | snowflake_account_parameter | snowflake_parameters | ❌ |
| Session Parameters | 🟨 | snowflake_session_parameter | snowflake_parameters | ❌ |
| Object Parameters | 🟨 | snowflake_object_parameter | snowflake_parameters | ❌ |
| Warehouse | ✅ | snowflake_warehouse | snowflake_warehouse | 🟨 |
| Resource Monitor | ✅ | snowflake_resource_monitor | snowflake_resource_monitor | ✅ |
| Database | ✅ | snowflake_database | snowflake_database | ✅ |
| Schema | ✅ | snowflake_schema | snowflake_schema | ❌ |
| Share | ✅ | snowflake_share | snowflake_share | ✅ |
| Table | 👨‍💻 | snowflake_table | snowflake_table | ❌ |
| Dynamic Table | ❌ | snowflake_dynamic_table | snowflake_dynamic_table | ❌ |
| External Table | 👨‍💻 | snowflake_external_table | snowflake_external_table | ❌ |
| Event Table | ❌ | snowflake_event_table | snowflake_event_table | ❌ |
| View | ❌ | snowflake_view | snowflake_view | ❌ |
| Materialized View | ❌ | snowflake_materialized_view | snowflake_materialized_view | ❌ |
| Sequence | ❌ | snowflake_sequence | snowflake_sequence | ❌ |
| Function | ❌ | snowflake_function | snowflake_function | ❌ |
| External Function | ❌ | snowflake_external_function | snowflake_external_function | ❌ |
| Stored Procedure | ❌ | snowflake_stored_procedure | snowflake_stored_procedure | ❌ |
| Stream | ❌ | snowflake_stream | snowflake_stream | ❌ |
| Task | ❌ | snowflake_task | snowflake_task | ❌ |
| Masking Policy | ✅ | snowflake_masking_policy | snowflake_masking_policy | ✅ |
| Row Access Policy | ❌ | snowflake_row_access_policy | snowflake_row_access_policy | ❌ |
| Tag | ❌ | snowflake_tag | snowflake_tag | ❌ |
| Secret | ❌ | snowflake_secret | snowflake_secret | ❌ |
| Stage | ❌ | snowflake_stage | snowflake_stage | ❌ |
| File Format | ✅ | snowflake_file_format | snowflake_file_format | ✅ |
| Pipe | ✅ | snowflake_pipe | snowflake_pipe | ✅ |
| Alert | ✅ | snowflake_alert | snowflake_alert | ✅ |
| Application | ❌ | snowflake_application | snowflake_application | ❌ |
| Application Package | ❌ | snowflake_application_package | snowflake_application_package | ❌ |
| Application Role | ❌ | snowflake_application_role | snowflake_application_role | ❌ |
| Streamlit | ❌ | snowflake_streamlit | snowflake_streamlit | ❌ |
| Versioned Schema | ❌ | snowflake_versioned_schema | snowflake_versioned_schema | ❌ |
| Tag Association | ❌ | snowflake_tag_association | snowflake_tag_association | ❌ |


## Getting Help

Some links that might help you:
Expand Down

0 comments on commit 0913292

Please sign in to comment.