Add new Firestore index and database options (#13600) (#9750)

[upstream:3275fb5894398769f2cb388675df7eb4b88afdb3]

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

Author: modular-magician

.changelog/13600.txt

@@ -0,0 +1,9 @@
+```release-note:enhancement
+firestore: added `density` and `multikey` fields to `google_firestore_index` resource
+```
+```release-note:enhancement
+firestore: added `MONGODB_COMPATIBLE_API` enum option to `apiScope` field of `google_firestore_index` resource
+```
+```release-note:enhancement
+firestore: added `databaseEdition` field to `google_firestore_database` resource
+```

google-beta/services/firestore/resource_firestore_database.go

@@ -141,6 +141,14 @@ The expected format is
 				ValidateFunc: verify.ValidateEnum([]string{"OPTIMISTIC", "PESSIMISTIC", "OPTIMISTIC_WITH_ENTITY_GROUPS", ""}),
 				Description:  `The concurrency control mode to use for this database. Possible values: ["OPTIMISTIC", "PESSIMISTIC", "OPTIMISTIC_WITH_ENTITY_GROUPS"]`,
 			},
+			"database_edition": {
+				Type:         schema.TypeString,
+				Computed:     true,
+				Optional:     true,
+				ForceNew:     true,
+				ValidateFunc: verify.ValidateEnum([]string{"STANDARD", "ENTERPRISE", ""}),
+				Description:  `The database edition. Possible values: ["STANDARD", "ENTERPRISE"]`,
+			},
 			"delete_protection_state": {
 				Type:         schema.TypeString,
 				Computed:     true,
@@ -254,6 +262,12 @@ func resourceFirestoreDatabaseCreate(d *schema.ResourceData, meta interface{}) e
 	} else if v, ok := d.GetOkExists("type"); !tpgresource.IsEmptyValue(reflect.ValueOf(typeProp)) && (ok || !reflect.DeepEqual(v, typeProp)) {
 		obj["type"] = typeProp
 	}
