Skip to main content

About search

Learn about the options for searching personal data​

You can retrieve objects from Vault using string and substring searches, returning all or a subset of the found object's values.

Search types​

Piiano Vault provides two search types:

  • Exact match string searches
  • Glob pattern substring searches

Substring searching is implemented for encrypted properties only.

You can request transformations of values in the search response where they are available. YoU can also use the unsafe option to get all the values of the objects (though it is not recommended). Using unsafe can be combined with the show_builtins option to include the built-in properties.

Whether your request for object values succeeds depends on the permissions granted to you as part of the Vault's identity and access management settings.

Availability​

Piiano Vault needs to index the content of properties to enable searching. Depending on the search you want to perform, you can set a property as either or both of:

  • String indexed, which you can apply to properties with any data types except LONG_TEXT, JSON, and BLOB, and custom data types based on those types.
  • Substring indexed, which you can apply to properties with data types STRING, LONG_TEXT EMAIL, EMAIL_STRICT, URL, NAME, GENDER, BAN, SSN, ADDRESS, CC_HOLDER_NAME, US_BANK_ROUTING, US_BANK_ACCOUNT_NUMBER, or custom data types based on STRING.

Substring index safety​

The substring index is secure and doesn't leak any information about the plaintext data. Vault doesn't load a collection's full content to memory to perform a substring search.

On this page