Skip to content

Commit

Permalink
pre push
Browse files Browse the repository at this point in the history
  • Loading branch information
sfc-gh-jmichalak committed Sep 17, 2024
1 parent c7a55b2 commit 24cc353
Show file tree
Hide file tree
Showing 2 changed files with 146 additions and 12 deletions.
157 changes: 146 additions & 11 deletions docs/data-sources/masking_policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,177 @@
page_title: "snowflake_masking_policies Data Source - terraform-provider-snowflake"
subcategory: ""
description: |-
Datasource used to get details of filtered masking policies. Filtering is aligned with the current possibilities for SHOW MASKING POLICIES https://docs.snowflake.com/en/sql-reference/sql/show-masking-policies query. The results of SHOW and DESCRIBE are encapsulated in one output collection masking_policies.
---

# snowflake_masking_policies (Data Source)


Datasource used to get details of filtered masking policies. Filtering is aligned with the current possibilities for [SHOW MASKING POLICIES](https://docs.snowflake.com/en/sql-reference/sql/show-masking-policies) query. The results of SHOW and DESCRIBE are encapsulated in one output collection `masking_policies`.

## Example Usage

```terraform
data "snowflake_masking_policies" "current" {
database = "MYDB"
schema = "MYSCHEMA"
# Simple usage
data "snowflake_masking_policies" "simple" {
}
output "simple_output" {
value = data.snowflake_masking_policies.simple.masking_policies
}
# Filtering (like)
data "snowflake_masking_policies" "like" {
like = "masking-policy-name"
}
output "like_output" {
value = data.snowflake_masking_policies.like.masking_policies
}
# Filtering by prefix (like)
data "snowflake_masking_policies" "like_prefix" {
like = "prefix%"
}
output "like_prefix_output" {
value = data.snowflake_masking_policies.like_prefix.masking_policies
}
# Filtering (limit)
data "snowflake_masking_policies" "limit" {
limit {
rows = 10
from = "prefix-"
}
}
output "limit_output" {
value = data.snowflake_masking_policies.limit.masking_policies
}
# Filtering (in)
data "snowflake_masking_policies" "in" {
in {
database = "database"
}
}
output "in_output" {
value = data.snowflake_masking_policies.in.masking_policies
}
# Without additional data (to limit the number of calls make for every found masking policy)
data "snowflake_masking_policies" "only_show" {
# with_describe is turned on by default and it calls DESCRIBE MASKING POLICY for every masking policy found and attaches its output to masking_policies.*.describe_output field
with_describe = false
}
output "only_show_output" {
value = data.snowflake_masking_policies.only_show.masking_policies
}
# Ensure the number of masking policies is equal to at least one element (with the use of postcondition)
data "snowflake_masking_policies" "assert_with_postcondition" {
like = "masking-policy-name%"
lifecycle {
postcondition {
condition = length(self.masking_policies) > 0
error_message = "there should be at least one masking policy"
}
}
}
# Ensure the number of masking policies is equal to at exactly one element (with the use of check block)
check "masking_policy_check" {
data "snowflake_masking_policies" "assert_with_check_block" {
like = "masking-policy-name"
}
assert {
condition = length(data.snowflake_masking_policies.assert_with_check_block.masking_policies) == 1
error_message = "masking policies filtered by '${data.snowflake_masking_policies.assert_with_check_block.like}' returned ${length(data.snowflake_masking_policies.assert_with_check_block.masking_policies)} masking policies where one was expected"
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required
### Optional

- `database` (String) The database from which to return the schemas from.
- `schema` (String) The schema from which to return the maskingPolicies from.
- `in` (Block List, Max: 1) IN clause to filter the list of masking policies (see [below for nested schema](#nestedblock--in))
- `like` (String) Filters the output with **case-insensitive** pattern, with support for SQL wildcard characters (`%` and `_`).
- `limit` (Block List, Max: 1) Limits the number of rows returned. If the `limit.from` is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with `starts_with` or `like`. (see [below for nested schema](#nestedblock--limit))
- `with_describe` (Boolean) Runs DESC MASKING POLICY for each masking policy returned by SHOW MASKING POLICIES. The output of describe is saved to the description field. By default this value is set to true.

### Read-Only

- `id` (String) The ID of this resource.
- `masking_policies` (List of Object) The maskingPolicies in the schema (see [below for nested schema](#nestedatt--masking_policies))
- `masking_policies` (List of Object) Holds the aggregated output of all views details queries. (see [below for nested schema](#nestedatt--masking_policies))

<a id="nestedblock--in"></a>
### Nested Schema for `in`

Optional:

- `account` (Boolean) Returns records for the entire account.
- `application` (String) Returns records for the specified application.
- `application_package` (String) Returns records for the specified application package.
- `database` (String) Returns records for the current database in use or for a specified database.
- `schema` (String) Returns records for the current schema in use or a specified schema. Use fully qualified name.


<a id="nestedblock--limit"></a>
### Nested Schema for `limit`

Required:

- `rows` (Number) The maximum number of rows to return.

Optional:

- `from` (String) Specifies a **case-sensitive** pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.


<a id="nestedatt--masking_policies"></a>
### Nested Schema for `masking_policies`

Read-Only:

- `describe_output` (List of Object) (see [below for nested schema](#nestedobjatt--masking_policies--describe_output))
- `show_output` (List of Object) (see [below for nested schema](#nestedobjatt--masking_policies--show_output))

<a id="nestedobjatt--masking_policies--describe_output"></a>
### Nested Schema for `masking_policies.describe_output`

Read-Only:

- `body` (String)
- `name` (String)
- `return_type` (String)
- `signature` (List of Object) (see [below for nested schema](#nestedobjatt--masking_policies--describe_output--signature))

<a id="nestedobjatt--masking_policies--describe_output--signature"></a>
### Nested Schema for `masking_policies.describe_output.signature`

Read-Only:

- `name` (String)
- `type` (String)



<a id="nestedobjatt--masking_policies--show_output"></a>
### Nested Schema for `masking_policies.show_output`

Read-Only:

- `comment` (String)
- `database` (String)
- `created_on` (String)
- `database_name` (String)
- `exempt_other_policies` (Boolean)
- `kind` (String)
- `name` (String)
- `schema` (String)
- `owner` (String)
- `owner_role_type` (String)
- `schema_name` (String)
1 change: 0 additions & 1 deletion pkg/datasources/common.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import (
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
)


func handleLike(d *schema.ResourceData, setField **sdk.Like) {
if likePattern, ok := d.GetOk("like"); ok {
*setField = &sdk.Like{
Expand Down

0 comments on commit 24cc353

Please sign in to comment.