com.marklogic.client.pojo.util

Class GenerateIndexConfig

java.lang.Object

com.marklogic.client.pojo.util.GenerateIndexConfig

public class GenerateIndexConfig
extends Object

Generates a MarkLogic index configuration file in JSON format describing the indexes required by the annotations on the specific classes. The output can be used by an administrator to create indexes in the database using the Management REST API.

WARNING! Applying this generated index file via management API will overwrite existing indexes! Only use this as-is if there are no other indexes on your database that you want to keep. To add these indexes to other indexes please get the configuration for existing indexes from the management API and add these to that file before applying.

Usage example:

     java com.marklogic.client.pojo.util.GenerateIndexConfig 
       -classes "com.marklogic.client.test.City com.marklogic.client.test.Country" 
       -file cityIndexes.json

     curl -i --digest --user admin:admin \
       -H 'Content-Type: application/json' \
       -d '@cityIndexes.json' \
       -X PUT 'http://localhost:8002/manage/LATEST/databases/java-unittest/properties'
 

Constructor Summary

Constructors

Constructor and Description
GenerateIndexConfig()

Method Summary

Methods

Modifier and Type	Method and Description
static void	main(String[] args) Reads the annotations from the specified classes and generates MarkLogic index configurations specified by the annotations.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerateIndexConfig

public GenerateIndexConfig()

Method Detail

main

public static void main(String[] args)
                 throws IOException,
                        ClassNotFoundException

Reads the annotations from the specified classes and generates MarkLogic index configurations specified by the annotations. Accepts the following options: -classes: a space-separated list of java pojo classes visible on the classpath -file: a file path to write with the output (otherwise uses standard out)

Throws:

IOException - if an error occurs reading the classes or writing the output

IllegalStateException - if errors are found in your annotations

ClassNotFoundException - if the classes are not found on the classpath