Skip to content

fix: Make non-required object fields as optional for input variables #377

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Mar 6, 2025
Merged

fix: Make non-required object fields as optional for input variables #377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
efd7b4e
add default values for input variables
ayushmjain Mar 5, 2025
7093632
revert back metadata version
ayushmjain Mar 5, 2025
4e09ca7
change description for location input variable
ayushmjain Mar 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,16 +196,16 @@ This module provisions a dataset and a list of tables with associated JSON schem
| deletion\_protection | Whether or not to allow deletion of tables and external tables defined by this module. Can be overriden by table-level deletion\_protection configuration. | `bool` | `false` | no |
| description | Dataset description. | `string` | `null` | no |
| encryption\_key | Default encryption key to apply to the dataset. Defaults to null (Google-managed). | `string` | `null` | no |
| external\_tables | A list of objects which include table\_id, expiration\_time, external\_data\_configuration, and labels. | <pre>list(object({<br> table_id = string,<br> description = optional(string),<br> autodetect = bool,<br> compression = string,<br> ignore_unknown_values = bool,<br> max_bad_records = number,<br> schema = string,<br> source_format = string,<br> source_uris = list(string),<br> csv_options = object({<br> quote = string,<br> allow_jagged_rows = bool,<br> allow_quoted_newlines = bool,<br> encoding = string,<br> field_delimiter = string,<br> skip_leading_rows = number,<br> }),<br> google_sheets_options = object({<br> range = string,<br> skip_leading_rows = number,<br> }),<br> hive_partitioning_options = object({<br> mode = string,<br> source_uri_prefix = string,<br> }),<br> expiration_time = string,<br> max_staleness = optional(string),<br> deletion_protection = optional(bool),<br> labels = map(string),<br> }))</pre> | `[]` | no |
| location | The regional location for the dataset only US and EU are allowed in module | `string` | `"US"` | no |
| materialized\_views | A list of objects which includes view\_id, view\_query, clustering, time\_partitioning, range\_partitioning, expiration\_time and labels | <pre>list(object({<br> view_id = string,<br> description = optional(string),<br> query = string,<br> enable_refresh = bool,<br> refresh_interval_ms = string,<br> clustering = list(string),<br> time_partitioning = object({<br> expiration_ms = string,<br> field = string,<br> type = string,<br> require_partition_filter = bool,<br> }),<br> range_partitioning = object({<br> field = string,<br> range = object({<br> start = string,<br> end = string,<br> interval = string,<br> }),<br> }),<br> expiration_time = string,<br> max_staleness = optional(string),<br> labels = map(string),<br> }))</pre> | `[]` | no |
| external\_tables | A list of objects which include table\_id, expiration\_time, external\_data\_configuration, and labels. | <pre>list(object({<br> table_id = string,<br> description = optional(string),<br> autodetect = bool,<br> compression = string,<br> ignore_unknown_values = bool,<br> max_bad_records = number,<br> schema = string,<br> source_format = string,<br> source_uris = list(string),<br> csv_options = object({<br> quote = string,<br> allow_jagged_rows = bool,<br> allow_quoted_newlines = bool,<br> encoding = string,<br> field_delimiter = string,<br> skip_leading_rows = number,<br> }),<br> google_sheets_options = object({<br> range = string,<br> skip_leading_rows = number,<br> }),<br> hive_partitioning_options = object({<br> mode = string,<br> source_uri_prefix = string,<br> }),<br> expiration_time = optional(string, null),<br> max_staleness = optional(string),<br> deletion_protection = optional(bool),<br> labels = optional(map(string), {}),<br> }))</pre> | `[]` | no |
| location | The location of the dataset. For multi-region, US or EU can be provided. | `string` | `"US"` | no |
| materialized\_views | A list of objects which includes view\_id, view\_query, clustering, time\_partitioning, range\_partitioning, expiration\_time and labels | <pre>list(object({<br> view_id = string,<br> description = optional(string),<br> query = string,<br> enable_refresh = bool,<br> refresh_interval_ms = string,<br> clustering = optional(list(string), []),<br> time_partitioning = optional(object({<br> expiration_ms = string,<br> field = string,<br> type = string,<br> require_partition_filter = bool,<br> }), null),<br> range_partitioning = optional(object({<br> field = string,<br> range = object({<br> start = string,<br> end = string,<br> interval = string,<br> }),<br> }), null),<br> expiration_time = optional(string, null),<br> max_staleness = optional(string),<br> labels = optional(map(string), {}),<br> }))</pre> | `[]` | no |
| max\_time\_travel\_hours | Defines the time travel window in hours | `number` | `null` | no |
| project\_id | Project where the dataset and table are created | `string` | n/a | yes |
| resource\_tags | A map of resource tags to add to the dataset | `map(string)` | `{}` | no |
| routines | A list of objects which include routine\_id, routine\_type, routine\_language, definition\_body, return\_type, routine\_description and arguments. | <pre>list(object({<br> routine_id = string,<br> routine_type = string,<br> language = string,<br> definition_body = string,<br> return_type = string,<br> description = string,<br> arguments = list(object({<br> name = string,<br> data_type = string,<br> argument_kind = string,<br> mode = string,<br> })),<br> }))</pre> | `[]` | no |
| routines | A list of objects which include routine\_id, routine\_type, routine\_language, definition\_body, return\_type, routine\_description and arguments. | <pre>list(object({<br> routine_id = string,<br> routine_type = string,<br> language = string,<br> definition_body = string,<br> return_type = string,<br> description = string,<br> arguments = optional(list(object({<br> name = string,<br> data_type = string,<br> argument_kind = string,<br> mode = string,<br> })), []),<br> }))</pre> | `[]` | no |
| storage\_billing\_model | Specifies the storage billing model for the dataset. Set this flag value to LOGICAL to use logical bytes for storage billing, or to PHYSICAL to use physical bytes instead. LOGICAL is the default if this flag isn't specified. | `string` | `null` | no |
| tables | A list of objects which include table\_id, table\_name, schema, clustering, time\_partitioning, range\_partitioning, expiration\_time and labels. | <pre>list(object({<br> table_id = string,<br> description = optional(string),<br> table_name = optional(string),<br> schema = string,<br> clustering = list(string),<br> require_partition_filter = optional(bool),<br> time_partitioning = object({<br> expiration_ms = string,<br> field = string,<br> type = string,<br> }),<br> range_partitioning = object({<br> field = string,<br> range = object({<br> start = string,<br> end = string,<br> interval = string,<br> }),<br> }),<br> expiration_time = string,<br> deletion_protection = optional(bool),<br> labels = map(string),<br> }))</pre> | `[]` | no |
| views | A list of objects which include view\_id and view query | <pre>list(object({<br> view_id = string,<br> description = optional(string),<br> query = string,<br> use_legacy_sql = bool,<br> labels = map(string),<br> }))</pre> | `[]` | no |
| tables | A list of objects which include table\_id, table\_name, schema, clustering, time\_partitioning, range\_partitioning, expiration\_time and labels. | <pre>list(object({<br> table_id = string,<br> description = optional(string),<br> table_name = optional(string),<br> schema = string,<br> clustering = optional(list(string), []),<br> require_partition_filter = optional(bool),<br> time_partitioning = optional(object({<br> expiration_ms = string,<br> field = string,<br> type = string,<br> }), null),<br> range_partitioning = optional(object({<br> field = string,<br> range = object({<br> start = string,<br> end = string,<br> interval = string,<br> }),<br> }), null),<br> expiration_time = optional(string, null),<br> deletion_protection = optional(bool),<br> labels = optional(map(string), {}),<br> }))</pre> | `[]` | no |
| views | A list of objects which include view\_id and view query | <pre>list(object({<br> view_id = string,<br> description = optional(string),<br> query = string,<br> use_legacy_sql = bool,<br> labels = optional(map(string), {}),<br> }))</pre> | `[]` | no |

