feat: optional table creation through IaC

PiperOrigin-RevId: 785444189

Author: Android Build Filesystem (ABFS) Team

examples/simple/main.tf

@@ -23,21 +23,22 @@ moved {
 }
 
 module "abfs_server" {
-  source = "github.com/terraform-google-modules/terraform-google-abfs//modules/server?ref=v0.7.0"
+  source = "github.com/terraform-google-modules/terraform-google-abfs//modules/server?ref=v0.7.1"
 
-  project_id                   = data.google_project.project.project_id
-  zone                         = var.zone
-  service_account_email        = data.google_service_account.abfs.email
-  subnetwork                   = module.abfs-vpc.subnets["${var.region}/abfs-subnet"].name
-  abfs_docker_image_uri        = var.abfs_docker_image_uri
-  abfs_license                 = var.abfs_license
-  abfs_bucket_location         = var.abfs_bucket_location
-  abfs_server_machine_type     = var.abfs_server_machine_type
-  abfs_spanner_instance_config = var.abfs_spanner_instance_config
+  project_id                          = data.google_project.project.project_id
+  zone                                = var.zone
+  service_account_email               = data.google_service_account.abfs.email
+  subnetwork                          = module.abfs-vpc.subnets["${var.region}/abfs-subnet"].name
+  abfs_docker_image_uri               = var.abfs_docker_image_uri
+  abfs_license                        = var.abfs_license
+  abfs_bucket_location                = var.abfs_bucket_location
+  abfs_server_machine_type            = var.abfs_server_machine_type
+  abfs_spanner_instance_config        = var.abfs_spanner_instance_config
+  abfs_spanner_database_create_tables = var.abfs_spanner_database_create_tables
 }
 
 module "abfs_uploaders" {
-  source = "github.com/terraform-google-modules/terraform-google-abfs//modules/uploaders?ref=v0.7.0"
+  source = "github.com/terraform-google-modules/terraform-google-abfs//modules/uploaders?ref=v0.7.1"
 
   project_id                            = data.google_project.project.project_id
   zone                                  = var.zone

examples/simple/outputs.tf

@@ -23,5 +23,15 @@ output "license_information" {
 
 output "spanner_database_schema_creation" {
   description = "The CLI command for creating the Spanner database schema"
-  value       = "SCHEMA_FILE=0.0.31-schema.sql; curl -O https://raw.githubusercontent.com/terraform-google-modules/terraform-google-abfs/refs/heads/main/files/schemas/$SCHEMA_FILE; gcloud --project ${data.google_project.project.project_id} spanner databases ddl update --instance ${module.abfs_server.abfs_spanner_instance.name} ${module.abfs_server.abfs_spanner_database.name} --ddl-file $SCHEMA_FILE; rm $SCHEMA_FILE"
+  value = var.abfs_spanner_database_create_tables ? (
+    "# The abfs_spanner_database_create_tables variable was set to true; no further action required."
+    ) : (
+    join(" ", [
+      "gcloud --project ${data.google_project.project.project_id}",
+      "spanner databases ddl update",
+      "--instance ${module.abfs_server.abfs_spanner_instance.name}",
+      "${module.abfs_server.abfs_spanner_database.name}",
+      "--ddl-file ${module.abfs_server.abfs_spanner_database_schema_file}",
+    ])
+  )
 }

examples/simple/variables.tf

@@ -105,6 +105,12 @@ variable "abfs_spanner_instance_config" {
   description = "The name of the instance's configuration (similar but not quite the same as a region) which defines the geographic placement and replication of your ABFS database in this instance (https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/spanner_instance.html#config-1)."
 }
 
+variable "abfs_spanner_database_create_tables" {
+  type        = bool
+  description = "Creates the tables in the database."
+  default     = false
+}
+
 variable "abfs_enable_git_lfs" {
   type        = bool
   description = "Enable Git LFS support"

modules/server/outputs.tf

@@ -26,3 +26,13 @@ output "abfs_spanner_database" {
   description = "The ABFS Spanner database object"
   value       = google_spanner_database.abfs
 }
+
+output "abfs_spanner_database_schema_version" {
+  description = "The schema version used for the ABFS Spanner database"
+  value       = var.abfs_spanner_database_schema_version
+}
+
+output "abfs_spanner_database_schema_file" {
+  description = "The ABFS Spanner database schema file"
+  value       = data.local_file.abfs_spanner_database_schema.filename
+}

modules/server/spanner.tf

@@ -32,8 +32,17 @@ resource "google_spanner_instance" "abfs" {
   }
 }
 
+data "local_file" "abfs_spanner_database_schema" {
+  filename = "${path.module}/../../files/schemas/${var.abfs_spanner_database_schema_version}-schema.sql"
+}
+
 resource "google_spanner_database" "abfs" {
   instance            = google_spanner_instance.abfs.name
   name                = var.abfs_spanner_database_name
+  ddl                 = var.abfs_spanner_database_create_tables ? split(";;", data.local_file.abfs_spanner_database_schema.content) : []
   deletion_protection = true
+  lifecycle {
+    # Ignore changes after database creation to avoid accidental data loss.
+    ignore_changes = [ddl]
+  }
 }

modules/server/variables.tf

@@ -126,6 +126,18 @@ variable "abfs_spanner_database_name" {
   default     = "abfs"
 }
 
+variable "abfs_spanner_database_create_tables" {
+  type        = bool
+  description = "Creates the tables in the database using the online DDL schema with the given schema version."
+  default     = false
+}
+
+variable "abfs_spanner_database_schema_version" {
+  type        = string
+  description = "The version of the DDL schema to use for the ABFS database."
+  default     = "0.0.31"
+}
+
 // Marketplace requires this variable name to be declared
 variable "goog_cm_deployment_name" {
   type        = string