com.mysql.cj.xdevapi

Class CreateIndexParams

java.lang.Object

com.mysql.cj.xdevapi.CreateIndexParams

public class CreateIndexParams
extends java.lang.Object

Internally-used object passing index creation parameters to XMessageBuilder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateIndexParams.IndexField Internally used object parsed from indexDefinition; see Collection.createIndex(String, DbDoc) description.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GEOJSON
static java.lang.String	INDEX
static java.lang.String	SPATIAL

Constructor Summary

Constructors

Constructor and Description
CreateIndexParams(java.lang.String indexName, DbDoc indexDefinition) Constructor.
CreateIndexParams(java.lang.String indexName, java.lang.String jsonIndexDefinition) Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.List<CreateIndexParams.IndexField>	getFields() Get index fields.
java.lang.String	getIndexName() Get index name.
java.lang.String	getIndexType() Get index type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INDEX

public static final java.lang.String INDEX

See Also:

Constant Field Values

SPATIAL

public static final java.lang.String SPATIAL

See Also:

Constant Field Values

GEOJSON

public static final java.lang.String GEOJSON

See Also:

Constant Field Values

Constructor Detail

CreateIndexParams

public CreateIndexParams(java.lang.String indexName,
                         DbDoc indexDefinition)

Constructor.

Parameters:

indexName - index name

indexDefinition - special JSON document containing index definition; see Collection.createIndex(String, DbDoc) description

CreateIndexParams

public CreateIndexParams(java.lang.String indexName,
                         java.lang.String jsonIndexDefinition)

Constructor.

Parameters:

indexName - index name

jsonIndexDefinition - special JSON document containing index definition; see Collection.createIndex(String, String) description

Method Detail

getIndexName

public java.lang.String getIndexName()

Get index name.

Returns:

index name

getIndexType

public java.lang.String getIndexType()

Get index type.

Returns:

index type

getFields

public java.util.List<CreateIndexParams.IndexField> getFields()

Get index fields.

Returns:

List of CreateIndexParams.IndexField objects