feat: Add num_partitions field in mongodbatlas_search_index #3982

filipcirtog · 2025-12-12T19:30:41Z

Description

The numPartitions field for MongoDB Atlas Search Index exists in the API, but Terraform can't manage it yet. The API overwrites nested fields like definition.numPartitions entirely (similar to PUT), making partial updates via PATCH unsupported. For now, customers need to use the MongoDB Atlas UI to manage this field until Terraform adds support.

This PR is for the addition of the num_partitions field in mongodbatlas_search_index

Link to any related issue(s): CLOUDP-365383

Type of change:

Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR. A migration guide must be created or updated if the new feature will go in a major version.
Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR. A migration guide must be created or updated.
This change requires a documentation update
Documentation fix/enhancement

Required Checklist:

I have signed the MongoDB CLA
I have read the contributing guides
I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
I have added any necessary documentation (if appropriate)
I have run make fmt and formatted my code
If changes include deprecations or removals I have added appropriate changelog entries.
If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Further comments

github-actions · 2025-12-12T19:31:01Z

APIx bot: a message has been sent to Docs Slack channel
APIx bot: a message has been sent to Docs Slack channel

QuiqueSanMongo

LGTM, just a small question

QuiqueSanMongo · 2025-12-12T21:36:45Z

docs/data-sources/search_index.md

 * `type_sets` - Set of type set definitions (when present). Each item includes:
  * `name` - Type set name.
  * `types` - JSON array string describing the types for the set.
+* `num_partitions` - (Optional) Number of index partitions. Allowed values are [1, 2, 4].


Does the feature just allow 1, 2, and 4, or is this a typo?

thank you! yess, link to the api definition in here. additionally, I've updated the definition with the default value:

Number of index partitions. Allowed values are [1, 2, 4]. Default value is 1.

internal/service/searchindex/resource_search_index_test.go

marcabreracast · 2025-12-15T09:41:23Z

