"docStore has type OBJECT rather than LIST" error when Elastic configuration is in application.conf

[cpoissonnier]

Hi,

When I add these lines to application.conf :

ebean.docstore.url="http://127.0.0.1:9200"
ebean.docstore.active=true
ebean.docstore.generateMapping=false
ebean.docstore.dropCreate=false
ebean.docstore.create=false

I have the following error :
play/conf/application.conf: 26: docStore has type OBJECT rather than LIST

[cpoissonnier]

I managed to make it work thanks to the ServerConfigStartup, by adding :

package models;

import com.avaje.ebean.config.ServerConfig;
import com.avaje.ebean.event.ServerConfigStartup;

public class MyServerConfigStartup implements ServerConfigStartup {
    public void onStart(ServerConfig serverConfig) {
        serverConfig.getDocStoreConfig().setUrl("http://localhost:9200");
        serverConfig.getDocStoreConfig().setActive(true);
        serverConfig.getDocStoreConfig().setGenerateMapping(false);
        serverConfig.getDocStoreConfig().setDropCreate(false);
        serverConfig.getDocStoreConfig().setCreate(false);
        serverConfig.getDocStoreConfig().setPathToResources("conf");
    }
}

[marcospereira]

Problem is here:

play-ebean/play-ebean/src/main/java/play/db/ebean/EbeanParsedConfig.java

Lines 49 to 54 in 34ec6cf

	if (raw.valueType() == ConfigValueType.STRING) {
	// Support legacy comma separated string
	models = Arrays.asList(((String) raw.unwrapped()).split(","));
	} else {
	models = ebeanConfig.getStringList(key);
	}

This is just accepting/parsing String and List configurations.

[thibaultmeyer]

To use DocStore, You have to put these lines on conf/ebean.properties. The file application.conf is only used to configure datasource and model location (for enhancement and register classes with Ebean server).

[cpoissonnier]

I could, but I would have to put all ebean configuration in this file (I tried to mix configuration between the ebean.properties and application.conf, but it doesn't work) and the way I deal with different environnement doesn't really allow that. A fix would be more than welcome :)

[thibaultmeyer]

I see, it make sense, something like that (see below) could be a good approach to handle configuration of all Ebean functionalities.

application.conf

ebean {

    servers {
        default {
            enhancement = ["models.*"]

            docstore {
                url = "http://127.0.0.1:9200"
                active = true
                generateMapping = false
                dropCreate = false
                create = false
            }
        }
    }

    querybean {
        # Configure type safe queries (http://ebean-orm.github.io/docs/query/typesafe)
        ...
    }

    encryption {
        # Configure encryption key manager to use for fields annotated with @Encrypted
        encryptKeyManager = "com.zero_x_baadf00d.ebean.encryption.StandardEncryptKeyManager"
    }
}

[thibaultmeyer]

...of course it doesn't work. It's an example of what play-ebean configuration could looks like in the future. I just said "could be a good approach to handle configuration of all Ebean functionalities.".

[cpoissonnier]

My bad !

That would be perfect

[thibaultmeyer]

I can propose a PR this weekend or next weekend... I don't promise all configuration keys will be implemented, but the docstore related keys should working.

[thibaultmeyer]

@cpoissonnier

I have rewritted so many files, not sure it will be merged in this project. So we are published our version under our organization.

in your project/plugins.sbt file, you can override sbt-play-ebean with :

addSbtPlugin("com.payintech" % "sbt-play-ebean" % "16.12")

And use this application.conf

# Ebean
# ~~~~~
ebean {
  servers {

    # You can declare as many servers as you want.
    # By convention, the default server is named `default`
    default {

      # Locations of the classes to enhance
      enhancement = ["models.*"]

      # Extra server settings
      settings {

        # Set to true if this server is Document store only
        onlyUseDocStore = false

        # Encryption key manager to use for fields annotated with @Encrypted
        #encryptKeyManager = "com.zero_x_baadf00d.ebean.encryption.StandardEncryptKeyManager"
      }

      # Document store
      docstore {

        # URL of the ElasticSearch server to use
        url = "http://127.0.0.1:9200"

        # Enable document store integration
        active = true

        # Set the relative file system path to resources when generating mapping files
        pathToResources = "conf"

        # Generate mapping files for each index and these will by default be
        # generated into ${pathToResources} under "elastic-mapping"
        generateMapping = false

        # Drop and re-create all indexes
        dropCreate = false

        # Create only indexes that have not already been defined
        create = false
      }
    }
  }
}

[cpoissonnier]

Great ! Thank you so much, I'll try this monday !

[ethereal-sandeep]

@cpoissonnier I tried this plugin addSbtPlugin("com.payintech" % "sbt-play-ebean" % "16.12"
& still got this error
/application.conf:** 87-90: docstore has type OBJECT rather than LIST]

Anyone else who is able to run this successfully...please share the config format.

[thibaultmeyer]

@ethereal-sandeep have you upgraded your application.conf file ? If you have in develop mode, think to restart server after editing project/plugins.sbt.

# Ebean
# ~~~~~
ebean {
  servers {

    # You can declare as many servers as you want.
    # By convention, the default server is named `default`
    default {

      # Locations of the classes to enhance
      enhancement = ["models.*"]

      # Extra server settings
      settings {

        # Set to true if this server is Document store only
        onlyUseDocStore = false

        # Encryption key manager to use for fields annotated with @Encrypted
        #encryptKeyManager = "com.zero_x_baadf00d.ebean.encryption.StandardEncryptKeyManager"
      }

      # Document store
      docstore {

        # URL of the ElasticSearch server to use
        url = "http://127.0.0.1:9200"

        # Enable document store integration
        active = true

        # Set the relative file system path to resources when generating mapping files
        pathToResources = "conf"

        # Generate mapping files for each index and these will by default be
        # generated into ${pathToResources} under "elastic-mapping"
        generateMapping = false

        # Drop and re-create all indexes
        dropCreate = false

        # Create only indexes that have not already been defined
        create = false
      }
    }
  }
}

@ethereal-sandeep Could copy / past your application.conf (gist) ? have you try to clean ivy cache ?