feat: standard database functions everywhere by patricebender · Pull Request #1750 · capire/docs

patricebender · 2025-04-01T14:53:28Z

The cds-compiler and the node database services now are on-par with regard to the supported standard database functions.

With this change we move the standard database function section out of the "runtime" part. Once CAP Java closed the gap, we can remove the disclaimer that this is only available for cds-compiler + node database services

The cds-compiler and the node database services now are on-par with regard to the supported standard database functions. With this change we move the standard database function section out of the "runtime" part. Once CAP Java closed the gap, we can remove the disclaimer that this is only available for cds-compiler + node database services

agoerler · 2025-04-01T15:02:49Z

guides/databases.md

+#### String Functions
+
+- `concat(x, y, ...)`
+  Concatenates the given strings or numbers.


not available in CAP Java

do you support the concat operator (||) ?

https://github.wdf.sap.corp/cds-java/home/issues/1998

returns String

Yes we support the concat operator

agoerler · 2025-04-01T15:03:14Z

guides/databases.md

+  Concatenates the given strings or numbers.
+
+- `trim(x)`
+  Removes leading and trailing whitespaces.


not available in CAP Java

returns String

According to OData, this should be whitespace characters, according to Unicode rules.

I think these are:

u2002

\u3000

\r

\u0085

\u200A

\u2005

\u2000

\u3000

\u2029

\u000B

\u3000

\u2008

\u2003

\u205F

\u3000

\u1680

\u0009

\u0020

\u2006

\u2001

\u202F

\u00A0

\u000C

\u2009

\u3000

\u2004

\u3000

\u3000

\u2028

\n

\u2007

\u3000

@patricebender - do you trim these characters or just whatever the DB considers to be a whitespace? I think the latter would be fine for most practical purposes. (Although we recently had an issue with a Chinese WS character (!)). At least we need to document which interpretation of whitespace character we apply.

agoerler · 2025-04-01T15:06:42Z

guides/databases.md

+  Removes leading and trailing whitespaces.
+
+- `contains(x, y)`
+  Checks whether `y` is contained in `x` (fuzzy matching may apply).


CAP Java

Value.contains(other)

Value.contains(other, isCaseInsensitive) to control if case sensitive

Value.contains is exact and never fuzzy

represented by CqnContainmentTest

implemented by LIKE or ILIKE, if available

is the Compiler's implementation case sensitive or case insensitive

OData v4, CAP: case sensitive

OData v4, RAP: case insensitive (!)

returns Boolean

all OData inspired functions are case sensitive

yes, OData specifies this function as case sensitive:

String comparison is case-sensitive, case-insensitive comparison can be achieved in combination with tolower or toupper.

agoerler · 2025-04-01T15:07:09Z

guides/databases.md

+  Checks whether `y` is contained in `x` (fuzzy matching may apply).
+
+- `startswith(x, y)`
+  Checks whether `y` starts with `x`.


CAP Java: startsWith

case sensitive?

return Boolean

all OData inspired functions are case sensitive

maybe cap-java could also provide a case sensitive variant in all lowercase to be in line with OData

all OData inspired functions are case sensitive

I am not referring to the function's name but to the comparison semantics. CAP Java has a case-sensitive and a case-insensitive variant of startsWith:

https://javadoc.io/doc/com.sap.cds/cds4j-api/latest/com/sap/cds/ql/CQL.html

https://javadoc.io/doc/com.sap.cds/cds4j-api/latest/com/sap/cds/ql/cqn/CqnContainmentTest.html

thanks for the clarification, we are in line with the OData spec for this function:

String comparison is case-sensitive, case-insensitive comparison can be achieved in combination with tolower or toupper.

agoerler · 2025-04-01T15:07:20Z

guides/databases.md

+- `startswith(x, y)`
+  Checks whether `y` starts with `x`.
+
+- `endswith(x, y)`


CAP Java: endsWith

case sensitive?

return Boolean

all OData inspired functions are case sensitive

maybe cap-java could also provide a case sensitive variant in all lowercase to be in line with OData

-> case sensitive?

yes, like specified by OData.

agoerler · 2025-04-01T16:50:30Z

guides/databases.md

+- `years_between`
+  Computes the number of years between two specified dates.
+- `months_between`
+  Computes the number of months between two specified dates.
+- `days_between`
+  Computes the number of days between two specified dates.
+- `seconds_between`
+  Computes the number of seconds between two specified dates.
+- `nano100_between`
+  Computes the time difference between two dates to the precision of 0.1 microseconds.


n/a in CAP Java

please link to the corresponding HANA functions.

these functions are very prone to one-off errors -> require a very precise specification

agoerler · 2025-04-01T16:52:04Z

guides/databases.md

+In addition to the OData and SAP HANA standard functions, the **CAP runtimes** provides special functions that are only available for runtime queries:
+
+- `search(xs, y)`
+  Checks whether `y` is contained in any element of `xs` (fuzzy matching may apply).


what is an xs?

please provide an example how this can be used in a view definition

It cant be used in a view defintion as indicated by the section heading and description. I will change xs to x :)

guides/databases.md

agoerler · 2025-04-01T16:53:03Z

guides/databases.md

+- `ceiling(x)`
+  Rounds the numeric parameter up to the nearest integer.
+
+- `floor(x)`


n/a in CAP Java

agoerler · 2025-04-01T16:55:23Z

guides/databases.md

