Documentation mismatch and confusing syntax for `ifnull()` 3-argument variant
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 88/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- sql
- Área
- documentation
Línea de trabajo
Actualiza SQL-Functions.md, el archivo mencionado en la incidencia. Lee la entrada de ifnull() y compara la sintaxis y la descripción con el comportamiento descrito para OSQLFunctionIfNull; incluye ambas formas de invocación, ejemplos del comportamiento ternario y una referencia cruzada a coalesce() para cadenas de respaldo que usan el primer valor no nulo. El trabajo estará terminado cuando la entrada documente correctamente el tercer argumento opcional y la diferencia con coalesce().
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
OrientDB Version: 1.3.0 through 3.2.x / develop
Component: SQL Functions / Documentation (SQL-Functions.md)
Description
The SQL function ifnull() supports both 2 and 3 arguments in code (OSQLFunctionIfNull), but the official documentation in SQL-Functions.md is incomplete, has malformed grammar, and omits the 3rd argument from the syntax definition and examples.
Furthermore, because standard SQL / MySQL / SQLite IFNULL() strictly takes 2 arguments, users and reviewers who encounter 3 arguments often mistakenly assume either:
- OrientDB
ifnull()only takes 2 arguments, or - The 3-argument version behaves like
coalesce()(returning the first non-null argument).
In reality, OrientDB's 3-argument ifnull() behaves like Oracle's NVL2() (ternary condition: val != null ? arg3 : arg2).
Documentation Issues in SQL-Functions.md
- Syntax definition omits the 3rd argument:
The code definessuper(NAME, 2, 3)with syntaxifnull(<field|value>, <return_value_if_null> [,<return_value_if_not_null>]), but the documentation only showsifnull(<field/value>, <return_value_if_null>). - Broken sentence in description:
"Returns the passed field/value (or optional parameter *return_value_if_not_null*). If field/value is not null, otherwise it returns *return_value_if_null*."
The original JavaDoc inOSQLFunctionIfNull.javareads:"Returns the passed
field/value(or optional parameterreturn_value_if_not_null) iffield/valueis not null; otherwise it returnsreturn_value_if_null." - No 3-argument example:
There are no examples demonstrating the 3-argument ternary behavior or clarifying that for first-non-null fallbacks (coalesce),coalesce()should be used instead.
Actual Code Behavior (OSQLFunctionIfNull.java)
public OSQLFunctionIfNull() {
super(NAME, 2, 3);
}
@Override
public Object execute(...) {
if (iParams[0] != null) {
if (iParams.length == 3) {
return iParams[2];
}
return iParams[0];
}
return iParams[1];
}
ifnull('a', 'b')->'a'ifnull('a', 'b', 'c')->'c'ifnull(null, 'b')->'b'ifnull(null, 'b', 'c')->'b'ifnull(null, null, 'x')->null(not'x')
Expected Documentation
Update SQL-Functions.md to:
- Correct the syntax to show the optional 3rd argument:
ifnull(<field|value>, <return_value_if_null> [, <return_value_if_not_null>]) - Fix the description phrasing and clarify the ternary semantics:
Returns the passed
field|value(or optional parameterreturn_value_if_not_null) iffield|valueis not null; otherwise returnsreturn_value_if_null. - Add examples for both 2-argument and 3-argument invocations.
- Add a note/cross-reference pointing users to
coalesce()if they need a multi-argument fallback chain (first non-null value).
- Lenguaje dominante
- CSS
- Estrellas
- 59
- Forks
- 164
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de orientechnologies/orientdb-docs
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 48/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 50/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 25/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 25/100
orientechnologies/orientdb-docs#387 · 1 comentario ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
Todos los issues de orientechnologies/orientdb-docs
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
ethereum/execution-apis#1017 ·
Los mantenedores suelen responder en 3 días
-
[Docs] CONTRIBUTING points the Backend Remake milestone at a branch that does not existPosiblemente ocupada @franpts2 la tomó hoy. Abiertodocs
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
Los mantenedores suelen responder en 3 días
-
postgresql-rules / queue-rules: implicit KEY SHARE before a parent key update, and job self-overlapAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
jonathanong/no-mistakes#3879 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
pearu/agent-sandbox#451 ·
Los mantenedores suelen responder en 1 día