[jOOQ/jOOQ#16436] Document DSL.jsonGetElement() index being 0 based

This commit is contained in:
Lukas Eder 2024-03-12 09:35:33 +01:00
parent 2b4460a423
commit 321a6367b5
2 changed files with 200 additions and 32 deletions

View File

@ -22997,8 +22997,8 @@ public class DSL {
* <p>
* Access an array element from a JSON array expression.
*
* @param field is wrapped as {@link DSL#val(Object)}.
* @param index is wrapped as {@link DSL#val(Object)}.
* @param field The JSON document
* @param index The 0-based JSON array index
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, TRINO, YUGABYTEDB })
@ -23011,7 +23011,8 @@ public class DSL {
* <p>
* Access an array element from a JSON array expression.
*
* @param field is wrapped as {@link DSL#val(Object)}.
* @param field The JSON document
* @param index The 0-based JSON array index
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, TRINO, YUGABYTEDB })
@ -23024,7 +23025,8 @@ public class DSL {
* <p>
* Access an array element from a JSON array expression.
*
* @param index is wrapped as {@link DSL#val(Object)}.
* @param field The JSON document
* @param index The 0-based JSON array index
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, TRINO, YUGABYTEDB })
@ -23036,6 +23038,9 @@ public class DSL {
* The <code>JSON_GET_ELEMENT</code> function.
* <p>
* Access an array element from a JSON array expression.
*
* @param field The JSON document
* @param index The 0-based JSON array index
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, TRINO, YUGABYTEDB })
@ -23048,8 +23053,8 @@ public class DSL {
* <p>
* Access an array element from a JSONB array expression.
*
* @param field is wrapped as {@link DSL#val(Object)}.
* @param index is wrapped as {@link DSL#val(Object)}.
* @param field The JSONB document
* @param index The 0-based JSONB array index
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, TRINO, YUGABYTEDB })
@ -23062,7 +23067,8 @@ public class DSL {
* <p>
* Access an array element from a JSONB array expression.
*
* @param field is wrapped as {@link DSL#val(Object)}.
* @param field The JSONB document
* @param index The 0-based JSONB array index
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, TRINO, YUGABYTEDB })
@ -23075,7 +23081,8 @@ public class DSL {
* <p>
* Access an array element from a JSONB array expression.
*
* @param index is wrapped as {@link DSL#val(Object)}.
* @param field The JSONB document
* @param index The 0-based JSONB array index
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, TRINO, YUGABYTEDB })
@ -23087,6 +23094,9 @@ public class DSL {
* The <code>JSONB_GET_ELEMENT</code> function.
* <p>
* Access an array element from a JSONB array expression.
*
* @param field The JSONB document
* @param index The 0-based JSONB array index
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, TRINO, YUGABYTEDB })
@ -23099,8 +23109,8 @@ public class DSL {
* <p>
* Access an array element from a JSON array expression and return it as a string.
*
* @param field is wrapped as {@link DSL#val(Object)}.
* @param index is wrapped as {@link DSL#val(Object)}.
* @param field The JSON document
* @param index The 0-based JSON array index
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
@ -23113,7 +23123,8 @@ public class DSL {
* <p>
* Access an array element from a JSON array expression and return it as a string.
*
* @param field is wrapped as {@link DSL#val(Object)}.
* @param field The JSON document
* @param index The 0-based JSON array index
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
@ -23126,7 +23137,8 @@ public class DSL {
* <p>
* Access an array element from a JSON array expression and return it as a string.
*
* @param index is wrapped as {@link DSL#val(Object)}.
* @param field The JSON document
* @param index The 0-based JSON array index
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
@ -23138,6 +23150,9 @@ public class DSL {
* The <code>JSON_GET_ELEMENT_AS_TEXT</code> function.
* <p>
* Access an array element from a JSON array expression and return it as a string.
*
* @param field The JSON document
* @param index The 0-based JSON array index
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
@ -23150,8 +23165,8 @@ public class DSL {
* <p>
* Access an array element from a JSONB array expression and return it as a string.
*
* @param field is wrapped as {@link DSL#val(Object)}.
* @param index is wrapped as {@link DSL#val(Object)}.
* @param field The JSONB document
* @param index The 0-based JSONB array index
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
@ -23164,7 +23179,8 @@ public class DSL {
* <p>
* Access an array element from a JSONB array expression and return it as a string.
*
* @param field is wrapped as {@link DSL#val(Object)}.
* @param field The JSONB document
* @param index The 0-based JSONB array index
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
@ -23177,7 +23193,8 @@ public class DSL {
* <p>
* Access an array element from a JSONB array expression and return it as a string.
*
* @param index is wrapped as {@link DSL#val(Object)}.
* @param field The JSONB document
* @param index The 0-based JSONB array index
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
@ -23189,6 +23206,9 @@ public class DSL {
* The <code>JSONB_GET_ELEMENT_AS_TEXT</code> function.
* <p>
* Access an array element from a JSONB array expression and return it as a string.
*
* @param field The JSONB document
* @param index The 0-based JSONB array index
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
@ -23201,8 +23221,8 @@ public class DSL {
* <p>
* Access an object attribute value from a JSON object expression.
*
* @param field is wrapped as {@link DSL#val(Object)}.
* @param attribute is wrapped as {@link DSL#val(Object)}.
* @param field The JSON document
* @param attribute The JSON object attribute name
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, TRINO, YUGABYTEDB })
@ -23215,7 +23235,8 @@ public class DSL {
* <p>
* Access an object attribute value from a JSON object expression.
*
* @param field is wrapped as {@link DSL#val(Object)}.
* @param field The JSON document
* @param attribute The JSON object attribute name
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, TRINO, YUGABYTEDB })
@ -23228,7 +23249,8 @@ public class DSL {
* <p>
* Access an object attribute value from a JSON object expression.
*
* @param attribute is wrapped as {@link DSL#val(Object)}.
* @param field The JSON document
* @param attribute The JSON object attribute name
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, TRINO, YUGABYTEDB })
@ -23240,6 +23262,9 @@ public class DSL {
* The <code>JSON_GET_ATTRIBUTE</code> function.
* <p>
* Access an object attribute value from a JSON object expression.
*
* @param field The JSON document
* @param attribute The JSON object attribute name
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, TRINO, YUGABYTEDB })
@ -23252,8 +23277,8 @@ public class DSL {
* <p>
* Access an object attribute value from a JSONB object expression.
*
* @param field is wrapped as {@link DSL#val(Object)}.
* @param attribute is wrapped as {@link DSL#val(Object)}.
* @param field The JSONB document
* @param attribute The JSONB object attribute name
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, TRINO, YUGABYTEDB })
@ -23266,7 +23291,8 @@ public class DSL {
* <p>
* Access an object attribute value from a JSONB object expression.
*
* @param field is wrapped as {@link DSL#val(Object)}.
* @param field The JSONB document
* @param attribute The JSONB object attribute name
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, TRINO, YUGABYTEDB })
@ -23279,7 +23305,8 @@ public class DSL {
* <p>
* Access an object attribute value from a JSONB object expression.
*
* @param attribute is wrapped as {@link DSL#val(Object)}.
* @param field The JSONB document
* @param attribute The JSONB object attribute name
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, TRINO, YUGABYTEDB })
@ -23291,6 +23318,9 @@ public class DSL {
* The <code>JSONB_GET_ATTRIBUTE</code> function.
* <p>
* Access an object attribute value from a JSONB object expression.
*
* @param field The JSONB document
* @param attribute The JSONB object attribute name
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, TRINO, YUGABYTEDB })
@ -23303,8 +23333,8 @@ public class DSL {
* <p>
* Access an object attribute value from a JSON object expression and return it as string.
*
* @param field is wrapped as {@link DSL#val(Object)}.
* @param attribute is wrapped as {@link DSL#val(Object)}.
* @param field The JSON document
* @param attribute The JSON object attribute name
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
@ -23317,7 +23347,8 @@ public class DSL {
* <p>
* Access an object attribute value from a JSON object expression and return it as string.
*
* @param field is wrapped as {@link DSL#val(Object)}.
* @param field The JSON document
* @param attribute The JSON object attribute name
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
@ -23330,7 +23361,8 @@ public class DSL {
* <p>
* Access an object attribute value from a JSON object expression and return it as string.
*
* @param attribute is wrapped as {@link DSL#val(Object)}.
* @param field The JSON document
* @param attribute The JSON object attribute name
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
@ -23342,6 +23374,9 @@ public class DSL {
* The <code>JSON_GET_ATTRIBUTE_AS_TEXT</code> function.
* <p>
* Access an object attribute value from a JSON object expression and return it as string.
*
* @param field The JSON document
* @param attribute The JSON object attribute name
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
@ -23355,8 +23390,8 @@ public class DSL {
* Access an object attribute value from a JSONB object expression and return it as
* string.
*
* @param field is wrapped as {@link DSL#val(Object)}.
* @param attribute is wrapped as {@link DSL#val(Object)}.
* @param field The JSONB document
* @param attribute The JSONB object attribute name
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
@ -23370,7 +23405,8 @@ public class DSL {
* Access an object attribute value from a JSONB object expression and return it as
* string.
*
* @param field is wrapped as {@link DSL#val(Object)}.
* @param field The JSONB document
* @param attribute The JSONB object attribute name
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
@ -23384,7 +23420,8 @@ public class DSL {
* Access an object attribute value from a JSONB object expression and return it as
* string.
*
* @param attribute is wrapped as {@link DSL#val(Object)}.
* @param field The JSONB document
* @param attribute The JSONB object attribute name
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
@ -23397,6 +23434,9 @@ public class DSL {
* <p>
* Access an object attribute value from a JSONB object expression and return it as
* string.
*
* @param field The JSONB document
* @param attribute The JSONB object attribute name
*/
@NotNull
@Support({ CLICKHOUSE, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })

View File

@ -12792,10 +12792,26 @@ public final class QOM {
//permits
// JSONGetElement
{
/**
* The JSON document
*/
@NotNull default Field<JSON> $field() { return $arg1(); }
/**
* The JSON document
*/
@CheckReturnValue
@NotNull default JSONGetElement $field(Field<JSON> newField) { return $arg1(newField); }
/**
* The 0-based JSON array index
*/
@NotNull default Field<Integer> $index() { return $arg2(); }
/**
* The 0-based JSON array index
*/
@CheckReturnValue
@NotNull default JSONGetElement $index(Field<Integer> newIndex) { return $arg2(newIndex); }
}
@ -12840,10 +12856,26 @@ public final class QOM {
//permits
// JSONBGetElement
{
/**
* The JSONB document
*/
@NotNull default Field<JSONB> $field() { return $arg1(); }
/**
* The JSONB document
*/
@CheckReturnValue
@NotNull default JSONBGetElement $field(Field<JSONB> newField) { return $arg1(newField); }
/**
* The 0-based JSONB array index
*/
@NotNull default Field<Integer> $index() { return $arg2(); }
/**
* The 0-based JSONB array index
*/
@CheckReturnValue
@NotNull default JSONBGetElement $index(Field<Integer> newIndex) { return $arg2(newIndex); }
}
@ -12888,10 +12920,26 @@ public final class QOM {
//permits
// JSONGetElementAsText
{
/**
* The JSON document
*/
@NotNull default Field<JSON> $field() { return $arg1(); }
/**
* The JSON document
*/
@CheckReturnValue
@NotNull default JSONGetElementAsText $field(Field<JSON> newField) { return $arg1(newField); }
/**
* The 0-based JSON array index
*/
@NotNull default Field<Integer> $index() { return $arg2(); }
/**
* The 0-based JSON array index
*/
@CheckReturnValue
@NotNull default JSONGetElementAsText $index(Field<Integer> newIndex) { return $arg2(newIndex); }
}
@ -12936,10 +12984,26 @@ public final class QOM {
//permits
// JSONBGetElementAsText
{
/**
* The JSONB document
*/
@NotNull default Field<JSONB> $field() { return $arg1(); }
/**
* The JSONB document
*/
@CheckReturnValue
@NotNull default JSONBGetElementAsText $field(Field<JSONB> newField) { return $arg1(newField); }
/**
* The 0-based JSONB array index
*/
@NotNull default Field<Integer> $index() { return $arg2(); }
/**
* The 0-based JSONB array index
*/
@CheckReturnValue
@NotNull default JSONBGetElementAsText $index(Field<Integer> newIndex) { return $arg2(newIndex); }
}
@ -12984,10 +13048,26 @@ public final class QOM {
//permits
// JSONGetAttribute
{
/**
* The JSON document
*/
@NotNull default Field<JSON> $field() { return $arg1(); }
/**
* The JSON document
*/
@CheckReturnValue
@NotNull default JSONGetAttribute $field(Field<JSON> newField) { return $arg1(newField); }
/**
* The JSON object attribute name
*/
@NotNull default Field<String> $attribute() { return $arg2(); }
/**
* The JSON object attribute name
*/
@CheckReturnValue
@NotNull default JSONGetAttribute $attribute(Field<String> newAttribute) { return $arg2(newAttribute); }
}
@ -13032,10 +13112,26 @@ public final class QOM {
//permits
// JSONBGetAttribute
{
/**
* The JSONB document
*/
@NotNull default Field<JSONB> $field() { return $arg1(); }
/**
* The JSONB document
*/
@CheckReturnValue
@NotNull default JSONBGetAttribute $field(Field<JSONB> newField) { return $arg1(newField); }
/**
* The JSONB object attribute name
*/
@NotNull default Field<String> $attribute() { return $arg2(); }
/**
* The JSONB object attribute name
*/
@CheckReturnValue
@NotNull default JSONBGetAttribute $attribute(Field<String> newAttribute) { return $arg2(newAttribute); }
}
@ -13080,10 +13176,26 @@ public final class QOM {
//permits
// JSONGetAttributeAsText
{
/**
* The JSON document
*/
@NotNull default Field<JSON> $field() { return $arg1(); }
/**
* The JSON document
*/
@CheckReturnValue
@NotNull default JSONGetAttributeAsText $field(Field<JSON> newField) { return $arg1(newField); }
/**
* The JSON object attribute name
*/
@NotNull default Field<String> $attribute() { return $arg2(); }
/**
* The JSON object attribute name
*/
@CheckReturnValue
@NotNull default JSONGetAttributeAsText $attribute(Field<String> newAttribute) { return $arg2(newAttribute); }
}
@ -13131,10 +13243,26 @@ public final class QOM {
//permits
// JSONBGetAttributeAsText
{
/**
* The JSONB document
*/
@NotNull default Field<JSONB> $field() { return $arg1(); }
/**
* The JSONB document
*/
@CheckReturnValue
@NotNull default JSONBGetAttributeAsText $field(Field<JSONB> newField) { return $arg1(newField); }
/**
* The JSONB object attribute name
*/
@NotNull default Field<String> $attribute() { return $arg2(); }
/**
* The JSONB object attribute name
*/
@CheckReturnValue
@NotNull default JSONBGetAttributeAsText $attribute(Field<String> newAttribute) { return $arg2(newAttribute); }
}