Package net.pricefx.formulaengine.scripting.queryapi.tables

Interface QapiDatamart

All Superinterfaces:

Map<String,SelectableExpression>, Tables.Columns, Tables.Table

public interface QapiDatamart
extends Tables.Table

Table of the rows of one Analytics Datamart. A Datamart combines the data of one or more Data Sources, joined through matching fields, and can add calculated fields.

Obtain it with api.queryApi().tables().datamart(String), passing the unique name of the Datamart. An unknown name fails with an error. The fields of the Datamart are accessed as properties by their field name, for example dm.Country.

To convert the money and quantity values when they are read, use api.queryApi().tables().datamart(String, Map) with the QapiDatamart.Options.

Example:

 def q = api.queryApi()
 def dm = q.tables().datamart("Gapminder")

 return q.source(dm, [dm.Country, dm.Population, dm.Year], dm.Country.equal("Canada"))
         .stream { it.collect { it } }
 

Since:

15.0 - Southside

See Also:

• QapiDataSource
• QapiRollup
• Tables
• Datamarts

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	QapiDatamart.Options	Options of api.queryApi().tables().datamart(String, Map), which convert the values of the Datamart when they are read.

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method	Description
SelectableExpression	isDeleted()	Returns whether the row is flagged as deleted.
SelectableExpression	lastUpdateDate()	Returns the date and time when the row was last updated.

Methods inherited from interface Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Details

isDeleted

SelectableExpression isDeleted()

Returns whether the row is flagged as deleted.

Since 16.3.16 and 17.0.7, this column is no longer exposed for Datamarts, and calling this method fails with a NoSuchElementException.

Returns:

the isDeleted column as a Boolean expression

lastUpdateDate

SelectableExpression lastUpdateDate()

Returns the date and time when the row was last updated.

Returns:

the lastUpdateDate column as a DateTime expression