Add unique index support in Firestore (#14682) (#24163)

[upstream:bdbcf3a3c90e028c6732668cebfc45d3a7340792]

Signed-off-by: Modular Magician <[email protected]>

Author: modular-magician

.changelog/14682.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+firestore: added `unique` field to `google_firestore_index` resource
+```

google/services/firestore/resource_firestore_index.go

@@ -204,6 +204,13 @@ with the same dimension.`,
 				Description:  `The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP", "COLLECTION_RECURSIVE"]`,
 				Default:      "COLLECTION",
 			},
+			"unique": {
+				Type:        schema.TypeBool,
+				Computed:    true,
+				Optional:    true,
+				ForceNew:    true,
+				Description: `Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents.`,
+			},
 			"name": {
 				Type:     schema.TypeString,
 				Computed: true,
@@ -265,6 +272,12 @@ func resourceFirestoreIndexCreate(d *schema.ResourceData, meta interface{}) erro
 	} else if v, ok := d.GetOkExists("multikey"); !tpgresource.IsEmptyValue(reflect.ValueOf(multikeyProp)) && (ok || !reflect.DeepEqual(v, multikeyProp)) {
 		obj["multikey"] = multikeyProp
 	}
+	uniqueProp, err := expandFirestoreIndexUnique(d.Get("unique"), d, config)
+	if err != nil {
+		return err
+	} else if v, ok := d.GetOkExists("unique"); !tpgresource.IsEmptyValue(reflect.ValueOf(uniqueProp)) && (ok || !reflect.DeepEqual(v, uniqueProp)) {
+		obj["unique"] = uniqueProp
+	}
 	fieldsProp, err := expandFirestoreIndexFields(d.Get("fields"), d, config)
 	if err != nil {
 		return err
@@ -406,6 +419,9 @@ func resourceFirestoreIndexRead(d *schema.ResourceData, meta interface{}) error
 	if err := d.Set("multikey", flattenFirestoreIndexMultikey(res["multikey"], d, config)); err != nil {
 		return fmt.Errorf("Error reading Index: %s", err)
 	}
+	if err := d.Set("unique", flattenFirestoreIndexUnique(res["unique"], d, config)); err != nil {
+		return fmt.Errorf("Error reading Index: %s", err)
+	}
 	if err := d.Set("fields", flattenFirestoreIndexFields(res["fields"], d, config)); err != nil {
 		return fmt.Errorf("Error reading Index: %s", err)
 	}
@@ -524,6 +540,10 @@ func flattenFirestoreIndexMultikey(v interface{}, d *schema.ResourceData, config
 	return v
 }
 
+func flattenFirestoreIndexUnique(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	return v
+}
+
 func flattenFirestoreIndexFields(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
 	if v == nil {
 		return v
@@ -621,6 +641,10 @@ func expandFirestoreIndexMultikey(v interface{}, d tpgresource.TerraformResource
 	return v, nil
 }
 
+func expandFirestoreIndexUnique(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}
+
 func expandFirestoreIndexFields(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
 	l := v.([]interface{})
 	req := make([]interface{}, 0, len(l))

google/services/firestore/resource_firestore_index_generated_meta.yaml

@@ -17,3 +17,4 @@ fields:
   - field: 'multikey'
   - field: 'name'
   - field: 'query_scope'
+  - field: 'unique'

google/services/firestore/resource_firestore_index_generated_test.go

@@ -390,6 +390,69 @@ resource "google_firestore_index" "my-index" {
 `, context)
 }
 
+func TestAccFirestoreIndex_firestoreIndexUniqueExample(t *testing.T) {
+	t.Parallel()
+
+	context := map[string]interface{}{
+		"project_id":    envvar.GetTestProjectFromEnv(),
+		"random_suffix": acctest.RandString(t, 10),
+	}
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		CheckDestroy:             testAccCheckFirestoreIndexDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccFirestoreIndex_firestoreIndexUniqueExample(context),
+			},
+			{
+				ResourceName:            "google_firestore_index.my-index",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"collection", "database"},
+			},
+		},
+	})
+}
+
+func testAccFirestoreIndex_firestoreIndexUniqueExample(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_firestore_database" "database" {
+	project                  = "%{project_id}"
+	name                     = "tf-test-database-id-unique%{random_suffix}"
+	location_id              = "nam5"
+	type                     = "FIRESTORE_NATIVE"
+	database_edition         = "ENTERPRISE"
+
+	delete_protection_state = "DELETE_PROTECTION_DISABLED"
+	deletion_policy         = "DELETE"
+}
+
+resource "google_firestore_index" "my-index" {
+	project    = "%{project_id}"
+	database   = google_firestore_database.database.name
+	collection = "atestcollection"
+
+	api_scope   = "MONGODB_COMPATIBLE_API"
+	query_scope = "COLLECTION_GROUP"
+	multikey    = true
+	density     = "DENSE"
+	unique      = true
+
+	fields {
+		field_path = "name"
+		order      = "ASCENDING"
+	}
+
+	fields {
+		field_path = "description"
+		order      = "DESCENDING"
+	}
+}
+`, context)
+}
+
 func testAccCheckFirestoreIndexDestroyProducer(t *testing.T) func(s *terraform.State) error {
 	return func(s *terraform.State) error {
 		for name, rs := range s.RootModule().Resources {

website/docs/r/firestore_index.html.markdown

@@ -239,6 +239,43 @@ resource "google_firestore_index" "my-index" {
 	}
 }
 ```
+## Example Usage - Firestore Index Unique
+
+
+```hcl
+resource "google_firestore_database" "database" {
+	project                  = "my-project-name"
+	name                     = "database-id-unique"
+	location_id              = "nam5"
+	type                     = "FIRESTORE_NATIVE"
+	database_edition         = "ENTERPRISE"
+
+	delete_protection_state = "DELETE_PROTECTION_DISABLED"
+	deletion_policy         = "DELETE"
+}
+
+resource "google_firestore_index" "my-index" {
+	project    = "my-project-name"
+	database   = google_firestore_database.database.name
+	collection = "atestcollection"
+
+	api_scope   = "MONGODB_COMPATIBLE_API"
+	query_scope = "COLLECTION_GROUP"
+	multikey    = true
+	density     = "DENSE"
+	unique      = true
+
+	fields {
+		field_path = "name"
+		order      = "ASCENDING"
+	}
+
+	fields {
+		field_path = "description"
+		order      = "DESCENDING"
+	}
+}
+```
 
 ## Argument Reference
 
@@ -285,6 +322,10 @@ The following arguments are supported:
   (Optional)
   Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to indexes with MONGODB_COMPATIBLE_API ApiScope.
 
+* `unique` -
+  (Optional)
+  Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents.
+
 * `project` - (Optional) The ID of the project in which the resource belongs.
     If it is not provided, the provider project is used.