API Reference / API Parameters / restrictSearchableAttributes

Feb. 26, 2019

restrictSearchableAttributes

Type: list of strings

Engine default: all attributes in searchableAttributes

Parameter syntax

'restrictSearchableAttributes' => [
  'attribute'
]

restrictSearchableAttributes: [
  'attribute'
]

restrictSearchableAttributes: [
  'attribute'
]

'restrictSearchableAttributes': [
  'attribute'
]

query.restrictSearchableAttributes = [
  "attribute"
]

restrictSearchableAttributes {
    +"attribute"
    +...
}

.setRestrictSearchableAttributes(
  "attribute"
)

.RestrictSearchableAttributes(
    new List<string>{ "attribute" }
)

.setRestrictSearchableAttributes(Arrays.asList(
  "attribute"
))

opt.RestrictSearchableAttributes(
  "attribute",
)

restrictSearchableAttributes = Some(Seq(
  "attribute"
))

Can be used in these methods:
search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browse, searchForFacetValues search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey searchAsync, browseAsync, searchForFacetValues Search, Browse, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, BrowseObjects, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, browse index, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Restricts a given query to look in only a subset of your searchable attributes.

This setting overrides searchableAttributes for specific searches.

Usage notes:

This setting is a query-level setting, affecting only the search that specifies it.
searchableAttributes must not be empty nor null for restrictSearchableAttributes to be applied.

Examples

Search on a restricted set of attributes

In this example let’s consider that searchableAttributes are set to: ['title', 'author', 'publisher', 'content'] but we want to only search in title and author

Copy

$results = $index->search('query', [
  'restrictSearchableAttributes' => [
    'title',
    'author'
  ]
]);

let query = Query(query: "query")
query.restrictSearchableAttributes = [
    "title",
    "author"
]

index.search(query, completionHandler: { (res, error) in
    print(res)
})

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

restrictSearchableAttributes

About this parameter

Usage notes:

Examples

Search on a restricted set of attributes

Did you find this page helpful?

On this page