001/*
002 * (C) Copyright 2014 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bdelbosc
018 */
019package org.nuxeo.elasticsearch;
020
021public final class ElasticSearchConstants {
022
023    public static final String AGG_INCLUDE_PROP = "include";
024
025    public static final String AGG_SIZE_PROP = "size";
026
027    public static final String AGG_MIN_DOC_COUNT_PROP = "minDocCount";
028
029    public static final String AGG_EXCLUDE_PROP = "exclude";
030
031    public static final String AGG_ORDER_PROP = "order";
032
033    public static final String AGG_INTERVAL_PROP = "interval";
034
035    public static final String AGG_EXTENDED_BOUND_MAX_PROP = "extendedBoundsMax";
036
037    public static final String AGG_EXTENDED_BOUND_MIN_PROP = "extendedBoundsMin";
038
039    public static final String AGG_FORMAT_PROP = "format";
040
041    public static final String AGG_TIME_ZONE_PROP = "timeZone";
042
043    public static final String AGG_PRE_ZONE_PROP = "preZone";
044
045    public static final String AGG_ORDER_COUNT_DESC = "count desc";
046
047    public static final String AGG_ORDER_COUNT_ASC = "count asc";
048
049    public static final String AGG_ORDER_TERM_DESC = "term desc";
050
051    public static final String AGG_ORDER_TERM_ASC = "term asc";
052
053    public static final String AGG_ORDER_KEY_DESC = "key desc";
054
055    public static final String AGG_ORDER_KEY_ASC = "key asc";
056
057    public static final String AGG_TYPE_TERMS = "terms";
058
059    public static final String AGG_CARDINALITY = "cardinality";
060
061    public static final String AGG_COUNT = "count";
062
063    public static final String AGG_SUM = "sum";
064
065    public static final String AGG_AVG = "avg";
066
067    public static final String AGG_MAX = "max";
068
069    public static final String AGG_MIN = "min";
070
071    public static final String AGG_MISSING = "missing";
072
073    public static final String AGG_TYPE_SIGNIFICANT_TERMS = "significant_terms";
074
075    public static final String AGG_TYPE_RANGE = "range";
076
077    public static final String AGG_TYPE_DATE_RANGE = "date_range";
078
079    public static final String AGG_TYPE_HISTOGRAM = "histogram";
080
081    public static final String AGG_TYPE_DATE_HISTOGRAM = "date_histogram";
082
083    public static final String ID_FIELD = "_id";
084
085    public static final String FULLTEXT_FIELD = "all_field";
086
087    /**
088     * Elasticsearch type name used to index Nuxeo documents
089     */
090    public static final String DOC_TYPE = "doc";
091
092    /**
093     * Elasticsearch type name used to index Nuxeo audit entries
094     */
095    public static final String ENTRY_TYPE = "entry";
096
097    /**
098     * Elasticsearch type name used for the UID sequencer index
099     */
100    public static final String SEQ_ID_TYPE = "seqId";
101
102    public static final String ACL_FIELD = "ecm:acl";
103
104    public static final String PATH_FIELD = "ecm:path";
105
106    public static final String CHILDREN_FIELD = "ecm:path.children";
107
108    public static final String BINARYTEXT_FIELD = "ecm:binarytext";
109
110    public static final String ALL_FIELDS = "*";
111
112    public static final String ES_ENABLED_PROPERTY = "elasticsearch.enabled";
113
114    public static final String FETCH_DOC_FROM_ES_PROPERTY = "elasticsearch.fetchDocFromEs";
115
116    public static final String REINDEX_BUCKET_READ_PROPERTY = "elasticsearch.reindex.bucketReadSize";
117
118    public static final String REINDEX_BUCKET_WRITE_PROPERTY = "elasticsearch.reindex.bucketWriteSize";
119
120    public static final String REINDEX_ON_STARTUP_PROPERTY = "elasticsearch.reindex.onStartup";
121
122    public static final String INDEX_BULK_MAX_SIZE_PROPERTY = "elasticsearch.index.bulkMaxSize";
123
124    public static final String DISABLE_AUTO_INDEXING = "disableAutoIndexing";
125
126    public static final String ES_SYNC_INDEXING_FLAG = "ESSyncIndexing";
127
128    public static final String REINDEX_USING_CHILDREN_TRAVERSAL_PROPERTY = "elasticsearch.reindex.useChildrenTraversal";
129
130    /** @since 7.4 */
131    public static final String INDEXING_QUEUE_ID = "elasticSearchIndexing";
132
133    public static final String EPOCH_MILLIS_FORMAT = "epoch_millis";
134
135    /** @since 10.2 */
136    public static final String ES_SCORE_FIELD = "_score";
137
138    private ElasticSearchConstants() {
139    }
140
141}