CreateIndexParams.IndexField

java.lang.Object
- com.mysql.cj.xdevapi.CreateIndexParams.IndexField

Enclosing class:

CreateIndexParams
```
public static class CreateIndexParams.IndexField
extends java.lang.Object
```
Internally used object parsed from indexDefinition; see Collection.createIndex(String, DbDoc) description.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.Boolean`	`array` (optional) true if the field is an array
`private static java.lang.String`	`ARRAY`
`private java.lang.String`	`field` The full document path to the document member or field to be indexed
`private static java.lang.String`	`FIELD`
`private java.lang.Integer`	`options` (optional) special option flags for use when decoding GEOJSON data
`private static java.lang.String`	`OPTIONS`
`private java.lang.Boolean`	`required` (optional) true if the field is required to exist in the document.
`private static java.lang.String`	`REQUIRED`
`private java.lang.Integer`	`srid` (optional) srid value for use when decoding GEOJSON data
`private static java.lang.String`	`SRID`
`private java.lang.String`	`type` One of the supported SQL column types to map the field into.
`private static java.lang.String`	`TYPE`

Constructor Summary

Constructors
Constructor and Description

IndexField(DbDoc indexField)
Constructor.

Constructors
Constructor and Description
`IndexField(DbDoc indexField)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getField()` Get the full document path to the document member or field to be indexed.
`java.lang.Integer`	`getOptions()` Get options for decoding GEOJSON data.
`java.lang.Integer`	`getSrid()` Get srid for decoding GEOJSON data.
`java.lang.String`	`getType()` Get column type.
`java.lang.Boolean`	`isArray()` Is the field an array?
`java.lang.Boolean`	`isRequired()` Is the field required to exist in the document?

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FIELD
```
private static final java.lang.String FIELD
```
    See Also:
    
    Constant Field Values
  - TYPE
```
private static final java.lang.String TYPE
```
    See Also:
    
    Constant Field Values
  - REQUIRED
```
private static final java.lang.String REQUIRED
```
    See Also:
    
    Constant Field Values
  - OPTIONS
```
private static final java.lang.String OPTIONS
```
    See Also:
    
    Constant Field Values
  - SRID
```
private static final java.lang.String SRID
```
    See Also:
    
    Constant Field Values
  - ARRAY
```
private static final java.lang.String ARRAY
```
    See Also:
    
    Constant Field Values
  - field
```
private java.lang.String field
```
    The full document path to the document member or field to be indexed
  - type
```
private java.lang.String type
```
    One of the supported SQL column types to map the field into. For numeric types, the optional UNSIGNED keyword may follow. For the TEXT type, the length to consider for indexing may be added.
  - required
```
private java.lang.Boolean required
```
    (optional) true if the field is required to exist in the document. defaults to false, except for GEOJSON where it defaults to true
  - options
```
private java.lang.Integer options
```
    (optional) special option flags for use when decoding GEOJSON data
  - srid
```
private java.lang.Integer srid
```
    (optional) srid value for use when decoding GEOJSON data
  - array
```
private java.lang.Boolean array
```
    (optional) true if the field is an array
- Constructor Detail
  - IndexField
```
public IndexField(DbDoc indexField)
```
    Constructor.
    Parameters:
    indexField - a special JSON document, part of indexDefinition document, consisting of the following fields:
    
    field: string, the full document path to the document member or field to be indexed
    
    type: string, one of the supported SQL column types to map the field into. For numeric types, the optional UNSIGNED keyword may follow. For the TEXT type, the length to consider for indexing may be added. Type descriptions are case insensitive.
    
    required: bool, (optional) true if the field is required to exist in the document. Defaults to false, except for GEOJSON where it defaults to true
    
    options: int, (optional) special option flags for use when decoding GEOJSON data
    
    srid: int, (optional) srid value for use when decoding GEOJSON data
    
    array: bool, (optional) true if the field is an array
- Method Detail
  - getField
```
public java.lang.String getField()
```
    Get the full document path to the document member or field to be indexed.
    
    Returns:
    
    field string
  - getType
```
public java.lang.String getType()
```
    Get column type.
    
    Returns:
    
    column type
  - isRequired
```
public java.lang.Boolean isRequired()
```
    Is the field required to exist in the document?
    
    Returns:
    
    true if required
  - getOptions
```
public java.lang.Integer getOptions()
```
    Get options for decoding GEOJSON data.
    
    Returns:
    
    options
  - getSrid
```
public java.lang.Integer getSrid()
```
    Get srid for decoding GEOJSON data.
    
    Returns:
    
    srid
  - isArray
```
public java.lang.Boolean isArray()
```
    Is the field an array?
    
    Returns:
    
    true if the field is an array

Class CreateIndexParams.IndexField

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FIELD

TYPE

REQUIRED

OPTIONS

SRID

ARRAY

field

type

required

options

srid

array

Constructor Detail

IndexField

Method Detail

getField

getType

isRequired

getOptions

getSrid

isArray