docs icon indicating copy to clipboard operation
docs copied to clipboard

fix: Move DB agnostic sections out of `sqlite` database guide

Open patricebender opened this issue 1 year ago • 6 comments

With this change, Common Operators and Common Functions have been moved from the sqlite guide to the generic database guide.

The function list is now including all functions which are supported by all cap-js/dbs.

Todos:

  • [ ] align with Java colleagues, I think we can make this section a shared one for both stacks
  • [ ] how to document the to-be-expected return types?

Also, it would be nice to remove the disclaimer only supported in runtime queries, but for that we first need compiler support for the functions as well as for the operators.

patricebender avatar Jun 03 '24 12:06 patricebender

ping @johannes-vogel @stewsk

patricebender avatar Jun 13 '24 11:06 patricebender

does that also apply to java?

johannes-vogel avatar Jun 20 '24 12:06 johannes-vogel

does that also apply to java?

@johannes-vogel Do you mean we'd need the equivalent docs for Java when moving those docs in the common guide?

@patricebender Is there anything I can support you with?

renejeglinsky avatar Jul 11 '24 07:07 renejeglinsky

does that also apply to java?

@johannes-vogel Do you mean we'd need the equivalent docs for Java when moving those docs in the common guide?

@patricebender Is there anything I can support you with?

I think the "common operators" section must be moved to the generic part of the db guide, I would like to hear the POs opinions here. From my side, this change is fine (I only need to apply the suggestion from Bob).

patricebender avatar Jul 11 '24 07:07 patricebender

does that also apply to java?

@johannes-vogel Do you mean we'd need the equivalent docs for Java when moving those docs in the common guide? @patricebender Is there anything I can support you with?

I think the "common operators" section must be moved to the generic part of the db guide, I would like to hear the POs opinions here. From my side, this change is fine (I only need to apply the suggestion from Bob).

I was simply wondering whether this is node specific or also applicable for java. at the moment it's tagged as node specific. in general, fine for me:)

johannes-vogel avatar Jul 12 '24 09:07 johannes-vogel

@MattSchur @agoerler Could you please check this PR? It's about moving a topic and also what is probably Node/Java specific (or not!)

renejeglinsky avatar Sep 23 '24 10:09 renejeglinsky

@stewsk @johannes-vogel could you kindly review

patricebender avatar Nov 06 '24 12:11 patricebender

@agoerler what do you think about adding the functions which are supported by the java runtime ({.impl .java}) in a similar fashion?

For CAP Java, the set of supported functions is documented here:

  • scalar functions: https://cap.cloud.sap/docs/java/working-with-cql/query-api#scalar-functions
  • predicated: https://cap.cloud.sap/docs/java/working-with-cql/query-api#predicate-functions

As mentioned earlier, these functions can be used on the DBs but also in remote OData consumption. We could add a link in an ({.impl .java}) variant. Maybe in a follow-up PR).

agoerler avatar Nov 06 '24 18:11 agoerler

@renejeglinsky how can I fix the broken anchor links mentioned in the build:

in: /releases/jun24
Unresolved hash link: /guides/databases-sqlite #standard-operators
Unresolved hash link: /guides/databases-sqlite #standard-functions
Unresolved hash link: /guides/databases-sqlite #sap-hana-functions

I can't find them in the repository :(

patricebender avatar Nov 07 '24 13:11 patricebender