Package 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 Description static class
CreateIndexParams.IndexField
Internally used object parsed from indexDefinition; seeCollection.createIndex(String, DbDoc)
description. -
Field Summary
-
Constructor Summary
Constructors Constructor 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 Description java.util.List<CreateIndexParams.IndexField>
getFields()
Get index fields.java.lang.String
getIndexName()
Get index name.java.lang.String
getIndexType()
Get index type.
-
Field Details
-
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 Details
-
CreateIndexParams
Constructor.- Parameters:
indexName
- index nameindexDefinition
- special JSON document containing index definition; seeCollection.createIndex(String, DbDoc)
description
-
CreateIndexParams
public CreateIndexParams(java.lang.String indexName, java.lang.String jsonIndexDefinition)Constructor.- Parameters:
indexName
- index namejsonIndexDefinition
- special JSON document containing index definition; seeCollection.createIndex(String, String)
description
-
-
Method Details
-
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
Get index fields.- Returns:
- List of
CreateIndexParams.IndexField
objects
-