API Reference / API Parameters / userData

Feb. 26, 2019

userData

Type: Object

Engine default:

Parameter syntax

'userData' => array object

userData: Hash object

userData: array object

'userData': dict object

Not available

userData: JsonObject

Not available

IndexSettings settings = new IndexSettings();
settings.UserData = T object;

new IndexSettings().setUserData(T object)

opt.UserData(map[string]interface{}{ object })

userData = `object` object

Can be used in these methods:
setSettings set_settings setSettings set_settings setSettings setSettings setSettingsAsync SetSettings setSettings SetSettings setSettings

See code examples

About this parameter

Lets you store custom data in your indices.

Usage notes:

The value you pass will be converted into a JSONObject. You can store any value that can be converted.

Do not store more than 32 KB: if you try to store more your search will stop working properly.

To access the userData you stored, you can use the getSettings method.

Examples

Set userDatas

Copy

$index->setSettings([
  'userData' =>   [
    'extraData' => 'This is the custom data that you want to store in your index',
   ]
]);

var extraData =  new Object { extraData= "This is the custom data that you want to store in your index"};
IndexSettings settings = new IndexSettings();
settings.UserData = extraData;

index.SetSettings(settings);

index.setSettings(
  new IndexSettings()
    .setUserData( new HashMap<String, Object>() {
    {
      put("UserDataKey", "This is the custom data that you want to store in your index");
    }
  });

userData := opt.UserData(map[string]interface{}{
    "extraData": "This is the custom data that you want to sore in your index",
})

res, err := index.SetSettings(search.Settings{
    UserData: userData,
})

val customData = Some(Map(
  "extraData" -> "This is the custom data that you want to store in your index"
))

client.execute {
  changeSettings of "myIndex" `with` IndexSettings(
    userData = customData
  )
}

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

userData

About this parameter

Usage notes:

Examples

Set userDatas

Did you find this page helpful?

On this page