I see that the PR is marked as Open, but the Required Checklist: section of the PR description is not marked, nor the Type of change section. Since we have some automations that get triggered depending on the change, shouldn't this be considered as a New Feature?
As we're adding a new field to the mongodbatlas_search_index, I'd expect that a new changelog will also be generated, that will be then included in the release notes (example: PR #3978

filipcirtog · 2025-12-15T09:45:06Z

@marcabreracast thank you! I have converted it back to draft until I address your feedback!

filipcirtog · 2025-12-15T16:50:55Z

@marcabreracast Thank you. I have updated the PR title, changelog and Required Checklist.

Copilot

Pull request overview

This PR adds support for the num_partitions field to the MongoDB Atlas search index resource and data sources in the Terraform provider. The field allows users to configure index partitioning (with allowed values of 1, 2, or 4) through Terraform.

Key changes:

Added num_partitions field to search index resource, data sources, and their schemas
Implemented create, read, and update logic for the new field
Added comprehensive test coverage including create and update scenarios

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
internal/service/searchindex/resource_search_index.go	Added `num_partitions` field to schema and implemented create/read/update logic
internal/service/searchindex/data_source_search_index.go	Added `num_partitions` as computed field in data source schema and read logic
internal/service/searchindex/data_source_search_indexes.go	Added `num_partitions` to flattened search indexes output
internal/service/searchindex/resource_search_index_test.go	Added test case for `num_partitions` with create and update scenarios
docs/resources/search_index.md	Documented `num_partitions` parameter with allowed values
docs/data-sources/search_index.md	Documented `num_partitions` attribute in data source
docs/data-sources/search_indexes.md	Documented `num_partitions` attribute in plural data source
.changelog/3982.txt	Added changelog entries for the enhancement

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

internal/service/searchindex/resource_search_index_test.go

Copilot

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

internal/service/searchindex/resource_search_index_test.go

lantoli · 2025-12-15T17:09:43Z

docs/data-sources/search_index.md

 * `type_sets` - Set of type set definitions (when present). Each item includes:
  * `name` - Type set name.
  * `types` - JSON array string describing the types for the set.
+* `num_partitions` - Number of index partitions. Allowed values are [1, 2, 4]. Default value is 1.


nit: for both datasource i think just "* num_partitions - Number of index partitions." is enough, allowed values and default value is more insteresting for the resource

thank you! updated!

lantoli · 2025-12-15T17:13:32Z

docs/resources/search_index.md

    EOF
  ```

+* `num_partitions` - (Optional) Number of index partitions. Allowed values are [1, 2, 4]. Default value is 1.


qq: can it be used in both search and vectorSearch types?

thank you! added the a test for vectorSearch as well.

lantoli · 2025-12-15T17:15:40Z

internal/service/searchindex/data_source_search_index.go

 		},
+		"num_partitions": {
+			Type:     schema.TypeInt,
+			Computed: true,


can you confirm that if num_partitions is not used when creating the resource, we'll get null in the data sources (instead of default 1)

We receive an integer pointer as nil. Since SDKv2 does not natively handle nil values, and our num_partitions field is of type integer, the field will default to an undefined integer value, equal to 0.

QuiqueSanMongo

LGTM!

lantoli · 2025-12-15T17:22:01Z

internal/service/searchindex/resource_search_index_test.go

 	resource.ParallelTest(t, *basicVectorTestCase(t))
 }
+func TestAccSearchIndex_withNumPartitions(t *testing.T) {
+	resource.ParallelTest(t, *numPartitionsTestCase(t))


in this case that we're not reusing the test (e.g. for acceptance and migration test), you can inline numPartitionsTestCase and just have the code in TestAccSearchIndex_withNumPartitions

thank you! changed.

oarbusi · 2025-12-16T07:39:51Z

internal/service/searchindex/resource_search_index_test.go

+		Steps: []resource.TestStep{
+			{
+				Config: configSearchWithNumPartitions(projectID, indexName, clusterName, 2),
+				Check:  checkSearchWithNumPartitions(projectID, indexName, clusterName, 2),


similar to what Leo mentioned in another comment, it would be nice to test the case of when we don't set the num_partitions, that in the resource the field is not set/nil, and in the data source it has the default value 1 (i assume the API returns the value even if not explitictly set)

would also revise behaviour if attribute is initially defined and then removed

I have added some more tests as you, Leo and Agustin suggested. However, since we are not able to handle the returned nil value (when not set), we process it as a 0 and that is why I assert based on that. Thank you!

oarbusi

LGTM, just one test case suggestion

marcabreracast

LGTM, thank you for addressing my suggestion. Agreed with Leo and Oriol on the test suggestions, feel free to apply those.

AgustinBettati · 2025-12-16T09:36:57Z

.changelog/3982.txt

@@ -0,0 +1,11 @@
+```release-note:enhancement
+resource/mongodbatlas_search_index: Adds the `num_partitions` attribute 


Suggested change

resource/mongodbatlas_search_index: Adds the `num_partitions` attribute

resource/mongodbatlas_search_index: Adds `num_partitions` attribute

nit: Just to stay consistent with other entries (applies to the 3 entries) https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/contributing/changelog-process.md#resource-and-provider-enhancements

thank you! changed.

Copilot

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-16T17:27:33Z

internal/service/searchindex/resource_search_index_test.go

+		var ret int
+		checks = append(checks,
+			resource.TestCheckResourceAttr(resourceName, "num_partitions", strconv.Itoa(ret)),
+			resource.TestCheckResourceAttr(datasourceName, "num_partitions", strconv.Itoa(ret)),
+		)


The variable ret is declared but never assigned a value, making its purpose unclear. Since it will always be 0 (the zero value for int), it would be clearer to either use '0' directly in the string, use strconv.Itoa(0), or rename the variable to something like defaultNumPartitions with an explicit assignment to 0.

I tried to replicate the actual behavior of the resource/data source. Specifically, the situation where an integer pointer is received as nil. Since SDKv2 does not natively handle nil values, and our num_partitions field is of type integer, in such cases, the field will default to an undefined integer value.

To simulate this behavior in Go, even when we receive a nil, it is processed as zero. Here’s the code snippet that demonstrates this.

if o == nil || IsNil(o.NumPartitions) { var ret int return ret }

I think that the point here is that var ret int is not an undefined int value, its always 0.
So we can directly check for "0" which is what we expect.

The go int zero value will never change, but in the hypothetical case it did, we want to make sure there is no regression in the datasource: we expect a 0.

yep, I think it says that you just do:

checks = append(checks, resource.TestCheckResourceAttr(resourceName, "num_partitions", "0"), resource.TestCheckResourceAttr(datasourceName, "num_partitions", "0"), )

thank you! changed

Copilot · 2025-12-16T17:27:34Z

internal/service/searchindex/resource_search_index_test.go

+		var ret int
+		checks = append(checks,
+			resource.TestCheckResourceAttr(resourceName, "num_partitions", strconv.Itoa(ret)),
+			resource.TestCheckResourceAttr(datasourceName, "num_partitions", strconv.Itoa(ret)),
+		)


The variable ret is declared but never assigned a value, making its purpose unclear. Since it will always be 0 (the zero value for int), it would be clearer to either use '0' directly in the string, use strconv.Itoa(0), or rename the variable to something like defaultNumPartitions with an explicit assignment to 0.

manupedrozo · 2025-12-16T23:18:07Z

internal/service/searchindex/resource_search_index_test.go

+			resource.TestCheckResourceAttr(resourceName, "num_partitions", fmt.Sprintf("%d", *numPartitions)),
+			resource.TestCheckResourceAttr(datasourceName, "num_partitions", fmt.Sprintf("%d", *numPartitions)),


Suggested change

resource.TestCheckResourceAttr(resourceName, "num_partitions", fmt.Sprintf("%d", *numPartitions)),

resource.TestCheckResourceAttr(datasourceName, "num_partitions", fmt.Sprintf("%d", *numPartitions)),

resource.TestCheckResourceAttr(resourceName, "num_partitions", strconv.Itoa(*numPartitions)),

resource.TestCheckResourceAttr(datasourceName, "num_partitions", strconv.Itoa(*numPartitions)),

thank you! changed

manupedrozo · 2025-12-16T23:18:54Z

internal/service/searchindex/resource_search_index_test.go

+			resource.TestCheckResourceAttr(resourceName, "num_partitions", fmt.Sprintf("%d", *numPartitions)),
+			resource.TestCheckResourceAttr(datasourceName, "num_partitions", fmt.Sprintf("%d", *numPartitions)),


Suggested change

resource.TestCheckResourceAttr(resourceName, "num_partitions", fmt.Sprintf("%d", *numPartitions)),

resource.TestCheckResourceAttr(datasourceName, "num_partitions", fmt.Sprintf("%d", *numPartitions)),

resource.TestCheckResourceAttr(resourceName, "num_partitions", strconv.Itoa(*numPartitions)),

resource.TestCheckResourceAttr(datasourceName, "num_partitions", strconv.Itoa(*numPartitions)),

thank you! changed

lantoli · 2025-12-17T07:16:55Z

note that a PR check is failing:

=== NAME  TestAccVectorSearchIndex_withNumPartitions
    resource_search_index_test.go:227: Step 1/3 error: Error running apply: exit status 1
        
        Error: error during search deployment creation
        
          with mongodbatlas_search_deployment.test,
          on terraform_plugin_test.tf line 13, in resource "mongodbatlas_search_deployment" "test":
          13: 		resource "mongodbatlas_search_deployment" "test" {
        
        https://cloud-dev.mongodb.com/api/atlas/v2/groups/694199be3d2621ae3a708994/clusters/test-acc-tf-c-858085136270834754/search/deployment
        POST: HTTP 409 Conflict (Error code:
        "ATLAS_SEARCH_DEPLOYMENT_ALREADY_EXISTS") Detail: Search deployment already
        exists for specified cluster. Reason: Conflict. Params: [], BadRequestDetail:
--- FAIL: TestAccVectorSearchIndex_withNumPartitions (2.65s)

Copilot

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-17T11:06:05Z

internal/service/searchindex/resource_search_index_test.go

+			type             = "search"
+			%[6]s
+
+		depends_on = [mongodbatlas_search_deployment.test]	


Inconsistent indentation in the depends_on line. The line uses a tab character while other lines in the same configuration use spaces. Consider using consistent indentation throughout the configuration string.

Suggested change

depends_on = [mongodbatlas_search_deployment.test]

depends_on = [mongodbatlas_search_deployment.test]

Copilot · 2025-12-17T11:06:06Z

docs/data-sources/search_indexes.md

 * `type_sets` - Set of type set definitions (when present). Each item includes:
  * `name` - Type set name.
  * `types` - JSON array string describing the types for the set.
+* `num_partitions` - Number of index partitions, returns 0 if not set in the resource


The documentation states 'returns 0 if not set in the resource', but this phrasing is unclear as this is a data source, not a resource. Consider rephrasing to 'returns 0 if not configured' or 'returns 0 when not set' for clarity.

if default value is 1(it says so in the API docs), why we return 0? seems like an inconsistency in the API?

@oarbusi We receive an integer pointer as nil. Since SDKv2 does not natively handle nil values, and our num_partitions field is of type integer, the field will default to an undefined integer value, equal to 0.

Copilot · 2025-12-17T11:06:06Z

docs/data-sources/search_index.md

 * `type_sets` - Set of type set definitions (when present). Each item includes:
  * `name` - Type set name.
  * `types` - JSON array string describing the types for the set.
+* `num_partitions` - Number of index partitions, returns 0 if not set in the resource


The documentation states 'returns 0 if not set in the resource', but this phrasing is unclear as this is a data source, not a resource. Consider rephrasing to 'returns 0 if not configured' or 'returns 0 when not set' for clarity.

filipcirtog added 2 commits December 12, 2025 20:26

num_partitions field addition

d540b4c

doc additions

636bf20

filipcirtog requested review from a team as code owners December 12, 2025 19:30

filipcirtog changed the title ~~chore: add num_partitions field in mongodbatlas_search_index~~ chore: Add num_partitions field in mongodbatlas_search_index Dec 12, 2025

QuiqueSanMongo approved these changes Dec 12, 2025

View reviewed changes

marcabreracast reviewed Dec 15, 2025

View reviewed changes

internal/service/searchindex/resource_search_index_test.go Show resolved Hide resolved

filipcirtog marked this pull request as draft December 15, 2025 09:40

filipcirtog changed the title ~~chore: Add num_partitions field in mongodbatlas_search_index~~ feat: Add num_partitions field in mongodbatlas_search_index Dec 15, 2025

github-actions bot added the enhancement label Dec 15, 2025

filipcirtog added 3 commits December 15, 2025 12:43

changelog and feedback improvements

94323db

update changelog

aee15fe

document default value for num_partitions

e7b8490

filipcirtog marked this pull request as ready for review December 15, 2025 16:51

filipcirtog requested review from Copilot and removed request for Copilot December 15, 2025 16:51

Copilot AI reviewed Dec 15, 2025

View reviewed changes

internal/service/searchindex/resource_search_index_test.go Outdated Show resolved Hide resolved

internal/service/searchindex/resource_search_index_test.go Outdated Show resolved Hide resolved

spacing consistency

b12949e

filipcirtog requested a review from Copilot December 15, 2025 17:08

Copilot AI reviewed Dec 15, 2025

View reviewed changes

internal/service/searchindex/resource_search_index_test.go Outdated Show resolved Hide resolved

internal/service/searchindex/resource_search_index_test.go Outdated Show resolved Hide resolved

lantoli reviewed Dec 15, 2025

View reviewed changes

QuiqueSanMongo approved these changes Dec 15, 2025

View reviewed changes

lantoli reviewed Dec 15, 2025

View reviewed changes

lantoli approved these changes Dec 15, 2025

View reviewed changes

oarbusi reviewed Dec 16, 2025

View reviewed changes

oarbusi approved these changes Dec 16, 2025

View reviewed changes

marcabreracast approved these changes Dec 16, 2025

View reviewed changes

AgustinBettati approved these changes Dec 16, 2025

View reviewed changes

filipcirtog added 2 commits December 16, 2025 17:36

testing improvements

a1f2219

improve test and docs

b251b43

filipcirtog requested a review from Copilot December 16, 2025 17:27

Copilot AI reviewed Dec 16, 2025

View reviewed changes

manupedrozo reviewed Dec 16, 2025

View reviewed changes

address feedback and fix test

bf5407c

manupedrozo approved these changes Dec 17, 2025

View reviewed changes

filipcirtog requested a review from Copilot December 17, 2025 11:04

Copilot AI reviewed Dec 17, 2025

View reviewed changes

		@@ -0,0 +1,11 @@
		```release-note:enhancement
		resource/mongodbatlas_search_index: Adds the `num_partitions` attribute

		resource.TestCheckResourceAttr(resourceName, "num_partitions", fmt.Sprintf("%d", *numPartitions)),
		resource.TestCheckResourceAttr(datasourceName, "num_partitions", fmt.Sprintf("%d", *numPartitions)),

	depends_on = [mongodbatlas_search_deployment.test]
	depends_on = [mongodbatlas_search_deployment.test]

feat: Add num_partitions field in mongodbatlas_search_index #3982

Are you sure you want to change the base?

feat: Add num_partitions field in mongodbatlas_search_index #3982

Uh oh!

Conversation

filipcirtog commented Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change:

Required Checklist:

Further comments

Uh oh!

github-actions bot commented Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

QuiqueSanMongo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

marcabreracast commented Dec 15, 2025

Uh oh!

filipcirtog commented Dec 15, 2025

Uh oh!

filipcirtog commented Dec 15, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lantoli Dec 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lantoli Dec 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

QuiqueSanMongo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oarbusi Dec 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

filipcirtog Dec 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oarbusi left a comment

Choose a reason for hiding this comment

Uh oh!

marcabreracast left a comment

Choose a reason for hiding this comment

filipcirtog commented Dec 12, 2025 •

edited

Loading

github-actions bot commented Dec 12, 2025 •

edited

Loading

lantoli Dec 15, 2025 •

edited

Loading

lantoli Dec 15, 2025 •

edited

Loading

oarbusi Dec 16, 2025 •

edited

Loading

filipcirtog Dec 16, 2025 •

edited

Loading

oarbusi Dec 17, 2025 •

edited

Loading