+	databaseEditionProp, err := expandFirestoreDatabaseDatabaseEdition(d.Get("database_edition"), d, config)
+	if err != nil {
+		return err
+	} else if v, ok := d.GetOkExists("database_edition"); !tpgresource.IsEmptyValue(reflect.ValueOf(databaseEditionProp)) && (ok || !reflect.DeepEqual(v, databaseEditionProp)) {
+		obj["databaseEdition"] = databaseEditionProp
+	}
 	concurrencyModeProp, err := expandFirestoreDatabaseConcurrencyMode(d.Get("concurrency_mode"), d, config)
 	if err != nil {
 		return err
@@ -418,6 +432,9 @@ func resourceFirestoreDatabaseRead(d *schema.ResourceData, meta interface{}) err
 	if err := d.Set("type", flattenFirestoreDatabaseType(res["type"], d, config)); err != nil {
 		return fmt.Errorf("Error reading Database: %s", err)
 	}
+	if err := d.Set("database_edition", flattenFirestoreDatabaseDatabaseEdition(res["databaseEdition"], d, config)); err != nil {
+		return fmt.Errorf("Error reading Database: %s", err)
+	}
 	if err := d.Set("concurrency_mode", flattenFirestoreDatabaseConcurrencyMode(res["concurrencyMode"], d, config)); err != nil {
 		return fmt.Errorf("Error reading Database: %s", err)
 	}
@@ -681,6 +698,10 @@ func flattenFirestoreDatabaseType(v interface{}, d *schema.ResourceData, config
 	return v
 }
 
+func flattenFirestoreDatabaseDatabaseEdition(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	return v
+}
+
 func flattenFirestoreDatabaseConcurrencyMode(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
 	return v
 }
@@ -760,6 +781,10 @@ func expandFirestoreDatabaseType(v interface{}, d tpgresource.TerraformResourceD
 	return v, nil
 }
 
+func expandFirestoreDatabaseDatabaseEdition(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}
+
 func expandFirestoreDatabaseConcurrencyMode(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
 	return v, nil
 }

google-beta/services/firestore/resource_firestore_database_generated_meta.yaml

@@ -10,6 +10,7 @@ fields:
   - field: 'cmek_config.kms_key_name'
   - field: 'concurrency_mode'
   - field: 'create_time'
+  - field: 'database_edition'
   - field: 'delete_protection_state'
   - field: 'deletion_policy'
     provider_only: true

google-beta/services/firestore/resource_firestore_database_generated_test.go

@@ -263,6 +263,45 @@ resource "google_kms_crypto_key_iam_binding" "firestore_cmek_keyuser" {
 `, context)
 }
 
+func TestAccFirestoreDatabase_firestoreDatabaseEnterpriseExample(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:             testAccCheckFirestoreDatabaseDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccFirestoreDatabase_firestoreDatabaseEnterpriseExample(context),
+			},
+			{
+				ResourceName:            "google_firestore_database.enterprise-db",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"deletion_policy", "etag", "project"},
+			},
+		},
+	})
+}
+
+func testAccFirestoreDatabase_firestoreDatabaseEnterpriseExample(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_firestore_database" "enterprise-db" {
+	project                  = "%{project_id}"
+	name                     = "tf-test-database-id%{random_suffix}"
+	location_id              = "nam5"
+	type                     = "FIRESTORE_NATIVE"
+	database_edition         = "ENTERPRISE"
+	deletion_policy          = "DELETE"
+}
+`, context)
+}
+
 func testAccCheckFirestoreDatabaseDestroyProducer(t *testing.T) func(s *terraform.State) error {
 	return func(s *terraform.State) error {
 		for name, rs := range s.RootModule().Resources {

google-beta/services/firestore/resource_firestore_index.go

@@ -170,8 +170,8 @@ with the same dimension.`,
 				Type:         schema.TypeString,
 				Optional:     true,
 				ForceNew:     true,
-				ValidateFunc: verify.ValidateEnum([]string{"ANY_API", "DATASTORE_MODE_API", ""}),
-				Description:  `The API scope at which a query is run. Default value: "ANY_API" Possible values: ["ANY_API", "DATASTORE_MODE_API"]`,
+				ValidateFunc: verify.ValidateEnum([]string{"ANY_API", "DATASTORE_MODE_API", "MONGODB_COMPATIBLE_API", ""}),
+				Description:  `The API scope at which a query is run. Default value: "ANY_API" Possible values: ["ANY_API", "DATASTORE_MODE_API", "MONGODB_COMPATIBLE_API"]`,
 				Default:      "ANY_API",
 			},
 			"database": {
@@ -181,6 +181,21 @@ with the same dimension.`,
 				Description: `The Firestore database id. Defaults to '"(default)"'.`,
 				Default:     "(default)",
 			},
+			"density": {
+				Type:         schema.TypeString,
+				Computed:     true,
+				Optional:     true,
+				ForceNew:     true,
+				ValidateFunc: verify.ValidateEnum([]string{"SPARSE_ALL", "SPARSE_ANY", "DENSE", ""}),
+				Description:  `The density configuration for this index. Possible values: ["SPARSE_ALL", "SPARSE_ANY", "DENSE"]`,
+			},
+			"multikey": {
+				Type:        schema.TypeBool,
+				Optional:    true,
+				ForceNew:    true,
+				Description: `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.`,
+				Default:     false,
+			},
 			"query_scope": {
 				Type:         schema.TypeString,
 				Optional:     true,
@@ -238,6 +253,18 @@ func resourceFirestoreIndexCreate(d *schema.ResourceData, meta interface{}) erro
 	} else if v, ok := d.GetOkExists("api_scope"); !tpgresource.IsEmptyValue(reflect.ValueOf(apiScopeProp)) && (ok || !reflect.DeepEqual(v, apiScopeProp)) {
 		obj["apiScope"] = apiScopeProp
 	}
+	densityProp, err := expandFirestoreIndexDensity(d.Get("density"), d, config)
+	if err != nil {
+		return err
+	} else if v, ok := d.GetOkExists("density"); !tpgresource.IsEmptyValue(reflect.ValueOf(densityProp)) && (ok || !reflect.DeepEqual(v, densityProp)) {
+		obj["density"] = densityProp
+	}
+	multikeyProp, err := expandFirestoreIndexMultikey(d.Get("multikey"), d, config)
+	if err != nil {
+		return err
+	} else if v, ok := d.GetOkExists("multikey"); !tpgresource.IsEmptyValue(reflect.ValueOf(multikeyProp)) && (ok || !reflect.DeepEqual(v, multikeyProp)) {
+		obj["multikey"] = multikeyProp
+	}
 	fieldsProp, err := expandFirestoreIndexFields(d.Get("fields"), d, config)
 	if err != nil {
 		return err
@@ -383,6 +410,12 @@ func resourceFirestoreIndexRead(d *schema.ResourceData, meta interface{}) error
 	if err := d.Set("api_scope", flattenFirestoreIndexApiScope(res["apiScope"], d, config)); err != nil {
 		return fmt.Errorf("Error reading Index: %s", err)
 	}
+	if err := d.Set("density", flattenFirestoreIndexDensity(res["density"], d, config)); err != nil {
+		return fmt.Errorf("Error reading Index: %s", err)
+	}
+	if err := d.Set("multikey", flattenFirestoreIndexMultikey(res["multikey"], 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)
 	}
@@ -493,6 +526,14 @@ func flattenFirestoreIndexApiScope(v interface{}, d *schema.ResourceData, config
 	return v
 }
 
+func flattenFirestoreIndexDensity(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	return v
+}
+
+func flattenFirestoreIndexMultikey(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
@@ -582,6 +623,14 @@ func expandFirestoreIndexApiScope(v interface{}, d tpgresource.TerraformResource
 	return v, nil
 }
 
+func expandFirestoreIndexDensity(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}
+
+func expandFirestoreIndexMultikey(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-beta/services/firestore/resource_firestore_index_generated_meta.yaml

@@ -8,10 +8,12 @@ fields:
   - field: 'api_scope'
   - field: 'collection'
   - field: 'database'
+  - field: 'density'
   - field: 'fields.array_config'
   - field: 'fields.field_path'
   - field: 'fields.order'
   - field: 'fields.vector_config.dimension'
   - field: 'fields.vector_config.flat'
+  - field: 'multikey'
   - field: 'name'
   - field: 'query_scope'

google-beta/services/firestore/resource_firestore_index_generated_test.go

@@ -130,12 +130,13 @@ resource "google_firestore_database" "database" {
 }
 
 resource "google_firestore_index" "my-index" {
-  project     = "%{project_id}"
+  project    = "%{project_id}"
   database   = google_firestore_database.database.name
   collection = "atestcollection"
 
   query_scope = "COLLECTION_RECURSIVE"
-  api_scope = "DATASTORE_MODE_API"
+  api_scope   = "DATASTORE_MODE_API"
+  density     = "SPARSE_ALL"
 
   fields {
     field_path = "name"
@@ -265,6 +266,130 @@ resource "google_firestore_index" "my-index" {
 `, context)
 }
 
+func TestAccFirestoreIndex_firestoreIndexMongodbCompatibleScopeExample(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_firestoreIndexMongodbCompatibleScopeExample(context),
+			},
+			{
+				ResourceName:            "google_firestore_index.my-index",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"collection", "database"},
+			},
+		},
+	})
+}
+
+func testAccFirestoreIndex_firestoreIndexMongodbCompatibleScopeExample(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_firestore_database" "database" {
+	project                  = "%{project_id}"
+	name                     = "tf-test-database-id-mongodb-compatible%{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"
+
+	fields {
+		field_path = "name"
+		order      = "ASCENDING"
+	}
+
+	fields {
+		field_path = "description"
+		order      = "DESCENDING"
+	}
+}
+`, context)
+}
+
+func TestAccFirestoreIndex_firestoreIndexSparseAnyExample(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_firestoreIndexSparseAnyExample(context),
+			},
+			{
+				ResourceName:            "google_firestore_index.my-index",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"collection", "database"},
+			},
+		},
+	})
+}
+
+func testAccFirestoreIndex_firestoreIndexSparseAnyExample(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_firestore_database" "database" {
+	project                  = "%{project_id}"
+	name                     = "tf-test-database-id-sparse-any%{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     = "SPARSE_ANY"
+
+	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 {