neuralib.sqlp.func_stat

SQL help functions.

neuralib.sqlp.func_stat.literal(x)[source]
Parameters:

x (str)

Return type:

SqlExpr

neuralib.sqlp.func_stat.wrap(x)[source]

wrap x as an SQL expression.

Return type:

SqlExpr

neuralib.sqlp.func_stat.alias(x: str, name: str) → Any[source]
neuralib.sqlp.func_stat.alias(x: type[T], name: str) → type[T]
neuralib.sqlp.func_stat.alias(x: SqlStat[T], name: str) → type[T]
neuralib.sqlp.func_stat.cast(t, x)[source]
Parameters:

t (type[T])

Return type:

T

neuralib.sqlp.func_stat.case(x=None)[source]

https://www.sqlite.org/lang_expr.html#the_case_expression

Parameters:

x

Returns:

Return type:

SqlCaseExpr

neuralib.sqlp.func_stat.exists(x: SqlStat) → SqlExpr[source]
neuralib.sqlp.func_stat.exists(x: type, *where: bool | expr.SqlExpr) → SqlExpr

https://www.sqlite.org/lang_expr.html#the_exists_operator

>>> exists(A, A.a == 1) # equivalent below
>>> exists(select_from(1, from_table=A).where(A.a == 1))
Parameters:

  • x

  • where

Returns:

neuralib.sqlp.func_stat.asc(x)[source]

ascending ordering Used by ORDER BY.

Return type:

SqlExpr

neuralib.sqlp.func_stat.desc(x)[source]

descending ordering used by ORDER BY.

Return type:

SqlExpr

neuralib.sqlp.func_stat.nulls_first(x)[source]

order null first used by ORDER BY.

Return type:

SqlExpr

neuralib.sqlp.func_stat.nulls_last(x)[source]

order null last used by ORDER BY.

Return type:

SqlExpr

neuralib.sqlp.func_stat.concat(*x)[source]

concatenate strings.

Return type:

SqlExpr

neuralib.sqlp.func_stat.and_(*other)[source]

“AND” SQL expressions.

Return type:

SqlExpr

neuralib.sqlp.func_stat.or_(*other)[source]

“OR” SQL expressions.

Return type:

SqlExpr

neuralib.sqlp.func_stat.like(x, s)[source]
Parameters:

  • x

  • s

Returns:

Return type:

SqlCompareOper

neuralib.sqlp.func_stat.not_like(x, s)[source]
Parameters:

  • x

  • s

Returns:

Return type:

SqlCompareOper

neuralib.sqlp.func_stat.glob(x, s)[source]
Parameters:

  • x

  • s

Returns:

Return type:

SqlCompareOper

neuralib.sqlp.func_stat.contains(x, coll)[source]
Parameters:

  • x

  • coll – a sequence or a select statement.

Returns:

Return type:

SqlCompareOper

neuralib.sqlp.func_stat.not_contains(x, coll)[source]
Parameters:

  • x

  • coll – a sequence or a select statement.

Returns:

Return type:

SqlCompareOper

neuralib.sqlp.func_stat.between(x, *value)[source]

https://www.sqlite.org/lang_expr.html#the_between_operator

Parameters:

  • x

  • value – two value, or a range, a slice.

Returns:

Return type:

SqlCompareOper

neuralib.sqlp.func_stat.not_between(x, *value)[source]

https://www.sqlite.org/lang_expr.html#the_between_operator

Parameters:

  • x

  • value – two value, or a range, a slice.

Returns:

Return type:

SqlCompareOper

neuralib.sqlp.func_stat.is_null(x)[source]
Return type:

SqlCompareOper

neuralib.sqlp.func_stat.is_not_null(x)[source]
Return type:

SqlCompareOper

neuralib.sqlp.func_stat.excluded(t)[source]

https://www.sqlite.org/lang_upsert.html

Parameters:

t (type[T])

Return type:

type[T]

neuralib.sqlp.func_stat.with_common_table(name: str, select: SqlSelectStat) → SqlCteExpr[source]
neuralib.sqlp.func_stat.with_common_table(name: type[T], select: SqlSelectStat) → type[T]
neuralib.sqlp.func_stat.fields(table, *, primary=None, has_default=None, excluded=None)[source]
Parameters:

  • table (type[T])

  • primary (bool | None)

  • has_default (bool | None)

  • excluded (Collection[str] | None)

Return type:

tuple[SqlField, …]