Core Functions - Spiral Docs

This page lists 20 functions in the spql namespace generated from the default SPQL function catalog.

Function	Kind	Summary
`spql.add`	scalar function	Add two values.
`spql.and`	scalar function	Return the boolean conjunction of two values.
`spql.case_when`	scalar function	Select between two values based on a boolean condition.
`spql.div`	scalar function	Divide the left value by the right value.
`spql.eq`	scalar function	Return whether two values are equal.
`spql.gt`	scalar function	Return whether the left value is greater than the right value.
`spql.gte`	scalar function	Return whether the left value is greater than or equal to the right value.
`spql.ilike`	scalar function	Return whether a UTF8 value matches a SQL ILIKE pattern.
`spql.is_null`	scalar function	Return whether a value is null.
`spql.like`	scalar function	Return whether a UTF8 value matches a SQL LIKE pattern.
`spql.lt`	scalar function	Return whether the left value is less than the right value.
`spql.lte`	scalar function	Return whether the left value is less than or equal to the right value.
`spql.mul`	scalar function	Multiply two values.
`spql.neq`	scalar function	Return whether two values are not equal.
`spql.not`	scalar function	Invert a boolean value.
`spql.not_ilike`	scalar function	Return whether a UTF8 value does not match a SQL ILIKE pattern.
`spql.not_like`	scalar function	Return whether a UTF8 value does not match a SQL LIKE pattern.
`spql.or`	scalar function	Return the boolean disjunction of two values.
`spql.sub`	scalar function	Subtract the right value from the left value.
`spql.range`	generator function	Generate integers from zero up to a stop value.

`spql.add`

Kind: scalar function

Add two values.

Signature

spql.add(left, right)

Parameters

Name	Required	Description
`left`	yes	Left-hand value.
`right`	yes	Right-hand value.

Returns

The sum as a value or expression.

`spql.and`

Kind: scalar function

Return the boolean conjunction of two values.

Signature

spql.and(left, right)

Parameters

Name	Required	Description
`left`	yes	Left-hand boolean value.
`right`	yes	Right-hand boolean value.

Returns

A boolean value or expression.

`spql.case_when`

Kind: scalar function

Select between two values based on a boolean condition.

Signature

spql.case_when(cond, then, otherwise)

Parameters

Name	Required	Description
`cond`	yes	Boolean condition selecting between the branches.
`then`	yes	Value produced where the condition is true.
`otherwise`	yes	Value produced where the condition is false or null.

Returns

The then value where the condition is true, otherwise the otherwise value.

`spql.div`

Kind: scalar function

Divide the left value by the right value.

Signature

spql.div(left, right)

Parameters

Name	Required	Description
`left`	yes	Left-hand value.
`right`	yes	Right-hand value.

Returns

The quotient as a value or expression.

`spql.eq`

Kind: scalar function

Return whether two values are equal.

Signature

spql.eq(left, right)

Parameters

Name	Required	Description
`left`	yes	Left-hand value.
`right`	yes	Right-hand value.

Returns

A boolean value or expression.

`spql.gt`

Kind: scalar function

Return whether the left value is greater than the right value.

Signature

spql.gt(left, right)

Parameters

Name	Required	Description
`left`	yes	Left-hand value.
`right`	yes	Right-hand value.

Returns

A boolean value or expression.

`spql.gte`

Kind: scalar function

Return whether the left value is greater than or equal to the right value.

Signature

spql.gte(left, right)

Parameters

Name	Required	Description
`left`	yes	Left-hand value.
`right`	yes	Right-hand value.

Returns

A boolean value or expression.

`spql.ilike`

Kind: scalar function

Return whether a UTF8 value matches a SQL ILIKE pattern.

Signature

spql.ilike(value, pattern)

Parameters

Name	Required	Description
`value`	yes	Input UTF8 value.
`pattern`	yes	SQL pattern.

Returns

A boolean value or expression.

`spql.is_null`

Kind: scalar function

Return whether a value is null.

Signature

spql.is_null(value)

Parameters

Name	Required	Description
`value`	yes	No parameter docs.

Returns

A boolean value or expression.

`spql.like`

Kind: scalar function

Return whether a UTF8 value matches a SQL LIKE pattern.

Signature

spql.like(value, pattern)

Parameters

Name	Required	Description
`value`	yes	Input UTF8 value.
`pattern`	yes	SQL pattern.

Returns

A boolean value or expression.

`spql.lt`

Kind: scalar function

Return whether the left value is less than the right value.

Signature

spql.lt(left, right)

Parameters

Name	Required	Description
`left`	yes	Left-hand value.
`right`	yes	Right-hand value.

Returns

A boolean value or expression.

`spql.lte`

Kind: scalar function

Return whether the left value is less than or equal to the right value.

Signature

spql.lte(left, right)

Parameters

Name	Required	Description
`left`	yes	Left-hand value.
`right`	yes	Right-hand value.

Returns

A boolean value or expression.

`spql.mul`

Kind: scalar function

Multiply two values.

Signature

spql.mul(left, right)

Parameters

Name	Required	Description
`left`	yes	Left-hand value.
`right`	yes	Right-hand value.

Returns

The product as a value or expression.

`spql.neq`

Kind: scalar function

Return whether two values are not equal.

Signature

spql.neq(left, right)

Parameters

Name	Required	Description
`left`	yes	Left-hand value.
`right`	yes	Right-hand value.

Returns

A boolean value or expression.

`spql.not`

Kind: scalar function

Invert a boolean value.

Signature

spql.not(value)

Parameters

Name	Required	Description
`value`	yes	No parameter docs.

Returns

A boolean value or expression.

`spql.not_ilike`

Kind: scalar function

Return whether a UTF8 value does not match a SQL ILIKE pattern.

Signature

spql.not_ilike(value, pattern)

Parameters

Name	Required	Description
`value`	yes	Input UTF8 value.
`pattern`	yes	SQL pattern.

Returns

A boolean value or expression.

`spql.not_like`

Kind: scalar function

Return whether a UTF8 value does not match a SQL LIKE pattern.

Signature

spql.not_like(value, pattern)

Parameters

Name	Required	Description
`value`	yes	Input UTF8 value.
`pattern`	yes	SQL pattern.

Returns

A boolean value or expression.

`spql.or`

Kind: scalar function

Return the boolean disjunction of two values.

Signature

spql.or(left, right)

Parameters

Name	Required	Description
`left`	yes	Left-hand boolean value.
`right`	yes	Right-hand boolean value.

Returns

A boolean value or expression.

`spql.sub`

Kind: scalar function

Subtract the right value from the left value.

Signature

spql.sub(left, right)

Parameters

Name	Required	Description
`left`	yes	Left-hand value.
`right`	yes	Right-hand value.

Returns

The difference as a value or expression.

`spql.range`

Kind: generator function

This function has multiple public overloads.

`spql.range(stop)`

Generate integers from zero up to a stop value.

Parameters

Name	Required	Description
`stop`	yes	No parameter docs.

Returns

Rows with one value field for each integer in [0, stop).

`spql.range(start, stop)`

Generate integers between start and stop values.

Parameters

Name	Required	Description
`start`	yes	No parameter docs.
`stop`	yes	No parameter docs.

Returns

Rows with one value field for each integer in [start, stop).