Azure-docs: Explanation of "automatic" property

[gmantri]

When creating an indexing policy, there's a property called "automatic" which can have a value of either true or false. I am not able to find the purpose of this property.

Can somebody please explain what exactly does this property do?

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: f1c7d0e0-b932-085e-6816-0b2219a1f37b
• Version Independent ID: b463dc0b-313c-d90a-b8aa-c2b64004f812
• Content: Manage indexing policies in Azure Cosmos DB
• Content Source: articles/cosmos-db/how-to-manage-indexing-policy.md
• Service: cosmos-db
• GitHub Login: @ThomasWeiss
• Microsoft Alias: thweiss

[timsander1]

Hi @gmantri,

I'm linking that doc here: https://docs.microsoft.com/en-us/azure/cosmos-db/index-policy#indexing-mode

You should leave automatic to its default "true" value. This will allow documents to automatically be indexed at the time of write/update.

[gmantri]

Thanks @timsander1. One followup question: So what happens if I set this property to false? Will the documents not indexed in that case?

[timsander1]

If you don't want documents to be indexed, I recommend turning indexing off entirely (set Indexing Mode to "none"). But yes you're absolutely correct. Setting "automatic" to false turns off automatic indexing. We are, however, planning to remove the property entirely in the future. On new containers, updating the automatic property won't have any impact (it will however on some older containers so we have documented the behavior).

[timsander1]

please-close