allowCompressionOfIntegerArray

Whether to compress integer array attributes

The allowCompressionOfIntegerArray parameter enables compression for array attributes that contain only non-negative integers.

This is useful for attributes such as lists of user IDs, permissions, or access control lists.

Usage

• Compression may alter the order of values within the array.
• Applies to both top-level and nested attributes, as long as the values are arrays of integers.

Example

Current API clients

C#

var response = await client.SetSettingsAsync(
  "INDEX_NAME",
  new IndexSettings { AllowCompressionOfIntegerArray = true }
);

final response = await client.setSettings(
  indexName: "INDEX_NAME",
  indexSettings: IndexSettings(
    allowCompressionOfIntegerArray: true,
  ),
);

response, err := client.SetSettings(client.NewApiSetSettingsRequest(
  "INDEX_NAME",
  search.NewEmptyIndexSettings().SetAllowCompressionOfIntegerArray(true)))
if err != nil {
  // handle the eventual error
  panic(err)
}

UpdatedAtResponse response = client.setSettings("INDEX_NAME", new IndexSettings().setAllowCompressionOfIntegerArray(true));

const response = await client.setSettings({
  indexName: 'theIndexName',
  indexSettings: { allowCompressionOfIntegerArray: true },
});

var response =
  client.setSettings(
    indexName = "INDEX_NAME",
    indexSettings = IndexSettings(allowCompressionOfIntegerArray = true),
  )

$response = $client->setSettings(
    'INDEX_NAME',
    ['allowCompressionOfIntegerArray' => true,
    ],
);

response = client.set_settings(
    index_name="INDEX_NAME",
    index_settings={
        "allowCompressionOfIntegerArray": True,
    },
)

response = client.set_settings(
  "INDEX_NAME",
  Algolia::Search::IndexSettings.new(allow_compression_of_integer_array: true)
)

val response = Await.result(
  client.setSettings(
    indexName = "INDEX_NAME",
    indexSettings = IndexSettings(
      allowCompressionOfIntegerArray = Some(true)
    )
  ),
  Duration(100, "sec")
)

let response = try await client.setSettings(
    indexName: "INDEX_NAME",
    indexSettings: IndexSettings(allowCompressionOfIntegerArray: true)
)

Legacy API clients

C#

IndexSettings settings = new IndexSettings();
settings.AllowCompressionOfIntegerArray = true;

index.SetSettings(settings);

res, err := index.SetSettings(search.Settings{
	AllowCompressionOfIntegerArray: opt.AllowCompressionOfIntegerArray(true),
})

index.setSettings(
  new IndexSettings()
    .setAllowCompressionOfIntegerArray(true)
);

index
  .setSettings({
    allowCompressionOfIntegerArray: true,
  })
  .then(() => {
    // done
  });

$index->setSettings([
  'allowCompressionOfIntegerArray' => true
]);

index.set_settings({"allowCompressionOfIntegerArray": True})

index.set_settings(
  {
    allowCompressionOfIntegerArray: true
  }
)

client.execute {
  setSettings of "myIndex" `with` IndexSettings(
    allowCompressionOfIntegerArray = Some(true)
  )
}

let settings = Settings()
  .set(\.allowCompressionOfIntegerArray, to: true)

index.setSettings(settings) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}