dialect/app.cash.sqldelight.dialect.api/AggregateFunctionExpression

AggregateFunctionExpression

interface AggregateFunctionExpression : SqlAnnotatedElement

An aggregate function which a dialect parses as its own expression rather than as a SqlFunctionExpr, for example Sqlite 3.44 group_concat(name, ',' ORDER BY name) or PostgreSql string_agg(name, ',') ORDER BY name.

Implementing AggregateFunctionExpression treats the expression as an aggregate when working out the nullability of a query's columns.

The defaults assume the grammar of name ( arguments ) [ FILTER ( WHERE condition ) ].

Properties

canReturnNullForNonNullArguments

open val canReturnNullForNonNullArguments: Boolean

True if the aggregate can return NULL for a group of non null functionArguments, for example because a FILTER clause can exclude every row of a group.

children

@get:Contract(pure = true)

@get:NotNull

abstract val children: @NotNull Array<out @NotNull PsiElement>

containingFile

@get:Contract(pure = true)

abstract val containingFile: PsiFile?

context

@get:Nullable

@get:Contract(pure = true)

abstract val context: @Nullable PsiElement?

firstChild

@get:Contract(pure = true)

abstract val firstChild: PsiElement?

functionArguments

open val functionArguments: List<SqlExpr>

The expressions being aggregated, whose nullability the result of the aggregate follows.

functionName

open val functionName: String

isPhysical

@get:Contract(pure = true)

abstract val isPhysical: Boolean

isValid

@get:Contract(pure = true)

abstract val isValid: Boolean

isWritable

@get:Contract(pure = true)

abstract val isWritable: Boolean

language

@get:NotNull

@get:Contract(pure = true)

abstract val language: @NotNull Language

lastChild

@get:Contract(pure = true)

abstract val lastChild: PsiElement?

manager

@get:Contract(pure = true)

abstract val manager: PsiManager?

navigationElement

@get:Contract(pure = true)

abstract val navigationElement: PsiElement?

nextSibling

@get:Contract(pure = true)

abstract val nextSibling: PsiElement?

node

@get:Contract(pure = true)

abstract val node: ASTNode?

originalElement

@get:Contract(pure = true)

abstract val originalElement: PsiElement?

ownDeclarations

@get:ApiStatus.Experimental

@get:ApiStatus.OverrideOnly

@get:NotNull

open val ownDeclarations: @NotNull Collection<out @NotNull PsiSymbolDeclaration>

ownReferences

@get:ApiStatus.Experimental

@get:ApiStatus.OverrideOnly

@get:NotNull

open val ownReferences: @NotNull Collection<out @NotNull PsiSymbolReference>

parent

@get:Contract(pure = true)

abstract val parent: PsiElement?

prevSibling

@get:Contract(pure = true)

abstract val prevSibling: PsiElement?

project

@get:NotNull

@get:Contract(pure = true)

abstract val project: @NotNull Project

reference

@get:Nullable

@get:Contract(pure = true)

abstract val reference: @Nullable PsiReference?

references

@get:Contract(pure = true)

abstract val references: @NotNull Array<out PsiReference?>

resolveScope

@get:NotNull

@get:Contract(pure = true)

abstract val resolveScope: @NotNull GlobalSearchScope

startOffsetInParent

@get:Contract(pure = true)

abstract val startOffsetInParent: Int

text

@get:Contract(pure = true)

@get:NlsSafe

abstract val text: @NlsSafe String?

textLength

@get:Contract(pure = true)

abstract val textLength: Int

textOffset

@get:Contract(pure = true)

abstract val textOffset: Int

textRange

@get:Contract(pure = true)

abstract val textRange: TextRange?

textRangeInParent

@get:Contract(pure = true)

@get:NotNull

open val textRangeInParent: @NotNull TextRange

useScope

@get:NotNull

@get:Contract(pure = true)

abstract val useScope: @NotNull SearchScope

Functions

abstract fun accept(@NotNull p0: @NotNull PsiElementVisitor)

acceptChildren

abstract fun acceptChildren(@NotNull p0: @NotNull PsiElementVisitor)

add

abstract fun add(@NotNull p0: @NotNull PsiElement): PsiElement?

addAfter

abstract fun addAfter(@NotNull p0: @NotNull PsiElement, @Nullable p1: @Nullable PsiElement?): PsiElement?

addBefore

abstract fun addBefore(@NotNull p0: @NotNull PsiElement, @Nullable p1: @Nullable PsiElement?): PsiElement?

addRange

abstract fun addRange(p0: PsiElement?, p1: PsiElement?): PsiElement?

addRangeAfter

abstract fun addRangeAfter(p0: PsiElement?, p1: PsiElement?, p2: PsiElement?): PsiElement?

addRangeBefore

abstract fun addRangeBefore(@NotNull p0: @NotNull PsiElement, @NotNull p1: @NotNull PsiElement, p2: PsiElement?): PsiElement?

annotate

abstract fun annotate(annotationHolder: SqlAnnotationHolder)

checkAdd

abstract fun ~~checkAdd~~(@NotNull p0: @NotNull PsiElement)

checkDelete

abstract fun ~~checkDelete~~()

copy

abstract fun copy(): PsiElement?

delete

abstract fun delete()

deleteChildRange

abstract fun deleteChildRange(p0: PsiElement?, p1: PsiElement?)

findElementAt

@Nullable

@Contract(pure = true)

abstract fun findElementAt(p0: Int): @Nullable PsiElement?

findReferenceAt

@Nullable

@Contract(pure = true)

abstract fun findReferenceAt(p0: Int): @Nullable PsiReference?

getCopyableUserData

@Nullable

@Contract(pure = true)

abstract fun <T : Any?> getCopyableUserData(@NotNull p0: @NotNull Key<T?>): @Nullable T?

getIcon

abstract fun getIcon(p0: Int): Icon?

getUserData

@Nullable

abstract fun <T : Any?> getUserData(@NotNull p0: @NotNull Key<T?>): @Nullable T?

isEquivalentTo

@Contract(pure = true)

abstract fun isEquivalentTo(p0: PsiElement?): Boolean

processDeclarations

abstract fun processDeclarations(@NotNull p0: @NotNull PsiScopeProcessor, @NotNull p1: @NotNull ResolveState, @Nullable p2: @Nullable PsiElement?, @NotNull p3: @NotNull PsiElement): Boolean

putCopyableUserData

abstract fun <T : Any?> putCopyableUserData(@NotNull p0: @NotNull Key<T?>, @Nullable p1: @Nullable T?)

putUserData

abstract fun <T : Any?> putUserData(@NotNull p0: @NotNull Key<T?>, @Nullable p1: @Nullable T?)

replace

abstract fun replace(@NotNull p0: @NotNull PsiElement): PsiElement?

textContains

@Contract(pure = true)

abstract fun textContains(p0: Char): Boolean

textMatches

@Contract(pure = true)

abstract fun textMatches(@NotNull p0: @NotNull PsiElement): Boolean

@Contract(pure = true)

abstract fun textMatches(@NotNull @NonNls p0: @NotNull @NonNls CharSequence): Boolean

textToCharArray

@Contract(pure = true)

abstract fun textToCharArray(): @NotNull CharArray