Skip to content

IndexesCreator

This API makes it easy to create various types of indexes for any table in your database

Usage

Create your own IndexesCreator instance

You need to create your own IndexesCreator instance and annotate is as @Component:

@Component // this annotation is required to enable the Spring Boot's mapping
public class CustomFullTextIndexCreator extends IndexesCreator {

}

@Component // this annotation is required to enable the Spring Boot's mapping
class CustomFullTextIndexCreator : IndexesCreator() {

}

Declare index fields

To create the index you have to declare which column of the table made up that index

private final List<String> INDEX_FIELDS = List.of("a", "b");

private val INDEX_FIELDS: List<String> = listOf("a", "b")

Create the indexes

Override the createIndexes method and invoke either the provided methods from IndexesCreator or your own custom methods to create indexes

@Override
@PostConstruct // this annotation is required to enable automatically its invocation by Spring Boot
public void createIndexes() {
    // invoke your custom methods to create your own indexes
    createCustomFullTextIndex();
}

@Wrapper // not mandatory, but suggested for a better readability
private void createCustomFullTextIndex() {
    // create your own custom index
    createFullTextIndex("table", "index_name", INDEX_FIELDS);
}

@PostConstruct // this annotation is required to enable automatically its invocation by Spring Boot
override fun createIndexes() {
    // invoke your custom methods to create your own indexes
    createCustomFullTextIndex()
}

@Wrapper // not mandatory, but suggested for a better readability
private fun createCustomFullTextIndex() {
    // create your own custom index
    createFullTextIndex("table", "index_name", INDEX_FIELDS)
}

Overview

The completed implementation is the following:

public class CustomFullTextIndexCreator extends IndexesCreator {

    private final List<String> INDEX_FIELDS = List.of("a", "b");

    @Override
    @PostConstruct // this annotation is required to enable automatically its invocation by Spring Boot
    public void createIndexes() {
        // invoke your custom methods to create your own indexes
        createCustomFullTextIndex();
    }

    @Wrapper // not mandatory, but suggested for a better readability
    private void createCustomFullTextIndex() {
        // create your own custom index
        createFullTextIndex("table", "index_name", INDEX_FIELDS);
    }

}

@Component
class CustomFullTextIndexCreator : IndexesCreator() {

    private val INDEX_FIELDS: List<String> = listOf("a", "b")

    @PostConstruct // this annotation is required to enable automatically its invocation by Spring Boot
    override fun createIndexes() {
        // invoke your custom methods to create your own indexes
        createCustomFullTextIndex()
    }

    @Wrapper // not mandatory, but suggested for a better readability
    private fun createCustomFullTextIndex() {
        // create your own custom index
        createFullTextIndex("table", "index_name", INDEX_FIELDS)
    }            

}

Provided indexes methods