Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

KeyTypeOptionalityDescriptionConstraints
typestring
Status
colourRed
titlerequired
type identifier, always dwh[dwh]

subtype

string

Status
colourRed
titlerequired

dwh subtype identifier

[basic, geometryPoint, geometryPolygon, geometryLine, date]
geometrystring

Status
colourYellow
titlevaries

geometry reference to a vector tile dataset

required only for geometryPolygon and geometryLine subtypes

{datasetName}
h3Geometriesarray
Status
colourGreen
titleoptional

array of references to h3Grid dataset names (see example above)

enables the grid visualization


visualizationsarray
Status
colourYellow
titlevaries

array of objects specifying the allowed visualizations of the dataset

required only for geometryPoint, geometryPolygon and geometryLine datasets


zoomobject
Status
colourGreen
titleoptional
map zoom object
tablestring

Status
colourGrey
titleREAD-ONLY

name of the actual dwh table this dataset represents

it's derived from the name of the dataset, and _X postfix is added for each full load, where X is the number of the load

(a-z0-9_-)
primaryKeystring

Status
colourRed
titlerequired

primary key of the table - must be one of the dataset properties

should be unique

{datasetProperty}
categorizableboolean
Status
colourGreen
titleoptional

indicates if the dataset is capable of being categorized in the Filters tool ()

default = true

should be true for fact datasets like "orders", "shops" or "clients", false for additional datasets like "postcodes", "dim_dates" or "price_categories"

[true, false]
fullTextIndexstring
Status
colourGreen
titleoptional

indicates if the dataset's data will be indexed for full text search in Search tool ()

default = true for geometry* subtypes, false for basic and date subtypes

[true, false]
propertiesarray
Status
colourRed
titlerequired

array of properties - database table column descriptions

dataset property order must be identical to the order of the data columns

size must be at least 1


...

KeyTypeOptionalityDescriptionConstraints
namestring
Status
colourRed
titlerequired
name of the column as it will be referenced in other objects(a-z0-9_-)

title

string

Status
colourRed
titlerequired

human-readable title of the column

(*)
columnstring

Status
colourRed
titlerequired

name of the column as it is in the database table

(a-z0-9_-)
typestring
Status
colourRed
titlerequired

column data type

detailed description in the table below

[integer, bigint, decimal, string, boolean, date, latitude, longitude, h3_grid]
foreignKeystring

Status
colourYellow
titlevaries

name of the dataset, whose primaryKey is referenced by this foreignKey

if this key is mentioned, type must be string

(a-z0-9_-)
filterableboolean
Status
colourGreen
titleoptional

indicates whether it's possible for this property to be added to a filter

default = true

[true, false]
descriptionstring
Status
colourGreen
titleoptional

description of the property which appears in Filters ()

(*)
displayOptionsobject
Status
colourGreen
titleoptional

options that specify how the property will be displayed


...