+- `session_context(v)`  
+  Utilizes standard variable names to maintain session context.
+  Refer to [Session Variables](#session-variables) for additional information.

+- `now()`


In CAP Java you can use the refs $now, $user, $valid.from, $valid.to.

same for node, but this is besides the point of the standard functions. I will add a link to the other section though!

guides/databases.md

agoerler · 2025-04-28T07:40:00Z

guides/databases.md

+  Checks whether `y` is contained in `x` (fuzzy matching may apply).
+
+- `startswith(x, y)`
+  Checks whether `y` starts with `x`.


all OData inspired functions are case sensitive

I am not referring to the function's name but to the comparison semantics. CAP Java has a case-sensitive and a case-insensitive variant of startsWith:

https://javadoc.io/doc/com.sap.cds/cds4j-api/latest/com/sap/cds/ql/CQL.html

https://javadoc.io/doc/com.sap.cds/cds4j-api/latest/com/sap/cds/ql/cqn/CqnContainmentTest.html

guides/databases.md

agoerler · 2025-04-28T08:09:21Z

guides/databases.md

+  Rounds the numeric parameter down to the nearest integer.
+
+- `round(x)`
+  Rounds the numeric parameter to the nearest integer.  


Java:

return type: Type of x.

available now

agoerler · 2025-04-29T12:44:04Z

guides/databases.md

+
+  ::: warning `round` function with more than one argument
+  please note that most databases support `round` functions with multiple arguments.
+  The second parameter being the precision. SAP HANA even has a third argument which is the rounding mode.


I found that using a negative precision does not work on SQLite.

we only take care of the one argument variant of the round function, as we try to replicate the OData round. Everything else will be db-specific, which is what I tried to outline in this warning. @stewsk what do you think?

guides/databases.md

Resolved

guides/databases.md

Co-authored-by: René Jeglinsky <rene.jeglinsky@sap.com>

guides/databases.md

Co-authored-by: René Jeglinsky <rene.jeglinsky@sap.com>

guides/databases.md

patricebender · 2025-05-06T08:42:43Z

@renejeglinsky ready to be merged :)

patricebender requested review from agoerler, danjoa and stewsk April 1, 2025 14:53

patricebender requested a review from renejeglinsky as a code owner April 1, 2025 14:53

be more precise

dc8994b

agoerler reviewed Apr 1, 2025

View reviewed changes

guides/databases.md Outdated Show resolved Hide resolved

agoerler reviewed Apr 3, 2025

View reviewed changes

guides/databases.md Outdated Show resolved Hide resolved

patricebender added 2 commits April 25, 2025 13:59

fixes

fa71952

some more suggestions

f6a4de8

stewsk approved these changes Apr 25, 2025

View reviewed changes

patricebender added 3 commits April 25, 2025 15:52

added hana functions links

cea35b4

Merge branch 'main' into patrice/std-functions

4ce5eaf

how to turn them on

ad564e1

agoerler reviewed Apr 28, 2025

View reviewed changes

patricebender added 3 commits April 28, 2025 13:35

add disclaimer like suggested

7cb9ea3

string funcs are case-sensitive

6c4b0c9

fallback anchor

655939d

patricebender enabled auto-merge April 28, 2025 12:42

patricebender added 2 commits April 28, 2025 15:50

add compile cmd to sample

9bf08ae

disclaimer for round

2ba678d

agoerler reviewed Apr 29, 2025

View reviewed changes

stewsk reviewed Apr 29, 2025

View reviewed changes

guides/databases.md Outdated Show resolved Hide resolved

review suggestion

fba6aab

danjoa previously requested changes Apr 29, 2025

View reviewed changes

guides/databases.md Show resolved Hide resolved

danjoa self-requested a review April 30, 2025 05:41

danjoa approved these changes Apr 30, 2025

View reviewed changes

renejeglinsky reviewed Apr 30, 2025

View reviewed changes

guides/databases.md Outdated Show resolved Hide resolved

Update guides/databases.md

096010c

Co-authored-by: René Jeglinsky <rene.jeglinsky@sap.com>

renejeglinsky reviewed Apr 30, 2025

View reviewed changes

guides/databases.md Outdated Show resolved Hide resolved

renejeglinsky reviewed Apr 30, 2025

View reviewed changes

guides/databases.md Outdated Show resolved Hide resolved

Update guides/databases.md

46385f9

Co-authored-by: René Jeglinsky <rene.jeglinsky@sap.com>

renejeglinsky reviewed Apr 30, 2025

View reviewed changes

guides/databases.md Outdated Show resolved Hide resolved

renejeglinsky and others added 6 commits April 30, 2025 12:10

edit

e9a63f8

acrolinx check

1fc02aa

merge

9696cb6

typo

bdabd63

better wording

2322e91

Merge branch 'main' into patrice/std-functions

0704002

patricebender requested a review from renejeglinsky April 30, 2025 14:00

patricebender disabled auto-merge April 30, 2025 14:00

patricebender enabled auto-merge April 30, 2025 14:00

Merge branch 'main' into patrice/std-functions

0bdfb5a

renejeglinsky approved these changes May 6, 2025

View reviewed changes

Merge branch 'main' into patrice/std-functions

31e9d4d

patricebender added this pull request to the merge queue May 6, 2025

Merged via the queue into main with commit 2d1dd5e May 6, 2025
4 checks passed

patricebender deleted the patrice/std-functions branch May 6, 2025 09:07

Comments

Conversation

patricebender commented Apr 1, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

patricebender commented May 6, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants