Record Class IndexConfig

java.lang.Object

java.lang.Record

com.loomcache.client.query.IndexConfig

public record IndexConfig(String indexName, List<String> columnNames, IndexType indexType)
extends Record

Describes a secondary index to be created on a distributed map.

Specifies the index name, the map column names to index, and the index type (sorted, hash, or bitmap). Use the static factory methods sorted(String, String, String...), hash(String, String, String...), or bitmap(String, String, String...) for the common cases, then supply the config to LoomClient.addIndex.

Note: SQL secondary indexes are disabled in this release — addIndex and addIndexAsync always fail (see the SQL-engine guide). This config type is retained for API stability.

Constructor Summary

Constructors

Constructor	Description
IndexConfig(String indexName, String columnName, IndexType indexType)
IndexConfig(String indexName, List<String> columnNames, IndexType indexType)	Creates an instance of a IndexConfig record class.

Method Summary

Modifier and Type	Method	Description
static IndexConfig	bitmap(String indexName, String columnName, String... moreColumnNames)
static IndexConfig	bitmap(String indexName, List<String> columnNames)
String	columnName()
List<String>	columnNames()	Returns the value of the columnNames record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static IndexConfig	hash(String indexName, String columnName, String... moreColumnNames)
static IndexConfig	hash(String indexName, List<String> columnNames)
final int	hashCode()	Returns a hash code value for this object.
String	indexName()	Returns the value of the indexName record component.
IndexType	indexType()	Returns the value of the indexType record component.
static IndexConfig	sorted(String indexName, String columnName, String... moreColumnNames)
static IndexConfig	sorted(String indexName, List<String> columnNames)
String	toCreateIndexSql(String mapName)
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

IndexConfig

public IndexConfig(String indexName,
 String columnName,
 IndexType indexType)

IndexConfig

public IndexConfig(String indexName,
 List<String> columnNames,
 IndexType indexType)

Creates an instance of a IndexConfig record class.

Parameters:

indexName - the value for the indexName record component

columnNames - the value for the columnNames record component

indexType - the value for the indexType record component

Method Details

sorted

public static IndexConfig sorted(String indexName,
 String columnName,
 String... moreColumnNames)

sorted

public static IndexConfig sorted(String indexName,
 List<String> columnNames)

hash

public static IndexConfig hash(String indexName,
 String columnName,
 String... moreColumnNames)

hash

public static IndexConfig hash(String indexName,
 List<String> columnNames)

bitmap

public static IndexConfig bitmap(String indexName,
 String columnName,
 String... moreColumnNames)

bitmap

public static IndexConfig bitmap(String indexName,
 List<String> columnNames)

columnName

public String columnName()

toCreateIndexSql

public String toCreateIndexSql(String mapName)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

indexName

public String indexName()

Returns the value of the indexName record component.

Returns:

the value of the indexName record component

columnNames

public List<String> columnNames()

Returns the value of the columnNames record component.

Returns:

the value of the columnNames record component

indexType

public IndexType indexType()

Returns the value of the indexType record component.

Returns:

the value of the indexType record component