All properties can be passed either as a environment variable or as a JVM parameter. The "." and "_" characters can be replaced with each other.
SET aspire_noSql_elastic_server=http://localhost:9200 //Setting a property as a environment variable java -Daspire.noSql.elastic.server=http://localhost:9200 //Passing a property like JVM parameter
Bellow are the list of properties to configure the Elasticsearch NoSQL Provider
Parameter | Default | Description |
---|---|---|
aspire.noSql.elastic.server | http://localhost:9200 | Required: The elasticsearch server url to use. It can be multiple urls separated by "," |
aspire.noSql.elastic.authentication.basic | false | (Optional) Enables elasticsearch basic authentication |
aspire.noSql.elastic.user | null | (Optional) The elasticsearch user to use for basic authentication |
aspire.noSql.elastic.password | null | (Optional) The elasticsearch password to use for basic authentication |
aspire.noSql.elastic.authentication.aws | false | (Optional) Enables elasticsearch AWS authentication |
aspire.noSql.elastic.authentication.useCredentialsProviderChain | false | (Optional) Option to use the AWS credentials provider chain to get the credentials |
aspire.noSql.elastic.aws.access.key | null | (Optional) AWS access key for authentication |
aspire.noSql.elastic.aws.secret.key | null | (Optional) AWS secret key for authentication |
aspire.noSql.elastic.aws.region | null | (Optional) The AWS region |
aspire.noSql.elastic.keepSearchContextAlive | 5m | (Optional) The amount of time to keep elasticsearch scrolls requests search context alive using "m" as a unit |
aspire.noSql.elastic.maxRequestSize | 104857600B | (Optional) The maximum size for a bulk request. The value can be specified in B, K, M and G units |
aspire.noSql.elastic.maxConnections | 100 | (Optional) The maximum amount of connections to mantain open. |
aspire.noSql.elastic.maxConnectionsPerRoute | 10 | (Optional) The maximum amount of connections per server |
aspire.noSql.elastic.maxRetries | 3 | (Optional) The amount of times to retry each request |
aspire.noSql.elastic.retriesWaitTime | 5000 | (Optional) The time to wait in ms between retries |
aspire.noSql.elastic.useThrottling | false | (Optional) Enables requests throttling to elasticsearch |
aspire.noSql.elastic.throttlingRate | 5000 | (Optional) The throttling rate in ms |
aspire.noSql.elastic.throttlingConnectionRate | 500 | (Optional) The maximum amount of requests allowed in the period specified by the throttlingRate |
aspire.noSql.elastic.waitTime429 | 3000 | (Optional) The time to wait in ms before retrying a 429 error |
aspire.noSql.elastic.bulk | true | (Optional) Enables using bulk for requests |
aspire.noSql.elastic.bulkSize | 500 | (Optional) The maximum number of documents to include in a bulk request |
aspire.noSql.elastic.bulkInactivityTimeout | 5 | (Optional) The inactivity in s before flushing a bulk request |
aspire.noSql.elastic.bulkRegularTimeout | 30 | (Optional) The maximum amount of time in s for a bulk request to be kept in memory before flushing |
aspire.noSql.elastic.debugFile | null | (Optional) The path to the debug file, request to ES are logged in this file |
aspire.noSql.elastic.mappingFile | null | (Optional) The file that includes the mapping for the indexes used by Aspire. By default mapping included in the provider is used |
aspire.noSql.elastic.index.prefix | aspire | (Optional) The prefix to use for the indexes created by the provider |