Dimension Type Attributes Quick Reference

In the following tables, the valid attributes for each dimension type are specified. The column labeled “Q” indicates which attributes are for query usage only. “D” indicates that the column impacts indexing at when the dimension is created.

Columns labeled “Q” can be set on the dimension and omitted from the query, effectively setting a common default for all queries against the dimension.

Geoloc

Attribute Q Example Notes
type D type = “geoloc”  
id   id = “name of dimension”  
reindexMethod   reindexMethod = “warmSwap”  
longitude   longitude = “changeset_property  
latitude   latitude = “changeset_property  
shapes Q shapes = “”  
delimiters   delimiters = ”,” used to create lists
distanceUnit Q distanceUnit = “km” Specifies the default distance unit to be used for queries against this dimension. May also be explicitly specified at query time. Supported values are miles and km.
zipcode   zipcode = “changeset_property Deprecated
zipcodeResource D   Deprecated.

keyword

Attribute Q Example Notes
type D type = “keyword”  
id   id = “name of dimension”  
key D key = “changeset_property_id(s)  
reindexMethod   reindexMethod = “warmSwap”  
locale D locale = “pt_BR” Default en_US
ignoreCase D ignoreCase = “false” Default = true
accentFolding D accentFolding = “false” Default = true
maxBuckets D maxBuckets = “0” Default no limits

tree, ordered, mutex

Attribute Q Example Notes
type D type = “keyword”  
id   id = “name of dimension”  
key D key = “changeset_property_id(s)  
reindexMethod   reindexMethod = “warmSwap”  
locale D locale = “pt_BR” Default en_US
ignoreCase D ignoreCase = “false” Default = true
accentFolding D accentFolding = “false” Default = true
value   value = “Califonia” Associates a data value with an id
notId Q    
notValue Q    

text

Attribute Q Example Notes
type   type = “text”  
id D id = “name of dimension”  
key D key = “changeset_property_id(s)  
reindexMethod   reindexMethod = “warmSwap”  
locale D locale = “pt_BR” Default en_US
ignoreCase D ignoreCase = “false” Default = true
accentFolding D accentFolding = “false” Default = true
stemming D stemming = “false” Default = true
stopWords D stopWords = “list of stop words Default = true
stopWords-ref D stopWords-ref = “word set id  
noAnalysis-ref D noAnalysis-ref = “word set id  
stemmingExclusion-ref D stemmingExclusion = “word set id  
stripHTML D stripHTML = “true” Default = false
phoneticAlgorithm D phoneticAlgorithm = “metaphone” Valid values:
      soundex, refinedSoundex
      metaphone, doubleMetaphone
maxCodeLen D maxCodeLen = “5” Default 4. For the Metaphone algorithms.
ignoreFieldLength   ignoreFieldLength = “true” Default = false.
fieldPositionIncrementGap D fieldPositionIncrementGap = “0” Default = 100.
stopWordPositionIncrements D stopWordPositionIncrements = “true” Default = false.
makeParts D makeParts = “both” Default = “words”
splitParts D splitParts = “both” Default = “case”
concatParts D concatParts = “words” Default = “none”
concatenateAll D concatenateAll = “false” Default = true.
stemEnglishPossessive D stemEnglishPossessive = “true” Default = true.

integer, long, double

Attribute Example Notes
type type = “integer”  
  type = “long”  
  type = “double”  
id id = “name of dimension”  
key key = “changeset_property_id(s)  
reindexMethod reindexMethod = “warmSwap”  
delimiters delimiters = ”,”  
min min = “minimum value Data values outside range are ignored
minInclusive minInclusive = “true” Default = false
max max = “false” Data values outside range are ignored
maxInclusive maxInclusive = “false” Default = false

time

Attribute Example Notes
type type = “time”  
id id = “name of dimension”  
key key = “changeset_property_id(s)  
reindexMethod reindexMethod = “warmSwap”  
delimiters delimiters = ”,”  
format format = “yyyy-MM-dd’T’HH:mm:ss”  
min min = “minimum value Data values outside range are ignored
minInclusive minInclusive = “true” Default = false
max max = “false” Data values outside range are ignored
maxInclusive maxInclusive = “false” Default = false

groupBy

Attribute Example Notes
type type = “keyword”  
id id = “name of dimension”  
key key = “changeset_property_id(s)  

random

Attribute Example Notes
type type = “text”  
id id = “name of dimension”