Skip to content

Conversation

@itaismith
Copy link
Contributor

Description of changes

Adding docs for metadata arrays

@github-actions
Copy link

github-actions bot commented Feb 9, 2026

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

@propel-code-bot
Copy link
Contributor

propel-code-bot bot commented Feb 9, 2026

Docs: Add array metadata guidance and refresh filtering examples

Expands the metadata filtering, search API, and schema docs to explain how array metadata works across Python, TypeScript, and Rust SDKs. Adds new sections covering $contains/$not_contains, supported array types, example insertions, and clarifies index behavior plus new Rust Where usage patterns for metadata and document filters.

Key Changes

• Extended docs/mintlify/docs/querying-collections/metadata-filtering.mdx with a "Using Array Metadata" section, full CRUD examples, and refreshed Rust Where snippets for logical, inclusion, and document filters.
• Updated docs/mintlify/docs/querying-collections/full-text-search.mdx to document Rust Where::Document usage, logical operators, and mixed metadata/document filters.
• Augmented docs/mintlify/cloud/search-api/filtering.mdx with array metadata storage/filtering guidance, clarified operator semantics, added warnings about regex capabilities, and highlighted schema/index implications.
• Added metadata-array examples to docs/mintlify/docs/collections/add-data.mdx and noted array support in docs/mintlify/docs/collections/update-data.mdx; introduced a schema callout in docs/mintlify/cloud/schema/schema-basics.mdx about array indexes sharing scalar inverted indexes.

Affected Areas

docs/mintlify/docs/querying-collections/metadata-filtering.mdx
docs/mintlify/docs/querying-collections/full-text-search.mdx
docs/mintlify/cloud/search-api/filtering.mdx
docs/mintlify/docs/collections/add-data.mdx
docs/mintlify/docs/collections/update-data.mdx
docs/mintlify/cloud/schema/schema-basics.mdx

This summary was automatically generated by @propel-code-bot

@kylediaz
Copy link
Contributor

kylediaz commented Feb 9, 2026

I feel these docs are incomplete without these things:

  • How does this work with quotas? Does each individual element have a 4kb limit, or is it the sum of their sizes?
  • How do these count towards the metadata key count limit? is it +1, or +(number of elements). If the former, max array size?
  • How does this interact with Schemas? I believe if, for example, the array is of type int, it uses the IntInvertedIndexConfig. Does contain fail if this index is disabled?

@HammadB
Copy link
Collaborator

HammadB commented Feb 9, 2026

Thanks good callouts @kylediaz

How does this work with quotas? Does each individual element have a 4kb limit, or is it the sum of their sizes?

The array size in total must be under quota so [<1kib item>, <1kib item>, <1kib item>, <1kib item>] sums to 4kib

How do these count towards the metadata key count limit? is it +1, or +(number of elements). If the former, max array size?

Its just one key so {'array1' : [], 'array2': []} is two keys

How does this interact with Schemas? I believe if, for example, the array is of type int, it uses the IntInvertedIndexConfig. Does contain fail if this index is disabled?

If the underlying type for the array has its index enabled, the corresponding array type has it enabled (int, bool, string, float etc). Queries fail if disabled.

@itaismith itaismith merged commit 917e713 into main Feb 10, 2026
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants