Managing the Metadata Index

Use the Midaz Module to manage the Metadata Index. Metadata indexes let you efficiently query entities by the custom key/value metadata you attach to organizations, ledgers, accounts, transactions, and other resources.

​

What you can do

• List indexes to see which metadata keys have an index.
• Create an index on a metadata key to speed up lookups and filters on that key.
• Remove an index when you no longer query that metadata key.

Create an index for a supported entity and metadata key. unique defaults to false. sparse defaults to true. Keep the index focused on the keys you actually query. This keeps search fast and predictable.