## Outputs

Expand Down
40 changes: 20 additions & 20 deletions metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ spec:
description: Dataset description.
varType: string
- name: location
description: The regional location for the dataset only US and EU are allowed in module
description: The location of the dataset. For multi-region, US or EU can be provided.
varType: string
defaultValue: US
- name: delete_contents_on_destroy
Expand Down Expand Up @@ -114,24 +114,24 @@ spec:
description = optional(string),
table_name = optional(string),
schema = string,
clustering = list(string),
clustering = optional(list(string), []),
require_partition_filter = optional(bool),
time_partitioning = object({
time_partitioning = optional(object({
expiration_ms = string,
field = string,
type = string,
}),
range_partitioning = object({
}), null),
range_partitioning = optional(object({
field = string,
range = object({
start = string,
end = string,
interval = string,
}),
}),
expiration_time = string,
}), null),
expiration_time = optional(string, null),
deletion_protection = optional(bool),
labels = map(string),
labels = optional(map(string), {}),
}))
defaultValue: []
- name: views
Expand All @@ -142,7 +142,7 @@ spec:
description = optional(string),
query = string,
use_legacy_sql = bool,
labels = map(string),
labels = optional(map(string), {}),
}))
defaultValue: []
- name: materialized_views
Expand All @@ -154,24 +154,24 @@ spec:
query = string,
enable_refresh = bool,
refresh_interval_ms = string,
clustering = list(string),
time_partitioning = object({
clustering = optional(list(string), []),
time_partitioning = optional(object({
expiration_ms = string,
field = string,
type = string,
require_partition_filter = bool,
}),
range_partitioning = object({
}), null),
range_partitioning = optional(object({
field = string,
range = object({
start = string,
end = string,
interval = string,
}),
}),
expiration_time = string,
}), null),
expiration_time = optional(string, null),
max_staleness = optional(string),
labels = map(string),
labels = optional(map(string), {}),
}))
defaultValue: []
- name: external_tables
Expand Down Expand Up @@ -203,10 +203,10 @@ spec:
mode = string,
source_uri_prefix = string,
}),
expiration_time = string,
expiration_time = optional(string, null),
max_staleness = optional(string),
deletion_protection = optional(bool),
labels = map(string),
labels = optional(map(string), {}),
}))
defaultValue: []
- name: routines
Expand All @@ -219,12 +219,12 @@ spec:
definition_body = string,
return_type = string,
description = string,
arguments = list(object({
arguments = optional(list(object({
name = string,
data_type = string,
argument_kind = string,
mode = string,
})),
})), []),
}))
defaultValue: []
outputs:
Expand Down
40 changes: 20 additions & 20 deletions variables.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ variable "description" {
}

variable "location" {
description = "The regional location for the dataset only US and EU are allowed in module"
description = "The location of the dataset. For multi-region, US or EU can be provided."
type = string
default = "US"
}
Expand Down Expand Up @@ -125,24 +125,24 @@ variable "tables" {
description = optional(string),
table_name = optional(string),
schema = string,
clustering = list(string),
clustering = optional(list(string), []),
require_partition_filter = optional(bool),
time_partitioning = object({
time_partitioning = optional(object({
expiration_ms = string,
field = string,
type = string,
}),
range_partitioning = object({
}), null),
range_partitioning = optional(object({
field = string,
range = object({
start = string,
end = string,
interval = string,
}),
}),
expiration_time = string,
}), null),
expiration_time = optional(string, null),
deletion_protection = optional(bool),
labels = map(string),
labels = optional(map(string), {}),
}))
}

Expand All @@ -154,7 +154,7 @@ variable "views" {
description = optional(string),
query = string,
use_legacy_sql = bool,
labels = map(string),
labels = optional(map(string), {}),
}))
}

Expand All @@ -167,24 +167,24 @@ variable "materialized_views" {
query = string,
enable_refresh = bool,
refresh_interval_ms = string,
clustering = list(string),
time_partitioning = object({
clustering = optional(list(string), []),
time_partitioning = optional(object({
expiration_ms = string,
field = string,
type = string,
require_partition_filter = bool,
}),
range_partitioning = object({
}), null),
range_partitioning = optional(object({
field = string,
range = object({
start = string,
end = string,
interval = string,
}),
}),
expiration_time = string,
}), null),
expiration_time = optional(string, null),
max_staleness = optional(string),
labels = map(string),
labels = optional(map(string), {}),
}))
}

Expand Down Expand Up @@ -217,10 +217,10 @@ variable "external_tables" {
mode = string,
source_uri_prefix = string,
}),
expiration_time = string,
expiration_time = optional(string, null),
max_staleness = optional(string),
deletion_protection = optional(bool),
labels = map(string),
labels = optional(map(string), {}),
}))
}

Expand All @@ -235,11 +235,11 @@ variable "routines" {
definition_body = string,
return_type = string,
description = string,
arguments = list(object({
arguments = optional(list(object({
name = string,
data_type = string,
argument_kind = string,
mode = string,
})),
})), []),
}))
}