TinyBase logoTinyBase

Definition type aliases

This is the collection of definition type aliases within the queries module. There are 8 definition type aliases in total.

Group

The Group type describes a function that lets you specify that the values of a Cell in multiple result Rows should be aggregated together.

GroupedAs

The GroupedAs type describes an object returned from calling a Group function so that the grouped Cell Id can be optionally aliased.

Having

The Having type describes a function that lets you specify conditions to filter results, based on the grouped Cells resulting from a Group clause.

Calling this function with two parameters is used to include only those Rows for which a specified Cell in the query's main Table has a specified value.

Calling this function with one callback parameter is used to include only those Rows which meet a calculated boolean condition.

Join

The Join type describes a function that lets you specify a Cell or calculated value to join the main query Table to other Tables, by their Row Id.

Calling this function with two Id parameters will indicate that the join to a Row in an adjacent Table is made by finding its Id in a Cell of the query's main Table.

Calling this function with two parameters (where the second is a function) will indicate that the join to a Row in an adjacent Table is made by calculating its Id from the Cells and the Row Id of the query's main Table.

Calling this function with three Id parameters will indicate that the join to a Row in distant Table is made by finding its Id in a Cell of an intermediately joined Table.

Calling this function with three parameters (where the third is a function) will indicate that the join to a Row in distant Table is made by calculating its Id from the Cells and the Row Id of an intermediately joined Table.

JoinedAs

The JoinedAs type describes an object returned from calling a Join function so that the joined Table Id can be optionally aliased.

Select

The Select type describes a function that lets you specify a Cell or calculated value for including into the query's result.

Calling this function with one Id parameter will indicate that the query should select the value of the specified Cell from the query's main Table.

Calling this function with two parameters will indicate that the query should select the value of the specified Cell from a Table that has been joined in the query.

Calling this function with one callback parameter will indicate that the query should select a calculated value, based on one or more Cell values in the main Table or a joined Table, or on the main Table's Row Id.

SelectedAs

The SelectedAs type describes an object returned from calling a Select function so that the selected Cell Id can be optionally aliased.

Where

The Where type describes a function that lets you specify conditions to filter results, based on the underlying Cells of the main or joined Tables.

Calling this function with two parameters is used to include only those Rows for which a specified Cell in the query's main Table has a specified value.

Calling this function with three parameters is used to include only those Rows for which a specified Cell in a joined Table has a specified value.

Calling this function with one callback parameter is used to include only those Rows which meet a calculated boolean condition, based on values in the main and (optionally) joined Tables.