{ "schema_version": "1.0.0", "library_id": "cloverdx-ctl2-builtins", "generated_date": "2026-09-01", "target": { "language": "CTL2", "product": "CloverDX", "product_version": null }, "sources": [ { "id": "ctl2-container-functions", "path": "ctl_doc/ctl2-container-functions.adoc", "kind": "documentation", "sha256": "1ff44521584eeae641053b22f68683f6b73261eeb49dc3767d97b7a4262e9398", "description": "CloverDX CTL2 container function documentation." }, { "id": "ctl2-conversion-functions", "path": "ctl_doc/ctl2-conversion-functions.adoc", "kind": "documentation", "sha256": "e5766643af1bd6cb5bf2522159a92840fc427c27f9b436d5838c3f9b284a5145", "description": "CloverDX CTL2 conversion function documentation." }, { "id": "ctl2-data-service-http-library-functions", "path": "ctl_doc/ctl2-data-service-http-library-functions.adoc", "kind": "documentation", "sha256": "869d2963fe8415b39e862aa3104f664995157a8ff2c533c631a9684aabf70f5a", "description": "CloverDX CTL2 data-service-http-library function documentation." }, { "id": "ctl2-date-functions", "path": "ctl_doc/ctl2-date-functions.adoc", "kind": "documentation", "sha256": "90f83f9421413b1a5cac7c6771ac6691098abb39006d0568d63b9f7466c192b4", "description": "CloverDX CTL2 date function documentation." }, { "id": "ctl2-lookup-table-functions", "path": "ctl_doc/ctl2-lookup-table-functions.adoc", "kind": "documentation", "sha256": "f82ac5d91957efff3c2ee4904762f24850ec49b381f669899d8c0835a0e28320", "description": "CloverDX CTL2 lookup-table function documentation." }, { "id": "ctl2-mapping-functions", "path": "ctl_doc/ctl2-mapping-functions.adoc", "kind": "documentation", "sha256": "dbf5b494f4c630e470d57b23c9cfe174fb70763546ac8a7c1c0e3d71a334cb8f", "description": "CloverDX CTL2 mapping function documentation." }, { "id": "ctl2-mathematical-functions", "path": "ctl_doc/ctl2-mathematical-functions.adoc", "kind": "documentation", "sha256": "b3351bd06b1f59bb641e4d925901db2869c91e23579efddb1d3d5e1a488812bb", "description": "CloverDX CTL2 mathematical function documentation." }, { "id": "ctl2-miscellaneous-functions", "path": "ctl_doc/ctl2-miscellaneous-functions.adoc", "kind": "documentation", "sha256": "fe98b92148b9d0aac926dcfa86d7a2a3dc235da52ecd594b3c6d84a091c80e08", "description": "CloverDX CTL2 miscellaneous function documentation." }, { "id": "ctl2-record-functions", "path": "ctl_doc/ctl2-record-functions.adoc", "kind": "documentation", "sha256": "ad8516389091c2b065e293684e28b6642009f835f590ada0e968c50ff18a8c0f", "description": "CloverDX CTL2 record function documentation." }, { "id": "ctl2-sequence-functions", "path": "ctl_doc/ctl2-sequence-functions.adoc", "kind": "documentation", "sha256": "9bd5e00b76efb078dd15182899351a3416b81a47b56eca510b9454eed90deb67", "description": "CloverDX CTL2 sequence function documentation." }, { "id": "ctl2-string-functions", "path": "ctl_doc/ctl2-string-functions.adoc", "kind": "documentation", "sha256": "87e5eb8bd5c08159951ae753c0f384f0b8dbe61169e5c6f1c6fef8d74c014552", "description": "CloverDX CTL2 string function documentation." }, { "id": "ctl2-subgraph-functions", "path": "ctl_doc/ctl2-subgraph-functions.adoc", "kind": "documentation", "sha256": "98883021660e88550663bf9c6d1120a4c6f71b79d762c2e1e0963321066ce6b6", "description": "CloverDX CTL2 subgraph function documentation." }, { "id": "ctl2-null-behavior", "path": "ctl_doc/ctl2-null-behavior.txt", "kind": "normalized_summary", "sha256": "3caf0210d0f45a4483039055958aaf3318bf071021e7acddb691935635a2e542", "description": "Normalized parameter-specific CTL2 built-in NULL behavior." }, { "id": "ctl2-list-of-functions", "path": "ctl_doc/ctl2-list-of-functions.adoc", "kind": "documentation", "sha256": "802ad3a21b7bbb59f63967d60eecda0d291372fafe3d51a269fccfc828fe1d71", "description": "Canonical CTL2 function-list reference used for required-subset validation." } ], "functions": { "NYSIIS": { "name": "NYSIIS", "category": "string", "summary": "The NYSIIS() function returns the New York State Identification and Intelligence System Phonetic Code of the argument.", "description": "The NYSIIS() function returns the New York State Identification and Intelligence System Phonetic Code of the argument. For more information, see the following site: http://en.wikipedia.org/wiki/New_York_State_Identification_and_Intelligence_System. This implementation works with numbers. Input string which contains numbers will result in unchanged string. E.g. input '1234' results in string '1234'. If the input of function is null, the function returns null. If the input of function is empty string, the function returns empty string.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "NYSIIS(string)", "canonical_signature": "string NYSIIS(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of NYSIIS as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "NYSIIS", "basis": "documentation" } ] }, "description": "The NYSIIS() function returns the New York State Identification and Intelligence System Phonetic Code of the argument. For more information, see the following site: http://en.wikipedia.org/wiki/New_York_State_Identification_and_Intelligence_System. This implementation works with numbers. Input string which contains numbers will result in unchanged string. E.g. input '1234' results in string '1234'. If the input of function is null, the function returns null. If the input of function is empty string, the function returns empty string.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "NYSIIS", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The NYSIIS(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "NYSIIS", "basis": "documentation" } ] } ], "see_also": [ "editDistance", "metaphone", "soundex" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "NYSIIS", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "abs": { "name": "abs", "category": "mathematical", "summary": "The abs() function returns the absolute value of a given argument of numeric data type (integer, long, number, or decimal).", "description": "The abs() function returns the absolute value of a given argument of numeric data type (integer, long, number, or decimal). If the given argument is null, the function fails with an error. The abs() function behaves in the same way as the abs() function in Java or C/C++. For the minimal integer, it returns minimal integer value: abs(-2147483648) returns -2147483648. For the minimal long, it returns minimal long value: abs(-9223372036854775808L) returns -9223372036854775808", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "abs(decimal)", "canonical_signature": "decimal abs(decimal arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "description": "Return value of abs as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "abs", "basis": "documentation" } ] }, "description": "The abs() function returns the absolute value of a given argument of numeric data type (integer, long, number, or decimal). If the given argument is null, the function fails with an error. The abs() function behaves in the same way as the abs() function in Java or C/C++. For the minimal integer, it returns minimal integer value: abs(-2147483648) returns -2147483648. For the minimal long, it returns minimal long value: abs(-9223372036854775808L) returns -9223372036854775808", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "abs", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "abs(integer)", "canonical_signature": "integer abs(integer arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of abs as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "abs", "basis": "documentation" } ] }, "description": "The abs() function returns the absolute value of a given argument of numeric data type (integer, long, number, or decimal). If the given argument is null, the function fails with an error. The abs() function behaves in the same way as the abs() function in Java or C/C++. For the minimal integer, it returns minimal integer value: abs(-2147483648) returns -2147483648. For the minimal long, it returns minimal long value: abs(-9223372036854775808L) returns -9223372036854775808", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "abs", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "abs(long)", "canonical_signature": "long abs(long arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of abs as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "abs", "basis": "documentation" } ] }, "description": "The abs() function returns the absolute value of a given argument of numeric data type (integer, long, number, or decimal). If the given argument is null, the function fails with an error. The abs() function behaves in the same way as the abs() function in Java or C/C++. For the minimal integer, it returns minimal integer value: abs(-2147483648) returns -2147483648. For the minimal long, it returns minimal long value: abs(-9223372036854775808L) returns -9223372036854775808", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "abs", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "abs(number)", "canonical_signature": "number abs(number arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of abs as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "abs", "basis": "documentation" } ] }, "description": "The abs() function returns the absolute value of a given argument of numeric data type (integer, long, number, or decimal). If the given argument is null, the function fails with an error. The abs() function behaves in the same way as the abs() function in Java or C/C++. For the minimal integer, it returns minimal integer value: abs(-2147483648) returns -2147483648. For the minimal long, it returns minimal long value: abs(-9223372036854775808L) returns -9223372036854775808", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "abs", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The abs(integer), abs(long), abs(decimal), abs(number) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "abs", "basis": "documentation" } ] } ], "see_also": [], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "abs", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "acos": { "name": "acos", "category": "mathematical", "summary": "The acos() function returns arc cosine of an angle.", "description": "The acos() function returns arc cosine of an angle. If a given argument is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "acos(decimal)", "canonical_signature": "number acos(decimal angle)", "type_parameters": [], "parameters": [ { "position": 0, "name": "angle", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The acos() function returns arc cosine of an angle.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of acos as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "acos", "basis": "documentation" } ] }, "description": "The acos() function returns arc cosine of an angle. If a given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "acos", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "angle == NULL", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "acos(number)", "canonical_signature": "number acos(number angle)", "type_parameters": [], "parameters": [ { "position": 0, "name": "angle", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The acos() function returns arc cosine of an angle.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of acos as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "acos", "basis": "documentation" } ] }, "description": "The acos() function returns arc cosine of an angle. If a given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "acos", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "angle == NULL", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The acos(decimal|number) function is available since CloverETL 3.5.0-M2.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "acos", "basis": "documentation" } ] } ], "see_also": [ "asin", "atan", "cos", "toDegrees" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "acos", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "addDataSetReloadNotification": { "name": "addDataSetReloadNotification", "category": "data_service_http", "summary": "The addDataSetReloadNotification function adds data set codes to the X-Clover-Refresh-Data-Set-Code response header.", "description": "The addDataSetReloadNotification function adds data set codes to the X-Clover-Refresh-Data-Set-Code response header. When a Data App modifies a data set and returns this header, the Data Manager notifies the user to reload the affected data sets. The dataSetCode parameter is the code of a single data set to add to the reload notification. Null or empty values will result in an error. Adding the same data set code more than once has no effect; the order of codes does not matter. The dataSetCodes parameter is a list of data set codes to add to the reload notification. If dataSetCodes is null, an error is raised. An empty list is valid — it adds nothing to the header. Adding the same data set code more than once (whether within a single call or across multiple calls) has no effect.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "addDataSetReloadNotification(string)", "canonical_signature": "void addDataSetReloadNotification(string dataSetCode)", "type_parameters": [], "parameters": [ { "position": 0, "name": "dataSetCode", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The dataSetCode parameter is the code of a single data set to add to the reload notification.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of addDataSetReloadNotification as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "addDataSetReloadNotification", "basis": "documentation" } ] }, "description": "The addDataSetReloadNotification function adds data set codes to the X-Clover-Refresh-Data-Set-Code response header. When a Data App modifies a data set and returns this header, the Data Manager notifies the user to reload the affected data sets. The dataSetCode parameter is the code of a single data set to add to the reload notification. Null or empty values will result in an error. Adding the same data set code more than once has no effect; the order of codes does not matter. The dataSetCodes parameter is a list of data set codes to add to the reload notification. If dataSetCodes is null, an error is raised. An empty list is valid — it adds nothing to the header. Adding the same data set code more than once (whether within a single call or across multiple calls) has no effect.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "addDataSetReloadNotification", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [ { "kind": "mutates_parameter", "parameter": "dataSetCode", "description": "Documentation states that addDataSetReloadNotification modifies its target argument.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "addDataSetReloadNotification", "basis": "documentation" } ] } ], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter dataSetCode is undocumented." ] } }, { "id": "addDataSetReloadNotification(string[])", "canonical_signature": "void addDataSetReloadNotification(string[] dataSetCodes)", "type_parameters": [], "parameters": [ { "position": 0, "name": "dataSetCodes", "type": { "kind": "list", "element": { "kind": "named", "name": "string", "display": "string" }, "display": "string[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The dataSetCodes parameter is a list of data set codes to add to the reload notification.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of addDataSetReloadNotification as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "addDataSetReloadNotification", "basis": "documentation" } ] }, "description": "The addDataSetReloadNotification function adds data set codes to the X-Clover-Refresh-Data-Set-Code response header. When a Data App modifies a data set and returns this header, the Data Manager notifies the user to reload the affected data sets. The dataSetCode parameter is the code of a single data set to add to the reload notification. Null or empty values will result in an error. Adding the same data set code more than once has no effect; the order of codes does not matter. The dataSetCodes parameter is a list of data set codes to add to the reload notification. If dataSetCodes is null, an error is raised. An empty list is valid — it adds nothing to the header. Adding the same data set code more than once (whether within a single call or across multiple calls) has no effect.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "addDataSetReloadNotification", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [ { "kind": "mutates_parameter", "parameter": "dataSetCodes", "description": "Documentation states that addDataSetReloadNotification modifies its target argument.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "addDataSetReloadNotification", "basis": "documentation" } ] } ], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter dataSetCodes is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The addDataSetReloadNotification(string) and addDataSetReloadNotification(string[]) functions are available since CloverDX 7.5.0.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "addDataSetReloadNotification", "basis": "documentation" } ] } ], "see_also": [ "addResponseHeader", "setResponseHeader" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "addDataSetReloadNotification", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "addNoise": { "name": "addNoise", "category": "mathematical", "summary": "The addNoise() function returns 'anonymized' value of the original value.", "description": "The addNoise() function returns 'anonymized' value of the original value. The parameter 'noise' allows to set ranges the return value can obtain - 'value +- noise'.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "addNoise(date,long)", "canonical_signature": "date addNoise(date value, long noise)", "type_parameters": [], "parameters": [ { "position": 0, "name": "value", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The addNoise() function returns 'anonymized' value of the original value.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "value is NULL -> NULL (documented example).", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "noise", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter 'noise' allows to set ranges the return value can obtain - 'value +- noise'.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "noise is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of addNoise as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "value == NULL", "behavior": { "kind": "returns_null", "description": "value is NULL -> NULL (documented example)." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "addNoise", "basis": "documentation" } ] }, "description": "The addNoise() function returns 'anonymized' value of the original value. The parameter 'noise' allows to set ranges the return value can obtain - 'value +- noise'.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "addNoise", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "noise == NULL", "description": "noise is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "addNoise(date,long,unit)", "canonical_signature": "date addNoise(date value, long noise, unit timeunit)", "type_parameters": [], "parameters": [ { "position": 0, "name": "value", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The addNoise() function returns 'anonymized' value of the original value.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "value is NULL -> NULL (documented example).", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "noise", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter 'noise' allows to set ranges the return value can obtain - 'value +- noise'.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "noise is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "timeunit", "type": { "kind": "named", "name": "unit", "display": "unit" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented timeunit argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Date-overload timeunit NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of addNoise as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "value == NULL", "behavior": { "kind": "returns_null", "description": "value is NULL -> NULL (documented example)." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "addNoise", "basis": "documentation" } ] }, "description": "The addNoise() function returns 'anonymized' value of the original value. The parameter 'noise' allows to set ranges the return value can obtain - 'value +- noise'.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "addNoise", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "noise == NULL", "description": "noise is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "timeunit == NULL", "description": "Date-overload timeunit NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "addNoise(decimal,decimal)", "canonical_signature": "decimal addNoise(decimal value, decimal noise)", "type_parameters": [], "parameters": [ { "position": 0, "name": "value", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The addNoise() function returns 'anonymized' value of the original value.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "value is NULL -> NULL (documented example).", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "noise", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter 'noise' allows to set ranges the return value can obtain - 'value +- noise'.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "noise is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "description": "Return value of addNoise as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "value == NULL", "behavior": { "kind": "returns_null", "description": "value is NULL -> NULL (documented example)." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "addNoise", "basis": "documentation" } ] }, "description": "The addNoise() function returns 'anonymized' value of the original value. The parameter 'noise' allows to set ranges the return value can obtain - 'value +- noise'.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "addNoise", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "noise == NULL", "description": "noise is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "addNoise(integer,integer)", "canonical_signature": "integer addNoise(integer value, integer noise)", "type_parameters": [], "parameters": [ { "position": 0, "name": "value", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The addNoise() function returns 'anonymized' value of the original value.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "value is NULL -> NULL (documented example).", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "noise", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter 'noise' allows to set ranges the return value can obtain - 'value +- noise'.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "noise is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of addNoise as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "value == NULL", "behavior": { "kind": "returns_null", "description": "value is NULL -> NULL (documented example)." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "addNoise", "basis": "documentation" } ] }, "description": "The addNoise() function returns 'anonymized' value of the original value. The parameter 'noise' allows to set ranges the return value can obtain - 'value +- noise'.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "addNoise", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "noise == NULL", "description": "noise is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "addNoise(long,long)", "canonical_signature": "long addNoise(long value, long noise)", "type_parameters": [], "parameters": [ { "position": 0, "name": "value", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The addNoise() function returns 'anonymized' value of the original value.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "value is NULL -> NULL (documented example).", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "noise", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter 'noise' allows to set ranges the return value can obtain - 'value +- noise'.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "noise is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of addNoise as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "value == NULL", "behavior": { "kind": "returns_null", "description": "value is NULL -> NULL (documented example)." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "addNoise", "basis": "documentation" } ] }, "description": "The addNoise() function returns 'anonymized' value of the original value. The parameter 'noise' allows to set ranges the return value can obtain - 'value +- noise'.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "addNoise", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "noise == NULL", "description": "noise is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "addNoise(number,number)", "canonical_signature": "number addNoise(number value, number noise)", "type_parameters": [], "parameters": [ { "position": 0, "name": "value", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The addNoise() function returns 'anonymized' value of the original value.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "value is NULL -> NULL (documented example).", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "noise", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter 'noise' allows to set ranges the return value can obtain - 'value +- noise'.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "noise is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of addNoise as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "value == NULL", "behavior": { "kind": "returns_null", "description": "value is NULL -> NULL (documented example)." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "addNoise", "basis": "documentation" } ] }, "description": "The addNoise() function returns 'anonymized' value of the original value. The parameter 'noise' allows to set ranges the return value can obtain - 'value +- noise'.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "addNoise", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "noise == NULL", "description": "noise is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [ "random", "randomBoolean", "randomGaussian", "randomInteger", "randomLong", "randomString", "randomUUID", "setRandomSeed" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "addNoise", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "addResponseHeader": { "name": "addResponseHeader", "category": "data_service_http", "summary": "The addResponseHeader function adds an HTTP response header field.", "description": "The addResponseHeader function adds an HTTP response header field. If the fuction is called multiple times, multiple headers will be added. The name parameter is a header field name. See https://www.iana.org/assignments/message-headers/message-headers.xml[list of header field names]. If name is null or empty string, the response header field is not added. The value parameter is a value of the header field. If value is empty string, empty string is used. If value is null the header field is not added.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "addResponseHeader(string,string)", "canonical_signature": "void addResponseHeader(string name, string value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "name", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The name parameter is a header field name.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "value", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The value parameter is a value of the header field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of addResponseHeader as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "addResponseHeader", "basis": "documentation" } ] }, "description": "The addResponseHeader function adds an HTTP response header field. If the fuction is called multiple times, multiple headers will be added. The name parameter is a header field name. See https://www.iana.org/assignments/message-headers/message-headers.xml[list of header field names]. If name is null or empty string, the response header field is not added. The value parameter is a value of the header field. If value is empty string, empty string is used. If value is null the header field is not added.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "addResponseHeader", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter name is undocumented.", "NULL behavior for parameter value is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The addResponseHeader(string,string) function is available since CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "addResponseHeader", "basis": "documentation" } ] } ], "see_also": [ "containsResponseHeader" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "addResponseHeader", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "append": { "name": "append", "category": "container", "summary": "Appends the item to the end of the target list.", "description": "Appends the item to the end of the target list. The function modifies target and then returns the modified list (i.e., it does not create a copy of the list before appending). This function is an alias of the push function.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "append(T[],T)", "canonical_signature": "T[] append(T[] target, T item)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "target", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Appends the item to the end of the target list.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "target is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "item", "type": { "kind": "type_variable", "name": "T", "display": "T" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Appends the item to the end of the target list.", "constraints": [], "null_behavior": { "kind": "mutates_with_null", "description": "Variant-overload item NULL -> appended to the list as a NULL element.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "description": "Return value of append as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "append", "basis": "documentation" } ] }, "description": "Appends the item to the end of the target list. The function modifies target and then returns the modified list (i.e., it does not create a copy of the list before appending). This function is an alias of the push function.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "append", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "target == NULL", "description": "target is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [ { "kind": "mutates_parameter", "parameter": "target", "description": "Documentation states that append modifies its target argument.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "append", "basis": "documentation" } ] } ], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "append(variant,variant)", "canonical_signature": "variant append(variant target, variant item)", "type_parameters": [], "parameters": [ { "position": 0, "name": "target", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Appends the item to the end of the target list.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "target is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "item", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Appends the item to the end of the target list.", "constraints": [], "null_behavior": { "kind": "mutates_with_null", "description": "Variant-overload item NULL -> appended to the list as a NULL element.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "variant", "display": "variant" }, "description": "Return value of append as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "append", "basis": "documentation" } ] }, "description": "Appends the item to the end of the target list. The function modifies target and then returns the modified list (i.e., it does not create a copy of the list before appending). This function is an alias of the push function.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "append", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "target == NULL", "description": "target is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [ { "kind": "mutates_parameter", "parameter": "target", "description": "Documentation states that append modifies its target argument.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "append", "basis": "documentation" } ] } ], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The append(element_type[], element_type) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "append", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The append(variant, variant) function is available since CloverDX 5.6.0.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "append", "basis": "documentation" } ] } ], "see_also": [ "insert", "pop", "push" ], "evidence": [ { "source_id": "ctl2-container-functions", "section": "append", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "appendAll": { "name": "appendAll", "category": "container", "summary": "Adds all elements from the source list or map to the end of the target list or map.", "description": "Adds all elements from the source list or map to the end of the target list or map. The function modifies the target and then returns the modified version. When appending a map with conflicting keys the original values are preserved (i.e., the function does not replace existing values). The opposite behavior can be achieved by using the copy() function. When appending to list, the function simply appends the values and does not check for duplicates.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "appendAll(T[],T)", "canonical_signature": "T[] appendAll(T[] target, T source)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "target", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Adds all elements from the source list or map to the end of the target list or map.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "source is NULL when target is a map -> runtime error.", "cases": [ { "condition": "source is NULL when target is a map", "behavior": { "kind": "runtime_error", "description": "source is NULL when target is a map -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "source", "type": { "kind": "type_variable", "name": "T", "display": "T" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Adds all elements from the source list or map to the end of the target list or map.", "constraints": [], "null_behavior": { "kind": "accepted", "description": "source is NULL for the list and variant overloads -> no error; returns a non-NULL result.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "description": "Return value of appendAll as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "appendAll", "basis": "documentation" } ] }, "description": "Adds all elements from the source list or map to the end of the target list or map. The function modifies the target and then returns the modified version. When appending a map with conflicting keys the original values are preserved (i.e., the function does not replace existing values). The opposite behavior can be achieved by using the copy() function. When appending to list, the function simply appends the values and does not check for duplicates.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "appendAll", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [ { "kind": "mutates_parameter", "parameter": "target", "description": "Documentation states that appendAll modifies its target argument.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "appendAll", "basis": "documentation" } ] } ], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "appendAll(map[K,V],map[K,V])", "canonical_signature": "map[K,V] appendAll(map[K,V] target, map[K,V] source)", "type_parameters": [ { "name": "K", "constraint": { "kind": "any", "display": "any" } }, { "name": "V", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "target", "type": { "kind": "map", "key": { "kind": "type_variable", "name": "K", "display": "K" }, "value": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "map[K,V]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Adds all elements from the source list or map to the end of the target list or map.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "source is NULL when target is a map -> runtime error.", "cases": [ { "condition": "source is NULL when target is a map", "behavior": { "kind": "runtime_error", "description": "source is NULL when target is a map -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "source", "type": { "kind": "map", "key": { "kind": "type_variable", "name": "K", "display": "K" }, "value": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "map[K,V]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Adds all elements from the source list or map to the end of the target list or map.", "constraints": [], "null_behavior": { "kind": "accepted", "description": "source is NULL for the list and variant overloads -> no error; returns a non-NULL result.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "map", "key": { "kind": "type_variable", "name": "K", "display": "K" }, "value": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "map[K,V]" }, "description": "Return value of appendAll as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "appendAll", "basis": "documentation" } ] }, "description": "Adds all elements from the source list or map to the end of the target list or map. The function modifies the target and then returns the modified version. When appending a map with conflicting keys the original values are preserved (i.e., the function does not replace existing values). The opposite behavior can be achieved by using the copy() function. When appending to list, the function simply appends the values and does not check for duplicates.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "appendAll", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [ { "kind": "mutates_parameter", "parameter": "target", "description": "Documentation states that appendAll modifies its target argument.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "appendAll", "basis": "documentation" } ] } ], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "appendAll(variant,variant)", "canonical_signature": "variant appendAll(variant target, variant source)", "type_parameters": [], "parameters": [ { "position": 0, "name": "target", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Adds all elements from the source list or map to the end of the target list or map.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "source is NULL when target is a map -> runtime error.", "cases": [ { "condition": "source is NULL when target is a map", "behavior": { "kind": "runtime_error", "description": "source is NULL when target is a map -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "source", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Adds all elements from the source list or map to the end of the target list or map.", "constraints": [], "null_behavior": { "kind": "accepted", "description": "source is NULL for the list and variant overloads -> no error; returns a non-NULL result.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "variant", "display": "variant" }, "description": "Return value of appendAll as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "appendAll", "basis": "documentation" } ] }, "description": "Adds all elements from the source list or map to the end of the target list or map. The function modifies the target and then returns the modified version. When appending a map with conflicting keys the original values are preserved (i.e., the function does not replace existing values). The opposite behavior can be achieved by using the copy() function. When appending to list, the function simply appends the values and does not check for duplicates.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "appendAll", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [ { "kind": "mutates_parameter", "parameter": "target", "description": "Documentation states that appendAll modifies its target argument.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "appendAll", "basis": "documentation" } ] } ], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The appendAll(element_type[], element_type[]) function is available since CloverDX 6.4.0.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "appendAll", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The appendAll(map[key_type, value_type], map[key_type, value_type]) function is available since CloverDX 6.4.0.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "appendAll", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The appendAll(variant, variant) function is available since CloverDX 6.4.0.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "appendAll", "basis": "documentation" } ] } ], "see_also": [ "append", "copy" ], "evidence": [ { "source_id": "ctl2-container-functions", "section": "appendAll", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "asin": { "name": "asin", "category": "mathematical", "summary": "The asin() function returns arc sine of an angle.", "description": "The asin() function returns arc sine of an angle. If the given argument is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "asin(decimal)", "canonical_signature": "number asin(decimal angle)", "type_parameters": [], "parameters": [ { "position": 0, "name": "angle", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The asin() function returns arc sine of an angle.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of asin as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "asin", "basis": "documentation" } ] }, "description": "The asin() function returns arc sine of an angle. If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "asin", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "angle == NULL", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "asin(number)", "canonical_signature": "number asin(number angle)", "type_parameters": [], "parameters": [ { "position": 0, "name": "angle", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The asin() function returns arc sine of an angle.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of asin as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "asin", "basis": "documentation" } ] }, "description": "The asin() function returns arc sine of an angle. If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "asin", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "angle == NULL", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The asin() function is available since CloverETL 3.5.0-M2.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "asin", "basis": "documentation" } ] } ], "see_also": [ "acos", "atan", "sin", "toDegrees" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "asin", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "atan": { "name": "atan", "category": "mathematical", "summary": "The atan() function returns arc tangent of an angle.", "description": "The atan() function returns arc tangent of an angle. If the given argument is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "atan(decimal)", "canonical_signature": "number atan(decimal angle)", "type_parameters": [], "parameters": [ { "position": 0, "name": "angle", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The atan() function returns arc tangent of an angle.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of atan as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "atan", "basis": "documentation" } ] }, "description": "The atan() function returns arc tangent of an angle. If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "atan", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "angle == NULL", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "atan(number)", "canonical_signature": "number atan(number angle)", "type_parameters": [], "parameters": [ { "position": 0, "name": "angle", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The atan() function returns arc tangent of an angle.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of atan as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "atan", "basis": "documentation" } ] }, "description": "The atan() function returns arc tangent of an angle. If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "atan", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "angle == NULL", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The atan() function is available since CloverETL 3.5.0-M2.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "atan", "basis": "documentation" } ] } ], "see_also": [ "acos", "asin", "tan", "toDegrees" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "atan", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "base64byte": { "name": "base64byte", "category": "conversion", "summary": "The base64byte() function converts the input string in base64 representation to an array of bytes.", "description": "The base64byte() function converts the input string in base64 representation to an array of bytes. Its counterpart is the function byte2base64. If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "base64byte(string)", "canonical_signature": "byte base64byte(string input)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The base64byte() function converts the input string in base64 representation to an array of bytes.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of base64byte as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "base64byte", "basis": "documentation" } ] }, "description": "The base64byte() function converts the input string in base64 representation to an array of bytes. Its counterpart is the function byte2base64. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "base64byte", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The base64byte(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "base64byte", "basis": "documentation" } ] } ], "see_also": [ "byte2base64" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "base64byte", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "binarySearch": { "name": "binarySearch", "category": "container", "summary": "The binarySearch() function searches the searchList for the first occurrence of value using the binary search algorithm.", "description": "The binarySearch() function searches the searchList for the first occurrence of value using the binary search algorithm. The elements of the list must be comparable (e.g., byte or cbyte cannot be used) and the list must be sorted in ascending order. If the it is not sorted, the results are undefined. If value is in the list, the function returns a non-negative integer (≥ 0) - and index of the value in the searchList. If the value is not in searchList, the function returns a negative number defined as (-(_insertion_point_) - 1). The _insertion_point_ is defined as the point at which the key would be inserted into the list to maintain the list properly sorted. If the list contains multiple elements equal to the value, the function does not make any guarantees about which one will be found (by definition, all of them will be next to each other in the searchList). === Error states The function fails if either of the arguments is null or if element_type is not comparable. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "binarySearch(T[],T)", "canonical_signature": "integer binarySearch(T[] searchList, T value)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "searchList", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The binarySearch() function searches the searchList for the first occurrence of value using the binary search algorithm.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "value", "type": { "kind": "type_variable", "name": "T", "display": "T" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The binarySearch() function searches the searchList for the first occurrence of value using the binary search algorithm.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of binarySearch as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "binarySearch", "basis": "documentation" } ] }, "description": "The binarySearch() function searches the searchList for the first occurrence of value using the binary search algorithm. The elements of the list must be comparable (e.g., byte or cbyte cannot be used) and the list must be sorted in ascending order. If the it is not sorted, the results are undefined. If value is in the list, the function returns a non-negative integer (≥ 0) - and index of the value in the searchList. If the value is not in searchList, the function returns a negative number defined as (-(_insertion_point_) - 1). The _insertion_point_ is defined as the point at which the key would be inserted into the list to maintain the list properly sorted. If the list contains multiple elements equal to the value, the function does not make any guarantees about which one will be found (by definition, all of them will be next to each other in the searchList). === Error states The function fails if either of the arguments is null or if element_type is not comparable. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "binarySearch", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "searchList == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "value == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-container-functions", "section": "binarySearch", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "bitAnd": { "name": "bitAnd", "category": "mathematical", "summary": "The bitAnd() function returns the number corresponding to the bitwise and of given integer, long or byte arguments.", "description": "The bitAnd() function returns the number corresponding to the bitwise and of given integer, long or byte arguments. For example, bitAnd(11,7) returns 3. As decimal 11 can be expressed as bitwise 1011, decimal 7 can be expressed as 111, thus the result is 11 which corresponds to decimal 3. If one of the arguments is long, the function returns the long data type. If one of the argument is null, the function fails with an error. If the byte arguments are of different length, the length of returned byte is a minimum of the lengths of the arguments.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "bitAnd(byte,byte)", "canonical_signature": "byte bitAnd(byte arg1, byte arg2)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of bitAnd as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitAnd", "basis": "documentation" } ] }, "description": "The bitAnd() function returns the number corresponding to the bitwise and of given integer, long or byte arguments. For example, bitAnd(11,7) returns 3. As decimal 11 can be expressed as bitwise 1011, decimal 7 can be expressed as 111, thus the result is 11 which corresponds to decimal 3. If one of the arguments is long, the function returns the long data type. If one of the argument is null, the function fails with an error. If the byte arguments are of different length, the length of returned byte is a minimum of the lengths of the arguments.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitAnd", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg1 == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "arg2 == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "bitAnd(integer,integer)", "canonical_signature": "integer bitAnd(integer arg1, integer arg2)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of bitAnd as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitAnd", "basis": "documentation" } ] }, "description": "The bitAnd() function returns the number corresponding to the bitwise and of given integer, long or byte arguments. For example, bitAnd(11,7) returns 3. As decimal 11 can be expressed as bitwise 1011, decimal 7 can be expressed as 111, thus the result is 11 which corresponds to decimal 3. If one of the arguments is long, the function returns the long data type. If one of the argument is null, the function fails with an error. If the byte arguments are of different length, the length of returned byte is a minimum of the lengths of the arguments.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitAnd", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg1 == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "arg2 == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "bitAnd(long,long)", "canonical_signature": "long bitAnd(long arg1, long arg2)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of bitAnd as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitAnd", "basis": "documentation" } ] }, "description": "The bitAnd() function returns the number corresponding to the bitwise and of given integer, long or byte arguments. For example, bitAnd(11,7) returns 3. As decimal 11 can be expressed as bitwise 1011, decimal 7 can be expressed as 111, thus the result is 11 which corresponds to decimal 3. If one of the arguments is long, the function returns the long data type. If one of the argument is null, the function fails with an error. If the byte arguments are of different length, the length of returned byte is a minimum of the lengths of the arguments.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitAnd", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg1 == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "arg2 == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The bitAnd(integer,integer) and bitAnd(long,long) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitAnd", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The byte bitAnd(byte, byte) function is available since CloverETL 4.0.0-M2.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitAnd", "basis": "documentation" } ] } ], "see_also": [ "bitIsSet", "bitLShift", "bitNegate", "bitOr", "bitRShift", "bitSet", "bitXor", "byteAt" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitAnd", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "bitIsSet": { "name": "bitIsSet", "category": "mathematical", "summary": "The bitIsSet() function determines the value of the bit of the first argument located on the index and returns true or false, if the bit is 1 or 0, respectively.", "description": "The bitIsSet() function determines the value of the bit of the first argument located on the index and returns true or false, if the bit is 1 or 0, respectively. If the index is greater than the number of bits in the data type, functions bitIsSet(integer, integer) and bitIsSet(long, integer) return false. For example, bitIsSet(11,3) returns true. As decimal 11 can be expressed as bitwise 1011, the bit whose index is 3 (the fourth from the right) is 1, thus the result is true. And bitIsSet(11,2) would return false. If one of the given arguments is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "bitIsSet(integer,integer)", "canonical_signature": "boolean bitIsSet(integer arg, integer index)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The bitIsSet() function determines the value of the bit of the first argument located on the index and returns true or false, if the bit is 1 or 0, respectively.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of bitIsSet as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitIsSet", "basis": "documentation" } ] }, "description": "The bitIsSet() function determines the value of the bit of the first argument located on the index and returns true or false, if the bit is 1 or 0, respectively. If the index is greater than the number of bits in the data type, functions bitIsSet(integer, integer) and bitIsSet(long, integer) return false. For example, bitIsSet(11,3) returns true. As decimal 11 can be expressed as bitwise 1011, the bit whose index is 3 (the fourth from the right) is 1, thus the result is true. And bitIsSet(11,2) would return false. If one of the given arguments is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitIsSet", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "index == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "bitIsSet(long,integer)", "canonical_signature": "boolean bitIsSet(long arg, integer index)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The bitIsSet() function determines the value of the bit of the first argument located on the index and returns true or false, if the bit is 1 or 0, respectively.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of bitIsSet as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitIsSet", "basis": "documentation" } ] }, "description": "The bitIsSet() function determines the value of the bit of the first argument located on the index and returns true or false, if the bit is 1 or 0, respectively. If the index is greater than the number of bits in the data type, functions bitIsSet(integer, integer) and bitIsSet(long, integer) return false. For example, bitIsSet(11,3) returns true. As decimal 11 can be expressed as bitwise 1011, the bit whose index is 3 (the fourth from the right) is 1, thus the result is true. And bitIsSet(11,2) would return false. If one of the given arguments is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitIsSet", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "index == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The bitIsSet(integer,integer) and bitIsSet(long,integer) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitIsSet", "basis": "documentation" } ] } ], "see_also": [ "bitAnd", "bitLShift", "bitNegate", "bitOr", "bitRShift", "bitSet", "bitXor", "byteAt" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitIsSet", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "bitLShift": { "name": "bitLShift", "category": "mathematical", "summary": "The bitLShift() function returns the number corresponding to the original number with bits shifted to the left.", "description": "The bitLShift() function returns the number corresponding to the original number with bits shifted to the left. The new bits added to the number on the right side are set to 0. (Shift number of bits on the left side are added and set to 0.) For example, bitLShift(11,2) returns 44. As decimal 11 can be expressed as bitwise 1011, thus the two bits on the right side (00) are added and the result is 101100 which corresponds to decimal 44. If one of the argument is long, the function returns the long data type. If one of the argument is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "bitLShift(integer,integer)", "canonical_signature": "integer bitLShift(integer arg, integer shift)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "shift", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "(Shift number of bits on the left side are added and set to 0.) For example, bitLShift(11,2) returns 44.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of bitLShift as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitLShift", "basis": "documentation" } ] }, "description": "The bitLShift() function returns the number corresponding to the original number with bits shifted to the left. The new bits added to the number on the right side are set to 0. (Shift number of bits on the left side are added and set to 0.) For example, bitLShift(11,2) returns 44. As decimal 11 can be expressed as bitwise 1011, thus the two bits on the right side (00) are added and the result is 101100 which corresponds to decimal 44. If one of the argument is long, the function returns the long data type. If one of the argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitLShift", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "shift == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "bitLShift(long,long)", "canonical_signature": "long bitLShift(long arg, long shift)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "shift", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "(Shift number of bits on the left side are added and set to 0.) For example, bitLShift(11,2) returns 44.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of bitLShift as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitLShift", "basis": "documentation" } ] }, "description": "The bitLShift() function returns the number corresponding to the original number with bits shifted to the left. The new bits added to the number on the right side are set to 0. (Shift number of bits on the left side are added and set to 0.) For example, bitLShift(11,2) returns 44. As decimal 11 can be expressed as bitwise 1011, thus the two bits on the right side (00) are added and the result is 101100 which corresponds to decimal 44. If one of the argument is long, the function returns the long data type. If one of the argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitLShift", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "shift == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The bitLShift(integer,integer) and bitLShift(long,long) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitLShift", "basis": "documentation" } ] } ], "see_also": [ "bitAnd", "bitIsSet", "bitNegate", "bitOr", "bitRShift", "bitSet", "bitXor", "byteAt" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitLShift", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "bitNegate": { "name": "bitNegate", "category": "mathematical", "summary": "The bitNegate() function returns the number corresponding to its bitwise inverted number.", "description": "The bitNegate() function returns the number corresponding to its bitwise inverted number. All ones are set up to zeros and all zeros are changed to ones. If a given argument is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "bitNegate(byte)", "canonical_signature": "byte bitNegate(byte arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of bitNegate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitNegate", "basis": "documentation" } ] }, "description": "The bitNegate() function returns the number corresponding to its bitwise inverted number. All ones are set up to zeros and all zeros are changed to ones. If a given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitNegate", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "bitNegate(integer)", "canonical_signature": "integer bitNegate(integer arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of bitNegate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitNegate", "basis": "documentation" } ] }, "description": "The bitNegate() function returns the number corresponding to its bitwise inverted number. All ones are set up to zeros and all zeros are changed to ones. If a given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitNegate", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "bitNegate(long)", "canonical_signature": "long bitNegate(long arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of bitNegate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitNegate", "basis": "documentation" } ] }, "description": "The bitNegate() function returns the number corresponding to its bitwise inverted number. All ones are set up to zeros and all zeros are changed to ones. If a given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitNegate", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The bitNegate(integer) and bitNegate(long) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitNegate", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The bitNegate(byte) function is available since CloverETL 4.0.0-M2.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitNegate", "basis": "documentation" } ] } ], "see_also": [ "bitAnd", "bitIsSet", "bitLShift", "bitOr", "bitRShift", "bitSet", "bitXor", "byteAt" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitNegate", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "bitOr": { "name": "bitOr", "category": "mathematical", "summary": "The bitOr() function returns the bitwise or of both arguments.", "description": "The bitOr() function returns the bitwise or of both arguments. For example, bitOr(11,7) returns 15. As decimal 11 can be expressed as bitwise 1011, decimal 7 can be expressed as 111, thus the result is 1111 which corresponds to decimal 15. If one of the given argument is long, the function returns the long data type. If one of the given argument is null, the function fails with an error. If the byte arguments are of different length, the length of returned byte is a minimum of the lengths of arguments.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "bitOr(byte,byte)", "canonical_signature": "byte bitOr(byte arg1, byte arg2)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of bitOr as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitOr", "basis": "documentation" } ] }, "description": "The bitOr() function returns the bitwise or of both arguments. For example, bitOr(11,7) returns 15. As decimal 11 can be expressed as bitwise 1011, decimal 7 can be expressed as 111, thus the result is 1111 which corresponds to decimal 15. If one of the given argument is long, the function returns the long data type. If one of the given argument is null, the function fails with an error. If the byte arguments are of different length, the length of returned byte is a minimum of the lengths of arguments.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitOr", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg1 == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "arg2 == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "bitOr(integer,integer)", "canonical_signature": "integer bitOr(integer arg1, integer arg2)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of bitOr as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitOr", "basis": "documentation" } ] }, "description": "The bitOr() function returns the bitwise or of both arguments. For example, bitOr(11,7) returns 15. As decimal 11 can be expressed as bitwise 1011, decimal 7 can be expressed as 111, thus the result is 1111 which corresponds to decimal 15. If one of the given argument is long, the function returns the long data type. If one of the given argument is null, the function fails with an error. If the byte arguments are of different length, the length of returned byte is a minimum of the lengths of arguments.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitOr", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg1 == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "arg2 == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "bitOr(long,long)", "canonical_signature": "long bitOr(long arg1, long arg2)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of bitOr as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitOr", "basis": "documentation" } ] }, "description": "The bitOr() function returns the bitwise or of both arguments. For example, bitOr(11,7) returns 15. As decimal 11 can be expressed as bitwise 1011, decimal 7 can be expressed as 111, thus the result is 1111 which corresponds to decimal 15. If one of the given argument is long, the function returns the long data type. If one of the given argument is null, the function fails with an error. If the byte arguments are of different length, the length of returned byte is a minimum of the lengths of arguments.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitOr", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg1 == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "arg2 == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The bitOr(integer,integer) and bitOr(long,long) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitOr", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The function byte bitOr(byte, byte) is available since CloverETL 4.0.0-M2.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitOr", "basis": "documentation" } ] } ], "see_also": [ "bitAnd", "bitIsSet", "bitLShift", "bitNegate", "bitRShift", "bitSet", "bitXor", "byteAt" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitOr", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "bitRShift": { "name": "bitRShift", "category": "mathematical", "summary": "The bitRShift() returns the number corresponding to the original number with bits shifted to the right.", "description": "The bitRShift() returns the number corresponding to the original number with bits shifted to the right. Shift number of bits on the right side are removed. (For example, bitRShift(11,2) returns 2.) As decimal 11 can be expressed as bitwise 1011, thus the two bits on the right side are removed and the result is 10 which corresponds to decimal 2. If one of the given arguments is long, the function returns long data type. If one of the given argument is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "bitRShift(integer,integer)", "canonical_signature": "integer bitRShift(integer arg, integer shift)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "shift", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Shift number of bits on the right side are removed.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of bitRShift as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitRShift", "basis": "documentation" } ] }, "description": "The bitRShift() returns the number corresponding to the original number with bits shifted to the right. Shift number of bits on the right side are removed. (For example, bitRShift(11,2) returns 2.) As decimal 11 can be expressed as bitwise 1011, thus the two bits on the right side are removed and the result is 10 which corresponds to decimal 2. If one of the given arguments is long, the function returns long data type. If one of the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitRShift", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "shift == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "bitRShift(long,long)", "canonical_signature": "long bitRShift(long arg, long shift)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "shift", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Shift number of bits on the right side are removed.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of bitRShift as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitRShift", "basis": "documentation" } ] }, "description": "The bitRShift() returns the number corresponding to the original number with bits shifted to the right. Shift number of bits on the right side are removed. (For example, bitRShift(11,2) returns 2.) As decimal 11 can be expressed as bitwise 1011, thus the two bits on the right side are removed and the result is 10 which corresponds to decimal 2. If one of the given arguments is long, the function returns long data type. If one of the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitRShift", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "shift == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The bitRshift(integer,integer) and bitRShift(long,long) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitRShift", "basis": "documentation" } ] } ], "see_also": [ "bitAnd", "bitIsSet", "bitLShift", "bitNegate", "bitSet", "bitXor", "byteAt" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitRShift", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "bitSet": { "name": "bitSet", "category": "mathematical", "summary": "The bitSet() function sets the value of the bit of the first argument located on the index specified as the second argument to 1 or 0 if the third argument is true or false, respectively, and returns the result as an integer or long.", "description": "The bitSet() function sets the value of the bit of the first argument located on the index specified as the second argument to 1 or 0 if the third argument is true or false, respectively, and returns the result as an integer or long. If one of the given arguments is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "bitSet(integer,integer,boolean)", "canonical_signature": "integer bitSet(integer arg1, integer index, boolean setBitTo1)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The bitSet() function sets the value of the bit of the first argument located on the index specified as the second argument to 1 or 0 if the third argument is true or false, respectively, and returns the result as an integer or long.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "setBitTo1", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented setBitTo1 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of bitSet as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitSet", "basis": "documentation" } ] }, "description": "The bitSet() function sets the value of the bit of the first argument located on the index specified as the second argument to 1 or 0 if the third argument is true or false, respectively, and returns the result as an integer or long. If one of the given arguments is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitSet", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg1 == NULL", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "index == NULL", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "setBitTo1 == NULL", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "bitSet(long,integer,boolean)", "canonical_signature": "long bitSet(long arg1, integer index, boolean setBitTo1)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The bitSet() function sets the value of the bit of the first argument located on the index specified as the second argument to 1 or 0 if the third argument is true or false, respectively, and returns the result as an integer or long.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "setBitTo1", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented setBitTo1 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of bitSet as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitSet", "basis": "documentation" } ] }, "description": "The bitSet() function sets the value of the bit of the first argument located on the index specified as the second argument to 1 or 0 if the third argument is true or false, respectively, and returns the result as an integer or long. If one of the given arguments is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitSet", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg1 == NULL", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "index == NULL", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "setBitTo1 == NULL", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The bitSet(integer,integer,integer,boolean) and bitSet(long,long,long,boolean) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitSet", "basis": "documentation" } ] } ], "see_also": [ "bitAnd", "bitIsSet", "bitLShift", "bitNegate", "bitRShift", "bitXor" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitSet", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "bitXor": { "name": "bitXor", "category": "mathematical", "summary": "The bitXor() function returns the bitwise _exclusive or_ of both arguments.", "description": "The bitXor() function returns the bitwise _exclusive or_ of both arguments. For example, bitXor(11,7) returns 12. As decimal 11 can be expressed as bitwise 1011, decimal 7 can be expressed as 111, thus the result is 1100 which corresponds to decimal 15. If one of the given argument is long, the function returns the long data type. If one of the given arguments is null, the function fails with an error. If the byte arguments are of different length, the length of returned byte is a minimum of the lengths of arguments.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "bitXor(byte,byte)", "canonical_signature": "byte bitXor(byte arg, byte arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of bitXor as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitXor", "basis": "documentation" } ] }, "description": "The bitXor() function returns the bitwise _exclusive or_ of both arguments. For example, bitXor(11,7) returns 12. As decimal 11 can be expressed as bitwise 1011, decimal 7 can be expressed as 111, thus the result is 1100 which corresponds to decimal 15. If one of the given argument is long, the function returns the long data type. If one of the given arguments is null, the function fails with an error. If the byte arguments are of different length, the length of returned byte is a minimum of the lengths of arguments.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitXor", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "arg == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "bitXor(integer,integer)", "canonical_signature": "integer bitXor(integer arg, integer arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of bitXor as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitXor", "basis": "documentation" } ] }, "description": "The bitXor() function returns the bitwise _exclusive or_ of both arguments. For example, bitXor(11,7) returns 12. As decimal 11 can be expressed as bitwise 1011, decimal 7 can be expressed as 111, thus the result is 1100 which corresponds to decimal 15. If one of the given argument is long, the function returns the long data type. If one of the given arguments is null, the function fails with an error. If the byte arguments are of different length, the length of returned byte is a minimum of the lengths of arguments.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitXor", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "arg == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "bitXor(long,long)", "canonical_signature": "long bitXor(long arg, long arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of bitXor as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitXor", "basis": "documentation" } ] }, "description": "The bitXor() function returns the bitwise _exclusive or_ of both arguments. For example, bitXor(11,7) returns 12. As decimal 11 can be expressed as bitwise 1011, decimal 7 can be expressed as 111, thus the result is 1100 which corresponds to decimal 15. If one of the given argument is long, the function returns the long data type. If one of the given arguments is null, the function fails with an error. If the byte arguments are of different length, the length of returned byte is a minimum of the lengths of arguments.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitXor", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "arg == NULL", "description": "Either argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The bitXor(integer,integer) and bitXor(long,long) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitXor", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The byte bitXor(byte,byte) function is available since CloverETL 4.0.0-M2.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitXor", "basis": "documentation" } ] } ], "see_also": [ "bitAnd", "bitIsSet", "bitLShift", "bitNegate", "bitRShift", "bitSet", "byteAt" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "bitXor", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "bits2str": { "name": "bits2str", "category": "conversion", "summary": "The bits2str() function converts an array of bytes to a string consisting of two characters: \"0\" or \"1\".", "description": "The bits2str() function converts an array of bytes to a string consisting of two characters: \"0\" or \"1\". Each byte is represented by eight characters (\"0\" or \"1\"). For each byte, the lowest bit is at the beginning of these eight characters. The counterpart is the function str2bits. If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "bits2str(byte)", "canonical_signature": "string bits2str(byte input)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the input is null, the function returns null.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of bits2str as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "bits2str", "basis": "documentation" } ] }, "description": "The bits2str() function converts an array of bytes to a string consisting of two characters: \"0\" or \"1\". Each byte is represented by eight characters (\"0\" or \"1\"). For each byte, the lowest bit is at the beginning of these eight characters. The counterpart is the function str2bits. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "bits2str", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The bits2str(byte) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "bits2str", "basis": "documentation" } ] } ], "see_also": [ "str2bits" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "bits2str", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "bool2num": { "name": "bool2num", "category": "conversion", "summary": "The bool2num() function converts the boolean input to either integer 1 (if the argument is true) or integer 0 (if the argument is false).", "description": "The bool2num() function converts the boolean input to either integer 1 (if the argument is true) or integer 0 (if the argument is false). If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "bool2num(boolean)", "canonical_signature": "integer bool2num(boolean input)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The bool2num() function converts the boolean input to either integer 1 (if the argument is true) or integer 0 (if the argument is false).", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of bool2num as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "bool2num", "basis": "documentation" } ] }, "description": "The bool2num() function converts the boolean input to either integer 1 (if the argument is true) or integer 0 (if the argument is false). If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "bool2num", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The bool2num(boolean) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "bool2num", "basis": "documentation" } ] } ], "see_also": [ "num2bool" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "bool2num", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "byte2base64": { "name": "byte2base64", "category": "conversion", "summary": "The byte2base64() function converts an array of bytes to a string in base64 representation.", "description": "The byte2base64() function converts an array of bytes to a string in base64 representation. The function with one input parameter wraps the encoded lines after 76 characters. The ability of the function with 2 parameters to wrap lines is affected by the second parameter. If the wrap parameter is set to true, the encoded lines are wrapped after 76 characters. If the input byte array is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "byte2base64(byte)", "canonical_signature": "string byte2base64(byte input)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The function with one input parameter wraps the encoded lines after 76 characters.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of byte2base64 as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "byte2base64", "basis": "documentation" } ] }, "description": "The byte2base64() function converts an array of bytes to a string in base64 representation. The function with one input parameter wraps the encoded lines after 76 characters. The ability of the function with 2 parameters to wrap lines is affected by the second parameter. If the wrap parameter is set to true, the encoded lines are wrapped after 76 characters. If the input byte array is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "byte2base64", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "byte2base64(byte,boolean)", "canonical_signature": "string byte2base64(byte input, boolean wrap)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The function with one input parameter wraps the encoded lines after 76 characters.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "wrap", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The ability of the function with 2 parameters to wrap lines is affected by the second parameter.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "wrap is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of byte2base64 as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "byte2base64", "basis": "documentation" } ] }, "description": "The byte2base64() function converts an array of bytes to a string in base64 representation. The function with one input parameter wraps the encoded lines after 76 characters. The ability of the function with 2 parameters to wrap lines is affected by the second parameter. If the wrap parameter is set to true, the encoded lines are wrapped after 76 characters. If the input byte array is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "byte2base64", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "wrap == NULL", "description": "wrap is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The byte2base64(byte) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "byte2base64", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The byte2base64(byte,boolean) function is available since CloverETL 3.5.0-M2.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "byte2base64", "basis": "documentation" } ] } ], "see_also": [ "base64byte", "byte2hex", "byte2str" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "byte2base64", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "byte2hex": { "name": "byte2hex", "category": "conversion", "summary": "The byte2hex() function converts an array of bytes to a string in hexadecimal representation.", "description": "The byte2hex() function converts an array of bytes to a string in hexadecimal representation. If the input is null, the function returns null. The escapeChars are prepended before hexadecimal characters of each byte. If the escapeChars is null, empty string, or the function has only one argument, nothing is escaped.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "byte2hex(byte)", "canonical_signature": "string byte2hex(byte input)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the input is null, the function returns null.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of byte2hex as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "byte2hex", "basis": "documentation" } ] }, "description": "The byte2hex() function converts an array of bytes to a string in hexadecimal representation. If the input is null, the function returns null. The escapeChars are prepended before hexadecimal characters of each byte. If the escapeChars is null, empty string, or the function has only one argument, nothing is escaped.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "byte2hex", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "byte2hex(byte,string)", "canonical_signature": "string byte2hex(byte input, string escapeChars)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the input is null, the function returns null.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "escapeChars", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The escapeChars are prepended before hexadecimal characters of each byte.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "escapeChars is NULL -> no characters are escaped.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of byte2hex as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "byte2hex", "basis": "documentation" } ] }, "description": "The byte2hex() function converts an array of bytes to a string in hexadecimal representation. If the input is null, the function returns null. The escapeChars are prepended before hexadecimal characters of each byte. If the escapeChars is null, empty string, or the function has only one argument, nothing is escaped.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "byte2hex", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter escapeChars is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The byte2hex(input) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "byte2hex", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The byte2hex(input,escapeChars) function is available since CloverETL 4.4.1.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "byte2hex", "basis": "documentation" } ] } ], "see_also": [ "byte2base64", "byte2str", "hex2byte" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "byte2hex", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "byte2str": { "name": "byte2str", "category": "conversion", "summary": "The byte2str() function converts an array of bytes to a string using given charset.", "description": "The byte2str() function converts an array of bytes to a string using given charset. If the charset is null, the function fails with an error. If the payload is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "byte2str(byte,string)", "canonical_signature": "string byte2str(byte payload, string charset)", "type_parameters": [], "parameters": [ { "position": 0, "name": "payload", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the payload is null, the function returns null.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "payload is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "charset", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The byte2str() function converts an array of bytes to a string using given charset.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "charset is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of byte2str as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "payload == NULL", "behavior": { "kind": "returns_null", "description": "payload is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "byte2str", "basis": "documentation" } ] }, "description": "The byte2str() function converts an array of bytes to a string using given charset. If the charset is null, the function fails with an error. If the payload is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "byte2str", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "charset == NULL", "description": "charset is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The byte2str(byte,string) is available since CloverETL 3.2.x.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "byte2str", "basis": "documentation" } ] } ], "see_also": [ "byte2base64", "byte2hex", "str2byte" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "byte2str", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "byteAt": { "name": "byteAt", "category": "string", "summary": "The function byteAt returns the byte on the specified position.", "description": "The function byteAt returns the byte on the specified position. The arg is an input byte array. The index defines the position in the arg. The first item has index equal to 0. If the index is out of bound, the function fails. If any of the arguments is null, the function fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "byteAt(byte,integer)", "canonical_signature": "integer byteAt(byte arg, integer index)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The arg is an input byte array.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or index is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The index defines the position in the arg.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or index is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of byteAt as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "byteAt", "basis": "documentation" } ] }, "description": "The function byteAt returns the byte on the specified position. The arg is an input byte array. The index defines the position in the arg. The first item has index equal to 0. If the index is out of bound, the function fails. If any of the arguments is null, the function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "byteAt", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg or index is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "index == NULL", "description": "arg or index is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The byteAt() function is available since CloverETL 4.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "byteAt", "basis": "documentation" } ] } ], "see_also": [ "bitAnd", "bitIsSet", "bitLShift", "bitNegate", "bitOr", "bitRShift", "bitSet", "bitXor", "charAt" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "byteAt", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "cast": { "name": "cast", "category": "miscellaneous", "summary": "Returns the value passed as the first argument cast to the type specified as the following arguments.", "description": "Returns the value passed as the first argument cast to the type specified as the following arguments. Returns null if the value is null. Fails with an error if the value is not of the selected type. Does not check the type of elements of lists and maps, only checks if the value is a list or map, respectively. E.g. the cast of a list of integers to a list of strings does not fail and will lead to runtime errors later in the code, see the examples below. Use a for loop if you need to check the type of elements.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "cast(variant,any,any...)", "canonical_signature": "any cast(variant value, any arg2, any arg3...)", "type_parameters": [], "parameters": [ { "position": 0, "name": "value", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Returns the value passed as the first argument cast to the type specified as the following arguments.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "arg3", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": true, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg3 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": "unbounded" }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of cast as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "cast", "basis": "documentation" } ] }, "description": "Returns the value passed as the first argument cast to the type specified as the following arguments. Returns null if the value is null. Fails with an error if the value is not of the selected type. Does not check the type of elements of lists and maps, only checks if the value is a list or map, respectively. E.g. the cast of a list of integers to a list of strings does not fail and will lead to runtime errors later in the code, see the examples below. Use a for loop if you need to check the type of elements.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "cast", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter value is undocumented.", "NULL behavior for parameter arg2 is undocumented.", "NULL behavior for parameter arg3 is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The cast(variant, type, subtype...) function is available since CloverDX 5.6.0.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "cast", "basis": "documentation" } ] } ], "see_also": [ "getType", "typeof", "variant" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "cast", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [ "See-also references outside the v1 core-source scope: typeof, variant." ] } }, "ceil": { "name": "ceil", "category": "mathematical", "summary": "The ceil() function returns the smallest (closest to negative infinity) value that is greater than or equal to the argument and is equal to a mathematical integer.", "description": "The ceil() function returns the smallest (closest to negative infinity) value that is greater than or equal to the argument and is equal to a mathematical integer. It returns number (double) for integer, long and number. It returns decimal for decimal. If the given argument is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "ceil(decimal)", "canonical_signature": "decimal ceil(decimal arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "description": "Return value of ceil as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "ceil", "basis": "documentation" } ] }, "description": "The ceil() function returns the smallest (closest to negative infinity) value that is greater than or equal to the argument and is equal to a mathematical integer. It returns number (double) for integer, long and number. It returns decimal for decimal. If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "ceil", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "ceil(number)", "canonical_signature": "number ceil(number arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of ceil as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "ceil", "basis": "documentation" } ] }, "description": "The ceil() function returns the smallest (closest to negative infinity) value that is greater than or equal to the argument and is equal to a mathematical integer. It returns number (double) for integer, long and number. It returns decimal for decimal. If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "ceil", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The ceil(number) and ceil(decimal) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "ceil", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The function returns number for all input numeric data types in [guilabel]##CloverDX 3.4## and older.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "ceil", "basis": "documentation" } ] } ], "see_also": [ "floor", "round", "roundHalfToEven" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "ceil", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "charAt": { "name": "charAt", "category": "string", "summary": "The charAt() function returns the character from arg which is located at the given index.", "description": "The charAt() function returns the character from arg which is located at the given index. The function works only for indexes between 0 and length of input - 1, otherwise it fails with an error. For null input and empty string input the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "charAt(string,integer)", "canonical_signature": "string charAt(string arg, integer index)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The charAt() function returns the character from arg which is located at the given index.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The charAt() function returns the character from arg which is located at the given index.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "index is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of charAt as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "charAt", "basis": "documentation" } ] }, "description": "The charAt() function returns the character from arg which is located at the given index. The function works only for indexes between 0 and length of input - 1, otherwise it fails with an error. For null input and empty string input the function fails with an error.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "charAt", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "index == NULL", "description": "index is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The charAt(string,integer) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "charAt", "basis": "documentation" } ] } ], "see_also": [ "byteAt", "codePointAt", "substring" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "charAt", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "chop": { "name": "chop", "category": "string", "summary": "The chop() function removes the line feed and the carriage return characters or characters corresponding to the provided regular pattern from the string.", "description": "The chop() function removes the line feed and the carriage return characters or characters corresponding to the provided regular pattern from the string. For null input the function fails with an error. If the input is empty string, the function returns empty string. If the regexp is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "chop(string)", "canonical_signature": "string chop(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or regexp is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of chop as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "chop", "basis": "documentation" } ] }, "description": "The chop() function removes the line feed and the carriage return characters or characters corresponding to the provided regular pattern from the string. For null input the function fails with an error. If the input is empty string, the function returns empty string. If the regexp is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "chop", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg or regexp is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "chop(string,string)", "canonical_signature": "string chop(string arg, string regexp)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or regexp is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "regexp", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the regexp is null, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or regexp is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of chop as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "chop", "basis": "documentation" } ] }, "description": "The chop() function removes the line feed and the carriage return characters or characters corresponding to the provided regular pattern from the string. For null input the function fails with an error. If the input is empty string, the function returns empty string. If the regexp is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "chop", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg or regexp is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "regexp == NULL", "description": "arg or regexp is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The chop(string) and chop(string,string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "chop", "basis": "documentation" } ] } ], "see_also": [ "matchGroups", "matches", "substring" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "chop", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "clear": { "name": "clear", "category": "container", "summary": "Empties the given list or map (removes all elements from them).", "description": "Empties the given list or map (removes all elements from them). If the target is a variant, it must be either a list or a map, it cannot be just plain value. === Error states If the target is null, the function fails with an error. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "clear(T[])", "canonical_signature": "void clear(T[] target)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "target", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the target is a variant, it must be either a list or a map, it cannot be just plain value.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "target is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of clear as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "clear", "basis": "documentation" } ] }, "description": "Empties the given list or map (removes all elements from them). If the target is a variant, it must be either a list or a map, it cannot be just plain value. === Error states If the target is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "clear", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "target == NULL", "description": "target is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "clear(map[K,V])", "canonical_signature": "void clear(map[K,V] target)", "type_parameters": [ { "name": "K", "constraint": { "kind": "any", "display": "any" } }, { "name": "V", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "target", "type": { "kind": "map", "key": { "kind": "type_variable", "name": "K", "display": "K" }, "value": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "map[K,V]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the target is a variant, it must be either a list or a map, it cannot be just plain value.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "target is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of clear as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "clear", "basis": "documentation" } ] }, "description": "Empties the given list or map (removes all elements from them). If the target is a variant, it must be either a list or a map, it cannot be just plain value. === Error states If the target is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "clear", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "target == NULL", "description": "target is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "clear(variant)", "canonical_signature": "void clear(variant target)", "type_parameters": [], "parameters": [ { "position": 0, "name": "target", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the target is a variant, it must be either a list or a map, it cannot be just plain value.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "target is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of clear as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "clear", "basis": "documentation" } ] }, "description": "Empties the given list or map (removes all elements from them). If the target is a variant, it must be either a list or a map, it cannot be just plain value. === Error states If the target is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "clear", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "target == NULL", "description": "target is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-container-functions", "section": "clear", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "codePointAt": { "name": "codePointAt", "category": "string", "summary": "The function codePointAt() returns code of a Unicode character from the given position in the string str.", "description": "The function codePointAt() returns code of a Unicode character from the given position in the string str. The str parameter contains string with Unicode characters. If str is null, the function fails. The index parameter specifies a position of the character in the string str. The first character has index 0. If the index parameter is null, the function fails. If the index parameter is out of range of the string (__negative__ or _greater than or equal to_ length of string), the function fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "codePointAt(string,integer)", "canonical_signature": "integer codePointAt(string str, integer index)", "type_parameters": [], "parameters": [ { "position": 0, "name": "str", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function codePointAt() returns code of a Unicode character from the given position in the string str.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "str or index is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The index parameter specifies a position of the character in the string str.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "str or index is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of codePointAt as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "codePointAt", "basis": "documentation" } ] }, "description": "The function codePointAt() returns code of a Unicode character from the given position in the string str. The str parameter contains string with Unicode characters. If str is null, the function fails. The index parameter specifies a position of the character in the string str. The first character has index 0. If the index parameter is null, the function fails. If the index parameter is out of range of the string (__negative__ or _greater than or equal to_ length of string), the function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "codePointAt", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "str == NULL", "description": "str or index is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "index == NULL", "description": "str or index is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The codePointAt(string,integer) function is available since CloverETL 4.0.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "codePointAt", "basis": "documentation" } ] } ], "see_also": [ "charAt", "codePointToChar", "isValidCodePoint" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "codePointAt", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "codePointLength": { "name": "codePointLength", "category": "string", "summary": "The function codePointLength() returns number of char values needed to encode the Unicode character code.", "description": "The function codePointLength() returns number of char values needed to encode the Unicode character code. If code is _greater than or equal to_ 0x10000, the function returns 2. Otherwise returns 1. Invalid codes are not checked. If validation is needed, use the isValidCodePoint function. The parameter code is Unicode code point. If the code is null, the function fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "codePointLength(integer)", "canonical_signature": "integer codePointLength(integer code)", "type_parameters": [], "parameters": [ { "position": 0, "name": "code", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function codePointLength() returns number of char values needed to encode the Unicode character code.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "code is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of codePointLength as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "codePointLength", "basis": "documentation" } ] }, "description": "The function codePointLength() returns number of char values needed to encode the Unicode character code. If code is _greater than or equal to_ 0x10000, the function returns 2. Otherwise returns 1. Invalid codes are not checked. If validation is needed, use the isValidCodePoint function. The parameter code is Unicode code point. If the code is null, the function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "codePointLength", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "code == NULL", "description": "code is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The codePointLength(integer) function is available since CloverETL 4.0.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "codePointLength", "basis": "documentation" } ] } ], "see_also": [ "codePointAt", "codePointToChar", "isValidCodePoint" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "codePointLength", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "codePointToChar": { "name": "codePointToChar", "category": "string", "summary": "The function codePointToChar() converts Unicode code to character.", "description": "The function codePointToChar() converts Unicode code to character. The parameter contains code of the character. If the code is null, _negative_ or _greater than_ 0x10FFFF, the function fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "codePointToChar(integer)", "canonical_signature": "string codePointToChar(integer code)", "type_parameters": [], "parameters": [ { "position": 0, "name": "code", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function codePointToChar() converts Unicode code to character.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "code is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of codePointToChar as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "codePointToChar", "basis": "documentation" } ] }, "description": "The function codePointToChar() converts Unicode code to character. The parameter contains code of the character. If the code is null, _negative_ or _greater than_ 0x10FFFF, the function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "codePointToChar", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "code == NULL", "description": "code is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The codePointToChar(integer) function is available since CloverETL 4.0.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "codePointToChar", "basis": "documentation" } ] } ], "see_also": [ "codePointAt", "codePointLength", "isUnicodeNormalized" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "codePointToChar", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "compare": { "name": "compare", "category": "record", "summary": "The compare() function compares two fields of given records.", "description": "The compare() function compares two fields of given records. The fields are identified by their index (integer - 0 is the first field) or name (string). The function returns an integer value which is either: . < 0 ... field2 is greater than field1 . > 0 ... field2 is lower than field1 . 0 ... fields are equal If one of the given record has a null reference, the function fails with an error. If one of the given record fields is of type list, map or variant, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "compare(record,integer,record,integer)", "canonical_signature": "integer compare(record record1, integer fieldIndex1, record record2, integer fieldIndex2)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record1", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented record1 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "fieldIndex1", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented fieldIndex1 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "record2", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented record2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 3, "name": "fieldIndex2", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented fieldIndex2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 4, "maximum": 4 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of compare as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "compare", "basis": "documentation" } ] }, "description": "The compare() function compares two fields of given records. The fields are identified by their index (integer - 0 is the first field) or name (string). The function returns an integer value which is either: . < 0 ... field2 is greater than field1 . > 0 ... field2 is lower than field1 . 0 ... fields are equal If one of the given record has a null reference, the function fails with an error. If one of the given record fields is of type list, map or variant, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "compare", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record1 is undocumented.", "NULL behavior for parameter fieldIndex1 is undocumented.", "NULL behavior for parameter record2 is undocumented.", "NULL behavior for parameter fieldIndex2 is undocumented." ] } }, { "id": "compare(record,string,record,string)", "canonical_signature": "integer compare(record record1, string fieldName1, record record2, string fieldName2)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record1", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented record1 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "fieldName1", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented fieldName1 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "record2", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented record2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 3, "name": "fieldName2", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented fieldName2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 4, "maximum": 4 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of compare as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "compare", "basis": "documentation" } ] }, "description": "The compare() function compares two fields of given records. The fields are identified by their index (integer - 0 is the first field) or name (string). The function returns an integer value which is either: . < 0 ... field2 is greater than field1 . > 0 ... field2 is lower than field1 . 0 ... fields are equal If one of the given record has a null reference, the function fails with an error. If one of the given record fields is of type list, map or variant, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "compare", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record1 is undocumented.", "NULL behavior for parameter fieldName1 is undocumented.", "NULL behavior for parameter record2 is undocumented.", "NULL behavior for parameter fieldName2 is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The compare(reference,integer,reference,integer) and compare(reference,string,reference,string) functions are available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "compare", "basis": "documentation" } ] } ], "see_also": [], "evidence": [ { "source_id": "ctl2-record-functions", "section": "compare", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "concat": { "name": "concat", "category": "string", "summary": "The function concat() returns concatenation of the strings.", "description": "The function concat() returns concatenation of the strings. The concat function accepts unlimited number of arguments of the string data type. You can also concatenate these arguments using plus signs, but this function is faster for more than two arguments. Null value of arguments are replaced with string 'null' in concatenated string. Concatenation of more strings with the concat() function is faster than concatenation with + operator.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "concat(string,string...)", "canonical_signature": "string concat(string arg1, string argN...)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "Any argument is NULL -> its text is the string \"null\" in the result.", "result": { "kind": "literal", "type": "string", "value": "null", "display": "\"null\"" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "argN", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": true, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented argN argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "Any argument is NULL -> its text is the string \"null\" in the result.", "result": { "kind": "literal", "type": "string", "value": "null", "display": "\"null\"" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": "unbounded" }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of concat as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "concat", "basis": "documentation" } ] }, "description": "The function concat() returns concatenation of the strings. The concat function accepts unlimited number of arguments of the string data type. You can also concatenate these arguments using plus signs, but this function is faster for more than two arguments. Null value of arguments are replaced with string 'null' in concatenated string. Concatenation of more strings with the concat() function is faster than concatenation with + operator.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "concat", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The concat(string, ...) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "concat", "basis": "documentation" } ] } ], "see_also": [ "concatWithSeparator", "cut", "join", "substring" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "concat", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "concatWithSeparator": { "name": "concatWithSeparator", "category": "string", "summary": "The function concatWithSeparator() joins parameters arg1 to argN using separator.", "description": "The function concatWithSeparator() joins parameters arg1 to argN using separator. The separator parameter defines a string to be used as a separator in the concatenated string. If the separator parameter is null, the function fails. The parameters arg1 to argN contain strings to be concatenated. Parameters to be concatenated having null values are omitted. The concat() and concatWithSeparator() functions handle null strings differently.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "concatWithSeparator(string,string,string...)", "canonical_signature": "string concatWithSeparator(string separator, string arg1, string argN...)", "type_parameters": [], "parameters": [ { "position": 0, "name": "separator", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function concatWithSeparator() joins parameters arg1 to argN using separator.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "separator is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg1", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function concatWithSeparator() joins parameters arg1 to argN using separator.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "argN", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": true, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function concatWithSeparator() joins parameters arg1 to argN using separator.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": "unbounded" }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of concatWithSeparator as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "concatWithSeparator", "basis": "documentation" } ] }, "description": "The function concatWithSeparator() joins parameters arg1 to argN using separator. The separator parameter defines a string to be used as a separator in the concatenated string. If the separator parameter is null, the function fails. The parameters arg1 to argN contain strings to be concatenated. Parameters to be concatenated having null values are omitted. The concat() and concatWithSeparator() functions handle null strings differently.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "concatWithSeparator", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "separator == NULL", "description": "separator is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg1 is undocumented.", "NULL behavior for parameter argN is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The concatWithSeparator(string,string,...) function is available since CloverETL 4.0.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "concatWithSeparator", "basis": "documentation" } ] } ], "see_also": [ "concat", "join", "split" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "concatWithSeparator", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "contains": { "name": "contains", "category": "string", "summary": "The function contains() returns true if the input string contains a substring.", "description": "The function contains() returns true if the input string contains a substring. Otherwise the function returns false. If the parameter input is null, the function returns false. If the parameter substring is null, the function fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "contains(string,string)", "canonical_signature": "boolean contains(string input, string substring)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function contains() returns true if the input string contains a substring.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "input is NULL -> false.", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "substring", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function contains() returns true if the input string contains a substring.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "substring is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of contains as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "contains", "basis": "documentation" } ] }, "description": "The function contains() returns true if the input string contains a substring. Otherwise the function returns false. If the parameter input is null, the function returns false. If the parameter substring is null, the function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "contains", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "substring == NULL", "description": "substring is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The contains(string,string) function is available since CloverETL 4.0.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "contains", "basis": "documentation" } ] } ], "see_also": [ "endsWith", "startsWith", "substring" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "contains", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "containsAll": { "name": "containsAll", "category": "container", "summary": "The containsAll() function returns true if the collection list contains every element of the subList list, i.e.", "description": "The containsAll() function returns true if the collection list contains every element of the subList list, i.e. if the second list is a sublist of the first list. === Error states If either of the given lists is null, the function fails with an error. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "containsAll(T[],T[])", "canonical_signature": "boolean containsAll(T[] collection, T[] subList)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "collection", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The containsAll() function returns true if the collection list contains every element of the subList list, i.e.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "collection or subList is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "subList", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The containsAll() function returns true if the collection list contains every element of the subList list, i.e.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "collection or subList is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of containsAll as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "containsAll", "basis": "documentation" } ] }, "description": "The containsAll() function returns true if the collection list contains every element of the subList list, i.e. if the second list is a sublist of the first list. === Error states If either of the given lists is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "containsAll", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "collection == NULL", "description": "collection or subList is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "subList == NULL", "description": "collection or subList is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-container-functions", "section": "containsAll", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "containsKey": { "name": "containsKey", "category": "container", "summary": "Returns true, if the searchMap contains element with key key.", "description": "Returns true, if the searchMap contains element with key key. Note that this function does not need to iterate over the map - it works in constant time. === Error states If searchMap is null, the function fails with an error. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "containsKey(map[K,V],K)", "canonical_signature": "boolean containsKey(map[K,V] searchMap, K key)", "type_parameters": [ { "name": "K", "constraint": { "kind": "any", "display": "any" } }, { "name": "V", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "searchMap", "type": { "kind": "map", "key": { "kind": "type_variable", "name": "K", "display": "K" }, "value": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "map[K,V]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Returns true, if the searchMap contains element with key key.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "searchMap is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "key", "type": { "kind": "type_variable", "name": "K", "display": "K" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Returns true, if the searchMap contains element with key key.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "Variant-overload key NULL -> false.", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of containsKey as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "containsKey", "basis": "documentation" } ] }, "description": "Returns true, if the searchMap contains element with key key. Note that this function does not need to iterate over the map - it works in constant time. === Error states If searchMap is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "containsKey", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "searchMap == NULL", "description": "searchMap is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "containsKey(variant,variant)", "canonical_signature": "boolean containsKey(variant searchMap, variant key)", "type_parameters": [], "parameters": [ { "position": 0, "name": "searchMap", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Returns true, if the searchMap contains element with key key.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "searchMap is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "key", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Returns true, if the searchMap contains element with key key.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "Variant-overload key NULL -> false.", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of containsKey as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "containsKey", "basis": "documentation" } ] }, "description": "Returns true, if the searchMap contains element with key key. Note that this function does not need to iterate over the map - it works in constant time. === Error states If searchMap is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "containsKey", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "searchMap == NULL", "description": "searchMap is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-container-functions", "section": "containsKey", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "containsResponseHeader": { "name": "containsResponseHeader", "category": "data_service_http", "summary": "The containsResponseHeader() function checks for presence of a user-added header field.", "description": "The containsResponseHeader() function checks for presence of a user-added header field. It does not check existence of header fields not added by user, e.g. Server: Apache-Coyote/1.1. The check is case insensitive. The headerField parameter is a name of HTTP header field.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "containsResponseHeader(string)", "canonical_signature": "boolean containsResponseHeader(string headerField)", "type_parameters": [], "parameters": [ { "position": 0, "name": "headerField", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The headerField parameter is a name of HTTP header field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of containsResponseHeader as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "containsResponseHeader", "basis": "documentation" } ] }, "description": "The containsResponseHeader() function checks for presence of a user-added header field. It does not check existence of header fields not added by user, e.g. Server: Apache-Coyote/1.1. The check is case insensitive. The headerField parameter is a name of HTTP header field.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "containsResponseHeader", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter headerField is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The containsResponseHeader(string) function is available since CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "containsResponseHeader", "basis": "documentation" } ] } ], "see_also": [ "addResponseHeader" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "containsResponseHeader", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "containsValue": { "name": "containsValue", "category": "container", "summary": "The function returns true if container searchIn contains value value.", "description": "The function returns true if container searchIn contains value value. The function iterates over the whole container - linear time search. The containsValue(map, value) function returns true if the specified map maps one or more keys to the specified value. The containsValue(list, value) function returns true if the specified list contains the specified value. Note that the list does not have to be sorted. If you have a sorted list, use binarySearch since it is faster on longer lists. The containsValue(variant, variant) function works as one of the two functions above, depending on whether the first argument contains a list or a map. === Error states If the first argument is null, the function fails with an error. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "containsValue(T[],T)", "canonical_signature": "boolean containsValue(T[] searchIn, T value)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "searchIn", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The function returns true if container searchIn contains value value.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "First argument (searchIn) is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "value", "type": { "kind": "type_variable", "name": "T", "display": "T" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The function returns true if container searchIn contains value value.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "Map and variant-overload value NULL -> false.", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of containsValue as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "containsValue", "basis": "documentation" } ] }, "description": "The function returns true if container searchIn contains value value. The function iterates over the whole container - linear time search. The containsValue(map, value) function returns true if the specified map maps one or more keys to the specified value. The containsValue(list, value) function returns true if the specified list contains the specified value. Note that the list does not have to be sorted. If you have a sorted list, use binarySearch since it is faster on longer lists. The containsValue(variant, variant) function works as one of the two functions above, depending on whether the first argument contains a list or a map. === Error states If the first argument is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "containsValue", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "searchIn == NULL", "description": "First argument (searchIn) is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "containsValue(map[K,V],V)", "canonical_signature": "boolean containsValue(map[K,V] searchIn, V value)", "type_parameters": [ { "name": "K", "constraint": { "kind": "any", "display": "any" } }, { "name": "V", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "searchIn", "type": { "kind": "map", "key": { "kind": "type_variable", "name": "K", "display": "K" }, "value": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "map[K,V]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The function returns true if container searchIn contains value value.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "First argument (searchIn) is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "value", "type": { "kind": "type_variable", "name": "V", "display": "V" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The function returns true if container searchIn contains value value.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "Map and variant-overload value NULL -> false.", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of containsValue as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "containsValue", "basis": "documentation" } ] }, "description": "The function returns true if container searchIn contains value value. The function iterates over the whole container - linear time search. The containsValue(map, value) function returns true if the specified map maps one or more keys to the specified value. The containsValue(list, value) function returns true if the specified list contains the specified value. Note that the list does not have to be sorted. If you have a sorted list, use binarySearch since it is faster on longer lists. The containsValue(variant, variant) function works as one of the two functions above, depending on whether the first argument contains a list or a map. === Error states If the first argument is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "containsValue", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "searchIn == NULL", "description": "First argument (searchIn) is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "containsValue(variant,variant)", "canonical_signature": "boolean containsValue(variant searchIn, variant value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "searchIn", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The function returns true if container searchIn contains value value.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "First argument (searchIn) is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "value", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The function returns true if container searchIn contains value value.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "Map and variant-overload value NULL -> false.", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of containsValue as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "containsValue", "basis": "documentation" } ] }, "description": "The function returns true if container searchIn contains value value. The function iterates over the whole container - linear time search. The containsValue(map, value) function returns true if the specified map maps one or more keys to the specified value. The containsValue(list, value) function returns true if the specified list contains the specified value. Note that the list does not have to be sorted. If you have a sorted list, use binarySearch since it is faster on longer lists. The containsValue(variant, variant) function works as one of the two functions above, depending on whether the first argument contains a list or a map. === Error states If the first argument is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "containsValue", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "searchIn == NULL", "description": "First argument (searchIn) is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-container-functions", "section": "containsValue", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "copy": { "name": "copy", "category": "container", "summary": "The copy function copies data from the source container to the target container.", "description": "The copy function copies data from the source container to the target container. It modifies the target container and then returns it. For lists, the function appends the items from the source list to the end of the target list. For maps, the function adds the key-value pairs from the source map to the target map. If the same key exists in both maps, the value from the source map replaces the value in the target map. Use appendAll if you want to keep the original value. === Error states If one of the arguments is null, the function fails with an error. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "copy(T[],T[])", "canonical_signature": "T[] copy(T[] target, T[] source)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "target", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The copy function copies data from the source container to the target container.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "source", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The copy function copies data from the source container to the target container.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "description": "Return value of copy as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "copy", "basis": "documentation" } ] }, "description": "The copy function copies data from the source container to the target container. It modifies the target container and then returns it. For lists, the function appends the items from the source list to the end of the target list. For maps, the function adds the key-value pairs from the source map to the target map. If the same key exists in both maps, the value from the source map replaces the value in the target map. Use appendAll if you want to keep the original value. === Error states If one of the arguments is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "copy", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "target == NULL", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "source == NULL", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [ { "kind": "mutates_parameter", "parameter": "target", "description": "Documentation states that copy modifies its target argument.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "copy", "basis": "documentation" } ] } ], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "copy(map[K,V],map[K,V])", "canonical_signature": "map[K,V] copy(map[K,V] target, map[K,V] source)", "type_parameters": [ { "name": "K", "constraint": { "kind": "any", "display": "any" } }, { "name": "V", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "target", "type": { "kind": "map", "key": { "kind": "type_variable", "name": "K", "display": "K" }, "value": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "map[K,V]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The copy function copies data from the source container to the target container.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "source", "type": { "kind": "map", "key": { "kind": "type_variable", "name": "K", "display": "K" }, "value": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "map[K,V]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The copy function copies data from the source container to the target container.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "map", "key": { "kind": "type_variable", "name": "K", "display": "K" }, "value": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "map[K,V]" }, "description": "Return value of copy as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "copy", "basis": "documentation" } ] }, "description": "The copy function copies data from the source container to the target container. It modifies the target container and then returns it. For lists, the function appends the items from the source list to the end of the target list. For maps, the function adds the key-value pairs from the source map to the target map. If the same key exists in both maps, the value from the source map replaces the value in the target map. Use appendAll if you want to keep the original value. === Error states If one of the arguments is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "copy", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "target == NULL", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "source == NULL", "description": "Any argument is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [ { "kind": "mutates_parameter", "parameter": "target", "description": "Documentation states that copy modifies its target argument.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "copy", "basis": "documentation" } ] } ], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-container-functions", "section": "copy", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "copyByName": { "name": "copyByName", "category": "record", "summary": "The copyByName() function copies data from the input record to the output record based on field names.", "description": "The copyByName() function copies data from the input record to the output record based on field names. Enables mapping of equally named fields only. If a record specified as a first argument has a null reference, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "copyByName(record,record)", "canonical_signature": "void copyByName(record to, record from)", "type_parameters": [], "parameters": [ { "position": 0, "name": "to", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The copyByName() function copies data from the input record to the output record based on field names.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "from", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The copyByName() function copies data from the input record to the output record based on field names.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of copyByName as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "copyByName", "basis": "documentation" } ] }, "description": "The copyByName() function copies data from the input record to the output record based on field names. Enables mapping of equally named fields only. If a record specified as a first argument has a null reference, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "copyByName", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter to is undocumented.", "NULL behavior for parameter from is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The copyByName(reference,reference) function is available since CloverETL 3.2.2 or earlier.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "copyByName", "basis": "documentation" } ] } ], "see_also": [ "copyByPosition" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "copyByName", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "copyByPosition": { "name": "copyByPosition", "category": "record", "summary": "The copyByPosition() function copies data from the input record to the output record based on fields order.", "description": "The copyByPosition() function copies data from the input record to the output record based on fields order. The number of fields in output metadata decides which input fields (beginning the first one) are mapped. If a record specified as a first argument has a null reference, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "copyByPosition(record,record)", "canonical_signature": "void copyByPosition(record to, record from)", "type_parameters": [], "parameters": [ { "position": 0, "name": "to", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The copyByPosition() function copies data from the input record to the output record based on fields order.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "from", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The copyByPosition() function copies data from the input record to the output record based on fields order.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of copyByPosition as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "copyByPosition", "basis": "documentation" } ] }, "description": "The copyByPosition() function copies data from the input record to the output record based on fields order. The number of fields in output metadata decides which input fields (beginning the first one) are mapped. If a record specified as a first argument has a null reference, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "copyByPosition", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter to is undocumented.", "NULL behavior for parameter from is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The copyByPosition(reference,reference) function is available since CloverETL 3.2.2 or earlier.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "copyByPosition", "basis": "documentation" } ] } ], "see_also": [ "copyByName" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "copyByPosition", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "cos": { "name": "cos", "category": "mathematical", "summary": "The cos() function returns the trigonometric cosine of a given angle.", "description": "The cos() function returns the trigonometric cosine of a given angle. Angle is in radians. If the given argument is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "cos(decimal)", "canonical_signature": "number cos(decimal angle)", "type_parameters": [], "parameters": [ { "position": 0, "name": "angle", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The cos() function returns the trigonometric cosine of a given angle.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of cos as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "cos", "basis": "documentation" } ] }, "description": "The cos() function returns the trigonometric cosine of a given angle. Angle is in radians. If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "cos", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "angle == NULL", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "cos(number)", "canonical_signature": "number cos(number angle)", "type_parameters": [], "parameters": [ { "position": 0, "name": "angle", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The cos() function returns the trigonometric cosine of a given angle.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of cos as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "cos", "basis": "documentation" } ] }, "description": "The cos() function returns the trigonometric cosine of a given angle. Angle is in radians. If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "cos", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "angle == NULL", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The cos(decimal) and cos(number) functions are available since CloverETL 3.5.0-M2.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "cos", "basis": "documentation" } ] } ], "see_also": [ "acos", "sin", "tan", "toRadians" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "cos", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "count": { "name": "count", "category": "lookup_table", "summary": "lookup().count(keyValue) The count() function returns the number of records whose key value equals to keyValue.", "description": "lookup().count(keyValue) The count() function returns the number of records whose key value equals to keyValue. The count() function used with DB lookup tables may return -1 instead of real count of record with specified key value (if you do not set [guilabel]##Max cached size## to a non-zero value). The lookup name is simply a name of the lookup table. It is not specified as a string enclosed with \" character. The keyValue is a value of a key of the lookup table. If the lookup table has a key of one field, keyValue is one string. If the lookup table has a key of more fields, keyValue is specified as series of the values of particular key parts. See the documentation of the particular lookup table for handling of duplicated keys.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "count(any...)", "canonical_signature": "any count(any keyValue...)", "type_parameters": [], "parameters": [ { "position": 0, "name": "keyValue", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": true, "default": { "kind": "none", "description": "No documented default." }, "description": "lookup().count(keyValue) The count() function returns the number of records whose key value equals to keyValue.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "count", "basis": "documentation" } ] } ], "arity": { "minimum": 0, "maximum": "unbounded" }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of count as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "count", "basis": "documentation" } ] }, "description": "lookup().count(keyValue) The count() function returns the number of records whose key value equals to keyValue. The count() function used with DB lookup tables may return -1 instead of real count of record with specified key value (if you do not set [guilabel]##Max cached size## to a non-zero value). The lookup name is simply a name of the lookup table. It is not specified as a string enclosed with \" character. The keyValue is a value of a key of the lookup table. If the lookup table has a key of one field, keyValue is one string. If the lookup table has a key of more fields, keyValue is specified as series of the values of particular key parts. See the documentation of the particular lookup table for handling of duplicated keys.", "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "count", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [ "The source documents an inline callable form but no formal typed signature.", "NULL behavior for parameter keyValue is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The count(string) function is available since CloverETL 3.0.x.", "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "count", "basis": "documentation" } ] } ], "see_also": [ "Allow key duplicates", "get" ], "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "count", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [ "No formal typed signature was found; an explicitly partial inline-call record was created.", "See-also references outside the v1 core-source scope: Allow key duplicates." ] } }, "countChar": { "name": "countChar", "category": "string", "summary": "The countChar() returns the number of occurrences of the character specified as the second argument in the string specified as the first argument.", "description": "The countChar() returns the number of occurrences of the character specified as the second argument in the string specified as the first argument. If one of the given arguments is null or an empty string, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "countChar(string,string)", "canonical_signature": "integer countChar(string arg, string character)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or character is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "character", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The countChar() returns the number of occurrences of the character specified as the second argument in the string specified as the first argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or character is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of countChar as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "countChar", "basis": "documentation" } ] }, "description": "The countChar() returns the number of occurrences of the character specified as the second argument in the string specified as the first argument. If one of the given arguments is null or an empty string, the function fails with an error.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "countChar", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg or character is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "character == NULL", "description": "arg or character is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The countChar(string,string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "countChar", "basis": "documentation" } ] } ], "see_also": [ "length" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "countChar", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "createDate": { "name": "createDate", "category": "date", "summary": "The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "description": "The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone. If any of the above mentioned parameters is missing, value is set to zero. If the time zone is missing, the default time zone is used. If one or more of specified parameters is null, the function fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "createDate(integer,integer,integer)", "canonical_signature": "date createDate(integer year, integer month, integer day)", "type_parameters": [], "parameters": [ { "position": 0, "name": "year", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "month", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "day", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of createDate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "createDate", "basis": "documentation" } ] }, "description": "The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone. If any of the above mentioned parameters is missing, value is set to zero. If the time zone is missing, the default time zone is used. If one or more of specified parameters is null, the function fails.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "createDate", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "year == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "month == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "day == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "createDate(integer,integer,integer,integer,integer,integer)", "canonical_signature": "date createDate(integer year, integer month, integer day, integer hour, integer minute, integer second)", "type_parameters": [], "parameters": [ { "position": 0, "name": "year", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "month", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "day", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "hour", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 4, "name": "minute", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 5, "name": "second", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 6, "maximum": 6 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of createDate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "createDate", "basis": "documentation" } ] }, "description": "The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone. If any of the above mentioned parameters is missing, value is set to zero. If the time zone is missing, the default time zone is used. If one or more of specified parameters is null, the function fails.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "createDate", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "year == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "month == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "day == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "hour == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "minute == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "second == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "createDate(integer,integer,integer,integer,integer,integer,integer)", "canonical_signature": "date createDate(integer year, integer month, integer day, integer hour, integer minute, integer second, integer millisecond)", "type_parameters": [], "parameters": [ { "position": 0, "name": "year", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "month", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "day", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "hour", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 4, "name": "minute", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 5, "name": "second", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 6, "name": "millisecond", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 7, "maximum": 7 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of createDate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "createDate", "basis": "documentation" } ] }, "description": "The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone. If any of the above mentioned parameters is missing, value is set to zero. If the time zone is missing, the default time zone is used. If one or more of specified parameters is null, the function fails.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "createDate", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "year == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "month == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "day == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "hour == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "minute == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "second == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "millisecond == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "createDate(integer,integer,integer,integer,integer,integer,integer,string)", "canonical_signature": "date createDate(integer year, integer month, integer day, integer hour, integer minute, integer second, integer millisecond, string timeZone)", "type_parameters": [], "parameters": [ { "position": 0, "name": "year", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "month", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "day", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "hour", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 4, "name": "minute", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 5, "name": "second", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 6, "name": "millisecond", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 7, "name": "timeZone", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented timeZone argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 8, "maximum": 8 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of createDate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "createDate", "basis": "documentation" } ] }, "description": "The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone. If any of the above mentioned parameters is missing, value is set to zero. If the time zone is missing, the default time zone is used. If one or more of specified parameters is null, the function fails.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "createDate", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "year == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "month == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "day == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "hour == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "minute == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "second == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "millisecond == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "timeZone == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "createDate(integer,integer,integer,integer,integer,integer,string)", "canonical_signature": "date createDate(integer year, integer month, integer day, integer hour, integer minute, integer second, string timeZone)", "type_parameters": [], "parameters": [ { "position": 0, "name": "year", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "month", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "day", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "hour", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 4, "name": "minute", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 5, "name": "second", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 6, "name": "timeZone", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented timeZone argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 7, "maximum": 7 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of createDate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "createDate", "basis": "documentation" } ] }, "description": "The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone. If any of the above mentioned parameters is missing, value is set to zero. If the time zone is missing, the default time zone is used. If one or more of specified parameters is null, the function fails.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "createDate", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "year == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "month == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "day == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "hour == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "minute == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "second == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "timeZone == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "createDate(integer,integer,integer,string)", "canonical_signature": "date createDate(integer year, integer month, integer day, string timeZone)", "type_parameters": [], "parameters": [ { "position": 0, "name": "year", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "month", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "day", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "timeZone", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented timeZone argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 4, "maximum": 4 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of createDate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "createDate", "basis": "documentation" } ] }, "description": "The function createDate() creates a date using provided year, month (numbered from 1), day of month, hour, minute, second, millisecond and time zone. If any of the above mentioned parameters is missing, value is set to zero. If the time zone is missing, the default time zone is used. If one or more of specified parameters is null, the function fails.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "createDate", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "year == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "month == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "day == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "timeZone == NULL", "description": "Any supplied parameter is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The functions createDate(integer,integer,integer), createDate(integer,integer,integer,string), createDate(integer,integer,integer,integer,integer,integer), createDate(integer,integer,integer,integer,integer,integer,integer), createDate(integer,integer,integer,integer,integer,integer,string) and createDate(integer,integer,integer,integer,integer,integer,string) are available since CloverETL 3.5.0-M1.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "createDate", "basis": "documentation" } ] } ], "see_also": [ "str2date" ], "evidence": [ { "source_id": "ctl2-date-functions", "section": "createDate", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "current": { "name": "current", "category": "sequence", "summary": "Sequence method documented as sequence().current().", "description": "Sequence method documented as sequence().current().", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "current()", "canonical_signature": "any current()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "The source documents this callable form but not a typed CTL signature.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented in a typed signature." }, "evidence": [ { "source_id": "ctl2-sequence-functions", "section": "current", "basis": "documentation" } ] }, "description": "Documented callable form with no formal typed signature.", "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "evidence": [ { "source_id": "ctl2-sequence-functions", "section": "current", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [ "The sequence reference documents method-call syntax but no formal typed CTL signature." ] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-sequence-functions", "section": "current", "basis": "documentation", "detail": "Verbatim sequence method call." } ], "data_quality": { "status": "partial", "issues": [ "The source has no formal function heading or typed signature for this method." ] } }, "currentTimeMillis": { "name": "currentTimeMillis", "category": "miscellaneous", "summary": "The currentTimeMillis() function returns the current time in milliseconds since the UNIX epoch (January 1, 1970 00:00:00 UTC).", "description": "The currentTimeMillis() function returns the current time in milliseconds since the UNIX epoch (January 1, 1970 00:00:00 UTC).", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "currentTimeMillis()", "canonical_signature": "long currentTimeMillis()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of currentTimeMillis as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "currentTimeMillis", "basis": "documentation" } ] }, "description": "The currentTimeMillis() function returns the current time in milliseconds since the UNIX epoch (January 1, 1970 00:00:00 UTC).", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "currentTimeMillis", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The currentTimeMillis() function is available since CloverDX 6.4.0.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "currentTimeMillis", "basis": "documentation" } ] } ], "see_also": [], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "currentTimeMillis", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "cut": { "name": "cut", "category": "string", "summary": "The cut() function returns a list of strings which are substrings of the original string specified in the first argument.", "description": "The cut() function returns a list of strings which are substrings of the original string specified in the first argument. The second argument (indices) specifies rules on how the first argument is cut. The number of elements of the list specified as the second argument must be even. The integers in the list serve as position (each number in the odd position) and length (each number in the even position). Substrings of the specified length are taken from the string specified as the first argument starting from the specified position (excluding the character at the specified position). If the first argument is null or an empty string, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "cut(string,integer[])", "canonical_signature": "string[] cut(string arg, integer[] indices)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "indices", "type": { "kind": "list", "element": { "kind": "named", "name": "integer", "display": "integer" }, "display": "integer[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The second argument (indices) specifies rules on how the first argument is cut.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "indices is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "list", "element": { "kind": "named", "name": "string", "display": "string" }, "display": "string[]" }, "description": "Return value of cut as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "cut", "basis": "documentation" } ] }, "description": "The cut() function returns a list of strings which are substrings of the original string specified in the first argument. The second argument (indices) specifies rules on how the first argument is cut. The number of elements of the list specified as the second argument must be even. The integers in the list serve as position (each number in the odd position) and length (each number in the even position). Substrings of the specified length are taken from the string specified as the first argument starting from the specified position (excluding the character at the specified position). If the first argument is null or an empty string, the function fails with an error.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "cut", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "indices == NULL", "description": "indices is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The cut(string,integer[]) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "cut", "basis": "documentation" } ] } ], "see_also": [ "matchGroups" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "cut", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "date2long": { "name": "date2long", "category": "conversion", "summary": "The date2long() function converts a date argument to the long data type.", "description": "The date2long() function converts a date argument to the long data type. The return value is the number of milliseconds elapsed from January 1, 1970, 00:00:00 GMT to the date specified as the argument. If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "date2long(date)", "canonical_signature": "long date2long(date input)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the input is null, the function returns null.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of date2long as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2long", "basis": "documentation" } ] }, "description": "The date2long() function converts a date argument to the long data type. The return value is the number of milliseconds elapsed from January 1, 1970, 00:00:00 GMT to the date specified as the argument. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2long", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The date2long(date) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2long", "basis": "documentation" } ] } ], "see_also": [ "date2num", "date2str", "long2date" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2long", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "date2num": { "name": "date2num", "category": "conversion", "summary": "The date2num() returns the number of specified time units from the date using system or specified locale.", "description": "The date2num() returns the number of specified time units from the date using system or specified locale. The date parameter is a date to be converted. If the input date is null, the function returns null. The unit of field timeunit can be one of the following: year, month, week, day, hour, minute, second or millisec. The unit must be specified as a constant. It can neither be received through an edge nor set as a variable. If the function takes two arguments, it returns an integer using the system locale. If the parameter locale is used, the function uses the locale from the locale parameter instead of the system locale. If the time unit is contained in the date, it is returned as an integer number. If it is not contained, the function returns 0. Remember that months are numbered starting from 1 unlike in CTL1. The default time zone is used in the conversion.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "date2num(date,unit)", "canonical_signature": "integer date2num(date input, unit timeunit)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the input date is null, the function returns null.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "timeunit", "type": { "kind": "named", "name": "unit", "display": "unit" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The unit of field timeunit can be one of the following: year, month, week, day, hour, minute, second or millisec.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "timeunit is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of date2num as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2num", "basis": "documentation" } ] }, "description": "The date2num() returns the number of specified time units from the date using system or specified locale. The date parameter is a date to be converted. If the input date is null, the function returns null. The unit of field timeunit can be one of the following: year, month, week, day, hour, minute, second or millisec. The unit must be specified as a constant. It can neither be received through an edge nor set as a variable. If the function takes two arguments, it returns an integer using the system locale. If the parameter locale is used, the function uses the locale from the locale parameter instead of the system locale. If the time unit is contained in the date, it is returned as an integer number. If it is not contained, the function returns 0. Remember that months are numbered starting from 1 unlike in CTL1. The default time zone is used in the conversion.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2num", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "timeunit == NULL", "description": "timeunit is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "date2num(date,unit,string)", "canonical_signature": "integer date2num(date input, unit timeunit, string locale)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the input date is null, the function returns null.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "timeunit", "type": { "kind": "named", "name": "unit", "display": "unit" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The unit of field timeunit can be one of the following: year, month, week, day, hour, minute, second or millisec.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "timeunit is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The date2num() returns the number of specified time units from the date using system or specified locale.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "locale is NULL -> returns a normal numeric result (runtime probe: 2 for 2024-01-02 and day).", "result": { "kind": "literal", "type": "integer", "value": 2, "display": "2" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of date2num as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2num", "basis": "documentation" } ] }, "description": "The date2num() returns the number of specified time units from the date using system or specified locale. The date parameter is a date to be converted. If the input date is null, the function returns null. The unit of field timeunit can be one of the following: year, month, week, day, hour, minute, second or millisec. The unit must be specified as a constant. It can neither be received through an edge nor set as a variable. If the function takes two arguments, it returns an integer using the system locale. If the parameter locale is used, the function uses the locale from the locale parameter instead of the system locale. If the time unit is contained in the date, it is returned as an integer number. If it is not contained, the function returns 0. Remember that months are numbered starting from 1 unlike in CTL1. The default time zone is used in the conversion.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2num", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "timeunit == NULL", "description": "timeunit is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The date2num(date,unit) and date2num(ate,unit,string) functions are available since CloverETL 3.0.x.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2num", "basis": "documentation" } ] } ], "see_also": [ "date2long", "date2str", "getDay", "getHour", "getMillisecond", "getMinute", "getMonth", "getSecond", "getYear" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2num", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "date2str": { "name": "date2str", "category": "conversion", "summary": "The date2str() function converts the input date to the string data type according to the specified pattern, locale and target timeZone.", "description": "The date2str() function converts the input date to the string data type according to the specified pattern, locale and target timeZone. The input contains date to be converted to the string. If the input date is null, the function returns null. The pattern describes date and time format. If the pattern is null, default value is used. The locale parameter defines what date format symbols should be used. If the locale is null, an empty string, or the function does not have the locale parameter, the respective default value is used. If the timeZone parameter is null, an empty string, or the function does not have the locale parameter, the default time zone value is used.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "date2str(date,string)", "canonical_signature": "string date2str(date input, string pattern)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The date2str() function converts the input date to the string data type according to the specified pattern, locale and target timeZone.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "pattern", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The date2str() function converts the input date to the string data type according to the specified pattern, locale and target timeZone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "pattern is NULL -> default date format.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of date2str as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2str", "basis": "documentation" } ] }, "description": "The date2str() function converts the input date to the string data type according to the specified pattern, locale and target timeZone. The input contains date to be converted to the string. If the input date is null, the function returns null. The pattern describes date and time format. If the pattern is null, default value is used. The locale parameter defines what date format symbols should be used. If the locale is null, an empty string, or the function does not have the locale parameter, the respective default value is used. If the timeZone parameter is null, an empty string, or the function does not have the locale parameter, the default time zone value is used.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2str", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "date2str(date,string,string)", "canonical_signature": "string date2str(date input, string pattern, string locale)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The date2str() function converts the input date to the string data type according to the specified pattern, locale and target timeZone.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "pattern", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The date2str() function converts the input date to the string data type according to the specified pattern, locale and target timeZone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "pattern is NULL -> default date format.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The date2str() function converts the input date to the string data type according to the specified pattern, locale and target timeZone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "locale is NULL -> default locale.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of date2str as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2str", "basis": "documentation" } ] }, "description": "The date2str() function converts the input date to the string data type according to the specified pattern, locale and target timeZone. The input contains date to be converted to the string. If the input date is null, the function returns null. The pattern describes date and time format. If the pattern is null, default value is used. The locale parameter defines what date format symbols should be used. If the locale is null, an empty string, or the function does not have the locale parameter, the respective default value is used. If the timeZone parameter is null, an empty string, or the function does not have the locale parameter, the default time zone value is used.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2str", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "date2str(date,string,string,string)", "canonical_signature": "string date2str(date input, string pattern, string locale, string timeZone)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The date2str() function converts the input date to the string data type according to the specified pattern, locale and target timeZone.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "pattern", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The date2str() function converts the input date to the string data type according to the specified pattern, locale and target timeZone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "pattern is NULL -> default date format.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The date2str() function converts the input date to the string data type according to the specified pattern, locale and target timeZone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "locale is NULL -> default locale.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "timeZone", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The date2str() function converts the input date to the string data type according to the specified pattern, locale and target timeZone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "timeZone is NULL -> default time zone.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 4, "maximum": 4 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of date2str as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2str", "basis": "documentation" } ] }, "description": "The date2str() function converts the input date to the string data type according to the specified pattern, locale and target timeZone. The input contains date to be converted to the string. If the input date is null, the function returns null. The pattern describes date and time format. If the pattern is null, default value is used. The locale parameter defines what date format symbols should be used. If the locale is null, an empty string, or the function does not have the locale parameter, the respective default value is used. If the timeZone parameter is null, an empty string, or the function does not have the locale parameter, the default time zone value is used.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2str", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The date2str(date,string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2str", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The date2str(date,string,string) function is available since CloverETL 3.0.1.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2str", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The date2str(date,string,string,string) function is available since CloverETL 3.5.0-M1.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2str", "basis": "documentation" } ] } ], "see_also": [ "date2long", "date2num", "getDay", "getHour", "getMillisecond", "getMinute", "getMonth", "getSecond", "getYear", "str2date" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "date2str", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "dateAdd": { "name": "dateAdd", "category": "date", "summary": "The dateAdd() function adds a number of time units to the date and returns a new date.", "description": "The dateAdd() function adds a number of time units to the date and returns a new date. Parameter arg is the date to which the number of time units is added. Parameter amount defines the number of units to be added. The unit parameter defines the unit of the second function parameter. The unit argument can be one of the following: year, month, week, day, hour, minute, second, millisec. The unit must be specified as a constant. It can neither be received through an edge nor set as a variable. The function returns the new resulting date. If one of the arguments is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "dateAdd(date,long,unit)", "canonical_signature": "date dateAdd(date arg, long amount, unit timeunit)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Parameter arg is the date to which the number of time units is added.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg, amount, or timeunit is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "amount", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Parameter amount defines the number of units to be added.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg, amount, or timeunit is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "timeunit", "type": { "kind": "named", "name": "unit", "display": "unit" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Compatibility The dateAdd(date,long,timeunit) function is available since CloverETL 3.0.0.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg, amount, or timeunit is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of dateAdd as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "dateAdd", "basis": "documentation" } ] }, "description": "The dateAdd() function adds a number of time units to the date and returns a new date. Parameter arg is the date to which the number of time units is added. Parameter amount defines the number of units to be added. The unit parameter defines the unit of the second function parameter. The unit argument can be one of the following: year, month, week, day, hour, minute, second, millisec. The unit must be specified as a constant. It can neither be received through an edge nor set as a variable. The function returns the new resulting date. If one of the arguments is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "dateAdd", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg, amount, or timeunit is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "amount == NULL", "description": "arg, amount, or timeunit is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "timeunit == NULL", "description": "arg, amount, or timeunit is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The dateAdd(date,long,timeunit) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "dateAdd", "basis": "documentation" } ] } ], "see_also": [ "createDate", "dateDiff" ], "evidence": [ { "source_id": "ctl2-date-functions", "section": "dateAdd", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "dateDiff": { "name": "dateDiff", "category": "date", "summary": "The dateDiff() function returns the difference of two date variables in a specified time units.", "description": "The dateDiff() function returns the difference of two date variables in a specified time units. The later and earlier parameters represent a later and earlier date respectively. The difference of two dates is expressed in defined time units. The unit can be one of the following: year, month, week, day, hour, minute, second, millisec. The unit must be specified as a constant. It can be neither received through an edge nor set as variable. If the unit is hour, minute, second or millisec, it counts the difference in the same way as it would be measured using __stopclock__. If the unit is day, month or year, the difference affected by winter/summer time turn is calculated differently. See examples. The result is a long number. The result of the function is truncated: two date variables with a difference of 40 hours yield a difference of 1 days. If one of the given argument is null, the function fails with an error. _Be aware that adjusting for the daylight saving time_ - winter/summer time affects the results of dateDiff(). Different countries switch between summer time and winter time on different days. The function dateDiff() uses the time zone of your operating system.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "dateDiff(date,date,unit)", "canonical_signature": "long dateDiff(date later, date earlier, unit timeunit)", "type_parameters": [], "parameters": [ { "position": 0, "name": "later", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The later and earlier parameters represent a later and earlier date respectively.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "later, earlier, or timeunit is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "earlier", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The later and earlier parameters represent a later and earlier date respectively.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "later, earlier, or timeunit is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "timeunit", "type": { "kind": "named", "name": "unit", "display": "unit" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "==== Compatibility The dateDiff(date,date,timeunit) function is available since CloverETL 3.0.0.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "later, earlier, or timeunit is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of dateDiff as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "dateDiff", "basis": "documentation" } ] }, "description": "The dateDiff() function returns the difference of two date variables in a specified time units. The later and earlier parameters represent a later and earlier date respectively. The difference of two dates is expressed in defined time units. The unit can be one of the following: year, month, week, day, hour, minute, second, millisec. The unit must be specified as a constant. It can be neither received through an edge nor set as variable. If the unit is hour, minute, second or millisec, it counts the difference in the same way as it would be measured using __stopclock__. If the unit is day, month or year, the difference affected by winter/summer time turn is calculated differently. See examples. The result is a long number. The result of the function is truncated: two date variables with a difference of 40 hours yield a difference of 1 days. If one of the given argument is null, the function fails with an error. _Be aware that adjusting for the daylight saving time_ - winter/summer time affects the results of dateDiff(). Different countries switch between summer time and winter time on different days. The function dateDiff() uses the time zone of your operating system.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "dateDiff", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "later == NULL", "description": "later, earlier, or timeunit is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "earlier == NULL", "description": "later, earlier, or timeunit is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "timeunit == NULL", "description": "later, earlier, or timeunit is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The dateDiff(date,date,timeunit) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "dateDiff", "basis": "documentation" } ] } ], "see_also": [ "dateAdd", "str2date" ], "evidence": [ { "source_id": "ctl2-date-functions", "section": "dateDiff", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "decimal2double": { "name": "decimal2double", "category": "conversion", "summary": "The decimal2double() function converts a decimal argument to a double value.", "description": "The decimal2double() function converts a decimal argument to a double value. The conversion is narrowing, and if the decimal value cannot be converted into double (as the range of the double data type does not cover all decimal values), the function fails with an error. On the other hand, any double can be converted into decimal. Both [guilabel]##Length## and [guilabel]##Scale## of a decimal can be adjusted for it. If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "decimal2double(decimal)", "canonical_signature": "number decimal2double(decimal arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of decimal2double as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "decimal2double", "basis": "documentation" } ] }, "description": "The decimal2double() function converts a decimal argument to a double value. The conversion is narrowing, and if the decimal value cannot be converted into double (as the range of the double data type does not cover all decimal values), the function fails with an error. On the other hand, any double can be converted into decimal. Both [guilabel]##Length## and [guilabel]##Scale## of a decimal can be adjusted for it. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "decimal2double", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The decimal2double(decimal) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "decimal2double", "basis": "documentation" } ] } ], "see_also": [ "decimal2integer", "decimal2long", "round", "roundHalfToEven" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "decimal2double", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "decimal2integer": { "name": "decimal2integer", "category": "conversion", "summary": "The decimal2integer() function converts a decimal argument to an integer.", "description": "The decimal2integer() function converts a decimal argument to an integer. The conversion is narrowing, and if the decimal value cannot be converted into integer (as the range of the integer data type does not cover the range of decimal values), the function fails with an error. On the other hand, any integer can be converted into decimal without a loss of precision. [guilabel]##Length## of decimal can be adjusted for it. If the input is null, the function returns null. There is no function decimal2integer(double). You can use double parameter of the function due to implicit conversion of double to decimal. If you need conversion from double to integer, use the function double2integer.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "decimal2integer(decimal)", "canonical_signature": "integer decimal2integer(decimal arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of decimal2integer as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "decimal2integer", "basis": "documentation" } ] }, "description": "The decimal2integer() function converts a decimal argument to an integer. The conversion is narrowing, and if the decimal value cannot be converted into integer (as the range of the integer data type does not cover the range of decimal values), the function fails with an error. On the other hand, any integer can be converted into decimal without a loss of precision. [guilabel]##Length## of decimal can be adjusted for it. If the input is null, the function returns null. There is no function decimal2integer(double). You can use double parameter of the function due to implicit conversion of double to decimal. If you need conversion from double to integer, use the function double2integer.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "decimal2integer", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The decimal2integer(decimal) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "decimal2integer", "basis": "documentation" } ] } ], "see_also": [ "decimal2double", "decimal2long", "round", "roundHalfToEven" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "decimal2integer", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "decimal2long": { "name": "decimal2long", "category": "conversion", "summary": "The decimal2long() function converts a decimal argument to a long value.", "description": "The decimal2long() function converts a decimal argument to a long value. The conversion is narrowing, and if the decimal value cannot be converted into long (as the range of long data type does not cover all decimal values), the function fails with an error. On the other hand, any long can be converted into decimal without loss of precision. [guilabel]##Length## of a decimal can be adjusted for it. If the input is null, the function returns null. There is no function decimal2long(double). You can use double parameter of the function due to implicit conversion of double to decimal. If you need conversion from double to long, use the function double2long.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "decimal2long(decimal)", "canonical_signature": "long decimal2long(decimal arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of decimal2long as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "decimal2long", "basis": "documentation" } ] }, "description": "The decimal2long() function converts a decimal argument to a long value. The conversion is narrowing, and if the decimal value cannot be converted into long (as the range of long data type does not cover all decimal values), the function fails with an error. On the other hand, any long can be converted into decimal without loss of precision. [guilabel]##Length## of a decimal can be adjusted for it. If the input is null, the function returns null. There is no function decimal2long(double). You can use double parameter of the function due to implicit conversion of double to decimal. If you need conversion from double to long, use the function double2long.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "decimal2long", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The decimal2long(decimal) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "decimal2long", "basis": "documentation" } ] } ], "see_also": [ "decimal2double", "decimal2integer", "round", "roundHalfToEven" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "decimal2long", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "decode": { "name": "decode", "category": "string", "summary": "The decode() function creates a small lookup from search-result pairs.", "description": "The decode() function creates a small lookup from search-result pairs. It compares the expression to each search value one by one, and returns the corresponding result value. If no match is found, then defaultResult is returned. If defaultResult is ommitted, then null is returned. If the first argument is null or an empty string, the function returns default value.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "decode(variant,variant,integer,variant,integer,variant...)", "canonical_signature": "integer decode(variant expression, variant search1, integer result1, variant search2, integer result2, variant searchResultPairs...)", "type_parameters": [], "parameters": [ { "position": 0, "name": "expression", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "It compares the expression to each search value one by one, and returns the corresponding result value.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "expression is NULL -> default result.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "search1", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented search1 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "result1", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented result1 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 3, "name": "search2", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented search2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 4, "name": "result2", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented result2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 5, "name": "searchResultPairs", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": true, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented searchResultPairs argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 5, "maximum": "unbounded" }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of decode as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "decode", "basis": "documentation" } ] }, "description": "The decode() function creates a small lookup from search-result pairs. It compares the expression to each search value one by one, and returns the corresponding result value. If no match is found, then defaultResult is returned. If defaultResult is ommitted, then null is returned. If the first argument is null or an empty string, the function returns default value.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "decode", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter search1 is undocumented.", "NULL behavior for parameter result1 is undocumented.", "NULL behavior for parameter search2 is undocumented.", "NULL behavior for parameter result2 is undocumented.", "NULL behavior for parameter searchResultPairs is undocumented." ] } }, { "id": "decode(variant,variant,string,variant,string,variant...)", "canonical_signature": "string decode(variant expression, variant search1, string result1, variant search2, string result2, variant searchResultPairs...)", "type_parameters": [], "parameters": [ { "position": 0, "name": "expression", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "It compares the expression to each search value one by one, and returns the corresponding result value.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "expression is NULL -> default result.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "search1", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented search1 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "result1", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented result1 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 3, "name": "search2", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented search2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 4, "name": "result2", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented result2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 5, "name": "searchResultPairs", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": true, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented searchResultPairs argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 5, "maximum": "unbounded" }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of decode as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "decode", "basis": "documentation" } ] }, "description": "The decode() function creates a small lookup from search-result pairs. It compares the expression to each search value one by one, and returns the corresponding result value. If no match is found, then defaultResult is returned. If defaultResult is ommitted, then null is returned. If the first argument is null or an empty string, the function returns default value.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "decode", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter search1 is undocumented.", "NULL behavior for parameter result1 is undocumented.", "NULL behavior for parameter search2 is undocumented.", "NULL behavior for parameter result2 is undocumented.", "NULL behavior for parameter searchResultPairs is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The decode() function is available since CloverETL 7.5.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "decode", "basis": "documentation" } ] } ], "see_also": [], "evidence": [ { "source_id": "ctl2-string-functions", "section": "decode", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "double2integer": { "name": "double2integer", "category": "conversion", "summary": "The double2integer() function converts a number argument to an integer.", "description": "The double2integer() function converts a number argument to an integer. The conversion is narrowing and if a double value cannot be converted into integer (as the range of double data type does not cover all integer values), the function fails with an error. On the other hand, any integer can be converted into double without loss of precision. If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "double2integer(number)", "canonical_signature": "integer double2integer(number arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of double2integer as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "double2integer", "basis": "documentation" } ] }, "description": "The double2integer() function converts a number argument to an integer. The conversion is narrowing and if a double value cannot be converted into integer (as the range of double data type does not cover all integer values), the function fails with an error. On the other hand, any integer can be converted into double without loss of precision. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "double2integer", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The double2integer(double) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "double2integer", "basis": "documentation" } ] } ], "see_also": [ "round", "roundHalfToEven" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "double2integer", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "double2long": { "name": "double2long", "category": "conversion", "summary": "The double2long() function converts a number argument to long.", "description": "The double2long() function converts a number argument to long. The conversion is narrowing, and if a double value cannot be converted into long (as the range of double data type does not cover all long values), the function fails with an error. On the other hand, any long can always be converted into double; however, the user should take into account that a loss of precision may occur. If the input argument is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "double2long(number)", "canonical_signature": "long double2long(number arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of double2long as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "double2long", "basis": "documentation" } ] }, "description": "The double2long() function converts a number argument to long. The conversion is narrowing, and if a double value cannot be converted into long (as the range of double data type does not cover all long values), the function fails with an error. On the other hand, any long can always be converted into double; however, the user should take into account that a loss of precision may occur. If the input argument is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "double2long", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The double2long(double) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "double2long", "basis": "documentation" } ] } ], "see_also": [ "double2integer", "round", "roundHalfToEven" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "double2long", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "e": { "name": "e", "category": "mathematical", "summary": "The e() function returns the Euler number.", "description": "The e() function returns the Euler number.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "e()", "canonical_signature": "number e()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of e as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "e", "basis": "documentation" } ] }, "description": "The e() function returns the Euler number.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "e", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The e() function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "e", "basis": "documentation" } ] } ], "see_also": [ "exp", "pi" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "e", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "editDistance": { "name": "editDistance", "category": "string", "summary": "The editDistance() function compares two string arguments to each other.", "description": "The editDistance() function compares two string arguments to each other. The strength of comparison is 4 by default, the default value of locale for comparison is the system value and the maximum difference is 3 by default. The function returns the number of letters that should be changed to transform one of the two arguments to the other. However, when the function is being executed, if it counts that the number of letters that should be changed is at least the number specified as the maximum difference, the execution terminates and the function returns maxDifference + 1 as the return value. For more details, see another version of the editDistance() function below - the \"editDistance (string, string, integer, string, integer)\" function. If one or both of the input strings to compare are empty strings or null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "editDistance(string,string)", "canonical_signature": "integer editDistance(string arg1, string arg2)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of editDistance as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "editDistance", "basis": "documentation" } ] }, "description": "The editDistance() function compares two string arguments to each other. The strength of comparison is 4 by default, the default value of locale for comparison is the system value and the maximum difference is 3 by default. The function returns the number of letters that should be changed to transform one of the two arguments to the other. However, when the function is being executed, if it counts that the number of letters that should be changed is at least the number specified as the maximum difference, the execution terminates and the function returns maxDifference + 1 as the return value. For more details, see another version of the editDistance() function below - the \"editDistance (string, string, integer, string, integer)\" function. If one or both of the input strings to compare are empty strings or null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "editDistance", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg1 == NULL", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "arg2 == NULL", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "editDistance(string,string,integer)", "canonical_signature": "integer editDistance(string arg1, string arg2, integer strength)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "strength", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The strength of comparison is 4 by default, the default value of locale for comparison is the system value and the maximum difference is 3 by default.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "strength or maxDifference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of editDistance as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "editDistance", "basis": "documentation" } ] }, "description": "The editDistance() function compares two string arguments to each other. The strength of comparison is 4 by default, the default value of locale for comparison is the system value and the maximum difference is 3 by default. The function returns the number of letters that should be changed to transform one of the two arguments to the other. However, when the function is being executed, if it counts that the number of letters that should be changed is at least the number specified as the maximum difference, the execution terminates and the function returns maxDifference + 1 as the return value. For more details, see another version of the editDistance() function below - the \"editDistance (string, string, integer, string, integer)\" function. If one or both of the input strings to compare are empty strings or null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "editDistance", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg1 == NULL", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "arg2 == NULL", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "strength == NULL", "description": "strength or maxDifference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "editDistance(string,string,integer,integer)", "canonical_signature": "integer editDistance(string arg1, string arg2, integer strength, integer maxDifference)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "strength", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The strength of comparison is 4 by default, the default value of locale for comparison is the system value and the maximum difference is 3 by default.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "strength or maxDifference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "maxDifference", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "However, when the function is being executed, if it counts that the number of letters that should be changed is at least the number specified as the maximum difference, the execution terminates and the function returns maxDifference + 1 as the return value.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "strength or maxDifference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 4, "maximum": 4 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of editDistance as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "editDistance", "basis": "documentation" } ] }, "description": "The editDistance() function compares two string arguments to each other. The strength of comparison is 4 by default, the default value of locale for comparison is the system value and the maximum difference is 3 by default. The function returns the number of letters that should be changed to transform one of the two arguments to the other. However, when the function is being executed, if it counts that the number of letters that should be changed is at least the number specified as the maximum difference, the execution terminates and the function returns maxDifference + 1 as the return value. For more details, see another version of the editDistance() function below - the \"editDistance (string, string, integer, string, integer)\" function. If one or both of the input strings to compare are empty strings or null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "editDistance", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg1 == NULL", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "arg2 == NULL", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "strength == NULL", "description": "strength or maxDifference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "maxDifference == NULL", "description": "strength or maxDifference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "editDistance(string,string,integer,integer)#2", "canonical_signature": "integer editDistance(string arg1, string arg2, integer strength, integer maxDifference)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "strength", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The strength of comparison is 4 by default, the default value of locale for comparison is the system value and the maximum difference is 3 by default.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "strength or maxDifference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "maxDifference", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "However, when the function is being executed, if it counts that the number of letters that should be changed is at least the number specified as the maximum difference, the execution terminates and the function returns maxDifference + 1 as the return value.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "strength or maxDifference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 4, "maximum": 4 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of editDistance as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "editDistance", "basis": "documentation" } ] }, "description": "The editDistance() function compares two string arguments to each other. The strength of comparison is 4 by default, the default value of locale for comparison is the system value and the maximum difference is 3 by default. The function returns the number of letters that should be changed to transform one of the two arguments to the other. However, when the function is being executed, if it counts that the number of letters that should be changed is at least the number specified as the maximum difference, the execution terminates and the function returns maxDifference + 1 as the return value. For more details, see another version of the editDistance() function below - the \"editDistance (string, string, integer, string, integer)\" function. If one or both of the input strings to compare are empty strings or null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "editDistance", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg1 == NULL", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "arg2 == NULL", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "strength == NULL", "description": "strength or maxDifference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "maxDifference == NULL", "description": "strength or maxDifference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "Duplicate normalized overload ID required a stable discriminator." ] } }, { "id": "editDistance(string,string,integer,string)", "canonical_signature": "integer editDistance(string arg1, string arg2, integer strength, string locale)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "strength", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The strength of comparison is 4 by default, the default value of locale for comparison is the system value and the maximum difference is 3 by default.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "strength or maxDifference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The strength of comparison is 4 by default, the default value of locale for comparison is the system value and the maximum difference is 3 by default.", "constraints": [], "null_behavior": { "kind": "accepted", "description": "locale is NULL -> no error; returns a non-NULL result.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 4, "maximum": 4 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of editDistance as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "editDistance", "basis": "documentation" } ] }, "description": "The editDistance() function compares two string arguments to each other. The strength of comparison is 4 by default, the default value of locale for comparison is the system value and the maximum difference is 3 by default. The function returns the number of letters that should be changed to transform one of the two arguments to the other. However, when the function is being executed, if it counts that the number of letters that should be changed is at least the number specified as the maximum difference, the execution terminates and the function returns maxDifference + 1 as the return value. For more details, see another version of the editDistance() function below - the \"editDistance (string, string, integer, string, integer)\" function. If one or both of the input strings to compare are empty strings or null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "editDistance", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg1 == NULL", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "arg2 == NULL", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "strength == NULL", "description": "strength or maxDifference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "editDistance(string,string,integer,string,integer)", "canonical_signature": "integer editDistance(string arg1, string arg2, integer strength, string locale, integer maxDifference)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "strength", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The strength of comparison is 4 by default, the default value of locale for comparison is the system value and the maximum difference is 3 by default.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "strength or maxDifference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The strength of comparison is 4 by default, the default value of locale for comparison is the system value and the maximum difference is 3 by default.", "constraints": [], "null_behavior": { "kind": "accepted", "description": "locale is NULL -> no error; returns a non-NULL result.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 4, "name": "maxDifference", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "However, when the function is being executed, if it counts that the number of letters that should be changed is at least the number specified as the maximum difference, the execution terminates and the function returns maxDifference + 1 as the return value.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "strength or maxDifference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 5, "maximum": 5 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of editDistance as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "editDistance", "basis": "documentation" } ] }, "description": "The editDistance() function compares two string arguments to each other. The strength of comparison is 4 by default, the default value of locale for comparison is the system value and the maximum difference is 3 by default. The function returns the number of letters that should be changed to transform one of the two arguments to the other. However, when the function is being executed, if it counts that the number of letters that should be changed is at least the number specified as the maximum difference, the execution terminates and the function returns maxDifference + 1 as the return value. For more details, see another version of the editDistance() function below - the \"editDistance (string, string, integer, string, integer)\" function. If one or both of the input strings to compare are empty strings or null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "editDistance", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg1 == NULL", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "arg2 == NULL", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "strength == NULL", "description": "strength or maxDifference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "maxDifference == NULL", "description": "strength or maxDifference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "editDistance(string,string,string)", "canonical_signature": "integer editDistance(string arg1, string arg2, string locale)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The strength of comparison is 4 by default, the default value of locale for comparison is the system value and the maximum difference is 3 by default.", "constraints": [], "null_behavior": { "kind": "accepted", "description": "locale is NULL -> no error; returns a non-NULL result.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of editDistance as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "editDistance", "basis": "documentation" } ] }, "description": "The editDistance() function compares two string arguments to each other. The strength of comparison is 4 by default, the default value of locale for comparison is the system value and the maximum difference is 3 by default. The function returns the number of letters that should be changed to transform one of the two arguments to the other. However, when the function is being executed, if it counts that the number of letters that should be changed is at least the number specified as the maximum difference, the execution terminates and the function returns maxDifference + 1 as the return value. For more details, see another version of the editDistance() function below - the \"editDistance (string, string, integer, string, integer)\" function. If one or both of the input strings to compare are empty strings or null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "editDistance", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg1 == NULL", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "arg2 == NULL", "description": "arg1 or arg2 is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The editDistance() function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "editDistance", "basis": "documentation" } ] } ], "see_also": [ "NYSIIS", "metaphone", "soundex" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "editDistance", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "endsWith": { "name": "endsWith", "category": "string", "summary": "The function endsWith() checks whether the string str ends with the substr string.", "description": "The function endsWith() checks whether the string str ends with the substr string. If the parameter str is null, the function returns false. If the parameter substr is null, the function fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "endsWith(string,string)", "canonical_signature": "boolean endsWith(string str, string substr)", "type_parameters": [], "parameters": [ { "position": 0, "name": "str", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function endsWith() checks whether the string str ends with the substr string.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "substr is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "substr", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function endsWith() checks whether the string str ends with the substr string.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "substr is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of endsWith as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "endsWith", "basis": "documentation" } ] }, "description": "The function endsWith() checks whether the string str ends with the substr string. If the parameter str is null, the function returns false. If the parameter substr is null, the function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "endsWith", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "str == NULL", "description": "substr is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "substr == NULL", "description": "substr is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The endsWith(string,string) function is available since CloverETL 4.0.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "endsWith", "basis": "documentation" } ] } ], "see_also": [ "contains", "startsWith" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "endsWith", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "escapeJson": { "name": "escapeJson", "category": "string", "summary": "The escapeJson function converts string to Json value safe string.", "description": "The escapeJson function converts string to Json value safe string.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "escapeJson(string)", "canonical_signature": "string escapeJson(string input)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented input argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "escapeJson/escapeXML input NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of escapeJson as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "escapeJson/escapeXML input NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "escapeJson", "basis": "documentation" } ] }, "description": "The escapeJson function converts string to Json value safe string.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "escapeJson", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The escapeJson(string) function is available since CloverDX 7.5.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "escapeJson", "basis": "documentation" } ] } ], "see_also": [ "unescapeJson" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "escapeJson", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "escapeUrl": { "name": "escapeUrl", "category": "string", "summary": "The escapeUrl() function escapes illegal characters within components of a specified URL (for the URL component description, see isUrl).", "description": "The escapeUrl() function escapes illegal characters within components of a specified URL (for the URL component description, see isUrl). Illegal characters must be escaped by a percent (%) symbol, followed by the two-digit hexadecimal representation (case-insensitive) of the ISO-Latin code point for the character, e.g. %20 is the escaped encoding for the US-ASCII space character. The function accepts a valid URL only. For an invalid URL, empty string or null input, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "escapeUrl(string)", "canonical_signature": "string escapeUrl(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of escapeUrl as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "escapeUrl", "basis": "documentation" } ] }, "description": "The escapeUrl() function escapes illegal characters within components of a specified URL (for the URL component description, see isUrl). Illegal characters must be escaped by a percent (%) symbol, followed by the two-digit hexadecimal representation (case-insensitive) of the ISO-Latin code point for the character, e.g. %20 is the escaped encoding for the US-ASCII space character. The function accepts a valid URL only. For an invalid URL, empty string or null input, the function fails with an error.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "escapeUrl", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The escapeUrl(string) function is available since CloverETL 3.1.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "escapeUrl", "basis": "documentation" } ] } ], "see_also": [ "escapeUrlFragment", "isUrl", "unescapeUrl", "unescapeUrlFragment" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "escapeUrl", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "escapeUrlFragment": { "name": "escapeUrlFragment", "category": "string", "summary": "The escapeUrlFragment function escapes potentially obtrusive characters.", "description": "The escapeUrlFragment function escapes potentially obtrusive characters. The input parameter is a string to be escaped. If the input is null, the null is returned. The optional parameter encoding enables to change encoding of the result string. The default encoding is UTF-8. If the encoding is null function fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "escapeUrlFragment(string)", "canonical_signature": "string escapeUrlFragment(string input)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The input parameter is a string to be escaped.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of escapeUrlFragment as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "escapeUrlFragment", "basis": "documentation" } ] }, "description": "The escapeUrlFragment function escapes potentially obtrusive characters. The input parameter is a string to be escaped. If the input is null, the null is returned. The optional parameter encoding enables to change encoding of the result string. The default encoding is UTF-8. If the encoding is null function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "escapeUrlFragment", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "escapeUrlFragment(string,string)", "canonical_signature": "string escapeUrlFragment(string input, string encoding)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The input parameter is a string to be escaped.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "encoding", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The optional parameter encoding enables to change encoding of the result string.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "encoding is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of escapeUrlFragment as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "escapeUrlFragment", "basis": "documentation" } ] }, "description": "The escapeUrlFragment function escapes potentially obtrusive characters. The input parameter is a string to be escaped. If the input is null, the null is returned. The optional parameter encoding enables to change encoding of the result string. The default encoding is UTF-8. If the encoding is null function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "escapeUrlFragment", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "encoding == NULL", "description": "encoding is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The escapeUrlFragment(string) function is available since CloverETL 4.0.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "escapeUrlFragment", "basis": "documentation" } ] } ], "see_also": [ "escapeUrl", "isUrl", "unescapeUrl", "unescapeUrlFragment" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "escapeUrlFragment", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "escapeXML": { "name": "escapeXML", "category": "string", "summary": "The escapeXML function replaces all occurence of XML special entities with their escaped alternatives (XML entities).", "description": "The escapeXML function replaces all occurence of XML special entities with their escaped alternatives (XML entities). By using the escapeXML function, you can safely incorporate user-generated content, external data, or any other string values into your XML documents without worrying about invalid XML syntax or potential security issues like XML injection attacks. List of reserved characters: ' , \", &, <, >", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "escapeXML(string)", "canonical_signature": "string escapeXML(string input)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented input argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "escapeJson/escapeXML input NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of escapeXML as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "escapeJson/escapeXML input NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "escapeXML", "basis": "documentation" } ] }, "description": "The escapeXML function replaces all occurence of XML special entities with their escaped alternatives (XML entities). By using the escapeXML function, you can safely incorporate user-generated content, external data, or any other string values into your XML documents without worrying about invalid XML syntax or potential security issues like XML injection attacks. List of reserved characters: ' , \", &, <, >", "evidence": [ { "source_id": "ctl2-string-functions", "section": "escapeXML", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The escapeXML(string) function is available since CloverDX 6.4.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "escapeXML", "basis": "documentation" } ] } ], "see_also": [ "unescapeXML" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "escapeXML", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "evalExpression": { "name": "evalExpression", "category": "miscellaneous", "summary": "The evalExpression() function evaluates the result of a given expression and returns it as a variant data type.", "description": "The evalExpression() function evaluates the result of a given expression and returns it as a variant data type. This function is useful for performing dynamic calculations, user-provided expressions, or evaluating conditional statements at runtime. Potential use cases for the evalExpression function include: Implementing custom business logic or rules using a more human-readable expression syntax. Dynamic calculations based on user input or configuration settings. Parsing and evaluating expressions from external sources, such as files or databases. Basic syntax for using the function: In this example, the expression variable is assigned the value of the USER_PROVIDED_CONDITION graph parameter using the getParamValue function. This demonstrates a use case where the condition to be evaluated is provided dynamically by the user at runtime. In the example user specifies a condition, which checks input field isValid from first input port. The value of expression is then passed to the evalExpression function, which evaluates the expression and returns the result as a variant data type. Please note, if you need to get the actual value with a proper data type, the cast function could be used. The expression parameter is a string containing the expression to be evaluated. The expression can include arithmetic, logical, or relational operators, as well as functions and constants supported by the CTL engine. The only requirement is the expression should return a value, for, if or other statements are not allowed. In addition to simple expressions, the evalExpression function can handle more complex logic using custom functions. To reference external custom functions, make sure the function is defined and accessible within the scope of the evalExpression function. The custom function should accept input parameters as needed and return a value that can be used within the expression. .Example of using a custom function: The external file myCustomFunctions.ctl is: Error handling In case the provided expression is invalid or causes a runtime error, the evalExpression function generates an exception. To handle these exceptions, use a try-catch block with the CTLException exception type. Error handling is important when using the evalExpression function because it is designed for defining external expressions, mainly from users or from dynamic configurations. Therefore, it is necessary to check for syntax and runtime errors. In case the expression is propagated from outside, it is essential to ensure proper error handling to prevent unexpected behavior or crashes in the application. .Error handling The external file myCustomFunctions.ctl is: In this example, a runtime exception will occur because b is equal to 0, which will cause a division by zero error. The actual source of the exception is in the doCalculation function (which is an external). In this example, the issue occurred on line 7 of the transformation, but the actual error is in myCustomFunctions.ctl on line 2. .Error output Example of error handling with the evalExpression function: .Error handling", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "evalExpression(string)", "canonical_signature": "variant evalExpression(string expression)", "type_parameters": [], "parameters": [ { "position": 0, "name": "expression", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The evalExpression() function evaluates the result of a given expression and returns it as a variant data type.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "variant", "display": "variant" }, "description": "Return value of evalExpression as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "evalExpression", "basis": "documentation" } ] }, "description": "The evalExpression() function evaluates the result of a given expression and returns it as a variant data type. This function is useful for performing dynamic calculations, user-provided expressions, or evaluating conditional statements at runtime. Potential use cases for the evalExpression function include: Implementing custom business logic or rules using a more human-readable expression syntax. Dynamic calculations based on user input or configuration settings. Parsing and evaluating expressions from external sources, such as files or databases. Basic syntax for using the function: In this example, the expression variable is assigned the value of the USER_PROVIDED_CONDITION graph parameter using the getParamValue function. This demonstrates a use case where the condition to be evaluated is provided dynamically by the user at runtime. In the example user specifies a condition, which checks input field isValid from first input port. The value of expression is then passed to the evalExpression function, which evaluates the expression and returns the result as a variant data type. Please note, if you need to get the actual value with a proper data type, the cast function could be used. The expression parameter is a string containing the expression to be evaluated. The expression can include arithmetic, logical, or relational operators, as well as functions and constants supported by the CTL engine. The only requirement is the expression should return a value, for, if or other statements are not allowed. In addition to simple expressions, the evalExpression function can handle more complex logic using custom functions. To reference external custom functions, make sure the function is defined and accessible within the scope of the evalExpression function. The custom function should accept input parameters as needed and return a value that can be used within the expression. .Example of using a custom function: The external file myCustomFunctions.ctl is: Error handling In case the provided expression is invalid or causes a runtime error, the evalExpression function generates an exception. To handle these exceptions, use a try-catch block with the CTLException exception type. Error handling is important when using the evalExpression function because it is designed for defining external expressions, mainly from users or from dynamic configurations. Therefore, it is necessary to check for syntax and runtime errors. In case the expression is propagated from outside, it is essential to ensure proper error handling to prevent unexpected behavior or crashes in the application. .Error handling The external file myCustomFunctions.ctl is: In this example, a runtime exception will occur because b is equal to 0, which will cause a division by zero error. The actual source of the exception is in the doCalculation function (which is an external). In this example, the issue occurred on line 7 of the transformation, but the actual error is in myCustomFunctions.ctl on line 2. .Error output Example of error handling with the evalExpression function: .Error handling", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "evalExpression", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter expression is undocumented." ] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "evalExpression", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "exp": { "name": "exp", "category": "mathematical", "summary": "The exp() function returns the result of the exponential function of the given argument.", "description": "The exp() function returns the result of the exponential function of the given argument. The argument can be of any numeric data type (integer, long, number, or decimal). If the given argument is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "exp(decimal)", "canonical_signature": "number exp(decimal arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of exp as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "exp", "basis": "documentation" } ] }, "description": "The exp() function returns the result of the exponential function of the given argument. The argument can be of any numeric data type (integer, long, number, or decimal). If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "exp", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "exp(integer)", "canonical_signature": "number exp(integer arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of exp as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "exp", "basis": "documentation" } ] }, "description": "The exp() function returns the result of the exponential function of the given argument. The argument can be of any numeric data type (integer, long, number, or decimal). If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "exp", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "exp(long)", "canonical_signature": "number exp(long arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of exp as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "exp", "basis": "documentation" } ] }, "description": "The exp() function returns the result of the exponential function of the given argument. The argument can be of any numeric data type (integer, long, number, or decimal). If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "exp", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "exp(number)", "canonical_signature": "number exp(number arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of exp as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "exp", "basis": "documentation" } ] }, "description": "The exp() function returns the result of the exponential function of the given argument. The argument can be of any numeric data type (integer, long, number, or decimal). If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "exp", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The exp(decimal) and exp(number) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "exp", "basis": "documentation" } ] } ], "see_also": [ "e", "log", "log10", "pow" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "exp", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "extractDate": { "name": "extractDate", "category": "date", "summary": "The extractDate function takes a date argument and returns only the information containing year, month, and day values.", "description": "The extractDate function takes a date argument and returns only the information containing year, month, and day values. The function's argument is not modified by the return value. If the input argument is null, the function returns null. The default locale and default time zone are applied.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "extractDate(date)", "canonical_signature": "date extractDate(date arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of extractDate as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "extractDate", "basis": "documentation" } ] }, "description": "The extractDate function takes a date argument and returns only the information containing year, month, and day values. The function's argument is not modified by the return value. If the input argument is null, the function returns null. The default locale and default time zone are applied.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "extractDate", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The extractDate(date) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "extractDate", "basis": "documentation" } ] } ], "see_also": [ "extractTime", "str2date" ], "evidence": [ { "source_id": "ctl2-date-functions", "section": "extractDate", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "extractTime": { "name": "extractTime", "category": "date", "summary": "The extractTime() function takes a date argument and returns only the information containing hours, minutes, seconds, and milliseconds.", "description": "The extractTime() function takes a date argument and returns only the information containing hours, minutes, seconds, and milliseconds. The function's argument is not modified by the return value. If the input argument is null, the function returns null. The default locale and default time zone are applied.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "extractTime(date)", "canonical_signature": "date extractTime(date arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of extractTime as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "extractTime", "basis": "documentation" } ] }, "description": "The extractTime() function takes a date argument and returns only the information containing hours, minutes, seconds, and milliseconds. The function's argument is not modified by the return value. If the input argument is null, the function returns null. The default locale and default time zone are applied.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "extractTime", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The extractTime(date) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "extractTime", "basis": "documentation" } ] } ], "see_also": [ "extractDate", "str2date" ], "evidence": [ { "source_id": "ctl2-date-functions", "section": "extractTime", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "find": { "name": "find", "category": "string", "summary": "The find() function returns a list of substrings corresponding to the _regular expression_ pattern that is found in the second argument.", "description": "The find() function returns a list of substrings corresponding to the _regular expression_ pattern that is found in the second argument. If the second argument is an empty string, the function returns a list of empty strings. The sum of empty strings in the list is same as the length of the original string plus one; e.g. the string 'mark' results in the list of five empty strings. If one or both of the two arguments are null value, the function fails with an error. The third argument specifies which regular expression group to use.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "find(string,string)", "canonical_signature": "string[] find(string arg, string regex)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or regex is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "regex", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented regex argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or regex is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "list", "element": { "kind": "named", "name": "string", "display": "string" }, "display": "string[]" }, "description": "Return value of find as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "find", "basis": "documentation" } ] }, "description": "The find() function returns a list of substrings corresponding to the _regular expression_ pattern that is found in the second argument. If the second argument is an empty string, the function returns a list of empty strings. The sum of empty strings in the list is same as the length of the original string plus one; e.g. the string 'mark' results in the list of five empty strings. If one or both of the two arguments are null value, the function fails with an error. The third argument specifies which regular expression group to use.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "find", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg or regex is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "regex == NULL", "description": "arg or regex is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "find(string,string,integer)", "canonical_signature": "string[] find(string arg, string regex, integer group_number)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or regex is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "regex", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented regex argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or regex is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "group_number", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented group_number argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "group_number is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "list", "element": { "kind": "named", "name": "string", "display": "string" }, "display": "string[]" }, "description": "Return value of find as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "find", "basis": "documentation" } ] }, "description": "The find() function returns a list of substrings corresponding to the _regular expression_ pattern that is found in the second argument. If the second argument is an empty string, the function returns a list of empty strings. The sum of empty strings in the list is same as the length of the original string plus one; e.g. the string 'mark' results in the list of five empty strings. If one or both of the two arguments are null value, the function fails with an error. The third argument specifies which regular expression group to use.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "find", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg or regex is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "regex == NULL", "description": "arg or regex is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "group_number == NULL", "description": "group_number is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The find(string,string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "find", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The find(string,string,integer) function is available since CloverETL 3.4.x.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "find", "basis": "documentation" } ] } ], "see_also": [ "matchGroups" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "find", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "findAllValues": { "name": "findAllValues", "category": "container", "summary": "Returns the list of all values associated with the specified key at any level of the structure passed as the first argument.", "description": "Returns the list of all values associated with the specified key at any level of the structure passed as the first argument. Returns an empty list if nothing is found. The container can be of any data type, however if it contains no map, the result will be an empty list. === Error states If the key is a record, byte, or cbyte array, the function fails with an error. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "findAllValues(variant,variant)", "canonical_signature": "variant findAllValues(variant container, variant key)", "type_parameters": [], "parameters": [ { "position": 0, "name": "container", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The container can be of any data type, however if it contains no map, the result will be an empty list.", "constraints": [], "null_behavior": { "kind": "accepted", "description": "container is NULL -> no error; returns a non-NULL result.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "key", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Returns the list of all values associated with the specified key at any level of the structure passed as the first argument.", "constraints": [], "null_behavior": { "kind": "accepted", "description": "key is NULL -> no error; returns a non-NULL result.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "variant", "display": "variant" }, "description": "Return value of findAllValues as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "findAllValues", "basis": "documentation" } ] }, "description": "Returns the list of all values associated with the specified key at any level of the structure passed as the first argument. Returns an empty list if nothing is found. The container can be of any data type, however if it contains no map, the result will be an empty list. === Error states If the key is a record, byte, or cbyte array, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "findAllValues", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-container-functions", "section": "findAllValues", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "floor": { "name": "floor", "category": "mathematical", "summary": "The floor() function returns the largest (closest to positive infinity) value that is less than or equal to the argument and is equal to a mathematical integer.", "description": "The floor() function returns the largest (closest to positive infinity) value that is less than or equal to the argument and is equal to a mathematical integer. It returns number (double) for integer, long and number and it returns decimal for decimal. If the given argument is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "floor(decimal)", "canonical_signature": "decimal floor(decimal arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "description": "Return value of floor as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "floor", "basis": "documentation" } ] }, "description": "The floor() function returns the largest (closest to positive infinity) value that is less than or equal to the argument and is equal to a mathematical integer. It returns number (double) for integer, long and number and it returns decimal for decimal. If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "floor", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "floor(number)", "canonical_signature": "number floor(number arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of floor as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "floor", "basis": "documentation" } ] }, "description": "The floor() function returns the largest (closest to positive infinity) value that is less than or equal to the argument and is equal to a mathematical integer. It returns number (double) for integer, long and number and it returns decimal for decimal. If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "floor", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The floor(decimal) and floor(number) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "floor", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The function returns number for all input numeric data types in CloverETL 3.4 and older.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "floor", "basis": "documentation" } ] } ], "see_also": [ "ceil", "round", "roundHalfToEven" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "floor", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "formatMessage": { "name": "formatMessage", "category": "string", "summary": "The formatMessage(string template, variant param1, variant ..., variant paramN) function returns a formatted message where the parameters referenced in the input template are replaced with their corresponding values.", "description": "The formatMessage(string template, variant param1, variant ..., variant paramN) function returns a formatted message where the parameters referenced in the input template are replaced with their corresponding values. This function is useful for constructing messages with dynamic content in a structured and readable manner. The template argument can also incorporate multi-line strings. This allows for the creation of more complex message formats that span multiple lines. A basic example: formatMessage(\"Name of the applicant is {0}. He is {1} years old.\", \"John Doe\", 32) returns \"Name of the applicant is John Doe. He is 32 years old.\" Where {0} references the first input parameter and {1} the second. The parameters can be of any type supported by the variant data type. In the message template string, placeholders are enclosed in curly braces {}. The format of a placeholder can be as simple as a number indicating the position of the parameter, like {0}, {1}, etc. However, the placeholders can also include additional formatting information, such as data type, style, or custom patterns. Here's a breakdown of the placeholder format: {argument_index[,format_type[,format_style]]} . argument_index: A non-negative integer indicating the position of the parameter in the input parameters. The index is 0-based, so the first parameter is referenced as {0}, the second as {1}, and so on. . format_type (optional): A string indicating the data type of the parameter. Supported types include number, date, time, and choice. If not specified, the parameter is treated as a plain string. . format_style (optional): A string indicating the formatting style for the specified data type. For example, short, medium, long, full, integer, currency, percent, or SubformatPattern. For more information refer to Oracle's documentation on the Java java.text.MessageFormat syntax https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html[here], Here are some examples of placeholders with different formats: . {0}: A simple placeholder that references the first parameter. . {1, number, integer}: A placeholder that formats the second parameter as an integer number. . {2, date, short}: A placeholder that formats the third parameter as a short date. . {3, time, medium}: A placeholder that formats the fourth parameter as a medium-style time. . {4, number,$'\\#',##}: A placeholder that formats the fifth parameter with the pound sign quoted. By understanding the https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html[Java java.text.MessageFormat syntax] and the various formatting options available, you can create more sophisticated and customized message templates for your applications. The formatMessage and formatMessageWithLocale functions support using multi-line strings strings as the template, which can help improve the readability and formatting of complex templates.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "formatMessage(string,variant,variant...)", "canonical_signature": "string formatMessage(string template, variant param1, variant argN...)", "type_parameters": [], "parameters": [ { "position": 0, "name": "template", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The formatMessage(string template, variant param1, variant ..., variant paramN) function returns a formatted message where the parameters referenced in the input template are replaced with their corresponding values.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "formatMessage template NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "param1", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The formatMessage(string template, variant param1, variant ..., variant paramN) function returns a formatted message where the parameters referenced in the input template are replaced with their corresponding values.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "argN", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": true, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented argN argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": "unbounded" }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of formatMessage as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "template == NULL", "behavior": { "kind": "returns_null", "description": "formatMessage template NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "formatMessage", "basis": "documentation" } ] }, "description": "The formatMessage(string template, variant param1, variant ..., variant paramN) function returns a formatted message where the parameters referenced in the input template are replaced with their corresponding values. This function is useful for constructing messages with dynamic content in a structured and readable manner. The template argument can also incorporate multi-line strings. This allows for the creation of more complex message formats that span multiple lines. A basic example: formatMessage(\"Name of the applicant is {0}. He is {1} years old.\", \"John Doe\", 32) returns \"Name of the applicant is John Doe. He is 32 years old.\" Where {0} references the first input parameter and {1} the second. The parameters can be of any type supported by the variant data type. In the message template string, placeholders are enclosed in curly braces {}. The format of a placeholder can be as simple as a number indicating the position of the parameter, like {0}, {1}, etc. However, the placeholders can also include additional formatting information, such as data type, style, or custom patterns. Here's a breakdown of the placeholder format: {argument_index[,format_type[,format_style]]} . argument_index: A non-negative integer indicating the position of the parameter in the input parameters. The index is 0-based, so the first parameter is referenced as {0}, the second as {1}, and so on. . format_type (optional): A string indicating the data type of the parameter. Supported types include number, date, time, and choice. If not specified, the parameter is treated as a plain string. . format_style (optional): A string indicating the formatting style for the specified data type. For example, short, medium, long, full, integer, currency, percent, or SubformatPattern. For more information refer to Oracle's documentation on the Java java.text.MessageFormat syntax https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html[here], Here are some examples of placeholders with different formats: . {0}: A simple placeholder that references the first parameter. . {1, number, integer}: A placeholder that formats the second parameter as an integer number. . {2, date, short}: A placeholder that formats the third parameter as a short date. . {3, time, medium}: A placeholder that formats the fourth parameter as a medium-style time. . {4, number,$'\\#',##}: A placeholder that formats the fifth parameter with the pound sign quoted. By understanding the https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html[Java java.text.MessageFormat syntax] and the various formatting options available, you can create more sophisticated and customized message templates for your applications. The formatMessage and formatMessageWithLocale functions support using multi-line strings strings as the template, which can help improve the readability and formatting of complex templates.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "formatMessage", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter param1 is undocumented.", "NULL behavior for parameter argN is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The formatMessage(string,variant) and formatMessageWithLocale(string,string,variant) functions", "evidence": [ { "source_id": "ctl2-string-functions", "section": "formatMessage", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "are available since CloverDX 6.4.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "formatMessage", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "ifdef::false[]", "evidence": [ { "source_id": "ctl2-string-functions", "section": "formatMessage", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": ".Example 1", "evidence": [ { "source_id": "ctl2-string-functions", "section": "formatMessage", "basis": "documentation" } ] } ], "see_also": [], "evidence": [ { "source_id": "ctl2-string-functions", "section": "formatMessage", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "get": { "name": "get", "category": "lookup_table", "summary": "lookup().get(keyValue) The function get searches the first record whose key value is equal to the value specified in the get(keyValue) function.", "description": "lookup().get(keyValue) The function get searches the first record whose key value is equal to the value specified in the get(keyValue) function. It returns the record of the lookup table. You can map it to other records in CTL2 (with the same metadata). If you want to get the value of the field, you can add the $$.$$ part to the expression or $$.$$* to get the values of all fields. If there is no record with the requested keyValue in the lookup table, the function returns null. The keyVal in the function is a sequence of values of the field names separated by comma (not semicolon!). The key has the following form: keyValuePart1,keyValuePart2,...,keyValuePartN.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "get(any...)", "canonical_signature": "any get(any keyValue...)", "type_parameters": [], "parameters": [ { "position": 0, "name": "keyValue", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": true, "default": { "kind": "none", "description": "No documented default." }, "description": "lookup().get(keyValue) The function get searches the first record whose key value is equal to the value specified in the get(keyValue) function.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "get", "basis": "documentation" } ] } ], "arity": { "minimum": 0, "maximum": "unbounded" }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of get as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "get", "basis": "documentation" } ] }, "description": "lookup().get(keyValue) The function get searches the first record whose key value is equal to the value specified in the get(keyValue) function. It returns the record of the lookup table. You can map it to other records in CTL2 (with the same metadata). If you want to get the value of the field, you can add the $$.$$ part to the expression or $$.$$* to get the values of all fields. If there is no record with the requested keyValue in the lookup table, the function returns null. The keyVal in the function is a sequence of values of the field names separated by comma (not semicolon!). The key has the following form: keyValuePart1,keyValuePart2,...,keyValuePartN.", "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "get", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [ "The source documents an inline callable form but no formal typed signature.", "NULL behavior for parameter keyValue is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The get(string) function is available since CloverETL 3.2.2 or earlier.", "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "get", "basis": "documentation" } ] } ], "see_also": [ "count", "next", "put" ], "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "get", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [ "No formal typed signature was found; an explicitly partial inline-call record was created." ] } }, "getAlphanumericChars": { "name": "getAlphanumericChars", "category": "string", "summary": "The getAlphanumericChars() function returns only letters and digits contained in a given argument in the order of their appearance in the string.", "description": "The getAlphanumericChars() function returns only letters and digits contained in a given argument in the order of their appearance in the string. The other characters are removed. For an empty string input, the function returns an empty string. For null input, the function returns null. If the takeAlpha is present and set to true and takeNumeric is set to false, the function will return letters only. If the takeNumeric is present and set to true and takeAlpha is set to false, the function will return numbers only.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getAlphanumericChars(string)", "canonical_signature": "string getAlphanumericChars(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getAlphanumericChars as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "getAlphanumericChars", "basis": "documentation" } ] }, "description": "The getAlphanumericChars() function returns only letters and digits contained in a given argument in the order of their appearance in the string. The other characters are removed. For an empty string input, the function returns an empty string. For null input, the function returns null. If the takeAlpha is present and set to true and takeNumeric is set to false, the function will return letters only. If the takeNumeric is present and set to true and takeAlpha is set to false, the function will return numbers only.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getAlphanumericChars", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "getAlphanumericChars(string,boolean,boolean)", "canonical_signature": "string getAlphanumericChars(string arg, boolean takeAlpha, boolean takeNumeric)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "takeAlpha", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the takeAlpha is present and set to true and takeNumeric is set to false, the function will return letters only.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "takeAlpha or takeNumeric is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "takeNumeric", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the takeAlpha is present and set to true and takeNumeric is set to false, the function will return letters only.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "takeAlpha or takeNumeric is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getAlphanumericChars as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "getAlphanumericChars", "basis": "documentation" } ] }, "description": "The getAlphanumericChars() function returns only letters and digits contained in a given argument in the order of their appearance in the string. The other characters are removed. For an empty string input, the function returns an empty string. For null input, the function returns null. If the takeAlpha is present and set to true and takeNumeric is set to false, the function will return letters only. If the takeNumeric is present and set to true and takeAlpha is set to false, the function will return numbers only.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getAlphanumericChars", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "takeAlpha == NULL", "description": "takeAlpha or takeNumeric is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "takeNumeric == NULL", "description": "takeAlpha or takeNumeric is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getAlphanumericChars(string) and getAlphanumericChars(string,boolean,boolean) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getAlphanumericChars", "basis": "documentation" } ] } ], "see_also": [ "removeBlankSpace", "removeDiacritic", "removeNonAscii" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "getAlphanumericChars", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getAvroSchema": { "name": "getAvroSchema", "category": "conversion", "summary": "Converts variant data type to Avro schema.", "description": "Converts variant data type to Avro schema. Resulted string contains JSON representation of Avro schema. This function should be used for one-time operations only. Using it together with parseAvro or writeAvro to generate schema for each processed record would reduce performance. .Schema generation from CTL types |=== h|CTL h|Avro h|Note |null value |null type |null value is considered to be different type than any instance |boolean |boolean | |byte, cbyte |bytes | |date |long, logicalType: timestamp-millis | |decimal |bytes, logicalType: decimal |precision: 32, scale: 16 |integer |int | |long |long | |number |double | |string |string | |list[type1] |array of type1 |items are of the same type type1 |list[type1, type2, ...] |array of union of type1, type2, ... |items are of different types (like null, string, map, ...) |map{string -> type1} |map(string) of type1 |keys are of type string; values are of the same type as type1 |map{string -> type1, type2, ...} |record |keys are of type string, keys become field names; values are of different types (like null, integer, string, list, map, ...) |map{noString -> type1} |map (string) of type1 |keys become strings; values are of the same type type1 |map{noString -> type1, type2, ...} |map (string) of union of type1, type2, ... |keys become strings; values are of different types (like null, string, map, ...) |===", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getAvroSchema(variant)", "canonical_signature": "string getAvroSchema(variant object)", "type_parameters": [], "parameters": [ { "position": 0, "name": "object", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented object argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "Input parameter NULL behavior -> not documented.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getAvroSchema as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "getAvroSchema", "basis": "documentation" } ] }, "description": "Converts variant data type to Avro schema. Resulted string contains JSON representation of Avro schema. This function should be used for one-time operations only. Using it together with parseAvro or writeAvro to generate schema for each processed record would reduce performance. .Schema generation from CTL types |=== h|CTL h|Avro h|Note |null value |null type |null value is considered to be different type than any instance |boolean |boolean | |byte, cbyte |bytes | |date |long, logicalType: timestamp-millis | |decimal |bytes, logicalType: decimal |precision: 32, scale: 16 |integer |int | |long |long | |number |double | |string |string | |list[type1] |array of type1 |items are of the same type type1 |list[type1, type2, ...] |array of union of type1, type2, ... |items are of different types (like null, string, map, ...) |map{string -> type1} |map(string) of type1 |keys are of type string; values are of the same type as type1 |map{string -> type1, type2, ...} |record |keys are of type string, keys become field names; values are of different types (like null, integer, string, list, map, ...) |map{noString -> type1} |map (string) of type1 |keys become strings; values are of the same type type1 |map{noString -> type1, type2, ...} |map (string) of union of type1, type2, ... |keys become strings; values are of different types (like null, string, map, ...) |===", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "getAvroSchema", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter object is undocumented." ] } } ], "compatibility": [], "see_also": [ "parseAvro", "writeAvro" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "getAvroSchema", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getBoolValue": { "name": "getBoolValue", "category": "record", "summary": "The getBoolValue() function returns the value of a boolean field.", "description": "The getBoolValue() function returns the value of a boolean field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getBoolValue(record,integer)", "canonical_signature": "boolean getBoolValue(record record, integer fieldIndex)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "fieldIndex", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented fieldIndex argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of getBoolValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getBoolValue", "basis": "documentation" } ] }, "description": "The getBoolValue() function returns the value of a boolean field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getBoolValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter fieldIndex is undocumented." ] } }, { "id": "getBoolValue(record,string)", "canonical_signature": "boolean getBoolValue(record record, string fieldName)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "fieldName", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented fieldName argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of getBoolValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getBoolValue", "basis": "documentation" } ] }, "description": "The getBoolValue() function returns the value of a boolean field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getBoolValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter fieldName is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getBoolValue(reference, integer) and getBoolValue(reference,string) functions are available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getBoolValue", "basis": "documentation" } ] } ], "see_also": [ "getByteValue", "getDateValue", "getDecimalValue", "getIntValue", "getLongValue", "getNumValue", "getStringValue", "getValueAsString", "setBoolValue" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "getBoolValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getByteValue": { "name": "getByteValue", "category": "record", "summary": "The getByteValue() function returns the value of a byte field.", "description": "The getByteValue() function returns the value of a byte field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getByteValue(record,integer)", "canonical_signature": "byte getByteValue(record record, integer fieldIndex)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "fieldIndex", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented fieldIndex argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of getByteValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getByteValue", "basis": "documentation" } ] }, "description": "The getByteValue() function returns the value of a byte field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getByteValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter fieldIndex is undocumented." ] } }, { "id": "getByteValue(record,string)", "canonical_signature": "byte getByteValue(record record, string fieldName)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "fieldName", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented fieldName argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of getByteValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getByteValue", "basis": "documentation" } ] }, "description": "The getByteValue() function returns the value of a byte field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getByteValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter fieldName is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getByteValue(record,integer) and getByteValue(record,string) functions are available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getByteValue", "basis": "documentation" } ] } ], "see_also": [ "getBoolValue", "getDateValue", "getDecimalValue", "getIntValue", "getLongValue", "getNumValue", "getStringValue", "getValueAsString", "setByteValue" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "getByteValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getComponentProperty": { "name": "getComponentProperty", "category": "string", "summary": "The function getComponentProperty() returns value of a component attribute.", "description": "The function getComponentProperty() returns value of a component attribute. The propertyName argument is a name of an attribute of a component. If propertyName is null, the function getComponentProperty() returns null. If propertyName does not match the name of any existing attribute, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getComponentProperty(string)", "canonical_signature": "string getComponentProperty(string propertyName)", "type_parameters": [], "parameters": [ { "position": 0, "name": "propertyName", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The propertyName argument is a name of an attribute of a component.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "propertyName is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getComponentProperty as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "propertyName == NULL", "behavior": { "kind": "returns_null", "description": "propertyName is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "getComponentProperty", "basis": "documentation" } ] }, "description": "The function getComponentProperty() returns value of a component attribute. The propertyName argument is a name of an attribute of a component. If propertyName is null, the function getComponentProperty() returns null. If propertyName does not match the name of any existing attribute, the function returns null.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getComponentProperty", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getComponentProperty() function is available since CloverETL 4.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getComponentProperty", "basis": "documentation" } ] } ], "see_also": [ "toProjectUrl" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "getComponentProperty", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getDateValue": { "name": "getDateValue", "category": "record", "summary": "The getDateValue() function returns the value of a date field.", "description": "The getDateValue() function returns the value of a date field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getDateValue(record,integer)", "canonical_signature": "date getDateValue(record record, integer fieldIndex)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "fieldIndex", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented fieldIndex argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of getDateValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getDateValue", "basis": "documentation" } ] }, "description": "The getDateValue() function returns the value of a date field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getDateValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter fieldIndex is undocumented." ] } }, { "id": "getDateValue(record,string)", "canonical_signature": "date getDateValue(record record, string fieldName)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "fieldName", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented fieldName argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of getDateValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getDateValue", "basis": "documentation" } ] }, "description": "The getDateValue() function returns the value of a date field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getDateValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter fieldName is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getDateValue(reference,integer) and getDateValue(reference,string) functions are available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getDateValue", "basis": "documentation" } ] } ], "see_also": [ "getBoolValue", "getByteValue", "getDecimalValue", "getIntValue", "getLongValue", "getNumValue", "getStringValue", "getValueAsString", "setDateValue" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "getDateValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getDay": { "name": "getDay", "category": "date", "summary": "The getDay() function returns the day of the month of arg.", "description": "The getDay() function returns the day of the month of arg. If the argument is null, the function returns null. If the timeZone argument is null or the time zone argument is not present, the function uses the default Time Zone.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getDay(date)", "canonical_signature": "integer getDay(date arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getDay() function returns the day of the month of arg.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getDay as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "getDay", "basis": "documentation" } ] }, "description": "The getDay() function returns the day of the month of arg. If the argument is null, the function returns null. If the timeZone argument is null or the time zone argument is not present, the function uses the default Time Zone.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getDay", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "getDay(date,string)", "canonical_signature": "integer getDay(date arg, string timeZone)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getDay() function returns the day of the month of arg.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "timeZone", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the timeZone argument is null or the time zone argument is not present, the function uses the default Time Zone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "timeZone is NULL -> default time zone.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getDay as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "getDay", "basis": "documentation" } ] }, "description": "The getDay() function returns the day of the month of arg. If the argument is null, the function returns null. If the timeZone argument is null or the time zone argument is not present, the function uses the default Time Zone.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getDay", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getDay(date) and getDay(date,string) functions are available since CloverETL 3.5.0-M1.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getDay", "basis": "documentation" } ] } ], "see_also": [ "date2str", "getDayOfWeek", "getHour", "getMillisecond", "getMinute", "getMonth", "getSecond", "getYear", "str2date" ], "evidence": [ { "source_id": "ctl2-date-functions", "section": "getDay", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getDayOfWeek": { "name": "getDayOfWeek", "category": "date", "summary": "The getDayOfWeek() function returns the day of the week (Monday = 1 ...", "description": "The getDayOfWeek() function returns the day of the week (Monday = 1 ... Sunday = 7) of arg. If the argument is null, the function returns null. If the timeZone argument is null or the time zone argument is not present, the function uses the default Time Zone.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getDayOfWeek(date)", "canonical_signature": "integer getDayOfWeek(date arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Sunday = 7) of arg.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getDayOfWeek as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "getDayOfWeek", "basis": "documentation" } ] }, "description": "The getDayOfWeek() function returns the day of the week (Monday = 1 ... Sunday = 7) of arg. If the argument is null, the function returns null. If the timeZone argument is null or the time zone argument is not present, the function uses the default Time Zone.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getDayOfWeek", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "getDayOfWeek(date,string)", "canonical_signature": "integer getDayOfWeek(date arg, string timeZone)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Sunday = 7) of arg.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "timeZone", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the timeZone argument is null or the time zone argument is not present, the function uses the default Time Zone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "timeZone is NULL -> default time zone.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getDayOfWeek as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "getDayOfWeek", "basis": "documentation" } ] }, "description": "The getDayOfWeek() function returns the day of the week (Monday = 1 ... Sunday = 7) of arg. If the argument is null, the function returns null. If the timeZone argument is null or the time zone argument is not present, the function uses the default Time Zone.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getDayOfWeek", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getDayOfWeek(date) and getDayOfWeek(date,string) functions are available since CloverDX 6.5.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getDayOfWeek", "basis": "documentation" } ] } ], "see_also": [ "date2str", "getDay", "getHour", "getMillisecond", "getMinute", "getMonth", "getSecond", "getYear", "str2date" ], "evidence": [ { "source_id": "ctl2-date-functions", "section": "getDayOfWeek", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getDecimalValue": { "name": "getDecimalValue", "category": "record", "summary": "The getDecimalValue() function returns the value of a decimal field.", "description": "The getDecimalValue() function returns the value of a decimal field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getDecimalValue(record,integer)", "canonical_signature": "decimal getDecimalValue(record record, integer fieldIndex)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "fieldIndex", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented fieldIndex argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "description": "Return value of getDecimalValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getDecimalValue", "basis": "documentation" } ] }, "description": "The getDecimalValue() function returns the value of a decimal field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getDecimalValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter fieldIndex is undocumented." ] } }, { "id": "getDecimalValue(record,string)", "canonical_signature": "decimal getDecimalValue(record record, string fieldName)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "fieldName", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented fieldName argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "description": "Return value of getDecimalValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getDecimalValue", "basis": "documentation" } ] }, "description": "The getDecimalValue() function returns the value of a decimal field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getDecimalValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter fieldName is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getDecimalValue(reference,integer) and getDecimalValue(reference,string) functions are available CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getDecimalValue", "basis": "documentation" } ] } ], "see_also": [ "getBoolValue", "getByteValue", "getDateValue", "getIntValue", "getLongValue", "getNumValue", "getStringValue", "getValueAsString", "setDecimalValue" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "getDecimalValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getEnvironmentVariables": { "name": "getEnvironmentVariables", "category": "miscellaneous", "summary": "The getEnvironmentVariables() function returns an unmodifiable map of system environment variables.", "description": "The getEnvironmentVariables() function returns an unmodifiable map of system environment variables. An environment variable is a system-dependent external named value. Similar to the Java function System.getenv(). Note that the keys are case-sensitive.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getEnvironmentVariables()", "canonical_signature": "map[string,string] getEnvironmentVariables()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "map", "key": { "kind": "named", "name": "string", "display": "string" }, "value": { "kind": "named", "name": "string", "display": "string" }, "display": "map[string,string]" }, "description": "Return value of getEnvironmentVariables as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getEnvironmentVariables", "basis": "documentation" } ] }, "description": "The getEnvironmentVariables() function returns an unmodifiable map of system environment variables. An environment variable is a system-dependent external named value. Similar to the Java function System.getenv(). Note that the keys are case-sensitive.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getEnvironmentVariables", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The isEmpty() function is available since CloverETL 3.3.x.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getEnvironmentVariables", "basis": "documentation" } ] } ], "see_also": [ "getJavaProperties" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getEnvironmentVariables", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getFieldIndex": { "name": "getFieldIndex", "category": "record", "summary": "The getFieldIndex() function returns the index (zero-based) of a field which is identified by its name.", "description": "The getFieldIndex() function returns the index (zero-based) of a field which is identified by its name. If the field name is not found in the record, the function returns -1. If a given record has a null reference, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getFieldIndex(record,string)", "canonical_signature": "integer getFieldIndex(record record, string field)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the field name is not found in the record, the function returns -1.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "field", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getFieldIndex() function returns the index (zero-based) of a field which is identified by its name.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getFieldIndex as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldIndex", "basis": "documentation" } ] }, "description": "The getFieldIndex() function returns the index (zero-based) of a field which is identified by its name. If the field name is not found in the record, the function returns -1. If a given record has a null reference, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldIndex", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter field is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getFieldIndex(reference,string) function is available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldIndex", "basis": "documentation" } ] } ], "see_also": [ "getFieldLabel", "getFieldName", "getFieldType" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldIndex", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getFieldLabel": { "name": "getFieldLabel", "category": "record", "summary": "The getFieldLabel() function returns the label of a field which is identified by its index.", "description": "The getFieldLabel() function returns the label of a field which is identified by its index. Please note a label is not a field's name, see Field Name vs. Label vs. Description. If a given record has a null reference, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getFieldLabel(record,integer)", "canonical_signature": "string getFieldLabel(record record, integer field)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "field", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getFieldLabel() function returns the label of a field which is identified by its index.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getFieldLabel as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldLabel", "basis": "documentation" } ] }, "description": "The getFieldLabel() function returns the label of a field which is identified by its index. Please note a label is not a field's name, see Field Name vs. Label vs. Description. If a given record has a null reference, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldLabel", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter field is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getFieldLabel(record,integer) and getFieldLabel(record,string) functions are available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldLabel", "basis": "documentation" } ] } ], "see_also": [ "getFieldIndex", "getFieldName", "getFieldType" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldLabel", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getFieldName": { "name": "getFieldName", "category": "record", "summary": "The getFieldName() function returns the name of the field with the specified index.", "description": "The getFieldName() function returns the name of the field with the specified index. Fields are numbered starting from 0. The argRecord may have any of the following forms: $.* + E.g. $in.0.* $.* + E.g. $customers.* + E.g. Customers or Customers.* (both cases, if Customers was declared as record in CTL.) lookup().get() + E.g. lookup(Comp).get(\"JohnSmith\") or lookup(Comp).get(\"JohnSmith\").* lookup().next() + E.g. lookup(Comp).next() or lookup(Comp).next().* If a given record has a null reference, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getFieldName(record,integer)", "canonical_signature": "string getFieldName(record argRecord, integer index)", "type_parameters": [], "parameters": [ { "position": 0, "name": "argRecord", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[IMPORTANT] ==== The argRecord may have any of the following forms: $.* + E.g.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getFieldName() function returns the name of the field with the specified index.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getFieldName as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldName", "basis": "documentation" } ] }, "description": "The getFieldName() function returns the name of the field with the specified index. Fields are numbered starting from 0. The argRecord may have any of the following forms: $.* + E.g. $in.0.* $.* + E.g. $customers.* + E.g. Customers or Customers.* (both cases, if Customers was declared as record in CTL.) lookup().get() + E.g. lookup(Comp).get(\"JohnSmith\") or lookup(Comp).get(\"JohnSmith\").* lookup().next() + E.g. lookup(Comp).next() or lookup(Comp).next().* If a given record has a null reference, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldName", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter argRecord is undocumented.", "NULL behavior for parameter index is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getFieldName(record,integer) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldName", "basis": "documentation" } ] } ], "see_also": [ "getFieldIndex", "getFieldLabel", "getFieldType" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldName", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getFieldProperties": { "name": "getFieldProperties", "category": "record", "summary": "The getFieldProperties() function returns an unmodifiable map of selected properties of the specified data field metadata.", "description": "The getFieldProperties() function returns an unmodifiable map of selected properties of the specified data field metadata. Fields are indexed starting from 0. New properties may be added to the map in future versions. If a null reference is passed to any of the arguments, if the field index is out of range or if the record does not contain a field with the specified name, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getFieldProperties(record,integer)", "canonical_signature": "map[string,string] getFieldProperties(record argRecord, integer index)", "type_parameters": [], "parameters": [ { "position": 0, "name": "argRecord", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented argRecord argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a null reference is passed to any of the arguments, if the field index is out of range or if the record does not contain a field with the specified name, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "map", "key": { "kind": "named", "name": "string", "display": "string" }, "value": { "kind": "named", "name": "string", "display": "string" }, "display": "map[string,string]" }, "description": "Return value of getFieldProperties as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldProperties", "basis": "documentation" } ] }, "description": "The getFieldProperties() function returns an unmodifiable map of selected properties of the specified data field metadata. Fields are indexed starting from 0. New properties may be added to the map in future versions. If a null reference is passed to any of the arguments, if the field index is out of range or if the record does not contain a field with the specified name, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldProperties", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter argRecord is undocumented.", "NULL behavior for parameter index is undocumented." ] } }, { "id": "getFieldProperties(record,string)", "canonical_signature": "map[string,string] getFieldProperties(record argRecord, string fieldName)", "type_parameters": [], "parameters": [ { "position": 0, "name": "argRecord", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented argRecord argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "fieldName", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented fieldName argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "map", "key": { "kind": "named", "name": "string", "display": "string" }, "value": { "kind": "named", "name": "string", "display": "string" }, "display": "map[string,string]" }, "description": "Return value of getFieldProperties as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldProperties", "basis": "documentation" } ] }, "description": "The getFieldProperties() function returns an unmodifiable map of selected properties of the specified data field metadata. Fields are indexed starting from 0. New properties may be added to the map in future versions. If a null reference is passed to any of the arguments, if the field index is out of range or if the record does not contain a field with the specified name, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldProperties", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter argRecord is undocumented.", "NULL behavior for parameter fieldName is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getFieldProperties(re) function is available since CloverETL 4.1.0-M1.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldProperties", "basis": "documentation" } ] } ], "see_also": [ "getRecordProperties" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldProperties", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getFieldType": { "name": "getFieldType", "category": "record", "summary": "The getFieldType() function returns the type of a field you specify by its index (i.e.", "description": "The getFieldType() function returns the type of a field you specify by its index (i.e. field's number starting from 0) or name. The returned string is the name of the type (string, integer, ...), see Data Types in Metadata. Example code: will return the data type of the third field for each incoming record (e.g. decimal). Records as arguments look like the records for the getFieldName() function. See above. If a given record has a null reference, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getFieldType(record,integer)", "canonical_signature": "string getFieldType(record argRecord, integer index)", "type_parameters": [], "parameters": [ { "position": 0, "name": "argRecord", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented argRecord argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getFieldType() function returns the type of a field you specify by its index (i.e.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getFieldType as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldType", "basis": "documentation" } ] }, "description": "The getFieldType() function returns the type of a field you specify by its index (i.e. field's number starting from 0) or name. The returned string is the name of the type (string, integer, ...), see Data Types in Metadata. Example code: will return the data type of the third field for each incoming record (e.g. decimal). Records as arguments look like the records for the getFieldName() function. See above. If a given record has a null reference, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldType", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter argRecord is undocumented.", "NULL behavior for parameter index is undocumented." ] } }, { "id": "getFieldType(record,string)", "canonical_signature": "string getFieldType(record argRecord, string fieldName)", "type_parameters": [], "parameters": [ { "position": 0, "name": "argRecord", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented argRecord argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "fieldName", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented fieldName argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getFieldType as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldType", "basis": "documentation" } ] }, "description": "The getFieldType() function returns the type of a field you specify by its index (i.e. field's number starting from 0) or name. The returned string is the name of the type (string, integer, ...), see Data Types in Metadata. Example code: will return the data type of the third field for each incoming record (e.g. decimal). Records as arguments look like the records for the getFieldName() function. See above. If a given record has a null reference, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldType", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter argRecord is undocumented.", "NULL behavior for parameter fieldName is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getFieldType(record,integer) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldType", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The getFieldType(record,string) function is available since CloverETL 4.1.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldType", "basis": "documentation" } ] } ], "see_also": [ "getFieldIndex", "getFieldLabel", "getFieldName" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "getFieldType", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getFileExtension": { "name": "getFileExtension", "category": "string", "summary": "The getFileExtension() function extracts a file extension from a specified path or URL.", "description": "The getFileExtension() function extracts a file extension from a specified path or URL. Returns the textual part of the file name after the last dot. There must be no directory separator after the dot. If extension is not present in the argument, returns an empty string. The function returns null value for null input.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getFileExtension(string)", "canonical_signature": "string getFileExtension(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getFileExtension as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "getFileExtension", "basis": "documentation" } ] }, "description": "The getFileExtension() function extracts a file extension from a specified path or URL. Returns the textual part of the file name after the last dot. There must be no directory separator after the dot. If extension is not present in the argument, returns an empty string. The function returns null value for null input.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getFileExtension", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getFileExtension(decimal) and log(number) functions are available since CloverETL 4.1.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getFileExtension", "basis": "documentation" } ] } ], "see_also": [ "getFileName", "getFileNameWithoutExtension", "getFilePath", "normalizePath" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "getFileExtension", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getFileName": { "name": "getFileName", "category": "string", "summary": "The getFileName() function extracts a file name from a specified path or URL.", "description": "The getFileName() function extracts a file name from a specified path or URL. Returns the text after the last forward or backslash. If the file name is not present in the argument, returns an empty string. The function returns null value for null input.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getFileName(string)", "canonical_signature": "string getFileName(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getFileName as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "getFileName", "basis": "documentation" } ] }, "description": "The getFileName() function extracts a file name from a specified path or URL. Returns the text after the last forward or backslash. If the file name is not present in the argument, returns an empty string. The function returns null value for null input.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getFileName", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getFileName(string) function is available since CloverETL 4.1.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getFileName", "basis": "documentation" } ] } ], "see_also": [ "getFileExtension", "getFileNameWithoutExtension", "getFilePath", "normalizePath" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "getFileName", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getFileNameWithoutExtension": { "name": "getFileNameWithoutExtension", "category": "string", "summary": "The getFileNameWithoutExtension() function extracts a base file name from a specified path or URL.", "description": "The getFileNameWithoutExtension() function extracts a base file name from a specified path or URL. Returns the text after the last forward or backslash and before the last dot. If the base name is not present in the argument, returns an empty string. The function returns null value for null input.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getFileNameWithoutExtension(string)", "canonical_signature": "string getFileNameWithoutExtension(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getFileNameWithoutExtension as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "getFileNameWithoutExtension", "basis": "documentation" } ] }, "description": "The getFileNameWithoutExtension() function extracts a base file name from a specified path or URL. Returns the text after the last forward or backslash and before the last dot. If the base name is not present in the argument, returns an empty string. The function returns null value for null input.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getFileNameWithoutExtension", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getFileNameWithoutExtension(string) function is available since CloverETL 4.1.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getFileNameWithoutExtension", "basis": "documentation" } ] } ], "see_also": [ "getFileExtension", "getFileName", "getFilePath", "normalizePath" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "getFileNameWithoutExtension", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getFilePath": { "name": "getFilePath", "category": "string", "summary": "The getFilePath() function extracts a file path (without the file name) from a specified full path or URL.", "description": "The getFilePath() function extracts a file path (without the file name) from a specified full path or URL. Returns the text before and including the last forward or backslash. Also replaces backslashes with forward slashes. If the path is not present in the argument, returns an empty string. The function returns null value for null input.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getFilePath(string)", "canonical_signature": "string getFilePath(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getFilePath as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "getFilePath", "basis": "documentation" } ] }, "description": "The getFilePath() function extracts a file path (without the file name) from a specified full path or URL. Returns the text before and including the last forward or backslash. Also replaces backslashes with forward slashes. If the path is not present in the argument, returns an empty string. The function returns null value for null input.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getFilePath", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getFilePath(string) function is available since CloverETL 4.1.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getFilePath", "basis": "documentation" } ] } ], "see_also": [ "getFileExtension", "getFileName", "getFileNameWithoutExtension", "normalizePath" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "getFilePath", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getHour": { "name": "getHour", "category": "date", "summary": "The getHour() function returns the hour of the day (24-hour clock) of arg.", "description": "The getHour() function returns the hour of the day (24-hour clock) of arg. If the argument is null, the function returns null. Otherwise the specified time zone is used. If the timeZone argument is null, the function uses the default Time Zone.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getHour(date)", "canonical_signature": "integer getHour(date arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getHour() function returns the hour of the day (24-hour clock) of arg.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getHour as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "getHour", "basis": "documentation" } ] }, "description": "The getHour() function returns the hour of the day (24-hour clock) of arg. If the argument is null, the function returns null. Otherwise the specified time zone is used. If the timeZone argument is null, the function uses the default Time Zone.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getHour", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "getHour(date,string)", "canonical_signature": "integer getHour(date arg, string timeZone)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getHour() function returns the hour of the day (24-hour clock) of arg.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "timeZone", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the timeZone argument is null, the function uses the default Time Zone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "timeZone is NULL -> default time zone.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getHour as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "getHour", "basis": "documentation" } ] }, "description": "The getHour() function returns the hour of the day (24-hour clock) of arg. If the argument is null, the function returns null. Otherwise the specified time zone is used. If the timeZone argument is null, the function uses the default Time Zone.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getHour", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getHour(date) and getHour(date) functions are available since CloverETL 3.5.0-M1.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getHour", "basis": "documentation" } ] } ], "see_also": [ "date2str", "getDay", "getDayOfWeek", "getMillisecond", "getMinute", "getMonth", "getSecond", "getYear", "str2date" ], "evidence": [ { "source_id": "ctl2-date-functions", "section": "getHour", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getIntValue": { "name": "getIntValue", "category": "record", "summary": "The getIntValue() function returns the value of an integer field.", "description": "The getIntValue() function returns the value of an integer field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getIntValue(record,integer)", "canonical_signature": "integer getIntValue(record record, integer index)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The field is identified by its index (integer) or name (string).", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getIntValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getIntValue", "basis": "documentation" } ] }, "description": "The getIntValue() function returns the value of an integer field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getIntValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter index is undocumented." ] } }, { "id": "getIntValue(record,string)", "canonical_signature": "integer getIntValue(record record, string field)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "field", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getIntValue() function returns the value of an integer field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getIntValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getIntValue", "basis": "documentation" } ] }, "description": "The getIntValue() function returns the value of an integer field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getIntValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter field is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getIntValue(record,integer) and getIntValue(record,string) functions are available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getIntValue", "basis": "documentation" } ] } ], "see_also": [ "getBoolValue", "getByteValue", "getDateValue", "getDecimalValue", "getLongValue", "getNumValue", "getStringValue", "getValueAsString", "setIntValue" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "getIntValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getJavaProperties": { "name": "getJavaProperties", "category": "miscellaneous", "summary": "The getJavaProperties() function returns the map of Java VM system properties.", "description": "The getJavaProperties() function returns the map of Java VM system properties. Similar to the Java function System.getProperties().", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getJavaProperties()", "canonical_signature": "map[string,string] getJavaProperties()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "map", "key": { "kind": "named", "name": "string", "display": "string" }, "value": { "kind": "named", "name": "string", "display": "string" }, "display": "map[string,string]" }, "description": "Return value of getJavaProperties as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getJavaProperties", "basis": "documentation" } ] }, "description": "The getJavaProperties() function returns the map of Java VM system properties. Similar to the Java function System.getProperties().", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getJavaProperties", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getJavaProperties() function is available since CloverETL 3.3.x.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getJavaProperties", "basis": "documentation" } ] } ], "see_also": [ "getEnvironmentVariables" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getJavaProperties", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getKeys": { "name": "getKeys", "category": "container", "summary": "Returns the list of keys from the specified map.", "description": "Returns the list of keys from the specified map. The returned list has elements of the same type as the map's keys. Order of returned keys is not specified - the function does not sort its result (use sort to sort the result if needed). === Error states If a given map is null, the function fails with an error. The variant version fails if the argument is not a map. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getKeys(map[K,V])", "canonical_signature": "any getKeys(map[K,V] map)", "type_parameters": [ { "name": "K", "constraint": { "kind": "any", "display": "any" } }, { "name": "V", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "map", "type": { "kind": "map", "key": { "kind": "type_variable", "name": "K", "display": "K" }, "value": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "map[K,V]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Returns the list of keys from the specified map.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "map is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of getKeys as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "getKeys", "basis": "documentation" } ] }, "description": "Returns the list of keys from the specified map. The returned list has elements of the same type as the map's keys. Order of returned keys is not specified - the function does not sort its result (use sort to sort the result if needed). === Error states If a given map is null, the function fails with an error. The variant version fails if the argument is not a map. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "getKeys", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "map == NULL", "description": "map is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "getKeys(variant)", "canonical_signature": "variant getKeys(variant map)", "type_parameters": [], "parameters": [ { "position": 0, "name": "map", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Returns the list of keys from the specified map.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "map is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "variant", "display": "variant" }, "description": "Return value of getKeys as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "getKeys", "basis": "documentation" } ] }, "description": "Returns the list of keys from the specified map. The returned list has elements of the same type as the map's keys. Order of returned keys is not specified - the function does not sort its result (use sort to sort the result if needed). === Error states If a given map is null, the function fails with an error. The variant version fails if the argument is not a map. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "getKeys", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "map == NULL", "description": "map is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-container-functions", "section": "getKeys", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getLongValue": { "name": "getLongValue", "category": "record", "summary": "The getLongValue() function returns the value of a long field.", "description": "The getLongValue() function returns the value of a long field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getLongValue(record,integer)", "canonical_signature": "long getLongValue(record record, integer index)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The field is identified by its index (integer) or name (string).", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of getLongValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getLongValue", "basis": "documentation" } ] }, "description": "The getLongValue() function returns the value of a long field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getLongValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter index is undocumented." ] } }, { "id": "getLongValue(record,string)", "canonical_signature": "long getLongValue(record record, string field)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "field", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getLongValue() function returns the value of a long field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of getLongValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getLongValue", "basis": "documentation" } ] }, "description": "The getLongValue() function returns the value of a long field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getLongValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter field is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getLongValue(record,integer) and getLongValue(record,string) functions are available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getLongValue", "basis": "documentation" } ] } ], "see_also": [ "getBoolValue", "getByteValue", "getDateValue", "getDecimalValue", "getIntValue", "getNumValue", "getStringValue", "getValueAsString", "setLongValue" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "getLongValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getMappedSourceFields": { "name": "getMappedSourceFields", "category": "mapping", "summary": "The getMappedSourceFields function returns the source fields at the specified source index (starting at 0) that are mapped to the named target field.", "description": "The getMappedSourceFields function returns the source fields at the specified source index (starting at 0) that are mapped to the named target field. If sourceIndex is omitted, the function returns fields from all sources that are mapped to the named target field. The result can be ambiguous if the sets of source fields are not disjoint. If targetField is also omitted, the function returns all source fields that are mapped to any target field. === Error states The function throws an exception if mapping is invalid or null. It also throws an exception if sourceIndex is out of bounds or null. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getMappedSourceFields(string)", "canonical_signature": "any getMappedSourceFields(string mapping)", "type_parameters": [], "parameters": [ { "position": 0, "name": "mapping", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "=== Error states The function throws an exception if mapping is invalid or null.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of getMappedSourceFields as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "getMappedSourceFields", "basis": "documentation" } ] }, "description": "The getMappedSourceFields function returns the source fields at the specified source index (starting at 0) that are mapped to the named target field. If sourceIndex is omitted, the function returns fields from all sources that are mapped to the named target field. The result can be ambiguous if the sets of source fields are not disjoint. If targetField is also omitted, the function returns all source fields that are mapped to any target field. === Error states The function throws an exception if mapping is invalid or null. It also throws an exception if sourceIndex is out of bounds or null. === Examples", "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "getMappedSourceFields", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter mapping is undocumented." ] } }, { "id": "getMappedSourceFields(string,string)", "canonical_signature": "any getMappedSourceFields(string mapping, string targetField)", "type_parameters": [], "parameters": [ { "position": 0, "name": "mapping", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "=== Error states The function throws an exception if mapping is invalid or null.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "targetField", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If targetField is also omitted, the function returns all source fields that are mapped to any target field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of getMappedSourceFields as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "getMappedSourceFields", "basis": "documentation" } ] }, "description": "The getMappedSourceFields function returns the source fields at the specified source index (starting at 0) that are mapped to the named target field. If sourceIndex is omitted, the function returns fields from all sources that are mapped to the named target field. The result can be ambiguous if the sets of source fields are not disjoint. If targetField is also omitted, the function returns all source fields that are mapped to any target field. === Error states The function throws an exception if mapping is invalid or null. It also throws an exception if sourceIndex is out of bounds or null. === Examples", "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "getMappedSourceFields", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter mapping is undocumented.", "NULL behavior for parameter targetField is undocumented." ] } }, { "id": "getMappedSourceFields(string,string,integer)", "canonical_signature": "any getMappedSourceFields(string mapping, string targetField, integer sourceIndex)", "type_parameters": [], "parameters": [ { "position": 0, "name": "mapping", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "=== Error states The function throws an exception if mapping is invalid or null.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "targetField", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If targetField is also omitted, the function returns all source fields that are mapped to any target field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "sourceIndex", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If sourceIndex is omitted, the function returns fields from all sources that are mapped to the named target field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of getMappedSourceFields as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "getMappedSourceFields", "basis": "documentation" } ] }, "description": "The getMappedSourceFields function returns the source fields at the specified source index (starting at 0) that are mapped to the named target field. If sourceIndex is omitted, the function returns fields from all sources that are mapped to the named target field. The result can be ambiguous if the sets of source fields are not disjoint. If targetField is also omitted, the function returns all source fields that are mapped to any target field. === Error states The function throws an exception if mapping is invalid or null. It also throws an exception if sourceIndex is out of bounds or null. === Examples", "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "getMappedSourceFields", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter mapping is undocumented.", "NULL behavior for parameter targetField is undocumented.", "NULL behavior for parameter sourceIndex is undocumented." ] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "getMappedSourceFields", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getMappedTargetFields": { "name": "getMappedTargetFields", "category": "mapping", "summary": "The getMappedTargetFields function returns the corresponding target fields mapped from the named field at the specified source index (starting at 0).", "description": "The getMappedTargetFields function returns the corresponding target fields mapped from the named field at the specified source index (starting at 0). If sourceIndex is omitted, the function returns target fields mapped from fields with the specified name in any source. If sourceField is also omitted, the function returns all target fields that have a mapping. === Error states The function throws an exception if mapping is invalid or null. It also throws an exception if sourceIndex is out of bounds or null. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getMappedTargetFields(string)", "canonical_signature": "any getMappedTargetFields(string mapping)", "type_parameters": [], "parameters": [ { "position": 0, "name": "mapping", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If sourceField is also omitted, the function returns all target fields that have a mapping.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of getMappedTargetFields as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "getMappedTargetFields", "basis": "documentation" } ] }, "description": "The getMappedTargetFields function returns the corresponding target fields mapped from the named field at the specified source index (starting at 0). If sourceIndex is omitted, the function returns target fields mapped from fields with the specified name in any source. If sourceField is also omitted, the function returns all target fields that have a mapping. === Error states The function throws an exception if mapping is invalid or null. It also throws an exception if sourceIndex is out of bounds or null. === Examples", "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "getMappedTargetFields", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter mapping is undocumented." ] } }, { "id": "getMappedTargetFields(string,string)", "canonical_signature": "any getMappedTargetFields(string mapping, string sourceField)", "type_parameters": [], "parameters": [ { "position": 0, "name": "mapping", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If sourceField is also omitted, the function returns all target fields that have a mapping.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "sourceField", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If sourceField is also omitted, the function returns all target fields that have a mapping.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of getMappedTargetFields as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "getMappedTargetFields", "basis": "documentation" } ] }, "description": "The getMappedTargetFields function returns the corresponding target fields mapped from the named field at the specified source index (starting at 0). If sourceIndex is omitted, the function returns target fields mapped from fields with the specified name in any source. If sourceField is also omitted, the function returns all target fields that have a mapping. === Error states The function throws an exception if mapping is invalid or null. It also throws an exception if sourceIndex is out of bounds or null. === Examples", "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "getMappedTargetFields", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter mapping is undocumented.", "NULL behavior for parameter sourceField is undocumented." ] } }, { "id": "getMappedTargetFields(string,string,integer)", "canonical_signature": "any getMappedTargetFields(string mapping, string sourceField, integer sourceIndex)", "type_parameters": [], "parameters": [ { "position": 0, "name": "mapping", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If sourceField is also omitted, the function returns all target fields that have a mapping.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "sourceField", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If sourceField is also omitted, the function returns all target fields that have a mapping.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "sourceIndex", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If sourceIndex is omitted, the function returns target fields mapped from fields with the specified name in any source.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of getMappedTargetFields as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "getMappedTargetFields", "basis": "documentation" } ] }, "description": "The getMappedTargetFields function returns the corresponding target fields mapped from the named field at the specified source index (starting at 0). If sourceIndex is omitted, the function returns target fields mapped from fields with the specified name in any source. If sourceField is also omitted, the function returns all target fields that have a mapping. === Error states The function throws an exception if mapping is invalid or null. It also throws an exception if sourceIndex is out of bounds or null. === Examples", "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "getMappedTargetFields", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter mapping is undocumented.", "NULL behavior for parameter sourceField is undocumented.", "NULL behavior for parameter sourceIndex is undocumented." ] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "getMappedTargetFields", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getMillisecond": { "name": "getMillisecond", "category": "date", "summary": "The getMillisecond() function returns the millisecond of the second of arg.", "description": "The getMillisecond() function returns the millisecond of the second of arg. If the argument is null, the function returns null. If the timeZone argument is null or the parameter is not present, the function uses the default Time Zone.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getMillisecond(date)", "canonical_signature": "integer getMillisecond(date arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getMillisecond() function returns the millisecond of the second of arg.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getMillisecond as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "getMillisecond", "basis": "documentation" } ] }, "description": "The getMillisecond() function returns the millisecond of the second of arg. If the argument is null, the function returns null. If the timeZone argument is null or the parameter is not present, the function uses the default Time Zone.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getMillisecond", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "getMillisecond(date,string)", "canonical_signature": "integer getMillisecond(date arg, string timeZone)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getMillisecond() function returns the millisecond of the second of arg.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "timeZone", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the timeZone argument is null or the parameter is not present, the function uses the default Time Zone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "timeZone is NULL -> default time zone.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getMillisecond as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "getMillisecond", "basis": "documentation" } ] }, "description": "The getMillisecond() function returns the millisecond of the second of arg. If the argument is null, the function returns null. If the timeZone argument is null or the parameter is not present, the function uses the default Time Zone.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getMillisecond", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getMillisecond(date) and getMillisecond(date,string) functions are available since CloverETL 3.5.0-M1.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getMillisecond", "basis": "documentation" } ] } ], "see_also": [ "date2str", "getDay", "getDayOfWeek", "getHour", "getMinute", "getMonth", "getSecond", "getYear", "str2date" ], "evidence": [ { "source_id": "ctl2-date-functions", "section": "getMillisecond", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getMinute": { "name": "getMinute", "category": "date", "summary": "The getMinute() function returns the minute of the hour of arg.", "description": "The getMinute() function returns the minute of the hour of arg. If the argument is null, the function returns null. If the timeZone argument is null or the parameter is not present, the function uses the default Time Zone.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getMinute(date)", "canonical_signature": "integer getMinute(date arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getMinute() function returns the minute of the hour of arg.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getMinute as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "getMinute", "basis": "documentation" } ] }, "description": "The getMinute() function returns the minute of the hour of arg. If the argument is null, the function returns null. If the timeZone argument is null or the parameter is not present, the function uses the default Time Zone.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getMinute", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "getMinute(date,string)", "canonical_signature": "integer getMinute(date arg, string timeZone)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getMinute() function returns the minute of the hour of arg.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "timeZone", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the timeZone argument is null or the parameter is not present, the function uses the default Time Zone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "timeZone is NULL -> default time zone.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getMinute as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "getMinute", "basis": "documentation" } ] }, "description": "The getMinute() function returns the minute of the hour of arg. If the argument is null, the function returns null. If the timeZone argument is null or the parameter is not present, the function uses the default Time Zone.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getMinute", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getMinute(date) and getMinute(date,string) functions are available since CloverETL 3.5.0-M1.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getMinute", "basis": "documentation" } ] } ], "see_also": [ "date2str", "getDay", "getDayOfWeek", "getHour", "getMillisecond", "getMonth", "getSecond", "getYear", "str2date" ], "evidence": [ { "source_id": "ctl2-date-functions", "section": "getMinute", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getMonth": { "name": "getMonth", "category": "date", "summary": "The getMonth() function returns the month of the year (numbered from 1) of arg.", "description": "The getMonth() function returns the month of the year (numbered from 1) of arg. If the argument is null, the function returns null. If the timeZone argument is null or the argument is missing, the function uses the default Time Zone.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getMonth(date)", "canonical_signature": "integer getMonth(date arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getMonth() function returns the month of the year (numbered from 1) of arg.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getMonth as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "getMonth", "basis": "documentation" } ] }, "description": "The getMonth() function returns the month of the year (numbered from 1) of arg. If the argument is null, the function returns null. If the timeZone argument is null or the argument is missing, the function uses the default Time Zone.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getMonth", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "getMonth(date,string)", "canonical_signature": "integer getMonth(date arg, string timeZone)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getMonth() function returns the month of the year (numbered from 1) of arg.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "timeZone", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the timeZone argument is null or the argument is missing, the function uses the default Time Zone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "timeZone is NULL -> default time zone.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getMonth as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "getMonth", "basis": "documentation" } ] }, "description": "The getMonth() function returns the month of the year (numbered from 1) of arg. If the argument is null, the function returns null. If the timeZone argument is null or the argument is missing, the function uses the default Time Zone.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getMonth", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getMonth(date) and getMonth(date,string) functions are available since CloverETL 3.5.0-M1.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getMonth", "basis": "documentation" } ] } ], "see_also": [ "date2str", "getDay", "getDayOfWeek", "getHour", "getMillisecond", "getMinute", "getSecond", "getYear", "str2date" ], "evidence": [ { "source_id": "ctl2-date-functions", "section": "getMonth", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getNumValue": { "name": "getNumValue", "category": "record", "summary": "The getNumValue() function returns the value of a number field.", "description": "The getNumValue() function returns the value of a number field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getNumValue(record,integer)", "canonical_signature": "number getNumValue(record record, integer index)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The field is identified by its index (integer) or name (string).", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of getNumValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getNumValue", "basis": "documentation" } ] }, "description": "The getNumValue() function returns the value of a number field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getNumValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter index is undocumented." ] } }, { "id": "getNumValue(record,string)", "canonical_signature": "number getNumValue(record record, string field)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "field", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getNumValue() function returns the value of a number field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of getNumValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getNumValue", "basis": "documentation" } ] }, "description": "The getNumValue() function returns the value of a number field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getNumValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter field is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getNumValue(recored,integer) and getNumValue(record,string) functions are available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getNumValue", "basis": "documentation" } ] } ], "see_also": [ "getBoolValue", "getByteValue", "getDateValue", "getDecimalValue", "getIntValue", "getLongValue", "getStringValue", "getValueAsString", "setNumValue" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "getNumValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getOAuth2Token": { "name": "getOAuth2Token", "category": "miscellaneous", "summary": "The getOAuth2Token function returns OAuth2 access token from authorized OAuth2 connection linked in graph.", "description": "The getOAuth2Token function returns OAuth2 access token from authorized OAuth2 connection linked in graph. The connectionName parameter is a name of the OAuth2 connection linked in graph. If the connection specified does not exist or is of the wrong type, an exception is thrown. The optional parameter forceRefresh can be used to ask the connection to obtain a new OAuth2 access token instead of the currently cached one. Without forceRefresh parameter, returned tokens are valid for at least the next 60 seconds after the call is made. Forcing a refresh ensures maximum possible validity time, but it is slower than using default because new tokens must be obtained from remote OAuth2 provider.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getOAuth2Token(string)", "canonical_signature": "string getOAuth2Token(string connectionName)", "type_parameters": [], "parameters": [ { "position": 0, "name": "connectionName", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The connectionName parameter is a name of the OAuth2 connection linked in graph.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getOAuth2Token as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getOAuth2Token", "basis": "documentation" } ] }, "description": "The getOAuth2Token function returns OAuth2 access token from authorized OAuth2 connection linked in graph. The connectionName parameter is a name of the OAuth2 connection linked in graph. If the connection specified does not exist or is of the wrong type, an exception is thrown. The optional parameter forceRefresh can be used to ask the connection to obtain a new OAuth2 access token instead of the currently cached one. Without forceRefresh parameter, returned tokens are valid for at least the next 60 seconds after the call is made. Forcing a refresh ensures maximum possible validity time, but it is slower than using default because new tokens must be obtained from remote OAuth2 provider.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getOAuth2Token", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter connectionName is undocumented." ] } }, { "id": "getOAuth2Token(string,boolean)", "canonical_signature": "string getOAuth2Token(string connectionName, boolean forceRefresh)", "type_parameters": [], "parameters": [ { "position": 0, "name": "connectionName", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The connectionName parameter is a name of the OAuth2 connection linked in graph.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "forceRefresh", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The optional parameter forceRefresh can be used to ask the connection to obtain a new OAuth2 access token instead of the currently cached one.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getOAuth2Token as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getOAuth2Token", "basis": "documentation" } ] }, "description": "The getOAuth2Token function returns OAuth2 access token from authorized OAuth2 connection linked in graph. The connectionName parameter is a name of the OAuth2 connection linked in graph. If the connection specified does not exist or is of the wrong type, an exception is thrown. The optional parameter forceRefresh can be used to ask the connection to obtain a new OAuth2 access token instead of the currently cached one. Without forceRefresh parameter, returned tokens are valid for at least the next 60 seconds after the call is made. Forcing a refresh ensures maximum possible validity time, but it is slower than using default because new tokens must be obtained from remote OAuth2 provider.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getOAuth2Token", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter connectionName is undocumented.", "NULL behavior for parameter forceRefresh is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getOAuth2Token(string) function is available since CloverDX 5.12.0.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getOAuth2Token", "basis": "documentation" } ] } ], "see_also": [], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getOAuth2Token", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getParamValue": { "name": "getParamValue", "category": "miscellaneous", "summary": "The getParamValue() function returns the value of the specified graph parameter.", "description": "The getParamValue() function returns the value of the specified graph parameter. The argument is the name of the graph parameter without the ${ } characters, e.g. PROJECT_DIR. The returned value is resolved, i.e. it does not contain any references to other graph parameters. The function returns null for non-existent parameters. Function getParamValue decrypts [guilabel]##secure parameters##. Secure parameters are being deciphered with each use. There is a performance penalty associated with this process and therefore, when single secure parameter is used in a single script, it is advisable to cache its value manually to avoid multiple resolutions.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getParamValue(string)", "canonical_signature": "string getParamValue(string paramName)", "type_parameters": [], "parameters": [ { "position": 0, "name": "paramName", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented paramName argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getParamValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getParamValue", "basis": "documentation" } ] }, "description": "The getParamValue() function returns the value of the specified graph parameter. The argument is the name of the graph parameter without the ${ } characters, e.g. PROJECT_DIR. The returned value is resolved, i.e. it does not contain any references to other graph parameters. The function returns null for non-existent parameters. Function getParamValue decrypts [guilabel]##secure parameters##. Secure parameters are being deciphered with each use. There is a performance penalty associated with this process and therefore, when single secure parameter is used in a single script, it is advisable to cache its value manually to avoid multiple resolutions.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getParamValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter paramName is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getParamValue(string) function is available since CloverETL 3.3.x.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getParamValue", "basis": "documentation" } ] } ], "see_also": [ "getParamValues" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getParamValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getParamValues": { "name": "getParamValues", "category": "miscellaneous", "summary": "The getParamValues() function returns a map of graph parameters and their values.", "description": "The getParamValues() function returns a map of graph parameters and their values. The keys are the names of the parameters without the ${ } characters, e.g. PROJECT_DIR. The values are resolved, i.e. they do not contain any references to other graph parameters. The map is unmodifiable. The function returns null for non-existent parameters. The function getParamValues decrypts [guilabel]##secure parameters##. Secure parameters are being deciphered with each use. There is a performance penalty associated with this process and therefore, when single secure parameter is used in a single script, it is advisable to cache its value manually to avoid multiple resolutions.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getParamValues()", "canonical_signature": "map[string,string] getParamValues()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "map", "key": { "kind": "named", "name": "string", "display": "string" }, "value": { "kind": "named", "name": "string", "display": "string" }, "display": "map[string,string]" }, "description": "Return value of getParamValues as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getParamValues", "basis": "documentation" } ] }, "description": "The getParamValues() function returns a map of graph parameters and their values. The keys are the names of the parameters without the ${ } characters, e.g. PROJECT_DIR. The values are resolved, i.e. they do not contain any references to other graph parameters. The map is unmodifiable. The function returns null for non-existent parameters. The function getParamValues decrypts [guilabel]##secure parameters##. Secure parameters are being deciphered with each use. There is a performance penalty associated with this process and therefore, when single secure parameter is used in a single script, it is advisable to cache its value manually to avoid multiple resolutions.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getParamValues", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getParamValues() function is available since CloverETL 3.3.x.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getParamValues", "basis": "documentation" } ] } ], "see_also": [ "getParamValue" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getParamValues", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getRawParamValue": { "name": "getRawParamValue", "category": "miscellaneous", "summary": "The getRawParamValue() function returns the value of the specified graph parameter.", "description": "The getRawParamValue() function returns the value of the specified graph parameter. The argument is the name of the graph parameter without the ${ } characters, e.g. PROJECT_DIR. In contrast with getParamValue(string) function, the returned value is unresolved, so references to other graph parameters are not resolved and secure parameters are not decrypted. The function returns null for non-existent parameters.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getRawParamValue(string)", "canonical_signature": "string getRawParamValue(string paramName)", "type_parameters": [], "parameters": [ { "position": 0, "name": "paramName", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented paramName argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getRawParamValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getRawParamValue", "basis": "documentation" } ] }, "description": "The getRawParamValue() function returns the value of the specified graph parameter. The argument is the name of the graph parameter without the ${ } characters, e.g. PROJECT_DIR. In contrast with getParamValue(string) function, the returned value is unresolved, so references to other graph parameters are not resolved and secure parameters are not decrypted. The function returns null for non-existent parameters.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getRawParamValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter paramName is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getRawParamValue(string) function is available since CloverETL 3.5.0.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getRawParamValue", "basis": "documentation" } ] } ], "see_also": [ "getRawParamValues" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getRawParamValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getRawParamValues": { "name": "getRawParamValues", "category": "miscellaneous", "summary": "The getRawParamValues() function returns a map of graph parameters and their values.", "description": "The getRawParamValues() function returns a map of graph parameters and their values. The keys are the names of the parameters without the ${ } characters, e.g. PROJECT_DIR. Unlike getParamValues() function, the values are unresolved, so references to other graph parameters are not resolved and secure parameters are not decrypted. The map is unmodifiable. The function returns null for non-existent parameters.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getRawParamValues()", "canonical_signature": "map[string,string] getRawParamValues()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "map", "key": { "kind": "named", "name": "string", "display": "string" }, "value": { "kind": "named", "name": "string", "display": "string" }, "display": "map[string,string]" }, "description": "Return value of getRawParamValues as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getRawParamValues", "basis": "documentation" } ] }, "description": "The getRawParamValues() function returns a map of graph parameters and their values. The keys are the names of the parameters without the ${ } characters, e.g. PROJECT_DIR. Unlike getParamValues() function, the values are unresolved, so references to other graph parameters are not resolved and secure parameters are not decrypted. The map is unmodifiable. The function returns null for non-existent parameters.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getRawParamValues", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getRawParamValues() function is available since CloverETL 3.5.0.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getRawParamValues", "basis": "documentation" } ] } ], "see_also": [ "getRawParamValue" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getRawParamValues", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getRecordProperties": { "name": "getRecordProperties", "category": "record", "summary": "The getRecordProperties() function returns an unmodifiable map of selected properties of the specified record metadata.", "description": "The getRecordProperties() function returns an unmodifiable map of selected properties of the specified record metadata. New properties may be added to the map in future versions. If a null reference is passed as the argument, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getRecordProperties(record)", "canonical_signature": "map[string,string] getRecordProperties(record argRecord)", "type_parameters": [], "parameters": [ { "position": 0, "name": "argRecord", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented argRecord argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "map", "key": { "kind": "named", "name": "string", "display": "string" }, "value": { "kind": "named", "name": "string", "display": "string" }, "display": "map[string,string]" }, "description": "Return value of getRecordProperties as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getRecordProperties", "basis": "documentation" } ] }, "description": "The getRecordProperties() function returns an unmodifiable map of selected properties of the specified record metadata. New properties may be added to the map in future versions. If a null reference is passed as the argument, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getRecordProperties", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter argRecord is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getRecordProperties(record) function is available since CloverETL 4.1.0-M1.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getRecordProperties", "basis": "documentation" } ] } ], "see_also": [ "getFieldProperties" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "getRecordProperties", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getRequestBody": { "name": "getRequestBody", "category": "data_service_http", "summary": "The getRequestBody() function returns the request body.", "description": "The getRequestBody() function returns the request body.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getRequestBody()", "canonical_signature": "string getRequestBody()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getRequestBody as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestBody", "basis": "documentation" } ] }, "description": "The getRequestBody() function returns the request body.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestBody", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getRequestBody() function is available since CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestBody", "basis": "documentation" } ] } ], "see_also": [ "getRequestEncoding" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestBody", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getRequestCertificateProperties": { "name": "getRequestCertificateProperties", "category": "data_service_http", "summary": "The getRequestCertificateProperties() function returns information about client certificate.", "description": "The getRequestCertificateProperties() function returns information about client certificate. ===== Compatibility The getRequestCertificateProperties() function is available since CloverETL 7.5-M1.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getRequestCertificateProperties()", "canonical_signature": "map[string,string] getRequestCertificateProperties()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "map", "key": { "kind": "named", "name": "string", "display": "string" }, "value": { "kind": "named", "name": "string", "display": "string" }, "display": "map[string,string]" }, "description": "Return value of getRequestCertificateProperties as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestCertificateProperties", "basis": "documentation" } ] }, "description": "The getRequestCertificateProperties() function returns information about client certificate. ===== Compatibility The getRequestCertificateProperties() function is available since CloverETL 7.5-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestCertificateProperties", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [ "getRequestClientIPAddress" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestCertificateProperties", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getRequestClientIPAddress": { "name": "getRequestClientIPAddress", "category": "data_service_http", "summary": "The getRequestClientIPAddress() function returns the IP address of client performing the request.", "description": "The getRequestClientIPAddress() function returns the IP address of client performing the request. ===== Compatibility The getRequestClientIPAddress() function is available since CloverETL 4.7.0-M1.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getRequestClientIPAddress()", "canonical_signature": "string getRequestClientIPAddress()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getRequestClientIPAddress as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestClientIPAddress", "basis": "documentation" } ] }, "description": "The getRequestClientIPAddress() function returns the IP address of client performing the request. ===== Compatibility The getRequestClientIPAddress() function is available since CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestClientIPAddress", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [ "getRequestBody" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestClientIPAddress", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getRequestContentType": { "name": "getRequestContentType", "category": "data_service_http", "summary": "The getRequestContentType() function returns the content type.", "description": "The getRequestContentType() function returns the content type.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getRequestContentType()", "canonical_signature": "string getRequestContentType()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getRequestContentType as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestContentType", "basis": "documentation" } ] }, "description": "The getRequestContentType() function returns the content type.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestContentType", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getRequestContentType() function is available since CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestContentType", "basis": "documentation" } ] } ], "see_also": [ "getResponseContentType" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestContentType", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getRequestEncoding": { "name": "getRequestEncoding", "category": "data_service_http", "summary": "The getRequestEncoding() function encoding specified in _Content-Type_ header.", "description": "The getRequestEncoding() function encoding specified in _Content-Type_ header. If the header does not exist, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getRequestEncoding()", "canonical_signature": "string getRequestEncoding()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getRequestEncoding as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestEncoding", "basis": "documentation" } ] }, "description": "The getRequestEncoding() function encoding specified in _Content-Type_ header. If the header does not exist, the function returns null.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestEncoding", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getRequestEncoding() function is available since CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestEncoding", "basis": "documentation" } ] } ], "see_also": [ "setRequestEncoding" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestEncoding", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getRequestHeader": { "name": "getRequestHeader", "category": "data_service_http", "summary": "The getRequestHeader() function returns value of the header field.", "description": "The getRequestHeader() function returns value of the header field. The headerField parameter is HTTP header field name. If the header field does not exist, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getRequestHeader(string)", "canonical_signature": "string getRequestHeader(string headerField)", "type_parameters": [], "parameters": [ { "position": 0, "name": "headerField", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The headerField parameter is HTTP header field name.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getRequestHeader as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestHeader", "basis": "documentation" } ] }, "description": "The getRequestHeader() function returns value of the header field. The headerField parameter is HTTP header field name. If the header field does not exist, the function returns null.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestHeader", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter headerField is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function getRequestHeader(string) is available since CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestHeader", "basis": "documentation" } ] } ], "see_also": [ "getRequestHeaderNames" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestHeader", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getRequestHeaderNames": { "name": "getRequestHeaderNames", "category": "data_service_http", "summary": "The getRequestHeaderNames() function returns names of request header fields.", "description": "The getRequestHeaderNames() function returns names of request header fields.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getRequestHeaderNames()", "canonical_signature": "string[] getRequestHeaderNames()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "list", "element": { "kind": "named", "name": "string", "display": "string" }, "display": "string[]" }, "description": "Return value of getRequestHeaderNames as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestHeaderNames", "basis": "documentation" } ] }, "description": "The getRequestHeaderNames() function returns names of request header fields.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestHeaderNames", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function getRequestHeaderNames() was introduced in CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestHeaderNames", "basis": "documentation" } ] } ], "see_also": [ "getRequestHeader", "getRequestHeaders" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestHeaderNames", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getRequestHeaders": { "name": "getRequestHeaders", "category": "data_service_http", "summary": "The getRequestHeaders() function returns a map with request headers.", "description": "The getRequestHeaders() function returns a map with request headers. The header name is a key, header field value is value. The param parameter is __header field name__.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getRequestHeaders()", "canonical_signature": "map[string,string] getRequestHeaders()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "map", "key": { "kind": "named", "name": "string", "display": "string" }, "value": { "kind": "named", "name": "string", "display": "string" }, "display": "map[string,string]" }, "description": "Return value of getRequestHeaders as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestHeaders", "basis": "documentation" } ] }, "description": "The getRequestHeaders() function returns a map with request headers. The header name is a key, header field value is value. The param parameter is __header field name__.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestHeaders", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "getRequestHeaders(string)", "canonical_signature": "string[] getRequestHeaders(string param)", "type_parameters": [], "parameters": [ { "position": 0, "name": "param", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The param parameter is __header field name__.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "list", "element": { "kind": "named", "name": "string", "display": "string" }, "display": "string[]" }, "description": "Return value of getRequestHeaders as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestHeaders", "basis": "documentation" } ] }, "description": "The getRequestHeaders() function returns a map with request headers. The header name is a key, header field value is value. The param parameter is __header field name__.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestHeaders", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter param is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function getRequestHeaders() is available since CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestHeaders", "basis": "documentation" } ] } ], "see_also": [ "getRequestHeader", "getRequestHeaderNames" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestHeaders", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getRequestMethod": { "name": "getRequestMethod", "category": "data_service_http", "summary": "The getRequestMethod() function returns the HTTP method: GET, POST, PUT, PATCH or DELETE.", "description": "The getRequestMethod() function returns the HTTP method: GET, POST, PUT, PATCH or DELETE.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getRequestMethod()", "canonical_signature": "string getRequestMethod()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getRequestMethod as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestMethod", "basis": "documentation" } ] }, "description": "The getRequestMethod() function returns the HTTP method: GET, POST, PUT, PATCH or DELETE.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestMethod", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function getRequestMethod() was introduced in CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestMethod", "basis": "documentation" } ] } ], "see_also": [], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestMethod", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getRequestParameter": { "name": "getRequestParameter", "category": "data_service_http", "summary": "The getRequestParameter() function returns value of GET or POST parameter.", "description": "The getRequestParameter() function returns value of GET or POST parameter. The param parameter is the parameter name.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getRequestParameter(string)", "canonical_signature": "string getRequestParameter(string param)", "type_parameters": [], "parameters": [ { "position": 0, "name": "param", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The param parameter is the parameter name.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getRequestParameter as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestParameter", "basis": "documentation" } ] }, "description": "The getRequestParameter() function returns value of GET or POST parameter. The param parameter is the parameter name.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestParameter", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter param is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function getRequestParameters() was introduced in CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestParameter", "basis": "documentation" } ] } ], "see_also": [ "getRequestParameterNames", "getRequestParameters" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestParameter", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getRequestParameterNames": { "name": "getRequestParameterNames", "category": "data_service_http", "summary": "The getRequestParameterNames() function returns names of GET or POST parameters., e.g.", "description": "The getRequestParameterNames() function returns names of GET or POST parameters., e.g. \\http://example.com/?id=123&", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getRequestParameterNames()", "canonical_signature": "string[] getRequestParameterNames()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "list", "element": { "kind": "named", "name": "string", "display": "string" }, "display": "string[]" }, "description": "Return value of getRequestParameterNames as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestParameterNames", "basis": "documentation" } ] }, "description": "The getRequestParameterNames() function returns names of GET or POST parameters., e.g. \\http://example.com/?id=123&", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestParameterNames", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function getRequestParameternames() was introduced in CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestParameterNames", "basis": "documentation" } ] } ], "see_also": [ "getRequestParameter", "getRequestParameters" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestParameterNames", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getRequestParameters": { "name": "getRequestParameters", "category": "data_service_http", "summary": "The getRequestParameters() function return map of GET or POST request parameters and request parameter values.", "description": "The getRequestParameters() function return map of GET or POST request parameters and request parameter values. The parameters are from URL: www.example.com/getRequestParameters?id=123&name=doe&name=john& The name parameter is name of the parameter.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getRequestParameters()", "canonical_signature": "map[string,string] getRequestParameters()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "map", "key": { "kind": "named", "name": "string", "display": "string" }, "value": { "kind": "named", "name": "string", "display": "string" }, "display": "map[string,string]" }, "description": "Return value of getRequestParameters as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestParameters", "basis": "documentation" } ] }, "description": "The getRequestParameters() function return map of GET or POST request parameters and request parameter values. The parameters are from URL: www.example.com/getRequestParameters?id=123&name=doe&name=john& The name parameter is name of the parameter.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestParameters", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "getRequestParameters(string)", "canonical_signature": "string[] getRequestParameters(string name)", "type_parameters": [], "parameters": [ { "position": 0, "name": "name", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameters are from URL: www.example.com/getRequestParameters?id=123&name=doe&name=john& The name parameter is name of the parameter.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "list", "element": { "kind": "named", "name": "string", "display": "string" }, "display": "string[]" }, "description": "Return value of getRequestParameters as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestParameters", "basis": "documentation" } ] }, "description": "The getRequestParameters() function return map of GET or POST request parameters and request parameter values. The parameters are from URL: www.example.com/getRequestParameters?id=123&name=doe&name=john& The name parameter is name of the parameter.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestParameters", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter name is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function getRequestParameters() was introduced in CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestParameters", "basis": "documentation" } ] } ], "see_also": [ "getRequestParameter", "getRequestParameterNames" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestParameters", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getRequestPartFilename": { "name": "getRequestPartFilename", "category": "data_service_http", "summary": "The getRequestPartFilename() function returns name of file received in multipart entity.", "description": "The getRequestPartFilename() function returns name of file received in multipart entity. Usually, it is a file name from HTML form. The paramName parameter is name of HTML input field containing the file.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getRequestPartFilename(string)", "canonical_signature": "string getRequestPartFilename(string paramName)", "type_parameters": [], "parameters": [ { "position": 0, "name": "paramName", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The paramName parameter is name of HTML input field containing the file.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getRequestPartFilename as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestPartFilename", "basis": "documentation" } ] }, "description": "The getRequestPartFilename() function returns name of file received in multipart entity. Usually, it is a file name from HTML form. The paramName parameter is name of HTML input field containing the file.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestPartFilename", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter paramName is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function getRequestPartFileName(string) is available since CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestPartFilename", "basis": "documentation" } ] } ], "see_also": [], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getRequestPartFilename", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getResponseContentType": { "name": "getResponseContentType", "category": "data_service_http", "summary": "The getResponseContentType() function retuns response content type - the value of Content-Type response header field.", "description": "The getResponseContentType() function retuns response content type - the value of Content-Type response header field.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getResponseContentType()", "canonical_signature": "string getResponseContentType()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getResponseContentType as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getResponseContentType", "basis": "documentation" } ] }, "description": "The getResponseContentType() function retuns response content type - the value of Content-Type response header field.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getResponseContentType", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function getResponseContentType() is available since CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getResponseContentType", "basis": "documentation" } ] } ], "see_also": [], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getResponseContentType", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getResponseEncoding": { "name": "getResponseEncoding", "category": "data_service_http", "summary": "The getResponseEncoding() function returns the response encoding.", "description": "The getResponseEncoding() function returns the response encoding.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getResponseEncoding()", "canonical_signature": "string getResponseEncoding()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getResponseEncoding as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getResponseEncoding", "basis": "documentation" } ] }, "description": "The getResponseEncoding() function returns the response encoding.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getResponseEncoding", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function getResponseEncoding() is available since CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getResponseEncoding", "basis": "documentation" } ] } ], "see_also": [ "getRequestEncoding", "setResponseEncoding" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "getResponseEncoding", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getSecond": { "name": "getSecond", "category": "date", "summary": "The getSecond() function returns the second of the minute of arg.", "description": "The getSecond() function returns the second of the minute of arg. If the argument is null, the function returns null. If the timeZone argument is null or the argument in not present, the function uses the default Time Zone.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getSecond(date)", "canonical_signature": "integer getSecond(date arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getSecond() function returns the second of the minute of arg.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getSecond as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "getSecond", "basis": "documentation" } ] }, "description": "The getSecond() function returns the second of the minute of arg. If the argument is null, the function returns null. If the timeZone argument is null or the argument in not present, the function uses the default Time Zone.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getSecond", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "getSecond(date,string)", "canonical_signature": "integer getSecond(date arg, string timeZone)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getSecond() function returns the second of the minute of arg.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "timeZone", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the timeZone argument is null or the argument in not present, the function uses the default Time Zone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "timeZone is NULL -> default time zone.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getSecond as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "getSecond", "basis": "documentation" } ] }, "description": "The getSecond() function returns the second of the minute of arg. If the argument is null, the function returns null. If the timeZone argument is null or the argument in not present, the function uses the default Time Zone.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getSecond", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getSecond(date) and getSecond(date,string) functions are available since CloverETL 3.5.0-M1.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getSecond", "basis": "documentation" } ] } ], "see_also": [ "date2str", "getDay", "getDayOfWeek", "getHour", "getMillisecond", "getMinute", "getMonth", "getYear", "str2date" ], "evidence": [ { "source_id": "ctl2-date-functions", "section": "getSecond", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getStringValue": { "name": "getStringValue", "category": "record", "summary": "The getStringValue() function returns the value of a string field.", "description": "The getStringValue() function returns the value of a string field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getStringValue(record,integer)", "canonical_signature": "string getStringValue(record record, integer index)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The field is identified by its index (integer) or name (string).", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getStringValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getStringValue", "basis": "documentation" } ] }, "description": "The getStringValue() function returns the value of a string field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getStringValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter index is undocumented." ] } }, { "id": "getStringValue(record,string)", "canonical_signature": "string getStringValue(record record, string field)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "field", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getStringValue() function returns the value of a string field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getStringValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getStringValue", "basis": "documentation" } ] }, "description": "The getStringValue() function returns the value of a string field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getStringValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter field is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getStringValue(record, integer) function is available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getStringValue", "basis": "documentation" } ] } ], "see_also": [ "getBoolValue", "getByteValue", "getDateValue", "getDecimalValue", "getIntValue", "getLongValue", "getNumValue", "getValueAsString", "setStringValue" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "getStringValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getSubgraphInputPortsCount": { "name": "getSubgraphInputPortsCount", "category": "subgraph", "summary": "The function getSubgraphInputPortsCount() returns the number of input ports.", "description": "The function getSubgraphInputPortsCount() returns the number of input ports.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getSubgraphInputPortsCount()", "canonical_signature": "integer getSubgraphInputPortsCount()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getSubgraphInputPortsCount as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-subgraph-functions", "section": "getSubgraphInputPortsCount", "basis": "documentation" } ] }, "description": "The function getSubgraphInputPortsCount() returns the number of input ports.", "evidence": [ { "source_id": "ctl2-subgraph-functions", "section": "getSubgraphInputPortsCount", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function getSubgraphInputPortsCount() is available since CloverETL 4.1.0.", "evidence": [ { "source_id": "ctl2-subgraph-functions", "section": "getSubgraphInputPortsCount", "basis": "documentation" } ] } ], "see_also": [ "getSubgraphOutputPortsCount", "isSubgraphInputPortConnected", "isSubgraphOutputPortConnected" ], "evidence": [ { "source_id": "ctl2-subgraph-functions", "section": "getSubgraphInputPortsCount", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getSubgraphOutputPortsCount": { "name": "getSubgraphOutputPortsCount", "category": "subgraph", "summary": "The function getSubgraphOutputPortsCount() returns the number of output ports.", "description": "The function getSubgraphOutputPortsCount() returns the number of output ports.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getSubgraphOutputPortsCount()", "canonical_signature": "integer getSubgraphOutputPortsCount()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getSubgraphOutputPortsCount as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-subgraph-functions", "section": "getSubgraphOutputPortsCount", "basis": "documentation" } ] }, "description": "The function getSubgraphOutputPortsCount() returns the number of output ports.", "evidence": [ { "source_id": "ctl2-subgraph-functions", "section": "getSubgraphOutputPortsCount", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function getSubgraphOutputPortsCount() is available since CloverETL 4.1.0.", "evidence": [ { "source_id": "ctl2-subgraph-functions", "section": "getSubgraphOutputPortsCount", "basis": "documentation" } ] } ], "see_also": [ "getSubgraphInputPortsCount", "isSubgraphInputPortConnected", "isSubgraphOutputPortConnected" ], "evidence": [ { "source_id": "ctl2-subgraph-functions", "section": "getSubgraphOutputPortsCount", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getType": { "name": "getType", "category": "miscellaneous", "summary": "Returns the actual runtime type of the argument as a string.", "description": "Returns the actual runtime type of the argument as a string. If the argument is null, the function returns the string \"null\".", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getType(variant)", "canonical_signature": "string getType(variant arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getType as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getType", "basis": "documentation" } ] }, "description": "Returns the actual runtime type of the argument as a string. If the argument is null, the function returns the string \"null\".", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getType", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getType(variant) function is available since CloverDX 5.6.0.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getType", "basis": "documentation" } ] } ], "see_also": [ "cast", "typeof", "variant" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "getType", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [ "See-also references outside the v1 core-source scope: typeof, variant." ] } }, "getUrlHost": { "name": "getUrlHost", "category": "string", "summary": "The getUrlHost() function parses out a host name from a specified URL.", "description": "The getUrlHost() function parses out a host name from a specified URL. If the hostname part is not present in the URL argument, an empty string is returned. If the URL is not valid, null is returned. For the scheme, see isUrl. The function returns null value for an empty string and null input.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getUrlHost(string)", "canonical_signature": "string getUrlHost(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getUrlHost as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlHost", "basis": "documentation" } ] }, "description": "The getUrlHost() function parses out a host name from a specified URL. If the hostname part is not present in the URL argument, an empty string is returned. If the URL is not valid, null is returned. For the scheme, see isUrl. The function returns null value for an empty string and null input.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlHost", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getUrlHost(string) function is available since CloverETL 3.1.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlHost", "basis": "documentation" } ] } ], "see_also": [ "getUrlPath", "getUrlPort", "getUrlProtocol", "getUrlQuery", "getUrlRef", "getUrlUserInfo", "isUrl" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlHost", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getUrlPath": { "name": "getUrlPath", "category": "string", "summary": "The getUrlPath() function parses out a path from a specified URL.", "description": "The getUrlPath() function parses out a path from a specified URL. If the path part is not present in the URL argument, an empty string is returned. If the URL is not valid, null is returned. For the scheme, see isUrl. The function returns null value for an empty string and null input.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getUrlPath(string)", "canonical_signature": "string getUrlPath(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getUrlPath as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlPath", "basis": "documentation" } ] }, "description": "The getUrlPath() function parses out a path from a specified URL. If the path part is not present in the URL argument, an empty string is returned. If the URL is not valid, null is returned. For the scheme, see isUrl. The function returns null value for an empty string and null input.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlPath", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getUrlPath(string) function is available since CloverETL 3.1.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlPath", "basis": "documentation" } ] } ], "see_also": [ "getUrlHost", "getUrlPort", "getUrlProtocol", "getUrlQuery", "getUrlRef", "getUrlUserInfo", "isUrl" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlPath", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getUrlPort": { "name": "getUrlPort", "category": "string", "summary": "The getUrlPort() function parses out a port number from a specified URL.", "description": "The getUrlPort() function parses out a port number from a specified URL. If the port part is not present in the URL argument, -1 is returned. If the URL has invalid syntax, -2 is returned. For the scheme, see isUrl. The function returns -2 value for an empty string and null input.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getUrlPort(string)", "canonical_signature": "integer getUrlPort(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> -2.", "result": { "kind": "literal", "type": "integer", "value": -2, "display": "-2" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getUrlPort as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlPort", "basis": "documentation" } ] }, "description": "The getUrlPort() function parses out a port number from a specified URL. If the port part is not present in the URL argument, -1 is returned. If the URL has invalid syntax, -2 is returned. For the scheme, see isUrl. The function returns -2 value for an empty string and null input.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlPort", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getUrlPort(string) function is available since CloverETL 3.1.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlPort", "basis": "documentation" } ] } ], "see_also": [ "getUrlHost", "getUrlPath", "getUrlProtocol", "getUrlQuery", "getUrlRef", "getUrlUserInfo", "isUrl" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlPort", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getUrlProtocol": { "name": "getUrlProtocol", "category": "string", "summary": "The getUrlProtocol() function parses out a protocol name from a specified URL.", "description": "The getUrlProtocol() function parses out a protocol name from a specified URL. If the protocol part is not present in the URL argument, an empty string is returned. If the URL is not valid, null is returned. For the scheme, see isUrl. The function returns null value for the empty string and null input.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getUrlProtocol(string)", "canonical_signature": "string getUrlProtocol(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getUrlProtocol as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlProtocol", "basis": "documentation" } ] }, "description": "The getUrlProtocol() function parses out a protocol name from a specified URL. If the protocol part is not present in the URL argument, an empty string is returned. If the URL is not valid, null is returned. For the scheme, see isUrl. The function returns null value for the empty string and null input.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlProtocol", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getUrlProtocol(string) function is available since CloverETL 3.1.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlProtocol", "basis": "documentation" } ] } ], "see_also": [ "getUrlHost", "getUrlPath", "getUrlPort", "getUrlQuery", "getUrlRef", "getUrlUserInfo", "isUrl" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlProtocol", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getUrlQuery": { "name": "getUrlQuery", "category": "string", "summary": "The getUrlQuery() function parses out a query (parameters) from a specified URL.", "description": "The getUrlQuery() function parses out a query (parameters) from a specified URL. If the query part is not present in the URL argument, an empty string is returned. If the URL syntax is invalid, null is returned. For the scheme, see isUrl. The function returns null value for the empty string and null input.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getUrlQuery(string)", "canonical_signature": "string getUrlQuery(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getUrlQuery as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlQuery", "basis": "documentation" } ] }, "description": "The getUrlQuery() function parses out a query (parameters) from a specified URL. If the query part is not present in the URL argument, an empty string is returned. If the URL syntax is invalid, null is returned. For the scheme, see isUrl. The function returns null value for the empty string and null input.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlQuery", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getUrlQuery(string) function is available since CloverETL 3.1.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlQuery", "basis": "documentation" } ] } ], "see_also": [ "getUrlHost", "getUrlPath", "getUrlPort", "getUrlProtocol", "getUrlRef", "getUrlUserInfo", "isUrl" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlQuery", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getUrlRef": { "name": "getUrlRef", "category": "string", "summary": "The getUrlRef() function parses out the fragment after # character, also known as ref, reference or anchor, from a specified URL.", "description": "The getUrlRef() function parses out the fragment after # character, also known as ref, reference or anchor, from a specified URL. If the fragment part is not present in the URL argument, an empty string is returned. If the URL syntax is invalid, null is returned. For the URL scheme, see isUrl. The function returns null value for the empty string and null input.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getUrlRef(string)", "canonical_signature": "string getUrlRef(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getUrlRef as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlRef", "basis": "documentation" } ] }, "description": "The getUrlRef() function parses out the fragment after # character, also known as ref, reference or anchor, from a specified URL. If the fragment part is not present in the URL argument, an empty string is returned. If the URL syntax is invalid, null is returned. For the URL scheme, see isUrl. The function returns null value for the empty string and null input.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlRef", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getUrlRef(string) function is available since CloverETL 3.1.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlRef", "basis": "documentation" } ] } ], "see_also": [ "getUrlHost", "getUrlPath", "getUrlPort", "getUrlProtocol", "getUrlQuery", "getUrlUserInfo", "isUrl" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlRef", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getUrlUserInfo": { "name": "getUrlUserInfo", "category": "string", "summary": "The getUrlUserInfo() function parses out a username and password from a specified URL.", "description": "The getUrlUserInfo() function parses out a username and password from a specified URL. If the userinfo part is not present in the URL argument, an empty string is returned. If the URL syntax is invalid, null is returned. For the scheme, see isUrl. The function returns null value for the empty string and null input.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getUrlUserInfo(string)", "canonical_signature": "string getUrlUserInfo(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getUrlUserInfo as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlUserInfo", "basis": "documentation" } ] }, "description": "The getUrlUserInfo() function parses out a username and password from a specified URL. If the userinfo part is not present in the URL argument, an empty string is returned. If the URL syntax is invalid, null is returned. For the scheme, see isUrl. The function returns null value for the empty string and null input.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlUserInfo", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getUrlUserInfo(string) function is available since CloverETL 3.1.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlUserInfo", "basis": "documentation" } ] } ], "see_also": [ "getUrlHost", "getUrlPath", "getUrlPort", "getUrlProtocol", "getUrlQuery", "getUrlRef", "isUrl" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "getUrlUserInfo", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getValue": { "name": "getValue", "category": "record", "summary": "Returns the value of the selected field.", "description": "Returns the value of the selected field. The field is identified by its zero-based index (integer) or name (string). The actual type of the returned value depends on the type of the data field, there is no automatic conversion. If the record is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getValue(record,integer)", "canonical_signature": "variant getValue(record record, integer index)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the record is null, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The field is identified by its zero-based index (integer) or name (string).", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "variant", "display": "variant" }, "description": "Return value of getValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getValue", "basis": "documentation" } ] }, "description": "Returns the value of the selected field. The field is identified by its zero-based index (integer) or name (string). The actual type of the returned value depends on the type of the data field, there is no automatic conversion. If the record is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter index is undocumented." ] } }, { "id": "getValue(record,string)", "canonical_signature": "variant getValue(record record, string field)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the record is null, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "field", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Returns the value of the selected field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "variant", "display": "variant" }, "description": "Return value of getValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getValue", "basis": "documentation" } ] }, "description": "Returns the value of the selected field. The field is identified by its zero-based index (integer) or name (string). The actual type of the returned value depends on the type of the data field, there is no automatic conversion. If the record is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter field is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function is available since CloverDX 5.7.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getValue", "basis": "documentation" } ] } ], "see_also": [ "getBoolValue", "getByteValue", "getDateValue", "getDecimalValue", "getIntValue", "getLongValue", "getNumValue", "getStringValue", "getValueAsString", "setValue" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "getValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getValueAsString": { "name": "getValueAsString", "category": "record", "summary": "The getValueAsString() function returns the value of a field (no matter its type) as a common string.", "description": "The getValueAsString() function returns the value of a field (no matter its type) as a common string. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getValueAsString(record,integer)", "canonical_signature": "string getValueAsString(record record, integer index)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The field is identified by its index (integer) or name (string).", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getValueAsString as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getValueAsString", "basis": "documentation" } ] }, "description": "The getValueAsString() function returns the value of a field (no matter its type) as a common string. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getValueAsString", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter index is undocumented." ] } }, { "id": "getValueAsString(record,string)", "canonical_signature": "string getValueAsString(record record, string field)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "field", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getValueAsString() function returns the value of a field (no matter its type) as a common string.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of getValueAsString as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "getValueAsString", "basis": "documentation" } ] }, "description": "The getValueAsString() function returns the value of a field (no matter its type) as a common string. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getValueAsString", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter field is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getValueAsString(record,integer) and getValueAsString(record,string) function is available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "getValueAsString", "basis": "documentation" } ] } ], "see_also": [ "getBoolValue", "getByteValue", "getDateValue", "getDecimalValue", "getIntValue", "getLongValue", "getNumValue", "getStringValue" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "getValueAsString", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "getValues": { "name": "getValues", "category": "container", "summary": "Returns the values contained in the specified map as a list.", "description": "Returns the values contained in the specified map as a list. If the argument is an empty map, the function returns an empty list. The order of elements in the result is not specified - the function does not sort its result (use sort to sort the result if needed). === Error states If the argument is null, the function fails. === Compatibility The getValues(map[key_type, value_type]) function is available since CloverETL 4.0.0. The getValues(variant) function is available since CloverDX 5.7.0.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getValues(map[K,V])", "canonical_signature": "V[] getValues(map[K,V] map)", "type_parameters": [ { "name": "V", "constraint": { "kind": "any", "display": "any" } }, { "name": "K", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "map", "type": { "kind": "map", "key": { "kind": "type_variable", "name": "K", "display": "K" }, "value": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "map[K,V]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Returns the values contained in the specified map as a list.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "map is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "list", "element": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "V[]" }, "description": "Return value of getValues as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "getValues", "basis": "documentation" } ] }, "description": "Returns the values contained in the specified map as a list. If the argument is an empty map, the function returns an empty list. The order of elements in the result is not specified - the function does not sort its result (use sort to sort the result if needed). === Error states If the argument is null, the function fails. === Compatibility The getValues(map[key_type, value_type]) function is available since CloverETL 4.0.0. The getValues(variant) function is available since CloverDX 5.7.0.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "getValues", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "map == NULL", "description": "map is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "getValues(variant)", "canonical_signature": "variant getValues(variant map)", "type_parameters": [], "parameters": [ { "position": 0, "name": "map", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Returns the values contained in the specified map as a list.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "map is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "variant", "display": "variant" }, "description": "Return value of getValues as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "getValues", "basis": "documentation" } ] }, "description": "Returns the values contained in the specified map as a list. If the argument is an empty map, the function returns an empty list. The order of elements in the result is not specified - the function does not sort its result (use sort to sort the result if needed). === Error states If the argument is null, the function fails. === Compatibility The getValues(map[key_type, value_type]) function is available since CloverETL 4.0.0. The getValues(variant) function is available since CloverDX 5.7.0.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "getValues", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "map == NULL", "description": "map is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-container-functions", "section": "getValues", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "getYear": { "name": "getYear", "category": "date", "summary": "The getYear() function returns the year of arg.", "description": "The getYear() function returns the year of arg. If the argument is null, the function returns null. If the timeZone argument is null or the argument is missing, the function uses the default Time Zone.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "getYear(date)", "canonical_signature": "integer getYear(date arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getYear() function returns the year of arg.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getYear as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "getYear", "basis": "documentation" } ] }, "description": "The getYear() function returns the year of arg. If the argument is null, the function returns null. If the timeZone argument is null or the argument is missing, the function uses the default Time Zone.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getYear", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "getYear(date,string)", "canonical_signature": "integer getYear(date arg, string timeZone)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The getYear() function returns the year of arg.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "timeZone", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the timeZone argument is null or the argument is missing, the function uses the default Time Zone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "timeZone is NULL -> default time zone.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of getYear as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "getYear", "basis": "documentation" } ] }, "description": "The getYear() function returns the year of arg. If the argument is null, the function returns null. If the timeZone argument is null or the argument is missing, the function uses the default Time Zone.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getYear", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The getYear(date) and getYear(date,string) functions are available since CloverETL 3.5.0-M1.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "getYear", "basis": "documentation" } ] } ], "see_also": [ "date2str", "getDay", "getDayOfWeek", "getHour", "getMillisecond", "getMinute", "getMonth", "getSecond", "str2date" ], "evidence": [ { "source_id": "ctl2-date-functions", "section": "getYear", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "hashCode": { "name": "hashCode", "category": "miscellaneous", "summary": "Returns java hashCode of parameter.", "description": "Returns java hashCode of parameter.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "hashCode(boolean)", "canonical_signature": "integer hashCode(boolean arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of hashCode as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ] }, "description": "Returns java hashCode of parameter.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg is undocumented." ] } }, { "id": "hashCode(date)", "canonical_signature": "integer hashCode(date arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of hashCode as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ] }, "description": "Returns java hashCode of parameter.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg is undocumented." ] } }, { "id": "hashCode(decimal)", "canonical_signature": "integer hashCode(decimal arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of hashCode as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ] }, "description": "Returns java hashCode of parameter.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg is undocumented." ] } }, { "id": "hashCode(integer)", "canonical_signature": "integer hashCode(integer arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of hashCode as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ] }, "description": "Returns java hashCode of parameter.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg is undocumented." ] } }, { "id": "hashCode(long)", "canonical_signature": "integer hashCode(long arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of hashCode as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ] }, "description": "Returns java hashCode of parameter.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg is undocumented." ] } }, { "id": "hashCode(map)", "canonical_signature": "integer hashCode(map arg)", "type_parameters": [ { "name": "map", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "type_variable", "name": "map", "display": "map" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of hashCode as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ] }, "description": "Returns java hashCode of parameter.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg is undocumented." ] } }, { "id": "hashCode(number)", "canonical_signature": "integer hashCode(number arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of hashCode as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ] }, "description": "Returns java hashCode of parameter.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg is undocumented." ] } }, { "id": "hashCode(record)", "canonical_signature": "integer hashCode(record arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of hashCode as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ] }, "description": "Returns java hashCode of parameter.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg is undocumented." ] } }, { "id": "hashCode(string)", "canonical_signature": "integer hashCode(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of hashCode as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ] }, "description": "Returns java hashCode of parameter.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg is undocumented." ] } }, { "id": "hashCode(variant)", "canonical_signature": "integer hashCode(variant arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of hashCode as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ] }, "description": "Returns java hashCode of parameter.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The hashcode(...) function is available since CloverETL 3.5.0-M1.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ] } ], "see_also": [], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "hashCode", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "hex2byte": { "name": "hex2byte", "category": "conversion", "summary": "The hex2byte() function converts a string argument in hexadecimal representation to an array of bytes.", "description": "The hex2byte() function converts a string argument in hexadecimal representation to an array of bytes. Its counterpart is the byte2hex function. If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "hex2byte(string)", "canonical_signature": "byte hex2byte(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of hex2byte as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "hex2byte", "basis": "documentation" } ] }, "description": "The hex2byte() function converts a string argument in hexadecimal representation to an array of bytes. Its counterpart is the byte2hex function. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "hex2byte", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The hex2byte(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "hex2byte", "basis": "documentation" } ] } ], "see_also": [ "byte2hex", "str2byte" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "hex2byte", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "iif": { "name": "iif", "category": "miscellaneous", "summary": "The iif() function returns the second argument if the first argument is true, or the third argument if the first argument is false.", "description": "The iif() function returns the second argument if the first argument is true, or the third argument if the first argument is false. If the first argument is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "iif(boolean,any,any)", "canonical_signature": "any iif(boolean con, any arg2, any arg3)", "type_parameters": [], "parameters": [ { "position": 0, "name": "con", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented con argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "arg3", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg3 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of iif as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "iif", "basis": "documentation" } ] }, "description": "The iif() function returns the second argument if the first argument is true, or the third argument if the first argument is false. If the first argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "iif", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter con is undocumented.", "NULL behavior for parameter arg2 is undocumented.", "NULL behavior for parameter arg3 is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The iif(boolean,E,E) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "iif", "basis": "documentation" } ] } ], "see_also": [ "nvl", "nvl2" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "iif", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "in": { "name": "in", "category": "container", "summary": "Returns true if the specified collection contains the specified element.", "description": "Returns true if the specified collection contains the specified element. If the collection is a map, returns true if the map contains the element as a key (the function does not search in values). Note that seach in list is performed as linear search and can be slow for large lists. Searching in maps is constant time since only keys are searched. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "in(K,map[K,V])", "canonical_signature": "boolean in(K key, map[K,V] map)", "type_parameters": [ { "name": "K", "constraint": { "kind": "any", "display": "any" } }, { "name": "V", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "key", "type": { "kind": "type_variable", "name": "K", "display": "K" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the collection is a map, returns true if the map contains the element as a key (the function does not search in values).", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "map", "type": { "kind": "map", "key": { "kind": "type_variable", "name": "K", "display": "K" }, "value": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "map[K,V]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the collection is a map, returns true if the map contains the element as a key (the function does not search in values).", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "NULL list, map, or variant container -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of in as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "in", "basis": "documentation" } ] }, "description": "Returns true if the specified collection contains the specified element. If the collection is a map, returns true if the map contains the element as a key (the function does not search in values). Note that seach in list is performed as linear search and can be slow for large lists. Searching in maps is constant time since only keys are searched. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "in", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "map == NULL", "description": "NULL list, map, or variant container -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter key is undocumented." ] } }, { "id": "in(T,T[])", "canonical_signature": "boolean in(T element, T[] list)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "element", "type": { "kind": "type_variable", "name": "T", "display": "T" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Returns true if the specified collection contains the specified element.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "NULL element in a non-NULL list, map, or variant container -> false.", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "list", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Note that seach in list is performed as linear search and can be slow for large lists.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "NULL list, map, or variant container -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of in as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "in", "basis": "documentation" } ] }, "description": "Returns true if the specified collection contains the specified element. If the collection is a map, returns true if the map contains the element as a key (the function does not search in values). Note that seach in list is performed as linear search and can be slow for large lists. Searching in maps is constant time since only keys are searched. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "in", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "list == NULL", "description": "NULL list, map, or variant container -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "in(T,variant)", "canonical_signature": "boolean in(T element, variant collection)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "element", "type": { "kind": "type_variable", "name": "T", "display": "T" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Returns true if the specified collection contains the specified element.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "NULL element in a non-NULL list, map, or variant container -> false.", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "collection", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Returns true if the specified collection contains the specified element.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of in as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "in", "basis": "documentation" } ] }, "description": "Returns true if the specified collection contains the specified element. If the collection is a map, returns true if the map contains the element as a key (the function does not search in values). Note that seach in list is performed as linear search and can be slow for large lists. Searching in maps is constant time since only keys are searched. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "in", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter collection is undocumented." ] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-container-functions", "section": "in", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "indexOf": { "name": "indexOf", "category": "string", "summary": "The indexOf() function returns the index (zero-based) of the first occurrence of substring in the string.", "description": "The indexOf() function returns the index (zero-based) of the first occurrence of substring in the string. Returns -1 if no occurrence is found. If the parameter arg is null, the function returns -1. See compatibility notice. If the second argument is null, the function fails with an error. If the second argument is an empty string, the function returns 0. Start position for search is set up using parameter fromIndex.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "indexOf(string,string)", "canonical_signature": "integer indexOf(string arg, string substring)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the parameter arg is null, the function returns -1.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Compatibility: arg NULL caused a runtime error in CloverETL 3.5.x and earlier.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "substring", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The indexOf() function returns the index (zero-based) of the first occurrence of substring in the string.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "substring is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of indexOf as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "indexOf", "basis": "documentation" } ] }, "description": "The indexOf() function returns the index (zero-based) of the first occurrence of substring in the string. Returns -1 if no occurrence is found. If the parameter arg is null, the function returns -1. See compatibility notice. If the second argument is null, the function fails with an error. If the second argument is an empty string, the function returns 0. Start position for search is set up using parameter fromIndex.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "indexOf", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "Compatibility: arg NULL caused a runtime error in CloverETL 3.5.x and earlier.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "substring == NULL", "description": "substring is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "indexOf(string,string,integer)", "canonical_signature": "integer indexOf(string arg, string substring, integer fromIndex)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the parameter arg is null, the function returns -1.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Compatibility: arg NULL caused a runtime error in CloverETL 3.5.x and earlier.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "substring", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The indexOf() function returns the index (zero-based) of the first occurrence of substring in the string.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "substring is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "fromIndex", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Start position for search is set up using parameter fromIndex.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "fromIndex is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of indexOf as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "indexOf", "basis": "documentation" } ] }, "description": "The indexOf() function returns the index (zero-based) of the first occurrence of substring in the string. Returns -1 if no occurrence is found. If the parameter arg is null, the function returns -1. See compatibility notice. If the second argument is null, the function fails with an error. If the second argument is an empty string, the function returns 0. Start position for search is set up using parameter fromIndex.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "indexOf", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "Compatibility: arg NULL caused a runtime error in CloverETL 3.5.x and earlier.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "substring == NULL", "description": "substring is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "fromIndex == NULL", "description": "fromIndex is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The indexOf(string,string) and indexOf(string,string,integer) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "indexOf", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "In CloverETL 3.5.x and earlier the function fails with an error if the arg argument is null.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "indexOf", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "For example indexOf(null, \"chair\") in CloverETL 3.5.x and earlier fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "indexOf", "basis": "documentation" } ] } ], "see_also": [ "indexOf", "matches" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "indexOf", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "insert": { "name": "insert", "category": "container", "summary": "Inserts one or more elements into the list at the specified position, indexed from 0.", "description": "Inserts one or more elements into the list at the specified position, indexed from 0. Moves the element currently at that position (if any) and all subsequent elements to the right. Modifies the target list and returns the modified list. === Error states If the list given as the first argument is null, the function fails with an error. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "insert(T[],integer,T...)", "canonical_signature": "T[] insert(T[] target, integer position, T elements...)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "target", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Modifies the target list and returns the modified list.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "First argument (target) is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "position", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Inserts one or more elements into the list at the specified position, indexed from 0.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Variant-overload position NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "elements", "type": { "kind": "type_variable", "name": "T", "display": "T" }, "optional": false, "variadic": true, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Inserts one or more elements into the list at the specified position, indexed from 0.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": "unbounded" }, "returns": { "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "description": "Return value of insert as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "insert", "basis": "documentation" } ] }, "description": "Inserts one or more elements into the list at the specified position, indexed from 0. Moves the element currently at that position (if any) and all subsequent elements to the right. Modifies the target list and returns the modified list. === Error states If the list given as the first argument is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "insert", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "target == NULL", "description": "First argument (target) is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "position == NULL", "description": "Variant-overload position NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [ { "kind": "mutates_parameter", "parameter": "target", "description": "Documentation states that insert modifies its target argument.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "insert", "basis": "documentation" } ] } ], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter elements is undocumented." ] } }, { "id": "insert(T[],integer,T[])", "canonical_signature": "T[] insert(T[] target, integer position, T[] source)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "target", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Modifies the target list and returns the modified list.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "First argument (target) is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "position", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Inserts one or more elements into the list at the specified position, indexed from 0.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Variant-overload position NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "source", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Inserts one or more elements into the list at the specified position, indexed from 0.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "List-overload source NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "description": "Return value of insert as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "insert", "basis": "documentation" } ] }, "description": "Inserts one or more elements into the list at the specified position, indexed from 0. Moves the element currently at that position (if any) and all subsequent elements to the right. Modifies the target list and returns the modified list. === Error states If the list given as the first argument is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "insert", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "target == NULL", "description": "First argument (target) is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "position == NULL", "description": "Variant-overload position NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "source == NULL", "description": "List-overload source NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [ { "kind": "mutates_parameter", "parameter": "target", "description": "Documentation states that insert modifies its target argument.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "insert", "basis": "documentation" } ] } ], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "insert(variant,integer,variant...)", "canonical_signature": "variant insert(variant target, integer position, variant elements...)", "type_parameters": [], "parameters": [ { "position": 0, "name": "target", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Modifies the target list and returns the modified list.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "First argument (target) is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "position", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Inserts one or more elements into the list at the specified position, indexed from 0.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Variant-overload position NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "elements", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": true, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Inserts one or more elements into the list at the specified position, indexed from 0.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": "unbounded" }, "returns": { "type": { "kind": "named", "name": "variant", "display": "variant" }, "description": "Return value of insert as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "insert", "basis": "documentation" } ] }, "description": "Inserts one or more elements into the list at the specified position, indexed from 0. Moves the element currently at that position (if any) and all subsequent elements to the right. Modifies the target list and returns the modified list. === Error states If the list given as the first argument is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "insert", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "target == NULL", "description": "First argument (target) is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "position == NULL", "description": "Variant-overload position NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [ { "kind": "mutates_parameter", "parameter": "target", "description": "Documentation states that insert modifies its target argument.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "insert", "basis": "documentation" } ] } ], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter elements is undocumented." ] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-container-functions", "section": "insert", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "isAscii": { "name": "isAscii", "category": "string", "summary": "The isAscii() checks the string for occurrence of non-ASCII characters.", "description": "The isAscii() checks the string for occurrence of non-ASCII characters. The function takes one string argument and returns a boolean value depending on whether the string can be encoded as an ASCII string (true) or not (false). If the input is null or empty string, the function returns true.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "isAscii(string)", "canonical_signature": "boolean isAscii(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isAscii as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isAscii", "basis": "documentation" } ] }, "description": "The isAscii() checks the string for occurrence of non-ASCII characters. The function takes one string argument and returns a boolean value depending on whether the string can be encoded as an ASCII string (true) or not (false). If the input is null or empty string, the function returns true.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isAscii", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The isAscii(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isAscii", "basis": "documentation" } ] } ], "see_also": [ "isBlank", "isDate", "isInteger", "isLong", "isNumber", "removeDiacritic", "removeNonAscii", "removeNonPrintable" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "isAscii", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "isBlank": { "name": "isBlank", "category": "miscellaneous", "summary": "// NOTE: isBlank is also mentioned in ctl2-string-functions.adoc.", "description": "// NOTE: isBlank is also mentioned in ctl2-string-functions.adoc. If this description is updated, review that version as well. For long, integer, decimal, boolean, date and number arguments the function returns a true if the input is null otherwise false. For following structured types: byte, map, list and variant it returns true if the input is null or if the number of elements forming a given structured data type is 0. For string argument, the isBlank() function returns a boolean value depending on whether the string contains only white space characters (true) or not (false), if the input is null or an empty string, the function returns true.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "isBlank(any)", "canonical_signature": "boolean isBlank(any arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isBlank as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ] }, "description": "// NOTE: isBlank is also mentioned in ctl2-string-functions.adoc. If this description is updated, review that version as well. For long, integer, decimal, boolean, date and number arguments the function returns a true if the input is null otherwise false. For following structured types: byte, map, list and variant it returns true if the input is null or if the number of elements forming a given structured data type is 0. For string argument, the isBlank() function returns a boolean value depending on whether the string contains only white space characters (true) or not (false), if the input is null or an empty string, the function returns true.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isBlank(any)#2", "canonical_signature": "boolean isBlank(any arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isBlank as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ] }, "description": "// NOTE: isBlank is also mentioned in ctl2-string-functions.adoc. If this description is updated, review that version as well. For long, integer, decimal, boolean, date and number arguments the function returns a true if the input is null otherwise false. For following structured types: byte, map, list and variant it returns true if the input is null or if the number of elements forming a given structured data type is 0. For string argument, the isBlank() function returns a boolean value depending on whether the string contains only white space characters (true) or not (false), if the input is null or an empty string, the function returns true.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "Duplicate normalized overload ID required a stable discriminator." ] } }, { "id": "isBlank(boolean)", "canonical_signature": "boolean isBlank(boolean arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isBlank as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ] }, "description": "// NOTE: isBlank is also mentioned in ctl2-string-functions.adoc. If this description is updated, review that version as well. For long, integer, decimal, boolean, date and number arguments the function returns a true if the input is null otherwise false. For following structured types: byte, map, list and variant it returns true if the input is null or if the number of elements forming a given structured data type is 0. For string argument, the isBlank() function returns a boolean value depending on whether the string contains only white space characters (true) or not (false), if the input is null or an empty string, the function returns true.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isBlank(byte)", "canonical_signature": "boolean isBlank(byte arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isBlank as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ] }, "description": "// NOTE: isBlank is also mentioned in ctl2-string-functions.adoc. If this description is updated, review that version as well. For long, integer, decimal, boolean, date and number arguments the function returns a true if the input is null otherwise false. For following structured types: byte, map, list and variant it returns true if the input is null or if the number of elements forming a given structured data type is 0. For string argument, the isBlank() function returns a boolean value depending on whether the string contains only white space characters (true) or not (false), if the input is null or an empty string, the function returns true.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isBlank(decimal)", "canonical_signature": "boolean isBlank(decimal arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isBlank as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ] }, "description": "// NOTE: isBlank is also mentioned in ctl2-string-functions.adoc. If this description is updated, review that version as well. For long, integer, decimal, boolean, date and number arguments the function returns a true if the input is null otherwise false. For following structured types: byte, map, list and variant it returns true if the input is null or if the number of elements forming a given structured data type is 0. For string argument, the isBlank() function returns a boolean value depending on whether the string contains only white space characters (true) or not (false), if the input is null or an empty string, the function returns true.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isBlank(integer)", "canonical_signature": "boolean isBlank(integer arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isBlank as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ] }, "description": "// NOTE: isBlank is also mentioned in ctl2-string-functions.adoc. If this description is updated, review that version as well. For long, integer, decimal, boolean, date and number arguments the function returns a true if the input is null otherwise false. For following structured types: byte, map, list and variant it returns true if the input is null or if the number of elements forming a given structured data type is 0. For string argument, the isBlank() function returns a boolean value depending on whether the string contains only white space characters (true) or not (false), if the input is null or an empty string, the function returns true.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isBlank(long)", "canonical_signature": "boolean isBlank(long arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isBlank as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ] }, "description": "// NOTE: isBlank is also mentioned in ctl2-string-functions.adoc. If this description is updated, review that version as well. For long, integer, decimal, boolean, date and number arguments the function returns a true if the input is null otherwise false. For following structured types: byte, map, list and variant it returns true if the input is null or if the number of elements forming a given structured data type is 0. For string argument, the isBlank() function returns a boolean value depending on whether the string contains only white space characters (true) or not (false), if the input is null or an empty string, the function returns true.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isBlank(number)", "canonical_signature": "boolean isBlank(number arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isBlank as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ] }, "description": "// NOTE: isBlank is also mentioned in ctl2-string-functions.adoc. If this description is updated, review that version as well. For long, integer, decimal, boolean, date and number arguments the function returns a true if the input is null otherwise false. For following structured types: byte, map, list and variant it returns true if the input is null or if the number of elements forming a given structured data type is 0. For string argument, the isBlank() function returns a boolean value depending on whether the string contains only white space characters (true) or not (false), if the input is null or an empty string, the function returns true.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isBlank(record)", "canonical_signature": "boolean isBlank(record arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isBlank as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ] }, "description": "// NOTE: isBlank is also mentioned in ctl2-string-functions.adoc. If this description is updated, review that version as well. For long, integer, decimal, boolean, date and number arguments the function returns a true if the input is null otherwise false. For following structured types: byte, map, list and variant it returns true if the input is null or if the number of elements forming a given structured data type is 0. For string argument, the isBlank() function returns a boolean value depending on whether the string contains only white space characters (true) or not (false), if the input is null or an empty string, the function returns true.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isBlank(string)", "canonical_signature": "boolean isBlank(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isBlank as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ] }, "description": "// NOTE: isBlank is also mentioned in ctl2-string-functions.adoc. If this description is updated, review that version as well. For long, integer, decimal, boolean, date and number arguments the function returns a true if the input is null otherwise false. For following structured types: byte, map, list and variant it returns true if the input is null or if the number of elements forming a given structured data type is 0. For string argument, the isBlank() function returns a boolean value depending on whether the string contains only white space characters (true) or not (false), if the input is null or an empty string, the function returns true.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isBlank(string)#2", "canonical_signature": "boolean isBlank(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isBlank as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isBlank", "basis": "documentation" } ] }, "description": "// NOTE: isBlank is also mentioned in ctl2-miscellaneous-functions.adoc. If this description is updated, review that version as well. The function returns a boolean value depending on whether the parameter contains only white space characters (true) or not (false), if the input is null or an empty string, the function returns true. Note: There are many other overloads of the isBlank function which work with arguments of other data types. See <)>> for more details.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isBlank", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "Duplicate normalized overload ID required a stable discriminator." ] } }, { "id": "isBlank(variant)", "canonical_signature": "boolean isBlank(variant arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isBlank as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ] }, "description": "// NOTE: isBlank is also mentioned in ctl2-string-functions.adoc. If this description is updated, review that version as well. For long, integer, decimal, boolean, date and number arguments the function returns a true if the input is null otherwise false. For following structured types: byte, map, list and variant it returns true if the input is null or if the number of elements forming a given structured data type is 0. For string argument, the isBlank() function returns a boolean value depending on whether the string contains only white space characters (true) or not (false), if the input is null or an empty string, the function returns true.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The isBlank(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The overloads for types other than string are available since CloverDX 7.3.0.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The isBlank(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isBlank", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The overloads for types other than string are available since CloverDX 7.3.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isBlank", "basis": "documentation" } ] } ], "see_also": [ "isBlank", "removeBlankSpace" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isBlank", "basis": "documentation" }, { "source_id": "ctl2-string-functions", "section": "isBlank", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "isDate": { "name": "isDate", "category": "string", "summary": "The isDate() function returns true if the input matches the date pattern.", "description": "The isDate() function returns true if the input matches the date pattern. Returns false otherwise. If the input is null, the function returns false. If the pattern is null or an empty string, the default date format is used. If the parameter locale is missing, default Locale is used. If the parameter timeZone is missing, default Time Zone is used. If strict is true, the date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of the input string and result string. If the input string and result string differ, the function returns false. This way you can enforce a required number of digits in the date. If strict is null or the function does not have the argument strict, it works the same way as if set to false - the format is not checked in the strict way.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "isDate(string,string)", "canonical_signature": "boolean isDate(string input, string pattern)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The isDate() function returns true if the input matches the date pattern.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "locale or timeZone is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "pattern", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The isDate() function returns true if the input matches the date pattern.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "pattern is NULL -> default date format.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isDate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDate", "basis": "documentation" } ] }, "description": "The isDate() function returns true if the input matches the date pattern. Returns false otherwise. If the input is null, the function returns false. If the pattern is null or an empty string, the default date format is used. If the parameter locale is missing, default Locale is used. If the parameter timeZone is missing, default Time Zone is used. If strict is true, the date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of the input string and result string. If the input string and result string differ, the function returns false. This way you can enforce a required number of digits in the date. If strict is null or the function does not have the argument strict, it works the same way as if set to false - the format is not checked in the strict way.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDate", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isDate(string,string,boolean)", "canonical_signature": "boolean isDate(string input, string pattern, boolean strict)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The isDate() function returns true if the input matches the date pattern.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "locale or timeZone is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "pattern", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The isDate() function returns true if the input matches the date pattern.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "pattern is NULL -> default date format.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "strict", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If strict is true, the date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of the input string and result string.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "strict is NULL -> treated as false (non-strict validation).", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isDate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDate", "basis": "documentation" } ] }, "description": "The isDate() function returns true if the input matches the date pattern. Returns false otherwise. If the input is null, the function returns false. If the pattern is null or an empty string, the default date format is used. If the parameter locale is missing, default Locale is used. If the parameter timeZone is missing, default Time Zone is used. If strict is true, the date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of the input string and result string. If the input string and result string differ, the function returns false. This way you can enforce a required number of digits in the date. If strict is null or the function does not have the argument strict, it works the same way as if set to false - the format is not checked in the strict way.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDate", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isDate(string,string,string)", "canonical_signature": "boolean isDate(string input, string pattern, string locale)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The isDate() function returns true if the input matches the date pattern.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "locale or timeZone is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "pattern", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The isDate() function returns true if the input matches the date pattern.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "pattern is NULL -> default date format.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the parameter locale is missing, default Locale is used.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "locale or timeZone is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isDate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDate", "basis": "documentation" } ] }, "description": "The isDate() function returns true if the input matches the date pattern. Returns false otherwise. If the input is null, the function returns false. If the pattern is null or an empty string, the default date format is used. If the parameter locale is missing, default Locale is used. If the parameter timeZone is missing, default Time Zone is used. If strict is true, the date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of the input string and result string. If the input string and result string differ, the function returns false. This way you can enforce a required number of digits in the date. If strict is null or the function does not have the argument strict, it works the same way as if set to false - the format is not checked in the strict way.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDate", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isDate(string,string,string,boolean)", "canonical_signature": "boolean isDate(string input, string pattern, string locale, boolean strict)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The isDate() function returns true if the input matches the date pattern.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "locale or timeZone is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "pattern", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The isDate() function returns true if the input matches the date pattern.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "pattern is NULL -> default date format.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the parameter locale is missing, default Locale is used.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "locale or timeZone is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "strict", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If strict is true, the date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of the input string and result string.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "strict is NULL -> treated as false (non-strict validation).", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 4, "maximum": 4 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isDate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDate", "basis": "documentation" } ] }, "description": "The isDate() function returns true if the input matches the date pattern. Returns false otherwise. If the input is null, the function returns false. If the pattern is null or an empty string, the default date format is used. If the parameter locale is missing, default Locale is used. If the parameter timeZone is missing, default Time Zone is used. If strict is true, the date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of the input string and result string. If the input string and result string differ, the function returns false. This way you can enforce a required number of digits in the date. If strict is null or the function does not have the argument strict, it works the same way as if set to false - the format is not checked in the strict way.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDate", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isDate(string,string,string,string)", "canonical_signature": "boolean isDate(string input, string pattern, string locale, string timeZone)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The isDate() function returns true if the input matches the date pattern.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "locale or timeZone is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "pattern", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The isDate() function returns true if the input matches the date pattern.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "pattern is NULL -> default date format.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the parameter locale is missing, default Locale is used.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "locale or timeZone is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "timeZone", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the parameter timeZone is missing, default Time Zone is used.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "locale or timeZone is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 4, "maximum": 4 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isDate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDate", "basis": "documentation" } ] }, "description": "The isDate() function returns true if the input matches the date pattern. Returns false otherwise. If the input is null, the function returns false. If the pattern is null or an empty string, the default date format is used. If the parameter locale is missing, default Locale is used. If the parameter timeZone is missing, default Time Zone is used. If strict is true, the date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of the input string and result string. If the input string and result string differ, the function returns false. This way you can enforce a required number of digits in the date. If strict is null or the function does not have the argument strict, it works the same way as if set to false - the format is not checked in the strict way.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDate", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isDate(string,string,string,string,boolean)", "canonical_signature": "boolean isDate(string input, string pattern, string locale, string timeZone, boolean strict)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The isDate() function returns true if the input matches the date pattern.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "locale or timeZone is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "pattern", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The isDate() function returns true if the input matches the date pattern.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "pattern is NULL -> default date format.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the parameter locale is missing, default Locale is used.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "locale or timeZone is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "timeZone", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the parameter timeZone is missing, default Time Zone is used.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "locale or timeZone is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 4, "name": "strict", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If strict is true, the date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of the input string and result string.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "strict is NULL -> treated as false (non-strict validation).", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 5, "maximum": 5 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isDate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDate", "basis": "documentation" } ] }, "description": "The isDate() function returns true if the input matches the date pattern. Returns false otherwise. If the input is null, the function returns false. If the pattern is null or an empty string, the default date format is used. If the parameter locale is missing, default Locale is used. If the parameter timeZone is missing, default Time Zone is used. If strict is true, the date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of the input string and result string. If the input string and result string differ, the function returns false. This way you can enforce a required number of digits in the date. If strict is null or the function does not have the argument strict, it works the same way as if set to false - the format is not checked in the strict way.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDate", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The isDate(string,string) and isDate(string,string,string) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDate", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The isDate(string,string,string,string) is available since CloverETL 3.5.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDate", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The functions isDate(string, string, boolean), isDate(string, string, string, boolean) and isDate(string, string, string, string, boolean) are available since CloverETL 4.1.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDate", "basis": "documentation" } ] } ], "see_also": [ "isInteger", "isLong", "isNumber", "str2date" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDate", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "isDecimal": { "name": "isDecimal", "category": "string", "summary": "The isDecimal function checks a possibility to convert a string to a decimal data type.", "description": "The isDecimal function checks a possibility to convert a string to a decimal data type. The format determines the data conversion. See Numeric Format. If format is not used, the function checks that arg is compatible with java BigDecimal. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used. The parameter arg is the string to be checked. If the parameter arg can be converted to decimal, the function returns true, otherwise it returns false. It the parameter is null, the function returns false.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "isDecimal(string)", "canonical_signature": "boolean isDecimal(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If format is not used, the function checks that arg is compatible with java BigDecimal.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isDecimal as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDecimal", "basis": "documentation" } ] }, "description": "The isDecimal function checks a possibility to convert a string to a decimal data type. The format determines the data conversion. See Numeric Format. If format is not used, the function checks that arg is compatible with java BigDecimal. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used. The parameter arg is the string to be checked. If the parameter arg can be converted to decimal, the function returns true, otherwise it returns false. It the parameter is null, the function returns false.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDecimal", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isDecimal(string,string)", "canonical_signature": "boolean isDecimal(string arg, string format)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If format is not used, the function checks that arg is compatible with java BigDecimal.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The format determines the data conversion.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isDecimal as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDecimal", "basis": "documentation" } ] }, "description": "The isDecimal function checks a possibility to convert a string to a decimal data type. The format determines the data conversion. See Numeric Format. If format is not used, the function checks that arg is compatible with java BigDecimal. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used. The parameter arg is the string to be checked. If the parameter arg can be converted to decimal, the function returns true, otherwise it returns false. It the parameter is null, the function returns false.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDecimal", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isDecimal(string,string,string)", "canonical_signature": "boolean isDecimal(string arg, string format, string locale)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If format is not used, the function checks that arg is compatible with java BigDecimal.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The format determines the data conversion.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The locale parameter is described in Locale.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isDecimal as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDecimal", "basis": "documentation" } ] }, "description": "The isDecimal function checks a possibility to convert a string to a decimal data type. The format determines the data conversion. See Numeric Format. If format is not used, the function checks that arg is compatible with java BigDecimal. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used. The parameter arg is the string to be checked. If the parameter arg can be converted to decimal, the function returns true, otherwise it returns false. It the parameter is null, the function returns false.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDecimal", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The isDecimal(string) function is available since CloverETL 4.0.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDecimal", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The isDecimal(string, format) and isDecimal(string, format, locale) functions are available since CloverETL 4.9.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDecimal", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "Since CloverDX 6.4.0 the whole string argument must be successfully parsed according to the format. If any part of the argument does not match format, the function returns false.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDecimal", "basis": "documentation" } ] } ], "see_also": [ "isDate", "isInteger", "isLong", "isNumber", "str2decimal" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "isDecimal", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "isEmpty": { "name": "isEmpty", "category": "container", "summary": "Returns true if the specified list, map or variant is empty.", "description": "Returns true if the specified list, map or variant is empty. === Error states If the argument is null, the function fails with an error. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "isEmpty(T[])", "canonical_signature": "boolean isEmpty(T[] list)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "list", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Returns true if the specified list, map or variant is empty.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isEmpty as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "isEmpty", "basis": "documentation" } ] }, "description": "Returns true if the specified list, map or variant is empty. === Error states If the argument is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "isEmpty", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isEmpty(map[K,V])", "canonical_signature": "boolean isEmpty(map[K,V] map)", "type_parameters": [ { "name": "K", "constraint": { "kind": "any", "display": "any" } }, { "name": "V", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "map", "type": { "kind": "map", "key": { "kind": "type_variable", "name": "K", "display": "K" }, "value": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "map[K,V]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Returns true if the specified list, map or variant is empty.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isEmpty as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "isEmpty", "basis": "documentation" } ] }, "description": "Returns true if the specified list, map or variant is empty. === Error states If the argument is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "isEmpty", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isEmpty(string)", "canonical_signature": "boolean isEmpty(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If arg is null, function returns true.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isEmpty as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isEmpty", "basis": "documentation" } ] }, "description": "The isEmpty() function checks whether a given string is null or of zero length. If arg is null, function returns true.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isEmpty", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isEmpty(variant)", "canonical_signature": "boolean isEmpty(variant listOrMap)", "type_parameters": [], "parameters": [ { "position": 0, "name": "listOrMap", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented listOrMap argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isEmpty as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "isEmpty", "basis": "documentation" } ] }, "description": "Returns true if the specified list, map or variant is empty. === Error states If the argument is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "isEmpty", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The isEmpty() function is available since CloverETL 4.1.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isEmpty", "basis": "documentation" } ] } ], "see_also": [ "isEmpty" ], "evidence": [ { "source_id": "ctl2-container-functions", "section": "isEmpty", "basis": "documentation" }, { "source_id": "ctl2-string-functions", "section": "isEmpty", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "isInteger": { "name": "isInteger", "category": "string", "summary": "The isInteger() function checks a possibility to convert a string to an integer.", "description": "The isInteger() function checks a possibility to convert a string to an integer. The parameter arg is the string to be checked. The function returns a boolean value depending on whether the string can be converted to an integer number (true) or not (false). If the parameter is an empty string or null, the function returns false. The format parameter is described in Numeric Format. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "isInteger(string)", "canonical_signature": "boolean isInteger(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter arg is the string to be checked.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isInteger as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isInteger", "basis": "documentation" } ] }, "description": "The isInteger() function checks a possibility to convert a string to an integer. The parameter arg is the string to be checked. The function returns a boolean value depending on whether the string can be converted to an integer number (true) or not (false). If the parameter is an empty string or null, the function returns false. The format parameter is described in Numeric Format. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isInteger", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isInteger(string,string)", "canonical_signature": "boolean isInteger(string arg, string format)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter arg is the string to be checked.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The format parameter is described in Numeric Format.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isInteger as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isInteger", "basis": "documentation" } ] }, "description": "The isInteger() function checks a possibility to convert a string to an integer. The parameter arg is the string to be checked. The function returns a boolean value depending on whether the string can be converted to an integer number (true) or not (false). If the parameter is an empty string or null, the function returns false. The format parameter is described in Numeric Format. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isInteger", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isInteger(string,string,string)", "canonical_signature": "boolean isInteger(string arg, string format, string locale)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter arg is the string to be checked.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The format parameter is described in Numeric Format.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The locale parameter is described in Locale.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isInteger as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isInteger", "basis": "documentation" } ] }, "description": "The isInteger() function checks a possibility to convert a string to an integer. The parameter arg is the string to be checked. The function returns a boolean value depending on whether the string can be converted to an integer number (true) or not (false). If the parameter is an empty string or null, the function returns false. The format parameter is described in Numeric Format. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isInteger", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The isInteger(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isInteger", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The isInteger(string, format) and isInteger(string, format, locale) functions are available since CloverDX 6.4.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isInteger", "basis": "documentation" } ] } ], "see_also": [ "isDate", "isDecimal", "isLong", "isNumber", "str2integer" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "isInteger", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "isLong": { "name": "isLong", "category": "string", "summary": "The isLong() function checks a possibility to convert a string to a long number.", "description": "The isLong() function checks a possibility to convert a string to a long number. The parameter arg is the string to be checked. The function returns a boolean value depending on whether the string can be converted to a long number (true) or not (false). If the parameter is an empty string or null, the function returns false. The format parameter is described in Numeric Format. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "isLong(string)", "canonical_signature": "boolean isLong(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter arg is the string to be checked.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isLong as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isLong", "basis": "documentation" } ] }, "description": "The isLong() function checks a possibility to convert a string to a long number. The parameter arg is the string to be checked. The function returns a boolean value depending on whether the string can be converted to a long number (true) or not (false). If the parameter is an empty string or null, the function returns false. The format parameter is described in Numeric Format. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isLong", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isLong(string,string)", "canonical_signature": "boolean isLong(string arg, string format)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter arg is the string to be checked.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The format parameter is described in Numeric Format.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isLong as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isLong", "basis": "documentation" } ] }, "description": "The isLong() function checks a possibility to convert a string to a long number. The parameter arg is the string to be checked. The function returns a boolean value depending on whether the string can be converted to a long number (true) or not (false). If the parameter is an empty string or null, the function returns false. The format parameter is described in Numeric Format. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isLong", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isLong(string,string,string)", "canonical_signature": "boolean isLong(string arg, string format, string locale)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter arg is the string to be checked.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The format parameter is described in Numeric Format.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The locale parameter is described in Locale.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isLong as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isLong", "basis": "documentation" } ] }, "description": "The isLong() function checks a possibility to convert a string to a long number. The parameter arg is the string to be checked. The function returns a boolean value depending on whether the string can be converted to a long number (true) or not (false). If the parameter is an empty string or null, the function returns false. The format parameter is described in Numeric Format. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isLong", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The isLong(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isLong", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The isLong(string, format) and isLong(string, format, locale) functions are available since CloverDX 6.4.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isLong", "basis": "documentation" } ] } ], "see_also": [ "isDate", "isDecimal", "isInteger", "isNumber", "str2long" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "isLong", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "isNull": { "name": "isNull", "category": "record", "summary": "The isNull() function checks whether a given field is null.", "description": "The isNull() function checks whether a given field is null. The field is identified by its index (integer) or name (string).", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "isNull(record,integer)", "canonical_signature": "boolean isNull(record record, integer index)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Compatibility The isNull(record,integer) and isNull(record,string) function is available since CloverETL 3.2.0.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The field is identified by its index (integer) or name (string).", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isNull as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "isNull", "basis": "documentation" } ] }, "description": "The isNull() function checks whether a given field is null. The field is identified by its index (integer) or name (string).", "evidence": [ { "source_id": "ctl2-record-functions", "section": "isNull", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter index is undocumented." ] } }, { "id": "isNull(record,string)", "canonical_signature": "boolean isNull(record record, string field)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Compatibility The isNull(record,integer) and isNull(record,string) function is available since CloverETL 3.2.0.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "field", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The isNull() function checks whether a given field is null.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isNull as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "isNull", "basis": "documentation" } ] }, "description": "The isNull() function checks whether a given field is null. The field is identified by its index (integer) or name (string).", "evidence": [ { "source_id": "ctl2-record-functions", "section": "isNull", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter field is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The isNull(record,integer) and isNull(record,string) function is available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "isNull", "basis": "documentation" } ] } ], "see_also": [ "isEmpty", "isnull" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "isNull", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "isNumber": { "name": "isNumber", "category": "string", "summary": "The isNumber() function checks the possibility to convert a string to a number (double).", "description": "The isNumber() function checks the possibility to convert a string to a number (double). The parameter arg is the string to be checked. The function returns a boolean value depending on whether the string can be converted to a double (true) or not (false). If the parameter is an empty string or null, the function returns false. The format parameter is described in Numeric Format. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "isNumber(string)", "canonical_signature": "boolean isNumber(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter arg is the string to be checked.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isNumber as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isNumber", "basis": "documentation" } ] }, "description": "The isNumber() function checks the possibility to convert a string to a number (double). The parameter arg is the string to be checked. The function returns a boolean value depending on whether the string can be converted to a double (true) or not (false). If the parameter is an empty string or null, the function returns false. The format parameter is described in Numeric Format. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isNumber", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isNumber(string,string)", "canonical_signature": "boolean isNumber(string arg, string format)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter arg is the string to be checked.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The format parameter is described in Numeric Format.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isNumber as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isNumber", "basis": "documentation" } ] }, "description": "The isNumber() function checks the possibility to convert a string to a number (double). The parameter arg is the string to be checked. The function returns a boolean value depending on whether the string can be converted to a double (true) or not (false). If the parameter is an empty string or null, the function returns false. The format parameter is described in Numeric Format. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isNumber", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "isNumber(string,string,string)", "canonical_signature": "boolean isNumber(string arg, string format, string locale)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter arg is the string to be checked.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The format parameter is described in Numeric Format.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The locale parameter is described in Locale.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format or locale is NULL -> no error; valid test input returned true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isNumber as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isNumber", "basis": "documentation" } ] }, "description": "The isNumber() function checks the possibility to convert a string to a number (double). The parameter arg is the string to be checked. The function returns a boolean value depending on whether the string can be converted to a double (true) or not (false). If the parameter is an empty string or null, the function returns false. The format parameter is described in Numeric Format. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isNumber", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The isNumber(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isNumber", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The isNumber(string, format) and isNumber(string, format, locale) functions are available since CloverDX 6.4.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isNumber", "basis": "documentation" } ] } ], "see_also": [ "isDate", "isDecimal", "isInteger", "isLong", "str2double" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "isNumber", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "isSourceFieldMapped": { "name": "isSourceFieldMapped", "category": "mapping", "summary": "The isSourceFieldMapped function returns true if the named field at the specified source index is mapped to any target field.", "description": "The isSourceFieldMapped function returns true if the named field at the specified source index is mapped to any target field. If sourceIndex is omitted, the function returns true if a field with the specified name in any source is mapped to a target field. === Error states The function throws an exception if mapping is invalid or null. It also throws an exception if sourceIndex is out of bounds or null. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "isSourceFieldMapped(string,string)", "canonical_signature": "boolean isSourceFieldMapped(string mapping, string sourceField)", "type_parameters": [], "parameters": [ { "position": 0, "name": "mapping", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "=== Error states The function throws an exception if mapping is invalid or null.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "sourceField", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented sourceField argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isSourceFieldMapped as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "isSourceFieldMapped", "basis": "documentation" } ] }, "description": "The isSourceFieldMapped function returns true if the named field at the specified source index is mapped to any target field. If sourceIndex is omitted, the function returns true if a field with the specified name in any source is mapped to a target field. === Error states The function throws an exception if mapping is invalid or null. It also throws an exception if sourceIndex is out of bounds or null. === Examples", "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "isSourceFieldMapped", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter mapping is undocumented.", "NULL behavior for parameter sourceField is undocumented." ] } }, { "id": "isSourceFieldMapped(string,string,integer)", "canonical_signature": "boolean isSourceFieldMapped(string mapping, string sourceField, integer sourceIndex)", "type_parameters": [], "parameters": [ { "position": 0, "name": "mapping", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "=== Error states The function throws an exception if mapping is invalid or null.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "sourceField", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented sourceField argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "sourceIndex", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If sourceIndex is omitted, the function returns true if a field with the specified name in any source is mapped to a target field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isSourceFieldMapped as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "isSourceFieldMapped", "basis": "documentation" } ] }, "description": "The isSourceFieldMapped function returns true if the named field at the specified source index is mapped to any target field. If sourceIndex is omitted, the function returns true if a field with the specified name in any source is mapped to a target field. === Error states The function throws an exception if mapping is invalid or null. It also throws an exception if sourceIndex is out of bounds or null. === Examples", "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "isSourceFieldMapped", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter mapping is undocumented.", "NULL behavior for parameter sourceField is undocumented.", "NULL behavior for parameter sourceIndex is undocumented." ] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "isSourceFieldMapped", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "isSubgraphInputPortConnected": { "name": "isSubgraphInputPortConnected", "category": "subgraph", "summary": "The function isSubgraphInputPortConnected() returns true if the particular subgraph input port is connected.", "description": "The function isSubgraphInputPortConnected() returns true if the particular subgraph input port is connected. Otherwise, it returns false. Port numbers start from zero. If portNo is not a valid port number of a particular subgraph (negative value or too big value), the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "isSubgraphInputPortConnected(integer)", "canonical_signature": "boolean isSubgraphInputPortConnected(integer portNo)", "type_parameters": [], "parameters": [ { "position": 0, "name": "portNo", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If portNo is not a valid port number of a particular subgraph (negative value or too big value), the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isSubgraphInputPortConnected as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-subgraph-functions", "section": "isSubgraphInputPortConnected", "basis": "documentation" } ] }, "description": "The function isSubgraphInputPortConnected() returns true if the particular subgraph input port is connected. Otherwise, it returns false. Port numbers start from zero. If portNo is not a valid port number of a particular subgraph (negative value or too big value), the function fails with an error.", "evidence": [ { "source_id": "ctl2-subgraph-functions", "section": "isSubgraphInputPortConnected", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter portNo is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The isSubgraphInputPortConnected() function is available since CloverETL 4.1.0.", "evidence": [ { "source_id": "ctl2-subgraph-functions", "section": "isSubgraphInputPortConnected", "basis": "documentation" } ] } ], "see_also": [ "getSubgraphInputPortsCount", "getSubgraphOutputPortsCount", "isSubgraphOutputPortConnected" ], "evidence": [ { "source_id": "ctl2-subgraph-functions", "section": "isSubgraphInputPortConnected", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "isSubgraphOutputPortConnected": { "name": "isSubgraphOutputPortConnected", "category": "subgraph", "summary": "The function isSubgraphOutputPortConnected() returns true if the particular subgraph output port is connected.", "description": "The function isSubgraphOutputPortConnected() returns true if the particular subgraph output port is connected. Otherwise, it returns false. Port numbers start from zero. If portNo is not a valid port number of a particular subgraph (negative value or too big value), the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "isSubgraphOutputPortConnected(integer)", "canonical_signature": "boolean isSubgraphOutputPortConnected(integer portNo)", "type_parameters": [], "parameters": [ { "position": 0, "name": "portNo", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If portNo is not a valid port number of a particular subgraph (negative value or too big value), the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isSubgraphOutputPortConnected as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-subgraph-functions", "section": "isSubgraphOutputPortConnected", "basis": "documentation" } ] }, "description": "The function isSubgraphOutputPortConnected() returns true if the particular subgraph output port is connected. Otherwise, it returns false. Port numbers start from zero. If portNo is not a valid port number of a particular subgraph (negative value or too big value), the function fails with an error.", "evidence": [ { "source_id": "ctl2-subgraph-functions", "section": "isSubgraphOutputPortConnected", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter portNo is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The isSubgraphOutputPortConnected() function is available since CloverETL 4.1.0.", "evidence": [ { "source_id": "ctl2-subgraph-functions", "section": "isSubgraphOutputPortConnected", "basis": "documentation" } ] } ], "see_also": [ "getSubgraphInputPortsCount", "getSubgraphOutputPortsCount", "isSubgraphInputPortConnected" ], "evidence": [ { "source_id": "ctl2-subgraph-functions", "section": "isSubgraphOutputPortConnected", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "isTargetFieldMapped": { "name": "isTargetFieldMapped", "category": "mapping", "summary": "The isTargetFieldMapped function returns true if any source field is mapped to the specified target field.", "description": "The isTargetFieldMapped function returns true if any source field is mapped to the specified target field. The function throws an exception if mapping is invalid or null. === Compatibility The isTargetFieldMapped function is available since CloverETL 4.1.0.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "isTargetFieldMapped(string,string)", "canonical_signature": "boolean isTargetFieldMapped(string mapping, string targetField)", "type_parameters": [], "parameters": [ { "position": 0, "name": "mapping", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The function throws an exception if mapping is invalid or null.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "targetField", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented targetField argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isTargetFieldMapped as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "isTargetFieldMapped", "basis": "documentation" } ] }, "description": "The isTargetFieldMapped function returns true if any source field is mapped to the specified target field. The function throws an exception if mapping is invalid or null. === Compatibility The isTargetFieldMapped function is available since CloverETL 4.1.0.", "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "isTargetFieldMapped", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter mapping is undocumented.", "NULL behavior for parameter targetField is undocumented." ] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-mapping-functions", "section": "isTargetFieldMapped", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "isUnicodeNormalized": { "name": "isUnicodeNormalized", "category": "string", "summary": "Determine whether the str input string is Unicode normalized according to the given form.", "description": "Determine whether the str input string is Unicode normalized according to the given form. The parameter str is a string to be checked for accordance with the normalized form. If the parameter str is null, the function returns true. The parameter form contains identification of the Unicode normalization form. Following normalization forms are available: NFD: Canonical Decomposition NFC: Canonical Decomposition followed by Canonical Composition NFKD: Compatibility Decomposition NFKC: Compatibility Decomposition followed by Canonical Composition If the parameter form is null, the function fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "isUnicodeNormalized(string,string)", "canonical_signature": "boolean isUnicodeNormalized(string str, string form)", "type_parameters": [], "parameters": [ { "position": 0, "name": "str", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Determine whether the str input string is Unicode normalized according to the given form.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "str is NULL -> true.", "result": { "kind": "literal", "type": "boolean", "value": true, "display": "true" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "form", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Determine whether the str input string is Unicode normalized according to the given form.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "form is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isUnicodeNormalized as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isUnicodeNormalized", "basis": "documentation" } ] }, "description": "Determine whether the str input string is Unicode normalized according to the given form. The parameter str is a string to be checked for accordance with the normalized form. If the parameter str is null, the function returns true. The parameter form contains identification of the Unicode normalization form. Following normalization forms are available: NFD: Canonical Decomposition NFC: Canonical Decomposition followed by Canonical Composition NFKD: Compatibility Decomposition NFKC: Compatibility Decomposition followed by Canonical Composition If the parameter form is null, the function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isUnicodeNormalized", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "form == NULL", "description": "form is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The isUnicodeNormalized(string) function is available since CloverETL 4.0.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isUnicodeNormalized", "basis": "documentation" } ] } ], "see_also": [ "codePointToChar", "isValidCodePoint", "unicodeNormalize" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "isUnicodeNormalized", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "isUrl": { "name": "isUrl", "category": "string", "summary": "The isUrl() function checks whether a specified string is a valid URL of the following syntax For more information about the URI standards, see http://www.ietf.org/rfc/rfc2396.txt.", "description": "The isUrl() function checks whether a specified string is a valid URL of the following syntax For more information about the URI standards, see http://www.ietf.org/rfc/rfc2396.txt. If the input is empty string or null, the function returns false.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "isUrl(string)", "canonical_signature": "boolean isUrl(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> false.", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isUrl as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isUrl", "basis": "documentation" } ] }, "description": "The isUrl() function checks whether a specified string is a valid URL of the following syntax For more information about the URI standards, see http://www.ietf.org/rfc/rfc2396.txt. If the input is empty string or null, the function returns false.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isUrl", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The isUrl() function is available since CloverETL 3.1.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isUrl", "basis": "documentation" } ] } ], "see_also": [ "escapeUrl", "getUrlHost", "getUrlPath", "getUrlPort", "getUrlProtocol", "getUrlQuery", "getUrlRef", "getUrlUserInfo", "unescapeUrl" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "isUrl", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "isValidCodePoint": { "name": "isValidCodePoint", "category": "string", "summary": "The function isValidCodePoint() returns true if the code value is valid __Unicode code point__.", "description": "The function isValidCodePoint() returns true if the code value is valid __Unicode code point__. If the parameter code is null, the function returns false.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "isValidCodePoint(integer)", "canonical_signature": "boolean isValidCodePoint(integer code)", "type_parameters": [], "parameters": [ { "position": 0, "name": "code", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function isValidCodePoint() returns true if the code value is valid __Unicode code point__.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "code is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isValidCodePoint as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "isValidCodePoint", "basis": "documentation" } ] }, "description": "The function isValidCodePoint() returns true if the code value is valid __Unicode code point__. If the parameter code is null, the function returns false.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isValidCodePoint", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "code == NULL", "description": "code is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The isValidCodePoint(integer) function is available since CloverETL 4.0.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "isValidCodePoint", "basis": "documentation" } ] } ], "see_also": [ "codePointAt", "codePointLength", "codePointToChar" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "isValidCodePoint", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "isnull": { "name": "isnull", "category": "miscellaneous", "summary": "The isnull() function returns a boolean value depending on whether the argument is null (true) or not (false).", "description": "The isnull() function returns a boolean value depending on whether the argument is null (true) or not (false). The argument may be of any data type. If you set the [guilabel]##Null value## property in metadata for any string data field to any non-empty string, the isnull() function will return true when applied on such string. And return false when applied on an empty field. For example, if field1 has [guilabel]##Null value## property set to \"\", isnull($in.0.field1) will return true on the records in which the value of field1 is \"\" and false on the others, even on those that are empty. For detailed information, see Null value.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "isnull(any)", "canonical_signature": "boolean isnull(any arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of isnull as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isnull", "basis": "documentation" } ] }, "description": "The isnull() function returns a boolean value depending on whether the argument is null (true) or not (false). The argument may be of any data type. If you set the [guilabel]##Null value## property in metadata for any string data field to any non-empty string, the isnull() function will return true when applied on such string. And return false when applied on an empty field. For example, if field1 has [guilabel]##Null value## property set to \"\", isnull($in.0.field1) will return true on the records in which the value of field1 is \"\" and false on the others, even on those that are empty. For detailed information, see Null value.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isnull", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The isnull() function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isnull", "basis": "documentation" } ] } ], "see_also": [ "isNull", "nvl", "nvl2" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "isnull", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "join": { "name": "join", "category": "string", "summary": "The join() converts elements from the list or map of elements to their string representation and puts them together with the first argument as a delimiter.", "description": "The join() converts elements from the list or map of elements to their string representation and puts them together with the first argument as a delimiter. If the delimiter is null, the function joins string representations of elements from the list with the empty string.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "join(string,any[])", "canonical_signature": "string join(string delimiter, any[] arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "delimiter", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The join() converts elements from the list or map of elements to their string representation and puts them together with the first argument as a delimiter.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "delimiter is NULL -> empty string used as delimiter.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg", "type": { "kind": "list", "element": { "kind": "any", "display": "any" }, "display": "any[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of join as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "join", "basis": "documentation" } ] }, "description": "The join() converts elements from the list or map of elements to their string representation and puts them together with the first argument as a delimiter. If the delimiter is null, the function joins string representations of elements from the list with the empty string.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "join", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter delimiter is undocumented." ] } }, { "id": "join(string,map[any,any])", "canonical_signature": "string join(string delimiter, map[any,any] arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "delimiter", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The join() converts elements from the list or map of elements to their string representation and puts them together with the first argument as a delimiter.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "delimiter is NULL -> empty string used as delimiter.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "arg", "type": { "kind": "map", "key": { "kind": "any", "display": "any" }, "value": { "kind": "any", "display": "any" }, "display": "map[any,any]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of join as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "join", "basis": "documentation" } ] }, "description": "The join() converts elements from the list or map of elements to their string representation and puts them together with the first argument as a delimiter. If the delimiter is null, the function joins string representations of elements from the list with the empty string.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "join", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter delimiter is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The join() function is available since CloverETL Designer 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "join", "basis": "documentation" } ] } ], "see_also": [ "concat", "concatWithSeparator", "split" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "join", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "json2xml": { "name": "json2xml", "category": "conversion", "summary": "The json2xml() function takes one string argument that is JSON formatted and converts it to an XML formatted string.", "description": "The json2xml() function takes one string argument that is JSON formatted and converts it to an XML formatted string. Its counterpart is the function xml2json. Parsing of an input does not have to result in a valid XML structure. For example, if the root element of input JSON contained array, the XML document with more than one root element would be created. If the input is an invalid JSON formatted string or null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "json2xml(string)", "canonical_signature": "string json2xml(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of json2xml as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "json2xml", "basis": "documentation" } ] }, "description": "The json2xml() function takes one string argument that is JSON formatted and converts it to an XML formatted string. Its counterpart is the function xml2json. Parsing of an input does not have to result in a valid XML structure. For example, if the root element of input JSON contained array, the XML document with more than one root element would be created. If the input is an invalid JSON formatted string or null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "json2xml", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The json2xml(string) function is available since CloverETL 3.1.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "json2xml", "basis": "documentation" } ] } ], "see_also": [ "xml2json" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "json2xml", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "lastIndexOf": { "name": "lastIndexOf", "category": "string", "summary": "The function lastIndexOf returns an index of the last occurrence of the substr substring within the given string input, searching backwards from the given position or from the end.", "description": "The function lastIndexOf returns an index of the last occurrence of the substr substring within the given string input, searching backwards from the given position or from the end. The parameter input is a string in which the occurrence of the substr string is searched. If input is null, the function returns -1. The parameter substr is a substring to be searched. If the parameter substr is null, the function fails. The parameter index denotes the position in the input, where the substring matching process starts. If the parameter is negative, the function returns -1. If the parameter is null, the function fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "lastIndexOf(string,string)", "canonical_signature": "integer lastIndexOf(string input, string substr)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function lastIndexOf returns an index of the last occurrence of the substr substring within the given string input, searching backwards from the given position or from the end.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "input is NULL -> -1.", "result": { "kind": "literal", "type": "integer", "value": -1, "display": "-1" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "substr", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function lastIndexOf returns an index of the last occurrence of the substr substring within the given string input, searching backwards from the given position or from the end.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "substr or index is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of lastIndexOf as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "lastIndexOf", "basis": "documentation" } ] }, "description": "The function lastIndexOf returns an index of the last occurrence of the substr substring within the given string input, searching backwards from the given position or from the end. The parameter input is a string in which the occurrence of the substr string is searched. If input is null, the function returns -1. The parameter substr is a substring to be searched. If the parameter substr is null, the function fails. The parameter index denotes the position in the input, where the substring matching process starts. If the parameter is negative, the function returns -1. If the parameter is null, the function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "lastIndexOf", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "substr == NULL", "description": "substr or index is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "lastIndexOf(string,string,integer)", "canonical_signature": "integer lastIndexOf(string input, string substr, integer index)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function lastIndexOf returns an index of the last occurrence of the substr substring within the given string input, searching backwards from the given position or from the end.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "input is NULL -> -1.", "result": { "kind": "literal", "type": "integer", "value": -1, "display": "-1" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "substr", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function lastIndexOf returns an index of the last occurrence of the substr substring within the given string input, searching backwards from the given position or from the end.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "substr or index is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function lastIndexOf returns an index of the last occurrence of the substr substring within the given string input, searching backwards from the given position or from the end.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "substr or index is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of lastIndexOf as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "lastIndexOf", "basis": "documentation" } ] }, "description": "The function lastIndexOf returns an index of the last occurrence of the substr substring within the given string input, searching backwards from the given position or from the end. The parameter input is a string in which the occurrence of the substr string is searched. If input is null, the function returns -1. The parameter substr is a substring to be searched. If the parameter substr is null, the function fails. The parameter index denotes the position in the input, where the substring matching process starts. If the parameter is negative, the function returns -1. If the parameter is null, the function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "lastIndexOf", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "substr == NULL", "description": "substr or index is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "index == NULL", "description": "substr or index is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The lastIndexOf(string,string) and lastIndexOf(string,string,integer) functions are available since CloverETL 4.0.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "lastIndexOf", "basis": "documentation" } ] } ], "see_also": [ "indexOf" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "lastIndexOf", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "left": { "name": "left", "category": "string", "summary": "The left() function returns a substring of input with the specified length.", "description": "The left() function returns a substring of input with the specified length. If the input is shorter than length, the function returns the input unmodified. The result may be padded with spaces, based on the value of spacePad. If the input is null, the function returns null. If spacePad is set to false, the function behaves the same way as the left(string, integer) function. If spacePad is set to true and the input is shorter than length, the function pads the input with blank spaces from the right side.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "left(string,integer)", "canonical_signature": "string left(string input, integer length)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The left() function returns a substring of input with the specified length.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "length", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The left() function returns a substring of input with the specified length.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "length or spacePad is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of left as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "left", "basis": "documentation" } ] }, "description": "The left() function returns a substring of input with the specified length. If the input is shorter than length, the function returns the input unmodified. The result may be padded with spaces, based on the value of spacePad. If the input is null, the function returns null. If spacePad is set to false, the function behaves the same way as the left(string, integer) function. If spacePad is set to true and the input is shorter than length, the function pads the input with blank spaces from the right side.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "left", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "length == NULL", "description": "length or spacePad is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "left(string,integer,boolean)", "canonical_signature": "string left(string input, integer length, boolean spacePad)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The left() function returns a substring of input with the specified length.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "length", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The left() function returns a substring of input with the specified length.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "length or spacePad is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "spacePad", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The result may be padded with spaces, based on the value of spacePad.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "length or spacePad is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of left as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "left", "basis": "documentation" } ] }, "description": "The left() function returns a substring of input with the specified length. If the input is shorter than length, the function returns the input unmodified. The result may be padded with spaces, based on the value of spacePad. If the input is null, the function returns null. If spacePad is set to false, the function behaves the same way as the left(string, integer) function. If spacePad is set to true and the input is shorter than length, the function pads the input with blank spaces from the right side.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "left", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "length == NULL", "description": "length or spacePad is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "spacePad == NULL", "description": "length or spacePad is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The left(string,integer) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "left", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The left(string,integer,boolean) function is available since CloverETL 3.1.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "left", "basis": "documentation" } ] } ], "see_also": [ "right", "substring" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "left", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "length": { "name": "length", "category": "container", "summary": "Returns the number of elements forming a given structured data type.", "description": "Returns the number of elements forming a given structured data type. The type of elements that are counted depend on argument type: For byte and cbyte the function counts bytes For string the function counts number of Unicode code units in the string. In many cases this will correspond to number of characters, but not always (e.g., if you use East Asian languages, emoji, etc.). For more complete discussion about string representation see string data type. For lists it counts number of elements in the list. Note that for nested lists, the top-level list is counted. For maps it counts number of entries (key-value pairs) in the map. For records it counts the number of fields in the record. For variant it depends on what the variant is - string, list, or map. Then it applies rules listed above. === Error states If the argument is null, the function returns 0. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "length()", "canonical_signature": "integer length()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of length as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "length", "basis": "documentation" } ] }, "description": "The length() function returns the number of fields of a record the function is called on. For a record with null reference, the function returns 0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "length", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "length(T[])", "canonical_signature": "integer length(T[] list)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "list", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "For lists it counts number of elements in the list.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> 0.", "result": { "kind": "literal", "type": "integer", "value": 0, "display": "0" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of length as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "length", "basis": "documentation" } ] }, "description": "Returns the number of elements forming a given structured data type. The type of elements that are counted depend on argument type: For byte and cbyte the function counts bytes For string the function counts number of Unicode code units in the string. In many cases this will correspond to number of characters, but not always (e.g., if you use East Asian languages, emoji, etc.). For more complete discussion about string representation see string data type. For lists it counts number of elements in the list. Note that for nested lists, the top-level list is counted. For maps it counts number of entries (key-value pairs) in the map. For records it counts the number of fields in the record. For variant it depends on what the variant is - string, list, or map. Then it applies rules listed above. === Error states If the argument is null, the function returns 0. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "length", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "length(byte)", "canonical_signature": "integer length(byte value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "value", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "For maps it counts number of entries (key-value pairs) in the map.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> 0.", "result": { "kind": "literal", "type": "integer", "value": 0, "display": "0" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of length as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "length", "basis": "documentation" } ] }, "description": "Returns the number of elements forming a given structured data type. The type of elements that are counted depend on argument type: For byte and cbyte the function counts bytes For string the function counts number of Unicode code units in the string. In many cases this will correspond to number of characters, but not always (e.g., if you use East Asian languages, emoji, etc.). For more complete discussion about string representation see string data type. For lists it counts number of elements in the list. Note that for nested lists, the top-level list is counted. For maps it counts number of entries (key-value pairs) in the map. For records it counts the number of fields in the record. For variant it depends on what the variant is - string, list, or map. Then it applies rules listed above. === Error states If the argument is null, the function returns 0. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "length", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "length(cbyte)", "canonical_signature": "integer length(cbyte value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "value", "type": { "kind": "named", "name": "cbyte", "display": "cbyte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "For maps it counts number of entries (key-value pairs) in the map.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> 0.", "result": { "kind": "literal", "type": "integer", "value": 0, "display": "0" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of length as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "length", "basis": "documentation" } ] }, "description": "Returns the number of elements forming a given structured data type. The type of elements that are counted depend on argument type: For byte and cbyte the function counts bytes For string the function counts number of Unicode code units in the string. In many cases this will correspond to number of characters, but not always (e.g., if you use East Asian languages, emoji, etc.). For more complete discussion about string representation see string data type. For lists it counts number of elements in the list. Note that for nested lists, the top-level list is counted. For maps it counts number of entries (key-value pairs) in the map. For records it counts the number of fields in the record. For variant it depends on what the variant is - string, list, or map. Then it applies rules listed above. === Error states If the argument is null, the function returns 0. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "length", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "length(map[K,V])", "canonical_signature": "integer length(map[K,V] map)", "type_parameters": [ { "name": "K", "constraint": { "kind": "any", "display": "any" } }, { "name": "V", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "map", "type": { "kind": "map", "key": { "kind": "type_variable", "name": "K", "display": "K" }, "value": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "map[K,V]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "For maps it counts number of entries (key-value pairs) in the map.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> 0.", "result": { "kind": "literal", "type": "integer", "value": 0, "display": "0" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of length as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "length", "basis": "documentation" } ] }, "description": "Returns the number of elements forming a given structured data type. The type of elements that are counted depend on argument type: For byte and cbyte the function counts bytes For string the function counts number of Unicode code units in the string. In many cases this will correspond to number of characters, but not always (e.g., if you use East Asian languages, emoji, etc.). For more complete discussion about string representation see string data type. For lists it counts number of elements in the list. Note that for nested lists, the top-level list is counted. For maps it counts number of entries (key-value pairs) in the map. For records it counts the number of fields in the record. For variant it depends on what the variant is - string, list, or map. Then it applies rules listed above. === Error states If the argument is null, the function returns 0. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "length", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "length(record)", "canonical_signature": "integer length(record recordValue)", "type_parameters": [], "parameters": [ { "position": 0, "name": "recordValue", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented recordValue argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> 0.", "result": { "kind": "literal", "type": "integer", "value": 0, "display": "0" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of length as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "length", "basis": "documentation" } ] }, "description": "Returns the number of elements forming a given structured data type. The type of elements that are counted depend on argument type: For byte and cbyte the function counts bytes For string the function counts number of Unicode code units in the string. In many cases this will correspond to number of characters, but not always (e.g., if you use East Asian languages, emoji, etc.). For more complete discussion about string representation see string data type. For lists it counts number of elements in the list. Note that for nested lists, the top-level list is counted. For maps it counts number of entries (key-value pairs) in the map. For records it counts the number of fields in the record. For variant it depends on what the variant is - string, list, or map. Then it applies rules listed above. === Error states If the argument is null, the function returns 0. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "length", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "length(string)", "canonical_signature": "integer length(string value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "value", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "For maps it counts number of entries (key-value pairs) in the map.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> 0.", "result": { "kind": "literal", "type": "integer", "value": 0, "display": "0" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of length as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "length", "basis": "documentation" } ] }, "description": "Returns the number of elements forming a given structured data type. The type of elements that are counted depend on argument type: For byte and cbyte the function counts bytes For string the function counts number of Unicode code units in the string. In many cases this will correspond to number of characters, but not always (e.g., if you use East Asian languages, emoji, etc.). For more complete discussion about string representation see string data type. For lists it counts number of elements in the list. Note that for nested lists, the top-level list is counted. For maps it counts number of entries (key-value pairs) in the map. For records it counts the number of fields in the record. For variant it depends on what the variant is - string, list, or map. Then it applies rules listed above. === Error states If the argument is null, the function returns 0. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "length", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "length(structured)", "canonical_signature": "integer length(structured arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "family", "name": "structured", "members": [ "byte", "cbyte", "string", "record", "variant" ], "display": "structured" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> 0.", "result": { "kind": "literal", "type": "integer", "value": 0, "display": "0" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of length as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "length", "basis": "documentation" } ] }, "description": "The length() function accepts a structured data type as its argument: string, [], map[,] or record. It takes the argument and returns a number of elements forming the structured data type. If the argument is null or empty string, the function returns 0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "length", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "length(variant)", "canonical_signature": "integer length(variant value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "value", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "For maps it counts number of entries (key-value pairs) in the map.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> 0.", "result": { "kind": "literal", "type": "integer", "value": 0, "display": "0" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of length as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "length", "basis": "documentation" } ] }, "description": "Returns the number of elements forming a given structured data type. The type of elements that are counted depend on argument type: For byte and cbyte the function counts bytes For string the function counts number of Unicode code units in the string. In many cases this will correspond to number of characters, but not always (e.g., if you use East Asian languages, emoji, etc.). For more complete discussion about string representation see string data type. For lists it counts number of elements in the list. Note that for nested lists, the top-level list is counted. For maps it counts number of entries (key-value pairs) in the map. For records it counts the number of fields in the record. For variant it depends on what the variant is - string, list, or map. Then it applies rules listed above. === Error states If the argument is null, the function returns 0. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "length", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The length(record) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "length", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The length(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "length", "basis": "documentation" } ] } ], "see_also": [ "length" ], "evidence": [ { "source_id": "ctl2-container-functions", "section": "length", "basis": "documentation" }, { "source_id": "ctl2-record-functions", "section": "length", "basis": "documentation" }, { "source_id": "ctl2-string-functions", "section": "length", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "log": { "name": "log", "category": "mathematical", "summary": "The log() function returns the result of the _natural logarithm_ of a given argument.", "description": "The log() function returns the result of the _natural logarithm_ of a given argument. If the given argument is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "log(decimal)", "canonical_signature": "number log(decimal arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of log as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "log", "basis": "documentation" } ] }, "description": "The log() function returns the result of the _natural logarithm_ of a given argument. If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "log", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "log(number)", "canonical_signature": "number log(number arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of log as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "log", "basis": "documentation" } ] }, "description": "The log() function returns the result of the _natural logarithm_ of a given argument. If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "log", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The log(decimal) and log(number) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "log", "basis": "documentation" } ] } ], "see_also": [ "exp", "log10" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "log", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "log10": { "name": "log10", "category": "mathematical", "summary": "The log10() function returns the result of the logarithm of a given argument to the base 10.", "description": "The log10() function returns the result of the logarithm of a given argument to the base 10. If the given argument is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "log10(decimal)", "canonical_signature": "number log10(decimal arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of log10 as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "log10", "basis": "documentation" } ] }, "description": "The log10() function returns the result of the logarithm of a given argument to the base 10. If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "log10", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "log10(number)", "canonical_signature": "number log10(number arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of log10 as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "log10", "basis": "documentation" } ] }, "description": "The log10() function returns the result of the logarithm of a given argument to the base 10. If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "log10", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The log10(decimal) and log10(number) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "log10", "basis": "documentation" } ] } ], "see_also": [ "log", "pow" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "log10", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "long2date": { "name": "long2date", "category": "conversion", "summary": "The long2date() function converts a long argument to a date.", "description": "The long2date() function converts a long argument to a date. It adds the argument number of milliseconds to January 1, 1970, 00:00:00 GMT and returns the result as a date. Its counterpart is function date2long. If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "long2date(long)", "canonical_signature": "date long2date(long arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of long2date as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "long2date", "basis": "documentation" } ] }, "description": "The long2date() function converts a long argument to a date. It adds the argument number of milliseconds to January 1, 1970, 00:00:00 GMT and returns the result as a date. Its counterpart is function date2long. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "long2date", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The long2date(long) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "long2date", "basis": "documentation" } ] } ], "see_also": [ "date2long" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "long2date", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "long2integer": { "name": "long2integer", "category": "conversion", "summary": "The long2integer() function converts a long argument to an integer value.", "description": "The long2integer() function converts a long argument to an integer value. The conversion is successful only if it is possible without any loss of information, otherwise the function fails with an error. On the other hand, any integer value can be converted into a long number without a loss of precision. If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "long2integer(long)", "canonical_signature": "integer long2integer(long arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of long2integer as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "long2integer", "basis": "documentation" } ] }, "description": "The long2integer() function converts a long argument to an integer value. The conversion is successful only if it is possible without any loss of information, otherwise the function fails with an error. On the other hand, any integer value can be converted into a long number without a loss of precision. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "long2integer", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The long2integer(long) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "long2integer", "basis": "documentation" } ] } ], "see_also": [], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "long2integer", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "long2packDecimal": { "name": "long2packDecimal", "category": "conversion", "summary": "The long2packDecimal() function converts a long data type argument to the representation of packed decimal number.", "description": "The long2packDecimal() function converts a long data type argument to the representation of packed decimal number. It is the counterpart of the function packDecimal2long. If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "long2packDecimal(long)", "canonical_signature": "byte long2packDecimal(long arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of long2packDecimal as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "long2packDecimal", "basis": "documentation" } ] }, "description": "The long2packDecimal() function converts a long data type argument to the representation of packed decimal number. It is the counterpart of the function packDecimal2long. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "long2packDecimal", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The long2packDecimal(long) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "long2packDecimal", "basis": "documentation" } ] } ], "see_also": [ "packDecimal2long" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "long2packDecimal", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "lowerCase": { "name": "lowerCase", "category": "string", "summary": "The lowerCase() function returns the input string with letters converted to lower case only.", "description": "The lowerCase() function returns the input string with letters converted to lower case only. If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "lowerCase(string)", "canonical_signature": "string lowerCase(string input)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The lowerCase() function returns the input string with letters converted to lower case only.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of lowerCase as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "lowerCase", "basis": "documentation" } ] }, "description": "The lowerCase() function returns the input string with letters converted to lower case only. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "lowerCase", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The lowerCase(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "lowerCase", "basis": "documentation" } ] } ], "see_also": [ "properCase", "upperCase" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "lowerCase", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "lpad": { "name": "lpad", "category": "string", "summary": "The lpad() function pads input string from left using specified characters.", "description": "The lpad() function pads input string from left using specified characters. If the parameter input is null the function returns null. The parameter length is minimal length of an output string. If the string length is lower than the parameter length, the string is padded from left using space or using filler. Otherwise the input string is returned. If the parameter length is _negative_ or null, the function fails. It the filler parameter is null, _empty string_ or longer than one character, function fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "lpad(string,integer)", "canonical_signature": "string lpad(string input, integer length)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The lpad() function pads input string from left using specified characters.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "length", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter length is minimal length of an output string.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "length or filler is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of lpad as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "lpad", "basis": "documentation" } ] }, "description": "The lpad() function pads input string from left using specified characters. If the parameter input is null the function returns null. The parameter length is minimal length of an output string. If the string length is lower than the parameter length, the string is padded from left using space or using filler. Otherwise the input string is returned. If the parameter length is _negative_ or null, the function fails. It the filler parameter is null, _empty string_ or longer than one character, function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "lpad", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "length == NULL", "description": "length or filler is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "lpad(string,integer,string)", "canonical_signature": "string lpad(string input, integer length, string filler)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The lpad() function pads input string from left using specified characters.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "length", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter length is minimal length of an output string.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "length or filler is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "filler", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the string length is lower than the parameter length, the string is padded from left using space or using filler.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "length or filler is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of lpad as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "lpad", "basis": "documentation" } ] }, "description": "The lpad() function pads input string from left using specified characters. If the parameter input is null the function returns null. The parameter length is minimal length of an output string. If the string length is lower than the parameter length, the string is padded from left using space or using filler. Otherwise the input string is returned. If the parameter length is _negative_ or null, the function fails. It the filler parameter is null, _empty string_ or longer than one character, function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "lpad", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "length == NULL", "description": "length or filler is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "filler == NULL", "description": "length or filler is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The lpad(string,integer,string) and lpad(string,integer,string) functions are available since CloverETL 4.0.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "lpad", "basis": "documentation" } ] } ], "see_also": [ "left", "right", "rpad" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "lpad", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "map2record": { "name": "map2record", "category": "conversion", "summary": "Copies values from a map into the fields of a record.", "description": "Copies values from a map into the fields of a record. An entry is copied when its key is the name of a field of record and its value can be assigned to that field. Entries which do not meet both conditions are left out. The function returns the number of fields it has populated, or -1 if map or record is null. Values are assigned using the standard CTL assignment compatibility, so a value is widened where necessary but never narrowed. An integer value is therefore copied into an integer, long, number or decimal field, while a long value is not copied into an integer field. A null value can be copied into a field of any type. The strict parameter turns the entries which have been left out into errors. In strict mode the function fails when a key does not match any field name, when a value cannot be assigned to its matching field, and when map or record is null. If strict is missing, it works in the same way as if it was set to false - such entries are left out silently. The function does not reset record first, so fields which are not matched by any entry keep their previous value. The first argument has to be a map[string, variant]. A map with a more specific value type, e.g. a map[string, string], does not match the signature. Use variant2record if you need to map such a map, or if the map contains nested maps and lists.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "map2record(map[string,variant],record)", "canonical_signature": "integer map2record(map[string,variant] map, record record)", "type_parameters": [], "parameters": [ { "position": 0, "name": "map", "type": { "kind": "map", "key": { "kind": "named", "name": "string", "display": "string" }, "value": { "kind": "named", "name": "variant", "display": "variant" }, "display": "map[string,variant]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Copies values from a map into the fields of a record.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "map or record is NULL when strict is true -> runtime error.", "cases": [ { "condition": "map or record is NULL when strict is true", "behavior": { "kind": "runtime_error", "description": "map or record is NULL when strict is true -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Copies values from a map into the fields of a record.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "map or record is NULL when strict is true -> runtime error.", "cases": [ { "condition": "map or record is NULL when strict is true", "behavior": { "kind": "runtime_error", "description": "map or record is NULL when strict is true -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of map2record as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "map2record", "basis": "documentation" } ] }, "description": "Copies values from a map into the fields of a record. An entry is copied when its key is the name of a field of record and its value can be assigned to that field. Entries which do not meet both conditions are left out. The function returns the number of fields it has populated, or -1 if map or record is null. Values are assigned using the standard CTL assignment compatibility, so a value is widened where necessary but never narrowed. An integer value is therefore copied into an integer, long, number or decimal field, while a long value is not copied into an integer field. A null value can be copied into a field of any type. The strict parameter turns the entries which have been left out into errors. In strict mode the function fails when a key does not match any field name, when a value cannot be assigned to its matching field, and when map or record is null. If strict is missing, it works in the same way as if it was set to false - such entries are left out silently. The function does not reset record first, so fields which are not matched by any entry keep their previous value. The first argument has to be a map[string, variant]. A map with a more specific value type, e.g. a map[string, string], does not match the signature. Use variant2record if you need to map such a map, or if the map contains nested maps and lists.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "map2record", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "map2record(map[string,variant],record,boolean)", "canonical_signature": "integer map2record(map[string,variant] map, record record, boolean strict)", "type_parameters": [], "parameters": [ { "position": 0, "name": "map", "type": { "kind": "map", "key": { "kind": "named", "name": "string", "display": "string" }, "value": { "kind": "named", "name": "variant", "display": "variant" }, "display": "map[string,variant]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Copies values from a map into the fields of a record.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "map or record is NULL when strict is true -> runtime error.", "cases": [ { "condition": "map or record is NULL when strict is true", "behavior": { "kind": "runtime_error", "description": "map or record is NULL when strict is true -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Copies values from a map into the fields of a record.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "map or record is NULL when strict is true -> runtime error.", "cases": [ { "condition": "map or record is NULL when strict is true", "behavior": { "kind": "runtime_error", "description": "map or record is NULL when strict is true -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "strict", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The strict parameter turns the entries which have been left out into errors.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "strict is NULL -> not documented.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of map2record as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "map2record", "basis": "documentation" } ] }, "description": "Copies values from a map into the fields of a record. An entry is copied when its key is the name of a field of record and its value can be assigned to that field. Entries which do not meet both conditions are left out. The function returns the number of fields it has populated, or -1 if map or record is null. Values are assigned using the standard CTL assignment compatibility, so a value is widened where necessary but never narrowed. An integer value is therefore copied into an integer, long, number or decimal field, while a long value is not copied into an integer field. A null value can be copied into a field of any type. The strict parameter turns the entries which have been left out into errors. In strict mode the function fails when a key does not match any field name, when a value cannot be assigned to its matching field, and when map or record is null. If strict is missing, it works in the same way as if it was set to false - such entries are left out silently. The function does not reset record first, so fields which are not matched by any entry keep their previous value. The first argument has to be a map[string, variant]. A map with a more specific value type, e.g. a map[string, string], does not match the signature. Use variant2record if you need to map such a map, or if the map contains nested maps and lists.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "map2record", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter strict is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The map2record(map, record) and map2record(map, record, boolean) functions are available since CloverDX 7.6.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "map2record", "basis": "documentation" } ] } ], "see_also": [ "record2map", "variant2record" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "map2record", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "matchGroups": { "name": "matchGroups", "category": "string", "summary": "The matchGroups() function returns the list of group matches (the substrings matched by the capturing groups of the regex) if text matches the _regular expression_ regex.", "description": "The matchGroups() function returns the list of group matches (the substrings matched by the capturing groups of the regex) if text matches the _regular expression_ regex. The list is zero-based and the element with index 0 is the match for the entire expression. The following elements (1, ...) correspond with the capturing groups indexed from left to right, starting at one. The returned list is unmodifiable. If text does not match regex, null is returned. If the text argument is null, the function returns null. If the regex is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "matchGroups(string,string)", "canonical_signature": "string[] matchGroups(string text, string regex)", "type_parameters": [], "parameters": [ { "position": 0, "name": "text", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The matchGroups() function returns the list of group matches (the substrings matched by the capturing groups of the regex) if text matches the _regular expression_ regex.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "text is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "regex", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The matchGroups() function returns the list of group matches (the substrings matched by the capturing groups of the regex) if text matches the _regular expression_ regex.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "regex is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "list", "element": { "kind": "named", "name": "string", "display": "string" }, "display": "string[]" }, "description": "Return value of matchGroups as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "text == NULL", "behavior": { "kind": "returns_null", "description": "text is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "matchGroups", "basis": "documentation" } ] }, "description": "The matchGroups() function returns the list of group matches (the substrings matched by the capturing groups of the regex) if text matches the _regular expression_ regex. The list is zero-based and the element with index 0 is the match for the entire expression. The following elements (1, ...) correspond with the capturing groups indexed from left to right, starting at one. The returned list is unmodifiable. If text does not match regex, null is returned. If the text argument is null, the function returns null. If the regex is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "matchGroups", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "regex == NULL", "description": "regex is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The matchGroups(string,string) function is available since CloverETL 3.4.x.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "matchGroups", "basis": "documentation" } ] } ], "see_also": [ "cut", "split", "substring" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "matchGroups", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "matches": { "name": "matches", "category": "string", "summary": "The matches() function checks the string to match the provided regular pattern.", "description": "The matches() function checks the string to match the provided regular pattern. The function returns true, if the text matches the _regular expression_ regex. Otherwise it returns false. If the text is null, the function returns false. If the regex is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "matches(string,string)", "canonical_signature": "boolean matches(string text, string regex)", "type_parameters": [], "parameters": [ { "position": 0, "name": "text", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The function returns true, if the text matches the _regular expression_ regex.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "text is NULL -> false.", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "regex", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The function returns true, if the text matches the _regular expression_ regex.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "regex is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of matches as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "matches", "basis": "documentation" } ] }, "description": "The matches() function checks the string to match the provided regular pattern. The function returns true, if the text matches the _regular expression_ regex. Otherwise it returns false. If the text is null, the function returns false. If the regex is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "matches", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "regex == NULL", "description": "regex is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The matches(string,string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "matches", "basis": "documentation" } ] } ], "see_also": [ "isAscii", "isBlank", "isDate", "isDecimal", "isInteger", "isLong", "isNumber", "isUrl" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "matches", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "max": { "name": "max", "category": "mathematical", "summary": "The max() function returns one of the given arguments which is bigger.", "description": "The max() function returns one of the given arguments which is bigger. If one of the given arguments is null, the function returns the other argument. If both of the given arguments are null, the function returns null. If a given list contains only null values or is empty, the function returns null. If the given list has a null reference, the function fails with an error. The returned element is the same data type as elements in the list.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "max(any[])", "canonical_signature": "any max(any[] list)", "type_parameters": [], "parameters": [ { "position": 0, "name": "list", "type": { "kind": "list", "element": { "kind": "any", "display": "any" }, "display": "any[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given list contains only null values or is empty, the function returns null.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "List reference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of max as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "max", "basis": "documentation" } ] }, "description": "The max() function returns one of the given arguments which is bigger. If one of the given arguments is null, the function returns the other argument. If both of the given arguments are null, the function returns null. If a given list contains only null values or is empty, the function returns null. If the given list has a null reference, the function fails with an error. The returned element is the same data type as elements in the list.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "max", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "list == NULL", "description": "List reference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "max(decimal,decimal)", "canonical_signature": "decimal max(decimal arg1, decimal arg2)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "description": "Return value of max as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "max", "basis": "documentation" } ] }, "description": "The max() function returns one of the given arguments which is bigger. If one of the given arguments is null, the function returns the other argument. If both of the given arguments are null, the function returns null. If a given list contains only null values or is empty, the function returns null. If the given list has a null reference, the function fails with an error. The returned element is the same data type as elements in the list.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "max", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg1 is undocumented.", "NULL behavior for parameter arg2 is undocumented." ] } }, { "id": "max(integer,integer)", "canonical_signature": "integer max(integer arg1, integer arg2)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of max as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "max", "basis": "documentation" } ] }, "description": "The max() function returns one of the given arguments which is bigger. If one of the given arguments is null, the function returns the other argument. If both of the given arguments are null, the function returns null. If a given list contains only null values or is empty, the function returns null. If the given list has a null reference, the function fails with an error. The returned element is the same data type as elements in the list.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "max", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg1 is undocumented.", "NULL behavior for parameter arg2 is undocumented." ] } }, { "id": "max(long,long)", "canonical_signature": "long max(long arg1, long arg2)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of max as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "max", "basis": "documentation" } ] }, "description": "The max() function returns one of the given arguments which is bigger. If one of the given arguments is null, the function returns the other argument. If both of the given arguments are null, the function returns null. If a given list contains only null values or is empty, the function returns null. If the given list has a null reference, the function fails with an error. The returned element is the same data type as elements in the list.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "max", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg1 is undocumented.", "NULL behavior for parameter arg2 is undocumented." ] } }, { "id": "max(number,number)", "canonical_signature": "number max(number arg1, number arg2)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of max as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "max", "basis": "documentation" } ] }, "description": "The max() function returns one of the given arguments which is bigger. If one of the given arguments is null, the function returns the other argument. If both of the given arguments are null, the function returns null. If a given list contains only null values or is empty, the function returns null. If the given list has a null reference, the function fails with an error. The returned element is the same data type as elements in the list.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "max", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg1 is undocumented.", "NULL behavior for parameter arg2 is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The max(integer, integer), max(long,long), max(number,number), max(decimal,decimal) and max(E[]) functions are available since CloverETL 3.5.0-M2.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "max", "basis": "documentation" } ] } ], "see_also": [ "min" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "max", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "md5": { "name": "md5", "category": "conversion", "summary": "The md5() function calculates an MD5 hash value of the argument.", "description": "The md5() function calculates an MD5 hash value of the argument. If the input is null, the function fails with an error. If the input string may contain a non-ASCII character, it is recommended to convert the input string to an array of byte manually using the function str2byte to the bytes and than use the function md5.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "md5(byte)", "canonical_signature": "byte md5(byte arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of md5 as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "md5", "basis": "documentation" } ] }, "description": "The md5() function calculates an MD5 hash value of the argument. If the input is null, the function fails with an error. If the input string may contain a non-ASCII character, it is recommended to convert the input string to an array of byte manually using the function str2byte to the bytes and than use the function md5.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "md5", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "md5(string)", "canonical_signature": "byte md5(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of md5 as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "md5", "basis": "documentation" } ] }, "description": "The md5() function calculates an MD5 hash value of the argument. If the input is null, the function fails with an error. If the input string may contain a non-ASCII character, it is recommended to convert the input string to an array of byte manually using the function str2byte to the bytes and than use the function md5.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "md5", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The md5(byte) and md5(string) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "md5", "basis": "documentation" } ] } ], "see_also": [ "byte2hex", "sha1", "sha256", "str2byte" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "md5", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "md5HexString": { "name": "md5HexString", "category": "conversion", "summary": "The md5HexString() function calculates an MD5 hash value of the argument.", "description": "The md5HexString() function calculates an MD5 hash value of the argument. Return value is converted to a hexadecimal string. If the input is null, the function returns null. If the input string may contain a non-ASCII character, it is recommended to convert the input string to an array of byte manually using the function str2byte to the bytes and than use the function md5.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "md5HexString(byte)", "canonical_signature": "string md5HexString(byte arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of md5HexString as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "md5HexString", "basis": "documentation" } ] }, "description": "The md5HexString() function calculates an MD5 hash value of the argument. Return value is converted to a hexadecimal string. If the input is null, the function returns null. If the input string may contain a non-ASCII character, it is recommended to convert the input string to an array of byte manually using the function str2byte to the bytes and than use the function md5.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "md5HexString", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "md5HexString(string)", "canonical_signature": "string md5HexString(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of md5HexString as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "md5HexString", "basis": "documentation" } ] }, "description": "The md5HexString() function calculates an MD5 hash value of the argument. Return value is converted to a hexadecimal string. If the input is null, the function returns null. If the input string may contain a non-ASCII character, it is recommended to convert the input string to an array of byte manually using the function str2byte to the bytes and than use the function md5.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "md5HexString", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The md5HexString(byte) and md5HexString(string) functions are available since", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "md5HexString", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "CloverETL 6.4.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "md5HexString", "basis": "documentation" } ] } ], "see_also": [ "byte2hex", "sha1HexString", "sha256HexString", "str2byte" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "md5HexString", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "metaphone": { "name": "metaphone", "category": "string", "summary": "The metaphone() function returns the metaphone code of the first argument.", "description": "The metaphone() function returns the metaphone code of the first argument. For more information, see the following site: http://www.lanw.com/java/phonetic/default.htm[www.lanw.com/java/phonetic/default.htm]. The default maximum length of the metaphone code is 4. The function returns null value for the null input.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "metaphone(string)", "canonical_signature": "string metaphone(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of metaphone as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "metaphone", "basis": "documentation" } ] }, "description": "The metaphone() function returns the metaphone code of the first argument. For more information, see the following site: http://www.lanw.com/java/phonetic/default.htm[www.lanw.com/java/phonetic/default.htm]. The default maximum length of the metaphone code is 4. The function returns null value for the null input.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "metaphone", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "metaphone(string,integer)", "canonical_signature": "string metaphone(string arg, integer maxLength)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "maxLength", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented maxLength argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "metaphone maxLength NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of metaphone as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "metaphone", "basis": "documentation" } ] }, "description": "The metaphone() function returns the metaphone code of the first argument. For more information, see the following site: http://www.lanw.com/java/phonetic/default.htm[www.lanw.com/java/phonetic/default.htm]. The default maximum length of the metaphone code is 4. The function returns null value for the null input.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "metaphone", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "maxLength == NULL", "description": "metaphone maxLength NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The metaphone(string) and metaphone(string,integer) function is available since CloverETL 3.2.1 or earlier.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "metaphone", "basis": "documentation" } ] } ], "see_also": [ "NYSIIS", "editDistance", "soundex" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "metaphone", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "min": { "name": "min", "category": "mathematical", "summary": "The min() function returns one of the given arguments which is smaller.", "description": "The min() function returns one of the given arguments which is smaller. If one of the given arguments is null, the function returns the other argument. If both of the given arguments are null, the function returns null. Null values in a list are omitted. The returned element is the same data type as elements in the list. If the given list contains only null values or is empty, the function returns null. If the given list has a null reference, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "min(any[])", "canonical_signature": "any min(any[] list)", "type_parameters": [], "parameters": [ { "position": 0, "name": "list", "type": { "kind": "list", "element": { "kind": "any", "display": "any" }, "display": "any[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Null values in a list are omitted.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "List reference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of min as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "min", "basis": "documentation" } ] }, "description": "The min() function returns one of the given arguments which is smaller. If one of the given arguments is null, the function returns the other argument. If both of the given arguments are null, the function returns null. Null values in a list are omitted. The returned element is the same data type as elements in the list. If the given list contains only null values or is empty, the function returns null. If the given list has a null reference, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "min", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "list == NULL", "description": "List reference is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "min(decimal,decimal)", "canonical_signature": "decimal min(decimal arg1, decimal arg2)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "description": "Return value of min as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "min", "basis": "documentation" } ] }, "description": "The min() function returns one of the given arguments which is smaller. If one of the given arguments is null, the function returns the other argument. If both of the given arguments are null, the function returns null. Null values in a list are omitted. The returned element is the same data type as elements in the list. If the given list contains only null values or is empty, the function returns null. If the given list has a null reference, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "min", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg1 is undocumented.", "NULL behavior for parameter arg2 is undocumented." ] } }, { "id": "min(integer,integer)", "canonical_signature": "integer min(integer arg1, integer arg2)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of min as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "min", "basis": "documentation" } ] }, "description": "The min() function returns one of the given arguments which is smaller. If one of the given arguments is null, the function returns the other argument. If both of the given arguments are null, the function returns null. Null values in a list are omitted. The returned element is the same data type as elements in the list. If the given list contains only null values or is empty, the function returns null. If the given list has a null reference, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "min", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg1 is undocumented.", "NULL behavior for parameter arg2 is undocumented." ] } }, { "id": "min(long,long)", "canonical_signature": "long min(long arg1, long arg2)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of min as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "min", "basis": "documentation" } ] }, "description": "The min() function returns one of the given arguments which is smaller. If one of the given arguments is null, the function returns the other argument. If both of the given arguments are null, the function returns null. Null values in a list are omitted. The returned element is the same data type as elements in the list. If the given list contains only null values or is empty, the function returns null. If the given list has a null reference, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "min", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg1 is undocumented.", "NULL behavior for parameter arg2 is undocumented." ] } }, { "id": "min(number,number)", "canonical_signature": "number min(number arg1, number arg2)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg1", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg1 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of min as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "min", "basis": "documentation" } ] }, "description": "The min() function returns one of the given arguments which is smaller. If one of the given arguments is null, the function returns the other argument. If both of the given arguments are null, the function returns null. Null values in a list are omitted. The returned element is the same data type as elements in the list. If the given list contains only null values or is empty, the function returns null. If the given list has a null reference, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "min", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg1 is undocumented.", "NULL behavior for parameter arg2 is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The min(integer),min(long), min(number), min(decimal) and min(E[]) functions are available since CloverETL 3.5.0-M2.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "min", "basis": "documentation" } ] } ], "see_also": [ "max" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "min", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "next": { "name": "next", "category": "lookup_table", "summary": "lookup().next() The next() function allows you to iterate the result of the search.", "description": "lookup().next() The next() function allows you to iterate the result of the search. It moves the pointer to the next record and returns this record. It returns the next record with the same key. If there is no such record, it returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "next()", "canonical_signature": "any next()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of next as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "next", "basis": "documentation" } ] }, "description": "lookup().next() The next() function allows you to iterate the result of the search. It moves the pointer to the next record and returns this record. It returns the next record with the same key. If there is no such record, it returns null.", "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "next", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [ "The source documents an inline callable form but no formal typed signature." ] } }, { "id": "next()#2", "canonical_signature": "any next()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "The source documents this callable form but not a typed CTL signature.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented in a typed signature." }, "evidence": [ { "source_id": "ctl2-sequence-functions", "section": "next", "basis": "documentation" } ] }, "description": "Documented callable form with no formal typed signature.", "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "evidence": [ { "source_id": "ctl2-sequence-functions", "section": "next", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [ "The sequence reference documents method-call syntax but no formal typed CTL signature.", "Duplicate normalized overload ID required a stable discriminator." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The next() function is available since CloverETL 3.2.2 or earlier.", "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "next", "basis": "documentation" } ] } ], "see_also": [ "get", "isnull" ], "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "next", "basis": "documentation" }, { "source_id": "ctl2-sequence-functions", "section": "next", "basis": "documentation", "detail": "Verbatim sequence method call." } ], "data_quality": { "status": "partial", "issues": [ "No formal typed signature was found; an explicitly partial inline-call record was created.", "Also documented as a sequence method without a formal typed signature." ] } }, "normalizeDecimal": { "name": "normalizeDecimal", "category": "string", "summary": "The normalizeDecimal() function preprocesses decimal number strings and removes non-numeric characters, standardizes decimal separators, and eliminates thousand separators and currency symbols.", "description": "The normalizeDecimal() function preprocesses decimal number strings and removes non-numeric characters, standardizes decimal separators, and eliminates thousand separators and currency symbols. By scanning the input string from right to left, it identifies the first occurrence of either a comma or a period, assuming it to be the decimal separator. While this approach offers a basic level of normalization, it's important to note that it relies on a simple heuristic and may not be suitable for all scenarios, e.g., when your data includes integers with commas used as thousand separators (1,000). In such scenarios, more sophisticated parsing techniques may be necessary to accurately identify and handle different number formats.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "normalizeDecimal(string)", "canonical_signature": "string normalizeDecimal(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of normalizeDecimal as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "normalizeDecimal", "basis": "documentation" } ] }, "description": "The normalizeDecimal() function preprocesses decimal number strings and removes non-numeric characters, standardizes decimal separators, and eliminates thousand separators and currency symbols. By scanning the input string from right to left, it identifies the first occurrence of either a comma or a period, assuming it to be the decimal separator. While this approach offers a basic level of normalization, it's important to note that it relies on a simple heuristic and may not be suitable for all scenarios, e.g., when your data includes integers with commas used as thousand separators (1,000). In such scenarios, more sophisticated parsing techniques may be necessary to accurately identify and handle different number formats.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "normalizeDecimal", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The normalizeDecimal(string) function is available since CloverDX 6.7.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "normalizeDecimal", "basis": "documentation" } ] } ], "see_also": [ "normalizeWhitespaces" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "normalizeDecimal", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "normalizePath": { "name": "normalizePath", "category": "string", "summary": "The normalizePath() function normalizes a specified path or URL to a standard format, removing single and double dot path segments.", "description": "The normalizePath() function normalizes a specified path or URL to a standard format, removing single and double dot path segments. Also replaces backslashes with forward slashes. If normalization fails because there is a double dot path segment that is not preceded by a removable parent path segment, the function returns null. The function returns a null value for a null input.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "normalizePath(string)", "canonical_signature": "string normalizePath(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of normalizePath as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "normalizePath", "basis": "documentation" } ] }, "description": "The normalizePath() function normalizes a specified path or URL to a standard format, removing single and double dot path segments. Also replaces backslashes with forward slashes. If normalization fails because there is a double dot path segment that is not preceded by a removable parent path segment, the function returns null. The function returns a null value for a null input.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "normalizePath", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The normalizePath(string) function is available since CloverETL 4.1.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "normalizePath", "basis": "documentation" } ] } ], "see_also": [ "getFileExtension", "getFileName", "getFileNameWithoutExtension", "getFilePath" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "normalizePath", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "normalizeWhitespaces": { "name": "normalizeWhitespaces", "category": "string", "summary": "The normalizeWhitespaces() function takes one string argument and returns another string with all white space characters replaced with a single space.", "description": "The normalizeWhitespaces() function takes one string argument and returns another string with all white space characters replaced with a single space. Leading and trailing white spaces are removed altogether (trimmed). Following Unicode character categories are considered as white space by the function: https://www.fileformat.info/info/unicode/category/Cc/list.htm['Other, Control' Category] https://www.fileformat.info/info/unicode/category/Zs/list.htm['Separator, Space' Category] https://www.fileformat.info/info/unicode/category/Zp/list.htm['Separator, Paragraph' Category] https://www.fileformat.info/info/unicode/category/Zl/list.htm['Separator, Line' Category] The function returns a null value for a null input.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "normalizeWhitespaces(string)", "canonical_signature": "string normalizeWhitespaces(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of normalizeWhitespaces as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "normalizeWhitespaces", "basis": "documentation" } ] }, "description": "The normalizeWhitespaces() function takes one string argument and returns another string with all white space characters replaced with a single space. Leading and trailing white spaces are removed altogether (trimmed). Following Unicode character categories are considered as white space by the function: https://www.fileformat.info/info/unicode/category/Cc/list.htm['Other, Control' Category] https://www.fileformat.info/info/unicode/category/Zs/list.htm['Separator, Space' Category] https://www.fileformat.info/info/unicode/category/Zp/list.htm['Separator, Paragraph' Category] https://www.fileformat.info/info/unicode/category/Zl/list.htm['Separator, Line' Category] The function returns a null value for a null input.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "normalizeWhitespaces", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The normalizeWhitespaces(string) function is available since CloverETL 6.1.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "normalizeWhitespaces", "basis": "documentation" } ] } ], "see_also": [ "normalizeDecimal", "trim" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "normalizeWhitespaces", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "num2bool": { "name": "num2bool", "category": "conversion", "summary": "The num2bool() function converts a numeric type to boolean.", "description": "The num2bool() function converts a numeric type to boolean. The function takes one argument of any numeric data type (integer, long, number or decimal) and returns boolean false for 0 and true for any other value. If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "num2bool(any)", "canonical_signature": "boolean num2bool(any arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of num2bool as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "num2bool", "basis": "documentation" } ] }, "description": "The num2bool() function converts a numeric type to boolean. The function takes one argument of any numeric data type (integer, long, number or decimal) and returns boolean false for 0 and true for any other value. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "num2bool", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The num2bool(integer), num2bool(long), num2bool(double) and num2bool(decimal) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "num2bool", "basis": "documentation" } ] } ], "see_also": [ "bool2num" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "num2bool", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "num2str": { "name": "num2str", "category": "conversion", "summary": "The num2str() converts any numeric type to the string decimal representation.", "description": "The num2str() converts any numeric type to the string decimal representation. The function takes one argument of any numeric data type (integer, long, number, or decimal) and converts it to a string in decimal representation. If the input is null, the function returns null. The radix enables to convert the input number to a different radix-based numerical system, e.g. to the octal numerical system. For both integer and long data types, any integer number can be used as radix. For the data type double (number) only 10 or 16 can be used as radix. The format describes format of number. If the parameter is missing, the numeric format is used. If the locale parameter is missing, the locale has system value.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "num2str(any)", "canonical_signature": "string num2str(any arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of num2str as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "num2str", "basis": "documentation" } ] }, "description": "The num2str() converts any numeric type to the string decimal representation. The function takes one argument of any numeric data type (integer, long, number, or decimal) and converts it to a string in decimal representation. If the input is null, the function returns null. The radix enables to convert the input number to a different radix-based numerical system, e.g. to the octal numerical system. For both integer and long data types, any integer number can be used as radix. For the data type double (number) only 10 or 16 can be used as radix. The format describes format of number. If the parameter is missing, the numeric format is used. If the locale parameter is missing, the locale has system value.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "num2str", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "num2str(any,string)", "canonical_signature": "string num2str(any arg, string format)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The format describes format of number.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format is NULL -> a normal string result (probe: \"42\").", "result": { "kind": "literal", "type": "integer", "value": 42, "display": "42" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of num2str as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "num2str", "basis": "documentation" } ] }, "description": "The num2str() converts any numeric type to the string decimal representation. The function takes one argument of any numeric data type (integer, long, number, or decimal) and converts it to a string in decimal representation. If the input is null, the function returns null. The radix enables to convert the input number to a different radix-based numerical system, e.g. to the octal numerical system. For both integer and long data types, any integer number can be used as radix. For the data type double (number) only 10 or 16 can be used as radix. The format describes format of number. If the parameter is missing, the numeric format is used. If the locale parameter is missing, the locale has system value.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "num2str", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "num2str(any,string,string)", "canonical_signature": "string num2str(any arg, string format, string locale)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The format describes format of number.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "format is NULL -> a normal string result (probe: \"42\").", "result": { "kind": "literal", "type": "integer", "value": 42, "display": "42" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the locale parameter is missing, the locale has system value.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "locale is NULL -> a normal string result (probe: \"42\").", "result": { "kind": "literal", "type": "integer", "value": 42, "display": "42" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of num2str as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "num2str", "basis": "documentation" } ] }, "description": "The num2str() converts any numeric type to the string decimal representation. The function takes one argument of any numeric data type (integer, long, number, or decimal) and converts it to a string in decimal representation. If the input is null, the function returns null. The radix enables to convert the input number to a different radix-based numerical system, e.g. to the octal numerical system. For both integer and long data types, any integer number can be used as radix. For the data type double (number) only 10 or 16 can be used as radix. The format describes format of number. If the parameter is missing, the numeric format is used. If the locale parameter is missing, the locale has system value.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "num2str", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "num2str(integer|long|number,integer)", "canonical_signature": "string num2str(integer|long|number arg, integer radix)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "union", "options": [ { "kind": "named", "name": "integer", "display": "integer" }, { "kind": "named", "name": "long", "display": "long" }, { "kind": "named", "name": "number", "display": "number" } ], "display": "integer|long|number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "radix", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The radix enables to convert the input number to a different radix-based numerical system, e.g.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "radix is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of num2str as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "num2str", "basis": "documentation" } ] }, "description": "The num2str() converts any numeric type to the string decimal representation. The function takes one argument of any numeric data type (integer, long, number, or decimal) and converts it to a string in decimal representation. If the input is null, the function returns null. The radix enables to convert the input number to a different radix-based numerical system, e.g. to the octal numerical system. For both integer and long data types, any integer number can be used as radix. For the data type double (number) only 10 or 16 can be used as radix. The format describes format of number. If the parameter is missing, the numeric format is used. If the locale parameter is missing, the locale has system value.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "num2str", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "radix == NULL", "description": "radix is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The num2str(integer), num2str(long), num2str(number), num2str(decimal), num2str(integer,integer), num2str(long,integer), num2str(number,integer), num2str(integer,string), num2str(long,string), num2str(double,string), num2str(decimal,string), num2str(integer,string,string), num2str(long,string,string), num2str(double,string,string) and num2str(decimal,string,string) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "num2str", "basis": "documentation" } ] } ], "see_also": [ "str2double", "toString" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "num2str", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "nvl": { "name": "nvl", "category": "miscellaneous", "summary": "The nvl() function returns the first argument, if its value is not null, otherwise the function returns the second argument.", "description": "The nvl() function returns the first argument, if its value is not null, otherwise the function returns the second argument. Both arguments must be of the same type.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "nvl(any,any)", "canonical_signature": "any nvl(any arg, any default)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "default", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented default argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of nvl as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "nvl", "basis": "documentation" } ] }, "description": "The nvl() function returns the first argument, if its value is not null, otherwise the function returns the second argument. Both arguments must be of the same type.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "nvl", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg is undocumented.", "NULL behavior for parameter default is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The nvl() function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "nvl", "basis": "documentation" } ] } ], "see_also": [ "iif", "isnull", "nvl2" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "nvl", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "nvl2": { "name": "nvl2", "category": "miscellaneous", "summary": "The nvl2() function returns the second argument, if the first argument has not null value.", "description": "The nvl2() function returns the second argument, if the first argument has not null value. If the first argument has a null value, the function returns the third argument.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "nvl2(any,any,any)", "canonical_signature": "any nvl2(any arg, any arg2, any arg3)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "arg2", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg2 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "arg3", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg3 argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of nvl2 as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "nvl2", "basis": "documentation" } ] }, "description": "The nvl2() function returns the second argument, if the first argument has not null value. If the first argument has a null value, the function returns the third argument.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "nvl2", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg is undocumented.", "NULL behavior for parameter arg2 is undocumented.", "NULL behavior for parameter arg3 is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The nvl2(obj,obj,obj) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "nvl2", "basis": "documentation" } ] } ], "see_also": [ "iif", "isnull", "nvl" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "nvl2", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "packDecimal2long": { "name": "packDecimal2long", "category": "conversion", "summary": "The packDecimal2long() function converts an array of bytes whose meaning is the packed decimal representation of a long number to a long number.", "description": "The packDecimal2long() function converts an array of bytes whose meaning is the packed decimal representation of a long number to a long number. If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "packDecimal2long(byte)", "canonical_signature": "long packDecimal2long(byte arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of packDecimal2long as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "packDecimal2long", "basis": "documentation" } ] }, "description": "The packDecimal2long() function converts an array of bytes whose meaning is the packed decimal representation of a long number to a long number. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "packDecimal2long", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The packDecimal2long(byte) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "packDecimal2long", "basis": "documentation" } ] } ], "see_also": [ "long2packDecimal" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "packDecimal2long", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "parseAvro": { "name": "parseAvro", "category": "conversion", "summary": "Converts bytes containing Avro data serialized with the https://avro.apache.org/docs/current/spec.html#binary_encoding[Binary encoding] to a variant using the specified Avro schema in JSON.", "description": "Converts bytes containing Avro data serialized with the https://avro.apache.org/docs/current/spec.html#binary_encoding[Binary encoding] to a variant using the specified Avro schema in JSON. Avro data have to match Avro schema supplemented as the second parameter. The Avro data bytes are not regular Avro file, but the data only without Avro schema. The Avro data can be received for example from a messaging system (JMS) or events streaming system (Kafka). If the data input is null, the function returns null. If the Avro schema is null, the function fails with an error. Its counterpart is the function writeAvro. .Type conversion in parseAvro() |=== h|Avro type h|Avro logical type h|Resulted CTL type h|Note |null type | |null value | |boolean | |boolean | |int | |integer | |int |date |date |system timezone is used for conversion to Clover date |int |time-millis |date |system timezone is used for conversion to Clover date |long | |long | |long |time-micros |date |system timezone is used for conversion to Clover date; micros are truncated |long |timestamp-millis |date | |long |timestamp-micros |date |micros are truncated |long |local-timestamp-millis |date |system timezone is used for conversion to Clover date |long |local-timestamp-micros |date |system timezone is used for conversion to Clover date; micros are truncated |float | |number | |double | |number | |bytes | |byte | |bytes |decimal |decimal | |string | |string | |string |uuid |string | |record | |map {string -> any} |keys match field names; apply this table to the value types |enum | |string | |array | |list |apply this table to the items type |map | |map |apply this table to the values type |union | |types from union |apply this table to the union types |fixed | |byte | |fixed |decimal |decimal | |fixed |duration | |not supported |===", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "parseAvro(byte,string)", "canonical_signature": "variant parseAvro(byte avroData, string schema)", "type_parameters": [], "parameters": [ { "position": 0, "name": "avroData", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented avroData argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "avroData is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "schema", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Converts bytes containing Avro data serialized with the https://avro.apache.org/docs/current/spec.html#binary_encoding[Binary encoding] to a variant using the specified Avro schema in JSON.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "schema is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "variant", "display": "variant" }, "description": "Return value of parseAvro as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "avroData == NULL", "behavior": { "kind": "returns_null", "description": "avroData is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "parseAvro", "basis": "documentation" } ] }, "description": "Converts bytes containing Avro data serialized with the https://avro.apache.org/docs/current/spec.html#binary_encoding[Binary encoding] to a variant using the specified Avro schema in JSON. Avro data have to match Avro schema supplemented as the second parameter. The Avro data bytes are not regular Avro file, but the data only without Avro schema. The Avro data can be received for example from a messaging system (JMS) or events streaming system (Kafka). If the data input is null, the function returns null. If the Avro schema is null, the function fails with an error. Its counterpart is the function writeAvro. .Type conversion in parseAvro() |=== h|Avro type h|Avro logical type h|Resulted CTL type h|Note |null type | |null value | |boolean | |boolean | |int | |integer | |int |date |date |system timezone is used for conversion to Clover date |int |time-millis |date |system timezone is used for conversion to Clover date |long | |long | |long |time-micros |date |system timezone is used for conversion to Clover date; micros are truncated |long |timestamp-millis |date | |long |timestamp-micros |date |micros are truncated |long |local-timestamp-millis |date |system timezone is used for conversion to Clover date |long |local-timestamp-micros |date |system timezone is used for conversion to Clover date; micros are truncated |float | |number | |double | |number | |bytes | |byte | |bytes |decimal |decimal | |string | |string | |string |uuid |string | |record | |map {string -> any} |keys match field names; apply this table to the value types |enum | |string | |array | |list |apply this table to the items type |map | |map |apply this table to the values type |union | |types from union |apply this table to the union types |fixed | |byte | |fixed |decimal |decimal | |fixed |duration | |not supported |===", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "parseAvro", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "schema == NULL", "description": "schema is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [ "getAvroSchema", "writeAvro" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "parseAvro", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "parseBson": { "name": "parseBson", "category": "conversion", "summary": "Converts bytes containing http://bsonspec.org[BSON] serialized data to a tree data structure composed of CTL lists and maps.", "description": "Converts bytes containing http://bsonspec.org[BSON] serialized data to a tree data structure composed of CTL lists and maps. Note that the return type is always variant, regardless of the actual returned value. If the input is null, the function returns null. Its counterpart is the function writeBson. The function can also read data written by writeExtendedBson.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "parseBson(byte)", "canonical_signature": "variant parseBson(byte bson)", "type_parameters": [], "parameters": [ { "position": 0, "name": "bson", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Converts bytes containing http://bsonspec.org[BSON] serialized data to a tree data structure composed of CTL lists and maps.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input (bson or json) is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "variant", "display": "variant" }, "description": "Return value of parseBson as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "bson == NULL", "behavior": { "kind": "returns_null", "description": "Input (bson or json) is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "parseBson", "basis": "documentation" } ] }, "description": "Converts bytes containing http://bsonspec.org[BSON] serialized data to a tree data structure composed of CTL lists and maps. Note that the return type is always variant, regardless of the actual returned value. If the input is null, the function returns null. Its counterpart is the function writeBson. The function can also read data written by writeExtendedBson.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "parseBson", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "Available since CloverDX 5.6.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "parseBson", "basis": "documentation" } ] } ], "see_also": [ "writeBson", "writeExtendedBson" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "parseBson", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "parseJson": { "name": "parseJson", "category": "conversion", "summary": "Converts a https://www.json.org[JSON] formatted string to a tree data structure composed of CTL lists and maps.", "description": "Converts a https://www.json.org[JSON] formatted string to a tree data structure composed of CTL lists and maps. Note that the return type is always variant, regardless of the actual returned value. If the input is null, the function returns null. The normalize parameter makes the CTL type of a parsed number depend on how the number is written rather than on how large it is. A whole number becomes a long and a number written with a decimal point or an exponent becomes a decimal. A whole number too large for a long becomes a decimal as well. If normalize is missing, it works in the same way as if it was set to false - the type follows the magnitude of the value, so the same JSON property can arrive as an integer, a long, a number or a decimal in different records. .Numeric types returned by parseJson() |=== h|JSON number h|normalize = false h|normalize = true |25 |integer |long |9223372036854775807 |long |long |92233720368547758071 |decimal |decimal - the value does not fit into a long |25.0 |number |decimal |3.14 |number |decimal |1e400 |number - the value overflows to Infinity |decimal - the value is kept exactly |NaN, Infinity, -Infinity |number |number |=== Its counterpart is the function writeJson. Normalization is useful when the parsed values are stored into record fields with variant2record, because a decimal value is never converted into an integer or a long field. Without normalization the same JSON property can be mapped in one record and skipped in another, depending on how large its value happens to be.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "parseJson(string)", "canonical_signature": "variant parseJson(string json)", "type_parameters": [], "parameters": [ { "position": 0, "name": "json", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Converts a https://www.json.org[JSON] formatted string to a tree data structure composed of CTL lists and maps.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input (bson or json) is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "variant", "display": "variant" }, "description": "Return value of parseJson as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "json == NULL", "behavior": { "kind": "returns_null", "description": "Input (bson or json) is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "parseJson", "basis": "documentation" } ] }, "description": "Converts a https://www.json.org[JSON] formatted string to a tree data structure composed of CTL lists and maps. Note that the return type is always variant, regardless of the actual returned value. If the input is null, the function returns null. The normalize parameter makes the CTL type of a parsed number depend on how the number is written rather than on how large it is. A whole number becomes a long and a number written with a decimal point or an exponent becomes a decimal. A whole number too large for a long becomes a decimal as well. If normalize is missing, it works in the same way as if it was set to false - the type follows the magnitude of the value, so the same JSON property can arrive as an integer, a long, a number or a decimal in different records. .Numeric types returned by parseJson() |=== h|JSON number h|normalize = false h|normalize = true |25 |integer |long |9223372036854775807 |long |long |92233720368547758071 |decimal |decimal - the value does not fit into a long |25.0 |number |decimal |3.14 |number |decimal |1e400 |number - the value overflows to Infinity |decimal - the value is kept exactly |NaN, Infinity, -Infinity |number |number |=== Its counterpart is the function writeJson. Normalization is useful when the parsed values are stored into record fields with variant2record, because a decimal value is never converted into an integer or a long field. Without normalization the same JSON property can be mapped in one record and skipped in another, depending on how large its value happens to be.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "parseJson", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "parseJson(string,boolean)", "canonical_signature": "variant parseJson(string json, boolean normalize)", "type_parameters": [], "parameters": [ { "position": 0, "name": "json", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Converts a https://www.json.org[JSON] formatted string to a tree data structure composed of CTL lists and maps.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input (bson or json) is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "normalize", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The normalize parameter makes the CTL type of a parsed number depend on how the number is written rather than on how large it is.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "normalize is NULL -> not documented.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "variant", "display": "variant" }, "description": "Return value of parseJson as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "json == NULL", "behavior": { "kind": "returns_null", "description": "Input (bson or json) is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "parseJson", "basis": "documentation" } ] }, "description": "Converts a https://www.json.org[JSON] formatted string to a tree data structure composed of CTL lists and maps. Note that the return type is always variant, regardless of the actual returned value. If the input is null, the function returns null. The normalize parameter makes the CTL type of a parsed number depend on how the number is written rather than on how large it is. A whole number becomes a long and a number written with a decimal point or an exponent becomes a decimal. A whole number too large for a long becomes a decimal as well. If normalize is missing, it works in the same way as if it was set to false - the type follows the magnitude of the value, so the same JSON property can arrive as an integer, a long, a number or a decimal in different records. .Numeric types returned by parseJson() |=== h|JSON number h|normalize = false h|normalize = true |25 |integer |long |9223372036854775807 |long |long |92233720368547758071 |decimal |decimal - the value does not fit into a long |25.0 |number |decimal |3.14 |number |decimal |1e400 |number - the value overflows to Infinity |decimal - the value is kept exactly |NaN, Infinity, -Infinity |number |number |=== Its counterpart is the function writeJson. Normalization is useful when the parsed values are stored into record fields with variant2record, because a decimal value is never converted into an integer or a long field. Without normalization the same JSON property can be mapped in one record and skipped in another, depending on how large its value happens to be.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "parseJson", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter normalize is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The parseJson(string) function is available since CloverDX 5.6.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "parseJson", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The parseJson(string, boolean) function is available since CloverDX 7.6.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "parseJson", "basis": "documentation" } ] } ], "see_also": [ "parseBson", "variant2record", "writeJson" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "parseJson", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "parseProperties": { "name": "parseProperties", "category": "miscellaneous", "summary": "The parseProperties() function converts key-value pairs separated with a new line from a string to a map.", "description": "The parseProperties() function converts key-value pairs separated with a new line from a string to a map. The order of properties is preserved. If the input string is null or empty, the function returns an empty map.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "parseProperties(string)", "canonical_signature": "map[string,string] parseProperties(string properties)", "type_parameters": [], "parameters": [ { "position": 0, "name": "properties", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The order of properties is preserved.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "map", "key": { "kind": "named", "name": "string", "display": "string" }, "value": { "kind": "named", "name": "string", "display": "string" }, "display": "map[string,string]" }, "description": "Return value of parseProperties as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "parseProperties", "basis": "documentation" } ] }, "description": "The parseProperties() function converts key-value pairs separated with a new line from a string to a map. The order of properties is preserved. If the input string is null or empty, the function returns an empty map.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "parseProperties", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter properties is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The parseProperties() function is available since CloverETL 4.1.0.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "parseProperties", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": ".Sample property file", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "parseProperties", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "====", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "parseProperties", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "[source, properties]", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "parseProperties", "basis": "documentation" } ] } ], "see_also": [ "Properties" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "parseProperties", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [ "See-also references outside the v1 core-source scope: Properties." ] } }, "pi": { "name": "pi", "category": "mathematical", "summary": "The pi function returns the pi number.", "description": "The pi function returns the pi number.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "pi()", "canonical_signature": "number pi()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of pi as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "pi", "basis": "documentation" } ] }, "description": "The pi function returns the pi number.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "pi", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The pi() function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "pi", "basis": "documentation" } ] } ], "see_also": [ "e" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "pi", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "poll": { "name": "poll", "category": "container", "summary": "The poll function removes the first element from a given list and returns this element.", "description": "The poll function removes the first element from a given list and returns this element. The list specified as the argument changes to this new value (without the removed first element). If the list is empty, the function returns null. === Error states If list is null, the function fails with an error. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "poll(T[])", "canonical_signature": "T poll(T[] list)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "list", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The poll function removes the first element from a given list and returns this element.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "list is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "type_variable", "name": "T", "display": "T" }, "description": "Return value of poll as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "poll", "basis": "documentation" } ] }, "description": "The poll function removes the first element from a given list and returns this element. The list specified as the argument changes to this new value (without the removed first element). If the list is empty, the function returns null. === Error states If list is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "poll", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "list == NULL", "description": "list is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-container-functions", "section": "poll", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "pop": { "name": "pop", "category": "container", "summary": "The pop function removes the last element from a given list and returns this element.", "description": "The pop function removes the last element from a given list and returns this element. The list specified as the argument changes to this new value (without the removed last element). === Error states If list is null, the function fails with an error. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "pop(T[])", "canonical_signature": "T pop(T[] list)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "list", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The pop function removes the last element from a given list and returns this element.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "list is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "type_variable", "name": "T", "display": "T" }, "description": "Return value of pop as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "pop", "basis": "documentation" } ] }, "description": "The pop function removes the last element from a given list and returns this element. The list specified as the argument changes to this new value (without the removed last element). === Error states If list is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "pop", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "list == NULL", "description": "list is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-container-functions", "section": "pop", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "pow": { "name": "pow", "category": "mathematical", "summary": "The pow() function returns the exponential function of the first argument as the exponent with the second as the base.", "description": "The pow() function returns the exponential function of the first argument as the exponent with the second as the base. The arguments can be of any numeric data type, data type do not need to be of the same type (integer, long, number or decimal). If one of the given arguments is null, the function fails with an error. The function pow with decimal arguments uses the integer part of second argument only. Thus pow(4D, 2.5D) leads to a calculation of pow(4D, 2D).", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "pow(decimal,decimal)", "canonical_signature": "decimal pow(decimal base, decimal exp)", "type_parameters": [], "parameters": [ { "position": 0, "name": "base", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The pow() function returns the exponential function of the first argument as the exponent with the second as the base.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "base or exp is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "exp", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "==== See also: exp, log, log10, sqrt", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "base or exp is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "description": "Return value of pow as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "pow", "basis": "documentation" } ] }, "description": "The pow() function returns the exponential function of the first argument as the exponent with the second as the base. The arguments can be of any numeric data type, data type do not need to be of the same type (integer, long, number or decimal). If one of the given arguments is null, the function fails with an error. The function pow with decimal arguments uses the integer part of second argument only. Thus pow(4D, 2.5D) leads to a calculation of pow(4D, 2D).", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "pow", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "base == NULL", "description": "base or exp is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "exp == NULL", "description": "base or exp is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "pow(number,number)", "canonical_signature": "number pow(number base, number exp)", "type_parameters": [], "parameters": [ { "position": 0, "name": "base", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The pow() function returns the exponential function of the first argument as the exponent with the second as the base.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "base or exp is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "exp", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "==== See also: exp, log, log10, sqrt", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "base or exp is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of pow as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "pow", "basis": "documentation" } ] }, "description": "The pow() function returns the exponential function of the first argument as the exponent with the second as the base. The arguments can be of any numeric data type, data type do not need to be of the same type (integer, long, number or decimal). If one of the given arguments is null, the function fails with an error. The function pow with decimal arguments uses the integer part of second argument only. Thus pow(4D, 2.5D) leads to a calculation of pow(4D, 2D).", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "pow", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "base == NULL", "description": "base or exp is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "exp == NULL", "description": "base or exp is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The pow(decimal), pow(number), power(number,number) and pow(decimal,decimal).", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "pow", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "pow", "basis": "documentation" } ] } ], "see_also": [ "exp", "log", "log10", "sqrt" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "pow", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "printErr": { "name": "printErr", "category": "miscellaneous", "summary": "The printErr() function prints out the message to the graph execution log with error log level.", "description": "The printErr() function prints out the message to the graph execution log with error log level. The printLocation parameter determines whether the source code location is also printed with the message. If printLocation is set to true, the location is appended at the end of the message as (on line: L col: C) where L is a line number and C is a column number.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "printErr(any)", "canonical_signature": "void printErr(any message)", "type_parameters": [], "parameters": [ { "position": 0, "name": "message", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The printErr() function prints out the message to the graph execution log with error log level.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of printErr as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "printErr", "basis": "documentation" } ] }, "description": "The printErr() function prints out the message to the graph execution log with error log level. The printLocation parameter determines whether the source code location is also printed with the message. If printLocation is set to true, the location is appended at the end of the message as (on line: L col: C) where L is a line number and C is a column number.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "printErr", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter message is undocumented." ] } }, { "id": "printErr(any,boolean)", "canonical_signature": "void printErr(any message, boolean printLocation)", "type_parameters": [], "parameters": [ { "position": 0, "name": "message", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The printErr() function prints out the message to the graph execution log with error log level.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "printLocation", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The printLocation parameter determines whether the source code location is also printed with the message.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of printErr as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "printErr", "basis": "documentation" } ] }, "description": "The printErr() function prints out the message to the graph execution log with error log level. The printLocation parameter determines whether the source code location is also printed with the message. If printLocation is set to true, the location is appended at the end of the message as (on line: L col: C) where L is a line number and C is a column number.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "printErr", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter message is undocumented.", "NULL behavior for parameter printLocation is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The printErr is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "printErr", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "In CloverETL 4.1, the functionality was changed and the function no longer writes to stderr but to a graph log. The original behavior with stderr was harder to work with in CloverDX Server environment.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "printErr", "basis": "documentation" } ] } ], "see_also": [ "printLog", "raiseError" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "printErr", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "printLog": { "name": "printLog", "category": "miscellaneous", "summary": "The printLog() function sends a message to a logger.", "description": "The printLog() function sends a message to a logger. The log level of the message must be one of the following: debug, info, warn, error, or fatal. The log level must be specified as a constant, it cannot be a variable reference. By default, the message is logged to graph’s run log. A custom logger may be chosen by referencing it by the name attribute. If the specified logger doesn’t exist, the function will revert to the default behavior. Custom loggers can be defined in log4j configuration files for both Worker and Core. For more details about custom logging configuration, please see Logging customization.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "printLog(level,any)", "canonical_signature": "void printLog(level loglevel, any message)", "type_parameters": [ { "name": "level", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "loglevel", "type": { "kind": "type_variable", "name": "level", "display": "level" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The printLog(level loglevel, string logger, message) function is available since CloverDX 6.4.0.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "message", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The printLog() function sends a message to a logger.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of printLog as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "printLog", "basis": "documentation" } ] }, "description": "The printLog() function sends a message to a logger. The log level of the message must be one of the following: debug, info, warn, error, or fatal. The log level must be specified as a constant, it cannot be a variable reference. By default, the message is logged to graph’s run log. A custom logger may be chosen by referencing it by the name attribute. If the specified logger doesn’t exist, the function will revert to the default behavior. Custom loggers can be defined in log4j configuration files for both Worker and Core. For more details about custom logging configuration, please see Logging customization.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "printLog", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter loglevel is undocumented.", "NULL behavior for parameter message is undocumented." ] } }, { "id": "printLog(level,string,any)", "canonical_signature": "void printLog(level loglevel, string logger, any message)", "type_parameters": [ { "name": "level", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "loglevel", "type": { "kind": "type_variable", "name": "level", "display": "level" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The printLog(level loglevel, string logger, message) function is available since CloverDX 6.4.0.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "logger", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The printLog() function sends a message to a logger.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "message", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The printLog() function sends a message to a logger.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of printLog as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "printLog", "basis": "documentation" } ] }, "description": "The printLog() function sends a message to a logger. The log level of the message must be one of the following: debug, info, warn, error, or fatal. The log level must be specified as a constant, it cannot be a variable reference. By default, the message is logged to graph’s run log. A custom logger may be chosen by referencing it by the name attribute. If the specified logger doesn’t exist, the function will revert to the default behavior. Custom loggers can be defined in log4j configuration files for both Worker and Core. For more details about custom logging configuration, please see Logging customization.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "printLog", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter loglevel is undocumented.", "NULL behavior for parameter logger is undocumented.", "NULL behavior for parameter message is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The printLog(level,string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "printLog", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The printLog(level loglevel, string logger, message) function is available", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "printLog", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "since CloverDX 6.4.0.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "printLog", "basis": "documentation" } ] } ], "see_also": [ "printErr", "raiseError" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "printLog", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "properCase": { "name": "properCase", "category": "string", "summary": "The properCase() function takes one string argument and returns another string with all words converted to proper case.", "description": "The properCase() function takes one string argument and returns another string with all words converted to proper case. Proper case is text that is written with each of the first letters of every word being capitalized. Specifying locale allows you to apply specifics of any language. For example, in English the proper case of word \"iceland\" is \"Iceland\" but in Dutch the proper case of word \"ijsland\" is \"IJsland\" because of the \"ij\" digraph present in the Dutch language. If the locale is null or an empty string, the respective default value is used instead. If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "properCase(string)", "canonical_signature": "string properCase(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of properCase as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "properCase", "basis": "documentation" } ] }, "description": "The properCase() function takes one string argument and returns another string with all words converted to proper case. Proper case is text that is written with each of the first letters of every word being capitalized. Specifying locale allows you to apply specifics of any language. For example, in English the proper case of word \"iceland\" is \"Iceland\" but in Dutch the proper case of word \"ijsland\" is \"IJsland\" because of the \"ij\" digraph present in the Dutch language. If the locale is null or an empty string, the respective default value is used instead. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "properCase", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "properCase(string,string)", "canonical_signature": "string properCase(string arg, string locale)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Specifying locale allows you to apply specifics of any language.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "locale is NULL -> default locale.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of properCase as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "properCase", "basis": "documentation" } ] }, "description": "The properCase() function takes one string argument and returns another string with all words converted to proper case. Proper case is text that is written with each of the first letters of every word being capitalized. Specifying locale allows you to apply specifics of any language. For example, in English the proper case of word \"iceland\" is \"Iceland\" but in Dutch the proper case of word \"ijsland\" is \"IJsland\" because of the \"ij\" digraph present in the Dutch language. If the locale is null or an empty string, the respective default value is used instead. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "properCase", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The properCase(string) function is available since CloverETL 6.1.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "properCase", "basis": "documentation" } ] } ], "see_also": [ "lowerCase", "upperCase" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "properCase", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "push": { "name": "push", "category": "container", "summary": "Adds an element element to the end of the target list.", "description": "Adds an element element to the end of the target list. Modifies the target list and then returns the modified list. This function is an alias of the append function. === Error states If the given list is null, the function fails with an error. The variant version fails if the first argument is not a list or if it is null. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "push(T[],T)", "canonical_signature": "T[] push(T[] target, T element)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "target", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Adds an element element to the end of the target list.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "element", "type": { "kind": "type_variable", "name": "T", "display": "T" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Adds an element element to the end of the target list.", "constraints": [], "null_behavior": { "kind": "mutates_with_null", "description": "item is NULL -> appended to the list as a NULL element.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "description": "Return value of push as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "push", "basis": "documentation" } ] }, "description": "Adds an element element to the end of the target list. Modifies the target list and then returns the modified list. This function is an alias of the append function. === Error states If the given list is null, the function fails with an error. The variant version fails if the first argument is not a list or if it is null. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "push", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [ { "kind": "mutates_parameter", "parameter": "target", "description": "Documentation states that push modifies its target argument.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "push", "basis": "documentation" } ] } ], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter target is undocumented." ] } }, { "id": "push(variant,variant)", "canonical_signature": "variant push(variant target, variant element)", "type_parameters": [], "parameters": [ { "position": 0, "name": "target", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Adds an element element to the end of the target list.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "element", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Adds an element element to the end of the target list.", "constraints": [], "null_behavior": { "kind": "mutates_with_null", "description": "item is NULL -> appended to the list as a NULL element.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "variant", "display": "variant" }, "description": "Return value of push as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "push", "basis": "documentation" } ] }, "description": "Adds an element element to the end of the target list. Modifies the target list and then returns the modified list. This function is an alias of the append function. === Error states If the given list is null, the function fails with an error. The variant version fails if the first argument is not a list or if it is null. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "push", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [ { "kind": "mutates_parameter", "parameter": "target", "description": "Documentation states that push modifies its target argument.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "push", "basis": "documentation" } ] } ], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter target is undocumented." ] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-container-functions", "section": "push", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "put": { "name": "put", "category": "lookup_table", "summary": "lookup().put() The put() function stores the record passed as its argument in the selected lookup table.", "description": "lookup().put() The put() function stores the record passed as its argument in the selected lookup table. It returns a boolean result indicating whether the operation has succeeded or not. Note that the metadata of the passed record must match the metadata of the lookup table. The operation may not be supported by all types of lookup tables (it is not supported by [guilabel]##Database lookup tables##, for example) and its exact semantics is implementation-specific (in particular, the stored records may not be immediately available for reading in the same phase).", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "put(any)", "canonical_signature": "any put(any record)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No documented default." }, "description": "lookup().put() The put() function stores the record passed as its argument in the selected lookup table.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "put", "basis": "documentation" } ] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of put as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "put", "basis": "documentation" } ] }, "description": "lookup().put() The put() function stores the record passed as its argument in the selected lookup table. It returns a boolean result indicating whether the operation has succeeded or not. Note that the metadata of the passed record must match the metadata of the lookup table. The operation may not be supported by all types of lookup tables (it is not supported by [guilabel]##Database lookup tables##, for example) and its exact semantics is implementation-specific (in particular, the stored records may not be immediately available for reading in the same phase).", "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "put", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [ "The source documents an inline callable form but no formal typed signature.", "NULL behavior for parameter record is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The put(record) function is available since CloverETL 3.4.x.", "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "put", "basis": "documentation" } ] } ], "see_also": [ "get" ], "evidence": [ { "source_id": "ctl2-lookup-table-functions", "section": "put", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [ "No formal typed signature was found; an explicitly partial inline-call record was created." ] } }, "raiseError": { "name": "raiseError", "category": "miscellaneous", "summary": "The raiseError() function throws out an error with the message specified as the argument.", "description": "The raiseError() function throws out an error with the message specified as the argument. The execution of the graph is aborted.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "raiseError(string)", "canonical_signature": "void raiseError(string message)", "type_parameters": [], "parameters": [ { "position": 0, "name": "message", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The raiseError() function throws out an error with the message specified as the argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of raiseError as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "raiseError", "basis": "documentation" } ] }, "description": "The raiseError() function throws out an error with the message specified as the argument. The execution of the graph is aborted.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "raiseError", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter message is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The raiseError(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "raiseError", "basis": "documentation" } ] } ], "see_also": [ "printErr", "printLog" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "raiseError", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "random": { "name": "random", "category": "mathematical", "summary": "The random() function generates random positive double greater than or equal to 0.0 and less than 1.0.", "description": "The random() function generates random positive double greater than or equal to 0.0 and less than 1.0. If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum. If one of the given arguments is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "random()", "canonical_signature": "number random()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of random as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "random", "basis": "documentation" } ] }, "description": "The random() function generates random positive double greater than or equal to 0.0 and less than 1.0. If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum. If one of the given arguments is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "random", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "random(number,number)", "canonical_signature": "number random(number minimum, number maximum)", "type_parameters": [], "parameters": [ { "position": 0, "name": "minimum", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "A supplied minimum or maximum is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "maximum", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "A supplied minimum or maximum is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of random as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "random", "basis": "documentation" } ] }, "description": "The random() function generates random positive double greater than or equal to 0.0 and less than 1.0. If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum. If one of the given arguments is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "random", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "minimum == NULL", "description": "A supplied minimum or maximum is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "maximum == NULL", "description": "A supplied minimum or maximum is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The random() function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "random", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The random(number,number) function is available since CloverETL 6.4.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "random", "basis": "documentation" } ] } ], "see_also": [ "addNoise", "randomBoolean", "randomDate", "randomDecimal", "randomGaussian", "randomInteger", "randomLong", "randomString", "randomUUID", "setRandomSeed" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "random", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "randomBoolean": { "name": "randomBoolean", "category": "mathematical", "summary": "The randomBoolean() function generates true or false boolean values at random.", "description": "The randomBoolean() function generates true or false boolean values at random. If these values are sent to any numeric data type field, they are converted to their numeric representation automatically (1 or 0, respectively).", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "randomBoolean()", "canonical_signature": "boolean randomBoolean()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of randomBoolean as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomBoolean", "basis": "documentation" } ] }, "description": "The randomBoolean() function generates true or false boolean values at random. If these values are sent to any numeric data type field, they are converted to their numeric representation automatically (1 or 0, respectively).", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomBoolean", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The randomBoolean() function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomBoolean", "basis": "documentation" } ] } ], "see_also": [ "addNoise", "random", "randomDate", "randomDecimal", "randomGaussian", "randomInteger", "randomLong", "randomString", "randomUUID", "setRandomSeed" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomBoolean", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "randomDate": { "name": "randomDate", "category": "date", "summary": "The randomDate() function returns a random date between startDate and endDate.", "description": "The randomDate() function returns a random date between startDate and endDate. These resulting dates are generated at random for different records and different fields. They can be different for both records and fields. The return value can also be startDate or endDate. However, it cannot be the date before startDate nor after endDate. If one of the given dates is null, the function fails with an error. If the format is null or the function does not have the format parameter, the default value is used. If the timezone is null or the function does not have the timezone parameter, the default Time Zone is used. If the locale is null or the field is missing, the default Locale is used.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "randomDate(date,date)", "canonical_signature": "date randomDate(date startDate, date endDate)", "type_parameters": [], "parameters": [ { "position": 0, "name": "startDate", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The randomDate() function returns a random date between startDate and endDate.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "endDate", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The randomDate() function returns a random date between startDate and endDate.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of randomDate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "randomDate", "basis": "documentation" } ] }, "description": "The randomDate() function returns a random date between startDate and endDate. These resulting dates are generated at random for different records and different fields. They can be different for both records and fields. The return value can also be startDate or endDate. However, it cannot be the date before startDate nor after endDate. If one of the given dates is null, the function fails with an error. If the format is null or the function does not have the format parameter, the default value is used. If the timezone is null or the function does not have the timezone parameter, the default Time Zone is used. If the locale is null or the field is missing, the default Locale is used.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "randomDate", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "startDate == NULL", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "endDate == NULL", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "randomDate(long,long)", "canonical_signature": "date randomDate(long startDate, long endDate)", "type_parameters": [], "parameters": [ { "position": 0, "name": "startDate", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The randomDate() function returns a random date between startDate and endDate.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "endDate", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The randomDate() function returns a random date between startDate and endDate.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of randomDate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "randomDate", "basis": "documentation" } ] }, "description": "The randomDate() function returns a random date between startDate and endDate. These resulting dates are generated at random for different records and different fields. They can be different for both records and fields. The return value can also be startDate or endDate. However, it cannot be the date before startDate nor after endDate. If one of the given dates is null, the function fails with an error. If the format is null or the function does not have the format parameter, the default value is used. If the timezone is null or the function does not have the timezone parameter, the default Time Zone is used. If the locale is null or the field is missing, the default Locale is used.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "randomDate", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "startDate == NULL", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "endDate == NULL", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "randomDate(string,string,string)", "canonical_signature": "date randomDate(string startDate, string endDate, string format)", "type_parameters": [], "parameters": [ { "position": 0, "name": "startDate", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The randomDate() function returns a random date between startDate and endDate.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "endDate", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The randomDate() function returns a random date between startDate and endDate.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the format is null or the function does not have the format parameter, the default value is used.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "format is NULL -> default date format.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of randomDate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "randomDate", "basis": "documentation" } ] }, "description": "The randomDate() function returns a random date between startDate and endDate. These resulting dates are generated at random for different records and different fields. They can be different for both records and fields. The return value can also be startDate or endDate. However, it cannot be the date before startDate nor after endDate. If one of the given dates is null, the function fails with an error. If the format is null or the function does not have the format parameter, the default value is used. If the timezone is null or the function does not have the timezone parameter, the default Time Zone is used. If the locale is null or the field is missing, the default Locale is used.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "randomDate", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "startDate == NULL", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "endDate == NULL", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "randomDate(string,string,string,string)", "canonical_signature": "date randomDate(string startDate, string endDate, string format, string locale)", "type_parameters": [], "parameters": [ { "position": 0, "name": "startDate", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The randomDate() function returns a random date between startDate and endDate.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "endDate", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The randomDate() function returns a random date between startDate and endDate.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the format is null or the function does not have the format parameter, the default value is used.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "format is NULL -> default date format.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the locale is null or the field is missing, the default Locale is used.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "locale is NULL -> default locale.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 4, "maximum": 4 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of randomDate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "randomDate", "basis": "documentation" } ] }, "description": "The randomDate() function returns a random date between startDate and endDate. These resulting dates are generated at random for different records and different fields. They can be different for both records and fields. The return value can also be startDate or endDate. However, it cannot be the date before startDate nor after endDate. If one of the given dates is null, the function fails with an error. If the format is null or the function does not have the format parameter, the default value is used. If the timezone is null or the function does not have the timezone parameter, the default Time Zone is used. If the locale is null or the field is missing, the default Locale is used.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "randomDate", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "startDate == NULL", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "endDate == NULL", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "randomDate(string,string,string,string,string)", "canonical_signature": "date randomDate(string startDate, string endDate, string format, string locale, string timeZone)", "type_parameters": [], "parameters": [ { "position": 0, "name": "startDate", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The randomDate() function returns a random date between startDate and endDate.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "endDate", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The randomDate() function returns a random date between startDate and endDate.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the format is null or the function does not have the format parameter, the default value is used.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "format is NULL -> default date format.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the locale is null or the field is missing, the default Locale is used.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "locale is NULL -> default locale.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 4, "name": "timeZone", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the timezone is null or the function does not have the timezone parameter, the default Time Zone is used.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "timeZone is NULL -> default time zone.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 5, "maximum": 5 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of randomDate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "randomDate", "basis": "documentation" } ] }, "description": "The randomDate() function returns a random date between startDate and endDate. These resulting dates are generated at random for different records and different fields. They can be different for both records and fields. The return value can also be startDate or endDate. However, it cannot be the date before startDate nor after endDate. If one of the given dates is null, the function fails with an error. If the format is null or the function does not have the format parameter, the default value is used. If the timezone is null or the function does not have the timezone parameter, the default Time Zone is used. If the locale is null or the field is missing, the default Locale is used.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "randomDate", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "startDate == NULL", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "endDate == NULL", "description": "startDate or endDate is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The randomDate(long,long), randomDate(date,date), randomDate(string,string,string,string) and randomDate(string,string,string) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "randomDate", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The function randomDate(string,string,string,string,string) is available since CloverETL 3.5.0-M1.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "randomDate", "basis": "documentation" } ] } ], "see_also": [ "addNoise", "random", "randomBoolean", "randomGaussian", "randomInteger", "randomLong", "randomString", "randomUUID", "setRandomSeed" ], "evidence": [ { "source_id": "ctl2-date-functions", "section": "randomDate", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "randomDecimal": { "name": "randomDecimal", "category": "mathematical", "summary": "The randomDecimal() function generates random positive decimal greater than or equal to 0.0 and less than 1.0.", "description": "The randomDecimal() function generates random positive decimal greater than or equal to 0.0 and less than 1.0. If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum. If one of the given arguments is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "randomDecimal()", "canonical_signature": "decimal randomDecimal()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "description": "Return value of randomDecimal as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomDecimal", "basis": "documentation" } ] }, "description": "The randomDecimal() function generates random positive decimal greater than or equal to 0.0 and less than 1.0. If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum. If one of the given arguments is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomDecimal", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "randomDecimal(decimal,decimal)", "canonical_signature": "decimal randomDecimal(decimal minimum, decimal maximum)", "type_parameters": [], "parameters": [ { "position": 0, "name": "minimum", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "A supplied minimum or maximum is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "maximum", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "A supplied minimum or maximum is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "description": "Return value of randomDecimal as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomDecimal", "basis": "documentation" } ] }, "description": "The randomDecimal() function generates random positive decimal greater than or equal to 0.0 and less than 1.0. If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum. If one of the given arguments is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomDecimal", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "minimum == NULL", "description": "A supplied minimum or maximum is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "maximum == NULL", "description": "A supplied minimum or maximum is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The randomDecimal() and randomDecimal(decimal, decimal) functions are available since", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomDecimal", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "CloverETL 6.4.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomDecimal", "basis": "documentation" } ] } ], "see_also": [ "addNoise", "random", "randomBoolean", "randomDate", "randomGaussian", "randomInteger", "randomLong", "randomString", "randomUUID", "setRandomSeed" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomDecimal", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "randomGaussian": { "name": "randomGaussian", "category": "mathematical", "summary": "The randomGaussian() function generates at random both positive and negative values of number data type in a Gaussian distribution.", "description": "The randomGaussian() function generates at random both positive and negative values of number data type in a Gaussian distribution. The mean value is 0. The standard deviation is 1.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "randomGaussian()", "canonical_signature": "number randomGaussian()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of randomGaussian as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomGaussian", "basis": "documentation" } ] }, "description": "The randomGaussian() function generates at random both positive and negative values of number data type in a Gaussian distribution. The mean value is 0. The standard deviation is 1.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomGaussian", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The randomGausian() function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomGaussian", "basis": "documentation" } ] } ], "see_also": [ "addNoise", "random", "randomBoolean", "randomDate", "randomDecimal", "randomInteger", "randomLong", "randomString", "randomUUID", "setRandomSeed" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomGaussian", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "randomInteger": { "name": "randomInteger", "category": "mathematical", "summary": "The randomInteger() function generates both positive and negative integer values at random.", "description": "The randomInteger() function generates both positive and negative integer values at random. If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum. If one of the given arguments is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "randomInteger()", "canonical_signature": "integer randomInteger()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of randomInteger as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomInteger", "basis": "documentation" } ] }, "description": "The randomInteger() function generates both positive and negative integer values at random. If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum. If one of the given arguments is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomInteger", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "randomInteger(integer,integer)", "canonical_signature": "integer randomInteger(integer minimum, integer maximum)", "type_parameters": [], "parameters": [ { "position": 0, "name": "minimum", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "A supplied minimum or maximum is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "maximum", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "A supplied minimum or maximum is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of randomInteger as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomInteger", "basis": "documentation" } ] }, "description": "The randomInteger() function generates both positive and negative integer values at random. If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum. If one of the given arguments is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomInteger", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "minimum == NULL", "description": "A supplied minimum or maximum is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "maximum == NULL", "description": "A supplied minimum or maximum is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The randomInteger() and randomInteger(integer,integer) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomInteger", "basis": "documentation" } ] } ], "see_also": [ "addNoise", "random", "randomBoolean", "randomDate", "randomDecimal", "randomGaussian", "randomLong", "randomString", "randomUUID", "setRandomSeed" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomInteger", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "randomLong": { "name": "randomLong", "category": "mathematical", "summary": "The randomLong() function generates both positive and negative long values at random.", "description": "The randomLong() function generates both positive and negative long values at random. If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum. If one of the given arguments is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "randomLong()", "canonical_signature": "long randomLong()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of randomLong as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomLong", "basis": "documentation" } ] }, "description": "The randomLong() function generates both positive and negative long values at random. If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum. If one of the given arguments is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomLong", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "randomLong(long,long)", "canonical_signature": "long randomLong(long minimum, long maximum)", "type_parameters": [], "parameters": [ { "position": 0, "name": "minimum", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "A supplied minimum or maximum is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "maximum", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "A supplied minimum or maximum is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of randomLong as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomLong", "basis": "documentation" } ] }, "description": "The randomLong() function generates both positive and negative long values at random. If the range of allowed values is specified, the result value will be greater than or equal to minimum and lower than or equal to maximum. If one of the given arguments is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomLong", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "minimum == NULL", "description": "A supplied minimum or maximum is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "maximum == NULL", "description": "A supplied minimum or maximum is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The randomLong() and randomLong(long,long) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomLong", "basis": "documentation" } ] } ], "see_also": [ "addNoise", "random", "randomBoolean", "randomDate", "randomDecimal", "randomGaussian", "randomInteger", "randomString", "randomUUID", "setRandomSeed" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "randomLong", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "randomString": { "name": "randomString", "category": "string", "summary": "The randomString() function returns a string consisting of lowercase letters.", "description": "The randomString() function returns a string consisting of lowercase letters. Its length is between . Characters in the generated string always belong to ['a'-'z'] (no special symbols). If one of the given arguments is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "randomString(integer,integer)", "canonical_signature": "string randomString(integer minLength, integer maxLength)", "type_parameters": [], "parameters": [ { "position": 0, "name": "minLength", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Its length is between .", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "minLength or maxLength is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "maxLength", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Its length is between .", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "minLength or maxLength is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of randomString as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "randomString", "basis": "documentation" } ] }, "description": "The randomString() function returns a string consisting of lowercase letters. Its length is between . Characters in the generated string always belong to ['a'-'z'] (no special symbols). If one of the given arguments is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "randomString", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "minLength == NULL", "description": "minLength or maxLength is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "maxLength == NULL", "description": "minLength or maxLength is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The randomString(integer,integer) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "randomString", "basis": "documentation" } ] } ], "see_also": [ "addNoise", "random", "randomBoolean", "randomDate", "randomGaussian", "randomInteger", "randomUUID", "setRandomSeed" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "randomString", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "randomUUID": { "name": "randomUUID", "category": "string", "summary": "The function randomUUID() generates a random universally unique identifier (UUID).", "description": "The function randomUUID() generates a random universally unique identifier (UUID). The generated string has this format: hhhhhhhh-hhhh-hhhh-hhhh-hhhhhhhhhhhh where h belongs to [0-9a-f]. In other words, you generate hexadecimal code of a random 128bit number. For more details on the algorithm used, see http://docs.oracle.com/javase/1.5.0/docs/api/java/util/UUID.html[ the Java documentation].", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "randomUUID()", "canonical_signature": "string randomUUID()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of randomUUID as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "randomUUID", "basis": "documentation" } ] }, "description": "The function randomUUID() generates a random universally unique identifier (UUID). The generated string has this format: hhhhhhhh-hhhh-hhhh-hhhh-hhhhhhhhhhhh where h belongs to [0-9a-f]. In other words, you generate hexadecimal code of a random 128bit number. For more details on the algorithm used, see http://docs.oracle.com/javase/1.5.0/docs/api/java/util/UUID.html[ the Java documentation].", "evidence": [ { "source_id": "ctl2-string-functions", "section": "randomUUID", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The randomUUID() function is available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "randomUUID", "basis": "documentation" } ] } ], "see_also": [ "addNoise", "random", "randomBoolean", "randomDate", "randomGaussian", "randomInteger", "randomString", "setRandomSeed" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "randomUUID", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "record2map": { "name": "record2map", "category": "conversion", "summary": "Converts a data record into a map.", "description": "Converts a data record into a map. Field names and values become the keys and values in the map, respectively. This can be used to convert records into JSON as there is no direct record2json function. Returns null if the record is null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "record2map(record)", "canonical_signature": "variant record2map(record record)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Converts a data record into a map.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "record is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "variant", "display": "variant" }, "description": "Return value of record2map as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "record == NULL", "behavior": { "kind": "returns_null", "description": "record is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "record2map", "basis": "documentation" } ] }, "description": "Converts a data record into a map. Field names and values become the keys and values in the map, respectively. This can be used to convert records into JSON as there is no direct record2json function. Returns null if the record is null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "record2map", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The record2map(record) function is available since CloverDX 5.7.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "record2map", "basis": "documentation" } ] } ], "see_also": [ "map2record", "toMap", "variant2record", "writeJson" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "record2map", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "remove": { "name": "remove", "category": "container", "summary": "The function removes: from a list or variant containing a list the element at the positions specified by position and returns the removed element.", "description": "The function removes: from a list or variant containing a list the element at the positions specified by position and returns the removed element. The list specified as the first argument is modified by removing the value at given position (i.e., it will be one element shorter). List elements are indexed starting from 0. from a map or variant containing a map the key-value pair identified by the key and returns the removed value. The map is modified to no longer include given key. === Error states If removeFrom is null, the function fails with an error. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "remove(T[],integer)", "canonical_signature": "T remove(T[] removeFrom, integer position)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "removeFrom", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "=== Error states If removeFrom is null, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "removeFrom is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "position", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The function removes: from a list or variant containing a list the element at the positions specified by position and returns the removed element.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Variant-list position NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "type_variable", "name": "T", "display": "T" }, "description": "Return value of remove as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "remove", "basis": "documentation" } ] }, "description": "The function removes: from a list or variant containing a list the element at the positions specified by position and returns the removed element. The list specified as the first argument is modified by removing the value at given position (i.e., it will be one element shorter). List elements are indexed starting from 0. from a map or variant containing a map the key-value pair identified by the key and returns the removed value. The map is modified to no longer include given key. === Error states If removeFrom is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "remove", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "removeFrom == NULL", "description": "removeFrom is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "position == NULL", "description": "Variant-list position NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "remove(map[K,V],K)", "canonical_signature": "V remove(map[K,V] removeFrom, K key)", "type_parameters": [ { "name": "V", "constraint": { "kind": "any", "display": "any" } }, { "name": "K", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "removeFrom", "type": { "kind": "map", "key": { "kind": "type_variable", "name": "K", "display": "K" }, "value": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "map[K,V]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "=== Error states If removeFrom is null, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "removeFrom is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "key", "type": { "kind": "type_variable", "name": "K", "display": "K" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "from a map or variant containing a map the key-value pair identified by the key and returns the removed value.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Variant-map key NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "type_variable", "name": "V", "display": "V" }, "description": "Return value of remove as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "key == NULL", "behavior": { "kind": "returns_null", "description": "Variant-map key NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "remove", "basis": "documentation" } ] }, "description": "The function removes: from a list or variant containing a list the element at the positions specified by position and returns the removed element. The list specified as the first argument is modified by removing the value at given position (i.e., it will be one element shorter). List elements are indexed starting from 0. from a map or variant containing a map the key-value pair identified by the key and returns the removed value. The map is modified to no longer include given key. === Error states If removeFrom is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "remove", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "removeFrom == NULL", "description": "removeFrom is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "remove(variant,variant)", "canonical_signature": "variant remove(variant removeFrom, variant position)", "type_parameters": [], "parameters": [ { "position": 0, "name": "removeFrom", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "=== Error states If removeFrom is null, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "removeFrom is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "position", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The function removes: from a list or variant containing a list the element at the positions specified by position and returns the removed element.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Variant-list position NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "variant", "display": "variant" }, "description": "Return value of remove as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "remove", "basis": "documentation" } ] }, "description": "The function removes: from a list or variant containing a list the element at the positions specified by position and returns the removed element. The list specified as the first argument is modified by removing the value at given position (i.e., it will be one element shorter). List elements are indexed starting from 0. from a map or variant containing a map the key-value pair identified by the key and returns the removed value. The map is modified to no longer include given key. === Error states If removeFrom is null, the function fails with an error. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "remove", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "removeFrom == NULL", "description": "removeFrom is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "position == NULL", "description": "Variant-list position NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-container-functions", "section": "remove", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "removeBlankSpace": { "name": "removeBlankSpace", "category": "string", "summary": "The removeBlankSpace() function takes one string argument and returns another string with white characters removed.", "description": "The removeBlankSpace() function takes one string argument and returns another string with white characters removed. The function removes chars 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x1C, 0x1D, 0x1E and 0x1F. The function does _not_ remove chars 0x00A0 (hard space), 0x2007 and 0x202F. If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "removeBlankSpace(string)", "canonical_signature": "string removeBlankSpace(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of removeBlankSpace as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "removeBlankSpace", "basis": "documentation" } ] }, "description": "The removeBlankSpace() function takes one string argument and returns another string with white characters removed. The function removes chars 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x1C, 0x1D, 0x1E and 0x1F. The function does _not_ remove chars 0x00A0 (hard space), 0x2007 and 0x202F. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "removeBlankSpace", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The removeBlankSpace() function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "removeBlankSpace", "basis": "documentation" } ] } ], "see_also": [ "isBlank", "removeDiacritic", "removeNonAscii", "removeNonPrintable", "trim" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "removeBlankSpace", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "removeDiacritic": { "name": "removeDiacritic", "category": "string", "summary": "The removeDiacritic() function takes one string argument and returns another string with diacritical marks removed.", "description": "The removeDiacritic() function takes one string argument and returns another string with diacritical marks removed. If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "removeDiacritic(string)", "canonical_signature": "string removeDiacritic(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of removeDiacritic as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "removeDiacritic", "basis": "documentation" } ] }, "description": "The removeDiacritic() function takes one string argument and returns another string with diacritical marks removed. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "removeDiacritic", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The removeDiacritic(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "removeDiacritic", "basis": "documentation" } ] } ], "see_also": [ "isAscii", "removeBlankSpace", "removeNonAscii", "removeNonPrintable" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "removeDiacritic", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "removeNonAscii": { "name": "removeNonAscii", "category": "string", "summary": "The removeNonAscii() function returns string with non-ASCII characters removed.", "description": "The removeNonAscii() function returns string with non-ASCII characters removed. If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "removeNonAscii(string)", "canonical_signature": "string removeNonAscii(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of removeNonAscii as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "removeNonAscii", "basis": "documentation" } ] }, "description": "The removeNonAscii() function returns string with non-ASCII characters removed. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "removeNonAscii", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The removeNonAscii(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "removeNonAscii", "basis": "documentation" } ] } ], "see_also": [ "isAscii", "removeBlankSpace", "removeNonAscii", "removeNonPrintable" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "removeNonAscii", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "removeNonPrintable": { "name": "removeNonPrintable", "category": "string", "summary": "The removeNonPrintable() function takes one string argument and returns another string with non-printable characters removed.", "description": "The removeNonPrintable() function takes one string argument and returns another string with non-printable characters removed. If the input is null, the function returns null. For the list of characters considered as non-printable, see http://www.fileformat.info/info/unicode/category/Cc/list.htm[www.fileformat.info/controlcharacters]. The function is not dependent on character encoding. Note that since CloverETL 3.5, the function does not remove non-ASCII characters anymore. If you need to have them removed, please use the removeNonAscii(string) function in addition.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "removeNonPrintable(string)", "canonical_signature": "string removeNonPrintable(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of removeNonPrintable as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "removeNonPrintable", "basis": "documentation" } ] }, "description": "The removeNonPrintable() function takes one string argument and returns another string with non-printable characters removed. If the input is null, the function returns null. For the list of characters considered as non-printable, see http://www.fileformat.info/info/unicode/category/Cc/list.htm[www.fileformat.info/controlcharacters]. The function is not dependent on character encoding. Note that since CloverETL 3.5, the function does not remove non-ASCII characters anymore. If you need to have them removed, please use the removeNonAscii(string) function in addition.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "removeNonPrintable", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The removeNonPrintable(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "removeNonPrintable", "basis": "documentation" } ] } ], "see_also": [ "isAscii", "removeBlankSpace", "removeDiacritic", "removeNonAscii" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "removeNonPrintable", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "replace": { "name": "replace", "category": "string", "summary": "The replace() function replaces characters from the input string matching the regexp with the specified replacement string.", "description": "The replace() function replaces characters from the input string matching the regexp with the specified replacement string. The function takes three string arguments - a string, a _regular expression_ and a replacement. All parts of the string that match the regex are replaced. The user can also reference the matched text using a backreference in the replacement string. A backreference to the entire match is indicated as $0. If there are capturing parentheses, specifics groups as $1, $2, $3, etc. can be referenced. Important - please beware of similar syntax of $0, $1, etc. While used inside the replacement string, it refers to matching regular expression parenthesis (in order). If used outside a string, it means a reference to an input field. See the examples. A modifier can be used at the start of the regular expression: (?i) for case-insensitive search, (?m) for multiline mode or (?s) for \"dotall\" mode where a dot (\".\") matches even a newline character. If the first argument of the function is null, the function returns null. If the regexp pattern is null, the function fails with an error. If the third argument is null, the function fails with an error, unless the specified regexp does not match the first input.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "replace(string,string,string)", "canonical_signature": "string replace(string arg, string regex, string replacement)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "replacement is NULL -> runtime error, unless regex has no match in arg.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "regex", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "All parts of the string that match the regex are replaced.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "replacement is NULL -> runtime error, unless regex has no match in arg.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "replacement", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The replace() function replaces characters from the input string matching the regexp with the specified replacement string.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "replacement is NULL -> runtime error, unless regex has no match in arg.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of replace as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "replace", "basis": "documentation" } ] }, "description": "The replace() function replaces characters from the input string matching the regexp with the specified replacement string. The function takes three string arguments - a string, a _regular expression_ and a replacement. All parts of the string that match the regex are replaced. The user can also reference the matched text using a backreference in the replacement string. A backreference to the entire match is indicated as $0. If there are capturing parentheses, specifics groups as $1, $2, $3, etc. can be referenced. Important - please beware of similar syntax of $0, $1, etc. While used inside the replacement string, it refers to matching regular expression parenthesis (in order). If used outside a string, it means a reference to an input field. See the examples. A modifier can be used at the start of the regular expression: (?i) for case-insensitive search, (?m) for multiline mode or (?s) for \"dotall\" mode where a dot (\".\") matches even a newline character. If the first argument of the function is null, the function returns null. If the regexp pattern is null, the function fails with an error. If the third argument is null, the function fails with an error, unless the specified regexp does not match the first input.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "replace", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "replacement is NULL -> runtime error, unless regex has no match in arg.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "regex == NULL", "description": "replacement is NULL -> runtime error, unless regex has no match in arg.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "replacement == NULL", "description": "replacement is NULL -> runtime error, unless regex has no match in arg.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The replace(string,string,string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "replace", "basis": "documentation" } ] } ], "see_also": [ "lowerCase", "properCase", "translate", "upperCase" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "replace", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "reset": { "name": "reset", "category": "sequence", "summary": "Sequence method documented as sequence().reset().", "description": "Sequence method documented as sequence().reset().", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "reset()", "canonical_signature": "any reset()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "The source documents this callable form but not a typed CTL signature.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented in a typed signature." }, "evidence": [ { "source_id": "ctl2-sequence-functions", "section": "reset", "basis": "documentation" } ] }, "description": "Documented callable form with no formal typed signature.", "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "evidence": [ { "source_id": "ctl2-sequence-functions", "section": "reset", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [ "The sequence reference documents method-call syntax but no formal typed CTL signature." ] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-sequence-functions", "section": "reset", "basis": "documentation", "detail": "Verbatim sequence method call." } ], "data_quality": { "status": "partial", "issues": [ "The source has no formal function heading or typed signature for this method." ] } }, "resetRecord": { "name": "resetRecord", "category": "record", "summary": "The function resetRecord() resets fields of the record to default values.", "description": "The function resetRecord() resets fields of the record to default values.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "resetRecord(record)", "canonical_signature": "void resetRecord(record record)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function resetRecord() resets fields of the record to default values.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of resetRecord as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "resetRecord", "basis": "documentation" } ] }, "description": "The function resetRecord() resets fields of the record to default values.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "resetRecord", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The resetRecord(record) function is available since CloverETL 3.2.2 or earlier.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "resetRecord", "basis": "documentation" } ] } ], "see_also": [ "length" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "resetRecord", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "resolveParams": { "name": "resolveParams", "category": "miscellaneous", "summary": "The resolveParams() function substitutes all graph parameter references in the text by the values of those parameters.", "description": "The resolveParams() function substitutes all graph parameter references in the text by the values of those parameters. Each occurrence of pattern ${} which is referencing an existing graph parameter is replaced by the parameter's value. Undefined parameter references are left without any change - i.e., they will be resolved as ${}. The function can also resolve environment variables in similar manner - e.g. PATH or JAVA_HOME. Note that parameter names are case sensitive, so ${BATCH_SIZE} is different than ${batch_size}. The second parameter controls whether character escape sequences (like \\n or \\t etc.) should be interpreted in the string as well. If resolveSpecialChars is null, the function fails. Default value is false (escape sequences are not resolved). Parameter and escape sequence resolution in CTL code is automatic when the graph is parsed if the parameter or sequence is \"hard-coded\" and there is no need to call resolveParams. For example, code like printLog(info, \"The input directory is ${DATAIN_DIR}\") will print \"The input directory is ./data-in\" into the graph log. The resolveParams is only needed when the data that includes parameter references is read from a file or computed in the graph.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "resolveParams(string)", "canonical_signature": "string resolveParams(string text)", "type_parameters": [], "parameters": [ { "position": 0, "name": "text", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The resolveParams() function substitutes all graph parameter references in the text by the values of those parameters.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of resolveParams as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "resolveParams", "basis": "documentation" } ] }, "description": "The resolveParams() function substitutes all graph parameter references in the text by the values of those parameters. Each occurrence of pattern ${} which is referencing an existing graph parameter is replaced by the parameter's value. Undefined parameter references are left without any change - i.e., they will be resolved as ${}. The function can also resolve environment variables in similar manner - e.g. PATH or JAVA_HOME. Note that parameter names are case sensitive, so ${BATCH_SIZE} is different than ${batch_size}. The second parameter controls whether character escape sequences (like \\n or \\t etc.) should be interpreted in the string as well. If resolveSpecialChars is null, the function fails. Default value is false (escape sequences are not resolved). Parameter and escape sequence resolution in CTL code is automatic when the graph is parsed if the parameter or sequence is \"hard-coded\" and there is no need to call resolveParams. For example, code like printLog(info, \"The input directory is ${DATAIN_DIR}\") will print \"The input directory is ./data-in\" into the graph log. The resolveParams is only needed when the data that includes parameter references is read from a file or computed in the graph.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "resolveParams", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter text is undocumented." ] } }, { "id": "resolveParams(string,boolean)", "canonical_signature": "string resolveParams(string text, boolean resolveSpecialChars)", "type_parameters": [], "parameters": [ { "position": 0, "name": "text", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The resolveParams() function substitutes all graph parameter references in the text by the values of those parameters.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "resolveSpecialChars", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If resolveSpecialChars is null, the function fails.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of resolveParams as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "resolveParams", "basis": "documentation" } ] }, "description": "The resolveParams() function substitutes all graph parameter references in the text by the values of those parameters. Each occurrence of pattern ${} which is referencing an existing graph parameter is replaced by the parameter's value. Undefined parameter references are left without any change - i.e., they will be resolved as ${}. The function can also resolve environment variables in similar manner - e.g. PATH or JAVA_HOME. Note that parameter names are case sensitive, so ${BATCH_SIZE} is different than ${batch_size}. The second parameter controls whether character escape sequences (like \\n or \\t etc.) should be interpreted in the string as well. If resolveSpecialChars is null, the function fails. Default value is false (escape sequences are not resolved). Parameter and escape sequence resolution in CTL code is automatic when the graph is parsed if the parameter or sequence is \"hard-coded\" and there is no need to call resolveParams. For example, code like printLog(info, \"The input directory is ${DATAIN_DIR}\") will print \"The input directory is ./data-in\" into the graph log. The resolveParams is only needed when the data that includes parameter references is read from a file or computed in the graph.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "resolveParams", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter text is undocumented.", "NULL behavior for parameter resolveSpecialChars is undocumented." ] } } ], "compatibility": [], "see_also": [ "Parameters", "getEnvironmentVariables", "getJavaProperties", "getParamValue", "getParamValues" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "resolveParams", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [ "See-also references outside the v1 core-source scope: Parameters." ] } }, "reverse": { "name": "reverse", "category": "container", "summary": "Reverses the order of elements of given list and returns the modified list (original list is modified).", "description": "Reverses the order of elements of given list and returns the modified list (original list is modified). === Error states If the argument is null, the function fails with an error. The variant version fails if the argument is not a list or if it is null. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "reverse(T[])", "canonical_signature": "T[] reverse(T[] list)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "list", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Reverses the order of elements of given list and returns the modified list (original list is modified).", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "description": "Return value of reverse as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "list == NULL", "behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "reverse", "basis": "documentation" } ] }, "description": "Reverses the order of elements of given list and returns the modified list (original list is modified). === Error states If the argument is null, the function fails with an error. The variant version fails if the argument is not a list or if it is null. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "reverse", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "reverse(string)#2", "canonical_signature": "string reverse(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of reverse as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "reverse", "basis": "documentation" } ] }, "description": "The reverse() function reverses the order of characters of a given string and returns the reverted string. If the given string is null, the function returns null.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "reverse", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "Duplicate normalized overload ID required a stable discriminator." ] } }, { "id": "reverse(string)", "canonical_signature": "string reverse(string value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "value", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented value argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of reverse as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "value == NULL", "behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "reverse", "basis": "documentation" } ] }, "description": "Reverses the order of elements of given list and returns the modified list (original list is modified). === Error states If the argument is null, the function fails with an error. The variant version fails if the argument is not a list or if it is null. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "reverse", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "reverse(variant)", "canonical_signature": "variant reverse(variant list)", "type_parameters": [], "parameters": [ { "position": 0, "name": "list", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] Reverses the order of elements of given list and returns the modified list (original list is modified).", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "variant", "display": "variant" }, "description": "Return value of reverse as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "list == NULL", "behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "reverse", "basis": "documentation" } ] }, "description": "Reverses the order of elements of given list and returns the modified list (original list is modified). === Error states If the argument is null, the function fails with an error. The variant version fails if the argument is not a list or if it is null. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "reverse", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The reverse(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "reverse", "basis": "documentation" } ] } ], "see_also": [ "reverse" ], "evidence": [ { "source_id": "ctl2-container-functions", "section": "reverse", "basis": "documentation" }, { "source_id": "ctl2-string-functions", "section": "reverse", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "right": { "name": "right", "category": "string", "summary": "The right() function returns the substring of the length specified as the second argument counted from the end of the string specified as the first argument.", "description": "The right() function returns the substring of the length specified as the second argument counted from the end of the string specified as the first argument. If the input string is shorter than the [parameter]length parameter, the function returns the original string. If the input is null, the function returns null. If the spacePad argument is set to true, the new string is padded. Whereas if it is false or the function does not have the argument spacePad, the input string is returned as the result with no space added.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "right(string,integer)", "canonical_signature": "string right(string arg, integer length)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "length", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The right() function returns the substring of the length specified as the second argument counted from the end of the string specified as the first argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "length or spacePad is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of right as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "right", "basis": "documentation" } ] }, "description": "The right() function returns the substring of the length specified as the second argument counted from the end of the string specified as the first argument. If the input string is shorter than the [parameter]length parameter, the function returns the original string. If the input is null, the function returns null. If the spacePad argument is set to true, the new string is padded. Whereas if it is false or the function does not have the argument spacePad, the input string is returned as the result with no space added.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "right", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "length == NULL", "description": "length or spacePad is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "right(string,integer,boolean)", "canonical_signature": "string right(string arg, integer length, boolean spacePad)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "length", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The right() function returns the substring of the length specified as the second argument counted from the end of the string specified as the first argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "length or spacePad is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "spacePad", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the spacePad argument is set to true, the new string is padded.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "length or spacePad is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of right as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "right", "basis": "documentation" } ] }, "description": "The right() function returns the substring of the length specified as the second argument counted from the end of the string specified as the first argument. If the input string is shorter than the [parameter]length parameter, the function returns the original string. If the input is null, the function returns null. If the spacePad argument is set to true, the new string is padded. Whereas if it is false or the function does not have the argument spacePad, the input string is returned as the result with no space added.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "right", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "length == NULL", "description": "length or spacePad is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "spacePad == NULL", "description": "length or spacePad is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The right(string,integer) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "right", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The right(string,integer,boolean) function is available since CloverETL 3.1.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "right", "basis": "documentation" } ] } ], "see_also": [ "left", "substring" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "right", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "round": { "name": "round", "category": "mathematical", "summary": "The round() function returns a rounded value using the \"half up\" rounding mode: if both neighbors are equidistant, rounds up.", "description": "The round() function returns a rounded value using the \"half up\" rounding mode: if both neighbors are equidistant, rounds up. Positive precision denotes the number of places after the decimal point and negative precision stands for the number of places before the decimal point. Therefore it only makes sense to use negative precision for integer and long data type arguments, since it signals to round to tens, hundreds, thousands and so on. So round(123, -2) will result in 100 and round(123.123, 2) will result in 123.12. If the parameter precision is missing, the function rounds to nearest integer value. If the given argument is null, the function fails with an error. See also roundHalfToEven(decimal, integer).", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "round(decimal)", "canonical_signature": "decimal round(decimal arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "description": "Return value of round as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "round", "basis": "documentation" } ] }, "description": "The round() function returns a rounded value using the \"half up\" rounding mode: if both neighbors are equidistant, rounds up. Positive precision denotes the number of places after the decimal point and negative precision stands for the number of places before the decimal point. Therefore it only makes sense to use negative precision for integer and long data type arguments, since it signals to round to tens, hundreds, thousands and so on. So round(123, -2) will result in 100 and round(123.123, 2) will result in 123.12. If the parameter precision is missing, the function rounds to nearest integer value. If the given argument is null, the function fails with an error. See also roundHalfToEven(decimal, integer).", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "round", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "round(decimal,integer)", "canonical_signature": "decimal round(decimal arg, integer precision)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "precision", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Positive precision denotes the number of places after the decimal point and negative precision stands for the number of places before the decimal point.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "description": "Return value of round as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "round", "basis": "documentation" } ] }, "description": "The round() function returns a rounded value using the \"half up\" rounding mode: if both neighbors are equidistant, rounds up. Positive precision denotes the number of places after the decimal point and negative precision stands for the number of places before the decimal point. Therefore it only makes sense to use negative precision for integer and long data type arguments, since it signals to round to tens, hundreds, thousands and so on. So round(123, -2) will result in 100 and round(123.123, 2) will result in 123.12. If the parameter precision is missing, the function rounds to nearest integer value. If the given argument is null, the function fails with an error. See also roundHalfToEven(decimal, integer).", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "round", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "precision == NULL", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "round(integer,integer)", "canonical_signature": "integer round(integer arg, integer precision)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "precision", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Positive precision denotes the number of places after the decimal point and negative precision stands for the number of places before the decimal point.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of round as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "round", "basis": "documentation" } ] }, "description": "The round() function returns a rounded value using the \"half up\" rounding mode: if both neighbors are equidistant, rounds up. Positive precision denotes the number of places after the decimal point and negative precision stands for the number of places before the decimal point. Therefore it only makes sense to use negative precision for integer and long data type arguments, since it signals to round to tens, hundreds, thousands and so on. So round(123, -2) will result in 100 and round(123.123, 2) will result in 123.12. If the parameter precision is missing, the function rounds to nearest integer value. If the given argument is null, the function fails with an error. See also roundHalfToEven(decimal, integer).", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "round", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "precision == NULL", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "round(long,integer)", "canonical_signature": "long round(long arg, integer precision)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "precision", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Positive precision denotes the number of places after the decimal point and negative precision stands for the number of places before the decimal point.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of round as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "round", "basis": "documentation" } ] }, "description": "The round() function returns a rounded value using the \"half up\" rounding mode: if both neighbors are equidistant, rounds up. Positive precision denotes the number of places after the decimal point and negative precision stands for the number of places before the decimal point. Therefore it only makes sense to use negative precision for integer and long data type arguments, since it signals to round to tens, hundreds, thousands and so on. So round(123, -2) will result in 100 and round(123.123, 2) will result in 123.12. If the parameter precision is missing, the function rounds to nearest integer value. If the given argument is null, the function fails with an error. See also roundHalfToEven(decimal, integer).", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "round", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "precision == NULL", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "round(number)", "canonical_signature": "long round(number arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of round as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "round", "basis": "documentation" } ] }, "description": "The round() function returns a rounded value using the \"half up\" rounding mode: if both neighbors are equidistant, rounds up. Positive precision denotes the number of places after the decimal point and negative precision stands for the number of places before the decimal point. Therefore it only makes sense to use negative precision for integer and long data type arguments, since it signals to round to tens, hundreds, thousands and so on. So round(123, -2) will result in 100 and round(123.123, 2) will result in 123.12. If the parameter precision is missing, the function rounds to nearest integer value. If the given argument is null, the function fails with an error. See also roundHalfToEven(decimal, integer).", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "round", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "round(number,integer)", "canonical_signature": "number round(number arg, integer precision)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "precision", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Positive precision denotes the number of places after the decimal point and negative precision stands for the number of places before the decimal point.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of round as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "round", "basis": "documentation" } ] }, "description": "The round() function returns a rounded value using the \"half up\" rounding mode: if both neighbors are equidistant, rounds up. Positive precision denotes the number of places after the decimal point and negative precision stands for the number of places before the decimal point. Therefore it only makes sense to use negative precision for integer and long data type arguments, since it signals to round to tens, hundreds, thousands and so on. So round(123, -2) will result in 100 and round(123.123, 2) will result in 123.12. If the parameter precision is missing, the function rounds to nearest integer value. If the given argument is null, the function fails with an error. See also roundHalfToEven(decimal, integer).", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "round", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "precision == NULL", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The round(decimal) and round(number) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "round", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The round(int), round(long), round(int,int) and round(long,int) functions are available since CloverETL 3.5.0-M2.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "round", "basis": "documentation" } ] } ], "see_also": [ "ceil", "floor", "roundHalfToEven" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "round", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "roundHalfToEven": { "name": "roundHalfToEven", "category": "mathematical", "summary": "The roundHalfToEven() function returns decimal value rounded to the closest integer value.", "description": "The roundHalfToEven() function returns decimal value rounded to the closest integer value. Uses the \"half to even\" rounding mode (also called banker's rounding), i.e. if both the neighbors are equidistant, rounds to the nearest even number. If a given argument is null, the function fails with an error. Positive precision denotes the number of places after the decimal point and negative precision stands for the number of places before the decimal point (tens, hundreds, thousands and so on).", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "roundHalfToEven(decimal)", "canonical_signature": "decimal roundHalfToEven(decimal arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "description": "Return value of roundHalfToEven as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "roundHalfToEven", "basis": "documentation" } ] }, "description": "The roundHalfToEven() function returns decimal value rounded to the closest integer value. Uses the \"half to even\" rounding mode (also called banker's rounding), i.e. if both the neighbors are equidistant, rounds to the nearest even number. If a given argument is null, the function fails with an error. Positive precision denotes the number of places after the decimal point and negative precision stands for the number of places before the decimal point (tens, hundreds, thousands and so on).", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "roundHalfToEven", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "roundHalfToEven(decimal,integer)", "canonical_signature": "decimal roundHalfToEven(decimal arg, integer precision)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "precision", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Positive precision denotes the number of places after the decimal point and negative precision stands for the number of places before the decimal point (tens, hundreds, thousands and so on).", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "description": "Return value of roundHalfToEven as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "roundHalfToEven", "basis": "documentation" } ] }, "description": "The roundHalfToEven() function returns decimal value rounded to the closest integer value. Uses the \"half to even\" rounding mode (also called banker's rounding), i.e. if both the neighbors are equidistant, rounds to the nearest even number. If a given argument is null, the function fails with an error. Positive precision denotes the number of places after the decimal point and negative precision stands for the number of places before the decimal point (tens, hundreds, thousands and so on).", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "roundHalfToEven", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "precision == NULL", "description": "arg or precision is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The roundHalfToEven(decimal) and roundHalfToEven(number) functions are available since CloverETL 3.5.0-M2.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "roundHalfToEven", "basis": "documentation" } ] } ], "see_also": [ "ceil", "floor", "round" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "roundHalfToEven", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "rpad": { "name": "rpad", "category": "string", "summary": "The function rpad pads a string from right side to specified length using space or user-defined character.", "description": "The function rpad pads a string from right side to specified length using space or user-defined character. The parameter input contains a string to be padded. If the input is shorter than specified in the parameter length, the input is padded from the right side using filler. The input with sufficient length is returned unmodified. If the parameter input is null, the function returns null. The parameter length defines the minimal length of the result string. If the parameter length is __negative__, the function fails. The optional parameter filler defines the character used for pad. The function rpad(string, integer) uses _space character_ as a filler. If the filler is null, _empty string_ or a string having more than 1 character, the function fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "rpad(string,integer)", "canonical_signature": "string rpad(string input, integer length)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter input contains a string to be padded.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "length", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function rpad pads a string from right side to specified length using space or user-defined character.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "length or filler is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of rpad as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "rpad", "basis": "documentation" } ] }, "description": "The function rpad pads a string from right side to specified length using space or user-defined character. The parameter input contains a string to be padded. If the input is shorter than specified in the parameter length, the input is padded from the right side using filler. The input with sufficient length is returned unmodified. If the parameter input is null, the function returns null. The parameter length defines the minimal length of the result string. If the parameter length is __negative__, the function fails. The optional parameter filler defines the character used for pad. The function rpad(string, integer) uses _space character_ as a filler. If the filler is null, _empty string_ or a string having more than 1 character, the function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "rpad", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "length == NULL", "description": "length or filler is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "rpad(string,integer,string)", "canonical_signature": "string rpad(string input, integer length, string filler)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter input contains a string to be padded.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "length", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The function rpad pads a string from right side to specified length using space or user-defined character.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "length or filler is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "filler", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the input is shorter than specified in the parameter length, the input is padded from the right side using filler.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "length or filler is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of rpad as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "rpad", "basis": "documentation" } ] }, "description": "The function rpad pads a string from right side to specified length using space or user-defined character. The parameter input contains a string to be padded. If the input is shorter than specified in the parameter length, the input is padded from the right side using filler. The input with sufficient length is returned unmodified. If the parameter input is null, the function returns null. The parameter length defines the minimal length of the result string. If the parameter length is __negative__, the function fails. The optional parameter filler defines the character used for pad. The function rpad(string, integer) uses _space character_ as a filler. If the filler is null, _empty string_ or a string having more than 1 character, the function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "rpad", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "length == NULL", "description": "length or filler is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "filler == NULL", "description": "length or filler is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The rpad(string,integer) and rpad(string,integer,string) functions are available since CloverETL 4.0.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "rpad", "basis": "documentation" } ] } ], "see_also": [ "left", "lpad", "right" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "rpad", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "setBoolValue": { "name": "setBoolValue", "category": "record", "summary": "The setBoolValue() function sets a boolean value to a field.", "description": "The setBoolValue() function sets a boolean value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of the record has a different data type and is not a variant data type, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "setBoolValue()", "canonical_signature": "any setBoolValue()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of setBoolValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "setBoolValue", "basis": "documentation" } ] }, "description": "The setBoolValue() function sets a boolean value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of the record has a different data type and is not a variant data type, the function fails with an error.", "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "evidence": [ { "source_id": "ctl2-record-functions", "section": "setBoolValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [ "The source documents an inline callable form but no formal typed signature." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The setBoolValue(record,integer,boolean) and setBoolValue(record,string,boolean) functions are available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setBoolValue", "basis": "documentation" } ] } ], "see_also": [ "getBoolValue", "setByteValue", "setDateValue", "setDecimalValue", "setIntValue", "setLongValue", "setNumValue", "setStringValue" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "setBoolValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [ "No formal typed signature was found; an explicitly partial inline-call record was created." ] } }, "setByteValue": { "name": "setByteValue", "category": "record", "summary": "The setByteValue() function sets a byte value to a field.", "description": "The setByteValue() function sets a byte value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "setByteValue(record,integer,byte)", "canonical_signature": "void setByteValue(record record, integer index, byte value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The field is identified by its index (integer) or name (string).", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "value", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setByteValue() function sets a byte value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setByteValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "setByteValue", "basis": "documentation" } ] }, "description": "The setByteValue() function sets a byte value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setByteValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter index is undocumented.", "NULL behavior for parameter value is undocumented." ] } }, { "id": "setByteValue(record,string,byte)", "canonical_signature": "void setByteValue(record record, string field, byte value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "field", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setByteValue() function sets a byte value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "value", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setByteValue() function sets a byte value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setByteValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "setByteValue", "basis": "documentation" } ] }, "description": "The setByteValue() function sets a byte value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setByteValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter field is undocumented.", "NULL behavior for parameter value is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The setByteValue(record,integer,byte), setByteValue(record,string,byte) functions are available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setByteValue", "basis": "documentation" } ] } ], "see_also": [ "getByteValue", "hex2byte", "setBoolValue", "setDateValue", "setDecimalValue", "setIntValue", "setLongValue", "setNumValue", "setStringValue", "str2byte" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "setByteValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "setDateValue": { "name": "setDateValue", "category": "record", "summary": "The setDateValue() function sets a date value to a field.", "description": "The setDateValue() function sets a date value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "setDateValue()", "canonical_signature": "any setDateValue()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "any", "display": "any" }, "description": "Return value of setDateValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "setDateValue", "basis": "documentation" } ] }, "description": "The setDateValue() function sets a date value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "evidence": [ { "source_id": "ctl2-record-functions", "section": "setDateValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [ "The source documents an inline callable form but no formal typed signature." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The setDateValue(record,integer,date) and setDateValue(record,string,date) functions are available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setDateValue", "basis": "documentation" } ] } ], "see_also": [ "getDateValue", "setBoolValue", "setByteValue", "setDecimalValue", "setIntValue", "setLongValue", "setNumValue", "setStringValue" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "setDateValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [ "No formal typed signature was found; an explicitly partial inline-call record was created." ] } }, "setDecimalValue": { "name": "setDecimalValue", "category": "record", "summary": "The setDecimalValue() function sets a decimal value to a field.", "description": "The setDecimalValue() function sets a decimal value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of a record has a different data type and is not a variant data type, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "setDecimalValue(record,integer,decimal)", "canonical_signature": "void setDecimalValue(record record, integer index, decimal value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The field is identified by its index (integer) or name (string).", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "value", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setDecimalValue() function sets a decimal value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setDecimalValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "setDecimalValue", "basis": "documentation" } ] }, "description": "The setDecimalValue() function sets a decimal value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of a record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setDecimalValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter index is undocumented.", "NULL behavior for parameter value is undocumented." ] } }, { "id": "setDecimalValue(record,string,decimal)", "canonical_signature": "void setDecimalValue(record record, string field, decimal value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "field", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setDecimalValue() function sets a decimal value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "value", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setDecimalValue() function sets a decimal value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setDecimalValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "setDecimalValue", "basis": "documentation" } ] }, "description": "The setDecimalValue() function sets a decimal value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of a record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setDecimalValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter field is undocumented.", "NULL behavior for parameter value is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The setDecimalValue(record,integer,decimal) and setDecimalValue(record,string,decimal) functions are available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setDecimalValue", "basis": "documentation" } ] } ], "see_also": [ "getDecimalValue", "setBoolValue", "setByteValue", "setDateValue", "setIntValue", "setLongValue", "setNumValue", "setStringValue" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "setDecimalValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "setIntValue": { "name": "setIntValue", "category": "record", "summary": "The setIntValue() function sets an integer value to a field.", "description": "The setIntValue() function sets an integer value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of a record has a different data type and is not a variant data type, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "setIntValue(record,integer,integer)", "canonical_signature": "void setIntValue(record record, integer index, integer value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The field is identified by its index (integer) or name (string).", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "value", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setIntValue() function sets an integer value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setIntValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "setIntValue", "basis": "documentation" } ] }, "description": "The setIntValue() function sets an integer value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of a record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setIntValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter index is undocumented.", "NULL behavior for parameter value is undocumented." ] } }, { "id": "setIntValue(record,string,integer)", "canonical_signature": "void setIntValue(record record, string field, integer value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "field", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setIntValue() function sets an integer value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "value", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setIntValue() function sets an integer value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setIntValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "setIntValue", "basis": "documentation" } ] }, "description": "The setIntValue() function sets an integer value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of a record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setIntValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter field is undocumented.", "NULL behavior for parameter value is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The setIntValue(record,integer,integer) and setIntValue(record,string,integer) functions are available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setIntValue", "basis": "documentation" } ] } ], "see_also": [ "getIntValue", "setBoolValue", "setByteValue", "setDateValue", "setDecimalValue", "setLongValue", "setNumValue", "setStringValue" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "setIntValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "setLongValue": { "name": "setLongValue", "category": "record", "summary": "The setLongValue() function sets a long value to a field.", "description": "The setLongValue() function sets a long value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "setLongValue(record,integer,long)", "canonical_signature": "void setLongValue(record record, integer index, long value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The field is identified by its index (integer) or name (string).", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "value", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setLongValue() function sets a long value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setLongValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "setLongValue", "basis": "documentation" } ] }, "description": "The setLongValue() function sets a long value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setLongValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter index is undocumented.", "NULL behavior for parameter value is undocumented." ] } }, { "id": "setLongValue(record,string,long)", "canonical_signature": "void setLongValue(record record, string field, long value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "field", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setLongValue() function sets a long value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "value", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setLongValue() function sets a long value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setLongValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "setLongValue", "basis": "documentation" } ] }, "description": "The setLongValue() function sets a long value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setLongValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter field is undocumented.", "NULL behavior for parameter value is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The setLongValue(record,integer,long) and setLongValue(record,string,long) functions are available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setLongValue", "basis": "documentation" } ] } ], "see_also": [ "getLongValue", "setBoolValue", "setByteValue", "setDateValue", "setDecimalValue", "setIntValue", "setNumValue", "setStringValue" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "setLongValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "setNumValue": { "name": "setNumValue", "category": "record", "summary": "The setNumValue() function sets a number value to a field.", "description": "The setNumValue() function sets a number value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of a record has a different data type and is not a variant data type, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "setNumValue(record,integer,number)", "canonical_signature": "void setNumValue(record record, integer index, number value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The field is identified by its index (integer) or name (string).", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "value", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setNumValue() function sets a number value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setNumValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "setNumValue", "basis": "documentation" } ] }, "description": "The setNumValue() function sets a number value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of a record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setNumValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter index is undocumented.", "NULL behavior for parameter value is undocumented." ] } }, { "id": "setNumValue(record,string,number)", "canonical_signature": "void setNumValue(record record, string field, number value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "field", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setNumValue() function sets a number value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "value", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setNumValue() function sets a number value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setNumValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "setNumValue", "basis": "documentation" } ] }, "description": "The setNumValue() function sets a number value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of a record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setNumValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter field is undocumented.", "NULL behavior for parameter value is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The setNumValue(record,integer,number) and setNumValue(record,string,number) functions are available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setNumValue", "basis": "documentation" } ] } ], "see_also": [ "getNumValue", "setBoolValue", "setByteValue", "setDateValue", "setDecimalValue", "setIntValue", "setLongValue", "setStringValue" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "setNumValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "setRandomSeed": { "name": "setRandomSeed", "category": "mathematical", "summary": "The setRandomSeed() function generates the seed for all functions that generate values at random.", "description": "The setRandomSeed() function generates the seed for all functions that generate values at random. This function should be used in the init() function or method. In such a case, all values generated at random do not change on different runs of the graph, they even remain the same after the graph is reset. If the given argument is null, the function fails with an error. The setRandomSeed() function sets random seed only for the CLT2 code of the component where it is used. It does not set the random seed for CTL2 functions in other components.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "setRandomSeed(long)", "canonical_signature": "void setRandomSeed(long arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setRandomSeed as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "setRandomSeed", "basis": "documentation" } ] }, "description": "The setRandomSeed() function generates the seed for all functions that generate values at random. This function should be used in the init() function or method. In such a case, all values generated at random do not change on different runs of the graph, they even remain the same after the graph is reset. If the given argument is null, the function fails with an error. The setRandomSeed() function sets random seed only for the CLT2 code of the component where it is used. It does not set the random seed for CTL2 functions in other components.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "setRandomSeed", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The setRandomSeed(long) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "setRandomSeed", "basis": "documentation" } ] } ], "see_also": [ "addNoise", "random", "randomBoolean", "randomDate", "randomDecimal", "randomGaussian", "randomInteger", "randomLong", "randomString", "randomUUID", "setRandomSeed" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "setRandomSeed", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "setRequestEncoding": { "name": "setRequestEncoding", "category": "data_service_http", "summary": "The setRequestEncoding() function sets the encoding to be used in POST request parsing.", "description": "The setRequestEncoding() function sets the encoding to be used in POST request parsing. Call this function in init(). The encoding parameter is encoding.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "setRequestEncoding(string)", "canonical_signature": "void setRequestEncoding(string encoding)", "type_parameters": [], "parameters": [ { "position": 0, "name": "encoding", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setRequestEncoding() function sets the encoding to be used in POST request parsing.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setRequestEncoding as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setRequestEncoding", "basis": "documentation" } ] }, "description": "The setRequestEncoding() function sets the encoding to be used in POST request parsing. Call this function in init(). The encoding parameter is encoding.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setRequestEncoding", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter encoding is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function setRequestEncoding(string) is available since CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setRequestEncoding", "basis": "documentation" } ] } ], "see_also": [ "getRequestEncoding" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setRequestEncoding", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "setResponseBody": { "name": "setResponseBody", "category": "data_service_http", "summary": "The setResponseBody() function sets HTTP response body.", "description": "The setResponseBody() function sets HTTP response body. Consider setting the response body encoding explicitly. The body parameter is the content of the body. If you try to create response body with setResponsebody() function and with writing to response:body, the later one will be used. You should use only one way to create the response body.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "setResponseBody(string)", "canonical_signature": "void setResponseBody(string body)", "type_parameters": [], "parameters": [ { "position": 0, "name": "body", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setResponseBody() function sets HTTP response body.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setResponseBody as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseBody", "basis": "documentation" } ] }, "description": "The setResponseBody() function sets HTTP response body. Consider setting the response body encoding explicitly. The body parameter is the content of the body. If you try to create response body with setResponsebody() function and with writing to response:body, the later one will be used. You should use only one way to create the response body.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseBody", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter body is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function setResponseBody(string) is available since CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseBody", "basis": "documentation" } ] } ], "see_also": [ "setResponseEncoding" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseBody", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "setResponseContentType": { "name": "setResponseContentType", "category": "data_service_http", "summary": "The setResponseContentType() function sets the response content type - the value of Content-Type response header field.", "description": "The setResponseContentType() function sets the response content type - the value of Content-Type response header field. The contentType parameter is the value of Content-Type response header field.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "setResponseContentType(string)", "canonical_signature": "void setResponseContentType(string contentType)", "type_parameters": [], "parameters": [ { "position": 0, "name": "contentType", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The contentType parameter is the value of Content-Type response header field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setResponseContentType as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseContentType", "basis": "documentation" } ] }, "description": "The setResponseContentType() function sets the response content type - the value of Content-Type response header field. The contentType parameter is the value of Content-Type response header field.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseContentType", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter contentType is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function setResponseContentType(string) is available since CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseContentType", "basis": "documentation" } ] } ], "see_also": [], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseContentType", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "setResponseEncoding": { "name": "setResponseEncoding", "category": "data_service_http", "summary": "The setResponseEncoding() function sets HTTP response encoding.", "description": "The setResponseEncoding() function sets HTTP response encoding. This encoding is used if you set the response body with the setResponseBody() function. The encoding parameter is the response body encoding.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "setResponseEncoding(string)", "canonical_signature": "void setResponseEncoding(string encoding)", "type_parameters": [], "parameters": [ { "position": 0, "name": "encoding", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setResponseEncoding() function sets HTTP response encoding.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setResponseEncoding as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseEncoding", "basis": "documentation" } ] }, "description": "The setResponseEncoding() function sets HTTP response encoding. This encoding is used if you set the response body with the setResponseBody() function. The encoding parameter is the response body encoding.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseEncoding", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter encoding is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function setResponseEncoding(string) is available since CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseEncoding", "basis": "documentation" } ] } ], "see_also": [ "getResponseEncoding", "setResponseBody" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseEncoding", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "setResponseHeader": { "name": "setResponseHeader", "category": "data_service_http", "summary": "The setResponseHeader() function sets the response header.", "description": "The setResponseHeader() function sets the response header. If the header does not exist, it will be created. The field parameter is HTTP header field name. The value parameter is HTTP header field value.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "setResponseHeader(string,string)", "canonical_signature": "void setResponseHeader(string field, string value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "field", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The field parameter is HTTP header field name.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "value", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The value parameter is HTTP header field value.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setResponseHeader as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseHeader", "basis": "documentation" } ] }, "description": "The setResponseHeader() function sets the response header. If the header does not exist, it will be created. The field parameter is HTTP header field name. The value parameter is HTTP header field value.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseHeader", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter field is undocumented.", "NULL behavior for parameter value is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function setResponseHeader(string,string) is available since CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseHeader", "basis": "documentation" } ] } ], "see_also": [ "addResponseHeader" ], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseHeader", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "setResponseStatus": { "name": "setResponseStatus", "category": "data_service_http", "summary": "The setResponseStatus() function sets the response status code.", "description": "The setResponseStatus() function sets the response status code. The statusCode parameter is the returned status code. The message parameter is a message.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "setResponseStatus(integer)", "canonical_signature": "void setResponseStatus(integer statusCode)", "type_parameters": [], "parameters": [ { "position": 0, "name": "statusCode", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The statusCode parameter is the returned status code.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setResponseStatus as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseStatus", "basis": "documentation" } ] }, "description": "The setResponseStatus() function sets the response status code. The statusCode parameter is the returned status code. The message parameter is a message.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseStatus", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter statusCode is undocumented." ] } }, { "id": "setResponseStatus(integer,string)", "canonical_signature": "void setResponseStatus(integer statusCode, string message)", "type_parameters": [], "parameters": [ { "position": 0, "name": "statusCode", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The statusCode parameter is the returned status code.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "message", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The message parameter is a message.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setResponseStatus as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseStatus", "basis": "documentation" } ] }, "description": "The setResponseStatus() function sets the response status code. The statusCode parameter is the returned status code. The message parameter is a message.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseStatus", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter statusCode is undocumented.", "NULL behavior for parameter message is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The setResponseStatus(string,string) is availables since CloverETL 4.7.0-M1.", "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseStatus", "basis": "documentation" } ] } ], "see_also": [], "evidence": [ { "source_id": "ctl2-data-service-http-library-functions", "section": "setResponseStatus", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "setStringValue": { "name": "setStringValue", "category": "record", "summary": "The setStringValue() function sets a string value to a field.", "description": "The setStringValue() function sets a string value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of a record has a different data type and is not a variant data type, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "setStringValue(record,integer,string)", "canonical_signature": "void setStringValue(record record, integer index, string value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The field is identified by its index (integer) or name (string).", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "value", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setStringValue() function sets a string value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setStringValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "setStringValue", "basis": "documentation" } ] }, "description": "The setStringValue() function sets a string value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of a record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setStringValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter index is undocumented.", "NULL behavior for parameter value is undocumented." ] } }, { "id": "setStringValue(record,string,string)", "canonical_signature": "void setStringValue(record record, string field, string value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If a given record has a null reference, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "field", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setStringValue() function sets a string value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "value", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The setStringValue() function sets a string value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setStringValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "setStringValue", "basis": "documentation" } ] }, "description": "The setStringValue() function sets a string value to a field. The field is identified by its index (integer) or name (string). If a given record has a null reference, the function fails with an error. If the accessed field of a record has a different data type and is not a variant data type, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setStringValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter field is undocumented.", "NULL behavior for parameter value is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The setStringValue(record,integer,string) and setStringValue(record,string,string) functions are available since CloverETL 3.2.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setStringValue", "basis": "documentation" } ] } ], "see_also": [ "getStringValue", "setBoolValue", "setByteValue", "setDateValue", "setDecimalValue", "setIntValue", "setLongValue", "setNumValue" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "setStringValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "setValue": { "name": "setValue", "category": "record", "summary": "Sets a value to a field.", "description": "Sets a value to a field. The field is identified by its zero-based index (integer) or name (string). If the field has an incompatible data type, the function fails with a runtime error. If the given record is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "setValue(record,integer,variant)", "canonical_signature": "void setValue(record record, integer index, variant value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the given record is null, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "index", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The field is identified by its zero-based index (integer) or name (string).", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "value", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Sets a value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "setValue", "basis": "documentation" } ] }, "description": "Sets a value to a field. The field is identified by its zero-based index (integer) or name (string). If the field has an incompatible data type, the function fails with a runtime error. If the given record is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter index is undocumented.", "NULL behavior for parameter value is undocumented." ] } }, { "id": "setValue(record,string,variant)", "canonical_signature": "void setValue(record record, string field, variant value)", "type_parameters": [], "parameters": [ { "position": 0, "name": "record", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the given record is null, the function fails with an error.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "field", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Sets a value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "value", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Sets a value to a field.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of setValue as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-record-functions", "section": "setValue", "basis": "documentation" } ] }, "description": "Sets a value to a field. The field is identified by its zero-based index (integer) or name (string). If the field has an incompatible data type, the function fails with a runtime error. If the given record is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setValue", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter record is undocumented.", "NULL behavior for parameter field is undocumented.", "NULL behavior for parameter value is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function is available since CloverDX 5.7.0.", "evidence": [ { "source_id": "ctl2-record-functions", "section": "setValue", "basis": "documentation" } ] } ], "see_also": [ "getValue", "setBoolValue", "setByteValue", "setDateValue", "setDecimalValue", "setIntValue", "setLongValue", "setNumValue", "setStringValue" ], "evidence": [ { "source_id": "ctl2-record-functions", "section": "setValue", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "sha1": { "name": "sha1", "category": "conversion", "summary": "The sha1() function calculates SHA-1 hash value of a given byte array or for a given string argument.", "description": "The sha1() function calculates SHA-1 hash value of a given byte array or for a given string argument. If the input is null, the function fails with an error. If the input string may contain a non-ASCII character, it is recommended to convert the input string to an array of bytes manually using the function str2byte.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "sha1(byte)", "canonical_signature": "string sha1(byte arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of sha1 as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha1", "basis": "documentation" } ] }, "description": "The sha1() function calculates SHA-1 hash value of a given byte array or for a given string argument. If the input is null, the function fails with an error. If the input string may contain a non-ASCII character, it is recommended to convert the input string to an array of bytes manually using the function str2byte.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha1", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "sha1(string)", "canonical_signature": "string sha1(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of sha1 as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha1", "basis": "documentation" } ] }, "description": "The sha1() function calculates SHA-1 hash value of a given byte array or for a given string argument. If the input is null, the function fails with an error. If the input string may contain a non-ASCII character, it is recommended to convert the input string to an array of bytes manually using the function str2byte.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha1", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The sha(byte) and sha(string) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha1", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "Since CloverETL 6.4.0 their names were changed to sha1(byte) and sha1(string).", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha1", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "Old function names sha(byte) and sha(string) were deprecated.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha1", "basis": "documentation" } ] } ], "see_also": [ "byte2hex", "md5", "sha256", "str2byte" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha1", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "sha1HexString": { "name": "sha1HexString", "category": "conversion", "summary": "The sha1HexString() function calculates SHA-1 hash value of a given byte array or for a given string argument.", "description": "The sha1HexString() function calculates SHA-1 hash value of a given byte array or for a given string argument. Returns hash value in a form of a hexadecimal string. If the input is null, the function returns null. If the input string may contain a non-ASCII character, it is recommended to convert the input string to an array of bytes manually using the function str2byte.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "sha1HexString(byte)", "canonical_signature": "string sha1HexString(byte arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of sha1HexString as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha1HexString", "basis": "documentation" } ] }, "description": "The sha1HexString() function calculates SHA-1 hash value of a given byte array or for a given string argument. Returns hash value in a form of a hexadecimal string. If the input is null, the function returns null. If the input string may contain a non-ASCII character, it is recommended to convert the input string to an array of bytes manually using the function str2byte.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha1HexString", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "sha1HexString(string)", "canonical_signature": "string sha1HexString(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of sha1HexString as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha1HexString", "basis": "documentation" } ] }, "description": "The sha1HexString() function calculates SHA-1 hash value of a given byte array or for a given string argument. Returns hash value in a form of a hexadecimal string. If the input is null, the function returns null. If the input string may contain a non-ASCII character, it is recommended to convert the input string to an array of bytes manually using the function str2byte.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha1HexString", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The sha1HexString(byte) and sha1HexString(string) functions are available since", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha1HexString", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "CloverETL 6.4.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha1HexString", "basis": "documentation" } ] } ], "see_also": [ "byte2hex", "md5HexString", "sha256HexString", "str2byte" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha1HexString", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "sha256": { "name": "sha256", "category": "conversion", "summary": "The sha256() function calculates a SHA-256 hash value of a given array of bytes or of a given string argument.", "description": "The sha256() function calculates a SHA-256 hash value of a given array of bytes or of a given string argument. If the input is null, the function fails with an error. If the input string may contain a non-ASCII character, it is recommended to convert the input string to an array of bytes manually using the function str2byte.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "sha256(byte)", "canonical_signature": "byte sha256(byte arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of sha256 as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha256", "basis": "documentation" } ] }, "description": "The sha256() function calculates a SHA-256 hash value of a given array of bytes or of a given string argument. If the input is null, the function fails with an error. If the input string may contain a non-ASCII character, it is recommended to convert the input string to an array of bytes manually using the function str2byte.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha256", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "sha256(string)", "canonical_signature": "byte sha256(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of sha256 as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha256", "basis": "documentation" } ] }, "description": "The sha256() function calculates a SHA-256 hash value of a given array of bytes or of a given string argument. If the input is null, the function fails with an error. If the input string may contain a non-ASCII character, it is recommended to convert the input string to an array of bytes manually using the function str2byte.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha256", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The sha256(byte) and sha256(string) functions are available since CloverETL 3.4.x.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha256", "basis": "documentation" } ] } ], "see_also": [ "byte2hex", "md5", "sha1", "str2byte" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha256", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "sha256HexString": { "name": "sha256HexString", "category": "conversion", "summary": "The sha256HexString() function calculates a SHA-256 hash value of a given array of bytes or of a given string argument.", "description": "The sha256HexString() function calculates a SHA-256 hash value of a given array of bytes or of a given string argument. It returns hash value in a form of a hexadecimal string. If the input is null, the function returns null. If the input string may contain a non-ASCII character, it is recommended to convert the input string to an array of bytes manually using the function str2byte.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "sha256HexString(byte)", "canonical_signature": "string sha256HexString(byte arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "byte", "display": "byte" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of sha256HexString as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha256HexString", "basis": "documentation" } ] }, "description": "The sha256HexString() function calculates a SHA-256 hash value of a given array of bytes or of a given string argument. It returns hash value in a form of a hexadecimal string. If the input is null, the function returns null. If the input string may contain a non-ASCII character, it is recommended to convert the input string to an array of bytes manually using the function str2byte.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha256HexString", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "sha256HexString(string)", "canonical_signature": "string sha256HexString(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of sha256HexString as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha256HexString", "basis": "documentation" } ] }, "description": "The sha256HexString() function calculates a SHA-256 hash value of a given array of bytes or of a given string argument. It returns hash value in a form of a hexadecimal string. If the input is null, the function returns null. If the input string may contain a non-ASCII character, it is recommended to convert the input string to an array of bytes manually using the function str2byte.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha256HexString", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The sha256HexString(byte) and sha256HexString(string) functions are available since CloverETL 6.4.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha256HexString", "basis": "documentation" } ] } ], "see_also": [ "byte2hex", "md5HexString", "sha1HexString", "str2byte" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "sha256HexString", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "signum": { "name": "signum", "category": "mathematical", "summary": "The signum() function returns signum of the argument.", "description": "The signum() function returns signum of the argument. If the argument is negative, the function returns -1. If the argument is positive, the function returns 1. It the argument is 0, the function returns 0. If the argument is null, the function fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "signum(decimal)", "canonical_signature": "integer signum(decimal arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of signum as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "signum", "basis": "documentation" } ] }, "description": "The signum() function returns signum of the argument. If the argument is negative, the function returns -1. If the argument is positive, the function returns 1. It the argument is 0, the function returns 0. If the argument is null, the function fails.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "signum", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "signum(integer)", "canonical_signature": "integer signum(integer arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of signum as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "signum", "basis": "documentation" } ] }, "description": "The signum() function returns signum of the argument. If the argument is negative, the function returns -1. If the argument is positive, the function returns 1. It the argument is 0, the function returns 0. If the argument is null, the function fails.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "signum", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "signum(long)", "canonical_signature": "long signum(long arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of signum as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "signum", "basis": "documentation" } ] }, "description": "The signum() function returns signum of the argument. If the argument is negative, the function returns -1. If the argument is positive, the function returns 1. It the argument is 0, the function returns 0. If the argument is null, the function fails.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "signum", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "signum(number)", "canonical_signature": "number signum(number arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of signum as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "signum", "basis": "documentation" } ] }, "description": "The signum() function returns signum of the argument. If the argument is negative, the function returns -1. If the argument is positive, the function returns 1. It the argument is 0, the function returns 0. If the argument is null, the function fails.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "signum", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The signum(integer), signum(long), signum(number) and signum(decimal) functions are available since CloverETL 3.5.0-M2.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "signum", "basis": "documentation" } ] } ], "see_also": [], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "signum", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "sin": { "name": "sin", "category": "mathematical", "summary": "The sin() function returns the trigonometric sine of a given angle.", "description": "The sin() function returns the trigonometric sine of a given angle. The angle is in radians. If the given argument is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "sin(decimal)", "canonical_signature": "number sin(decimal angle)", "type_parameters": [], "parameters": [ { "position": 0, "name": "angle", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The sin() function returns the trigonometric sine of a given angle.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of sin as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "sin", "basis": "documentation" } ] }, "description": "The sin() function returns the trigonometric sine of a given angle. The angle is in radians. If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "sin", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "angle == NULL", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "sin(number)", "canonical_signature": "number sin(number angle)", "type_parameters": [], "parameters": [ { "position": 0, "name": "angle", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The sin() function returns the trigonometric sine of a given angle.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of sin as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "sin", "basis": "documentation" } ] }, "description": "The sin() function returns the trigonometric sine of a given angle. The angle is in radians. If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "sin", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "angle == NULL", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The sin(decimal) and sin(number) functions are available since CloverETL 3.5.0-M2.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "sin", "basis": "documentation" } ] } ], "see_also": [ "asin", "cos", "tan", "toRadians" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "sin", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "sleep": { "name": "sleep", "category": "miscellaneous", "summary": "The sleep() function pauses the execution for specified time in milliseconds.", "description": "The sleep() function pauses the execution for specified time in milliseconds.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "sleep(long)", "canonical_signature": "void sleep(long duration)", "type_parameters": [], "parameters": [ { "position": 0, "name": "duration", "type": { "kind": "named", "name": "long", "display": "long" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented duration argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "void", "display": "void" }, "description": "Return value of sleep as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "sleep", "basis": "documentation" } ] }, "description": "The sleep() function pauses the execution for specified time in milliseconds.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "sleep", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter duration is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The sleep(long) function is available since CloverETL 3.1.0.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "sleep", "basis": "documentation" } ] } ], "see_also": [], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "sleep", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "sort": { "name": "sort", "category": "container", "summary": "The sort function sorts the elements of a given list in ascending order according to their values and returns such new value of the list specified as the first argument.", "description": "The sort function sorts the elements of a given list in ascending order according to their values and returns such new value of the list specified as the first argument. Sorting is done in-place - the original list is modified as well. null values are listed at the end of the sorted list, if present. === Error states The function will fail if the input list is null. === Examples", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "sort(T[])", "canonical_signature": "T[] sort(T[] list)", "type_parameters": [ { "name": "T", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "list", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source,ctl,subs=\"+quotes\"] The sort function sorts the elements of a given list in ascending order according to their values and returns such new value of the list specified as the first argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "NULL elements inside a non-NULL list -> sorted to the end of the list.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "list", "element": { "kind": "type_variable", "name": "T", "display": "T" }, "display": "T[]" }, "description": "Return value of sort as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "sort", "basis": "documentation" } ] }, "description": "The sort function sorts the elements of a given list in ascending order according to their values and returns such new value of the list specified as the first argument. Sorting is done in-place - the original list is modified as well. null values are listed at the end of the sorted list, if present. === Error states The function will fail if the input list is null. === Examples", "evidence": [ { "source_id": "ctl2-container-functions", "section": "sort", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter list is undocumented." ] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-container-functions", "section": "sort", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "soundex": { "name": "soundex", "category": "string", "summary": "The soundex() function takes one string argument and converts the string to another.", "description": "The soundex() function takes one string argument and converts the string to another. The resulting string consists of the first letter of the string specified as the argument and three digits. The three digits are based on the consonants contained in the string when similar numbers correspond to similarly sounding consonants. If the input of the function is null, the function returns null. If the input is an empty string, the function returns an empty string.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "soundex(string)", "canonical_signature": "string soundex(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of soundex as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "soundex", "basis": "documentation" } ] }, "description": "The soundex() function takes one string argument and converts the string to another. The resulting string consists of the first letter of the string specified as the argument and three digits. The three digits are based on the consonants contained in the string when similar numbers correspond to similarly sounding consonants. If the input of the function is null, the function returns null. If the input is an empty string, the function returns an empty string.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "soundex", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The soundex(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "soundex", "basis": "documentation" } ] } ], "see_also": [ "NYSIIS", "editDistance", "metaphone" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "soundex", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "split": { "name": "split", "category": "string", "summary": "The split() function splits a string from the first argument, based on a _regular expression_ given as the second argument.", "description": "The split() function splits a string from the first argument, based on a _regular expression_ given as the second argument. The function searches in the first argument for substrings matching the regexp. If any substring matching the regexp exists, it is used as a delimiter and the arg is split up using the delimiter. The resulting parts of the string are returned as a list of strings. If the regular pattern does not match any character in the string arg, a list containing one item (the string arg) is returned. The function split() removes terminating empty list items from the result. See the function split(\"cuckoo\",\"o\") in examples. If the input parameter arg is an empty string, the function returns a list with one empty string. If the input arg is null, the function returns an empty list. If the regexp argument is null, the function fails with an error. The limit parameter limits the number of items in the list to be returned. If the limit is __positive__, at most the specified number of items will be returned. The unsplit residue of input string is the last item of the list. If the limit is __zero__, the limit is not applied and the function works as without the limit parameter: The trailing empty list items are trimmed. If the limit parameter is __negative__, the limit is not applied and trailing empty fields are not trimmed. If the function is called without the limit parameter, it works in the same way as with limit set to 0.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "split(string,string)", "canonical_signature": "string[] split(string arg, string regex)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If any substring matching the regexp exists, it is used as a delimiter and the arg is split up using the delimiter.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "Compatibility: arg NULL returned a one-element list containing NULL in CloverETL 3.5.x and earlier.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "regex", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented regex argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "regexp is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "list", "element": { "kind": "named", "name": "string", "display": "string" }, "display": "string[]" }, "description": "Return value of split as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "split", "basis": "documentation" } ] }, "description": "The split() function splits a string from the first argument, based on a _regular expression_ given as the second argument. The function searches in the first argument for substrings matching the regexp. If any substring matching the regexp exists, it is used as a delimiter and the arg is split up using the delimiter. The resulting parts of the string are returned as a list of strings. If the regular pattern does not match any character in the string arg, a list containing one item (the string arg) is returned. The function split() removes terminating empty list items from the result. See the function split(\"cuckoo\",\"o\") in examples. If the input parameter arg is an empty string, the function returns a list with one empty string. If the input arg is null, the function returns an empty list. If the regexp argument is null, the function fails with an error. The limit parameter limits the number of items in the list to be returned. If the limit is __positive__, at most the specified number of items will be returned. The unsplit residue of input string is the last item of the list. If the limit is __zero__, the limit is not applied and the function works as without the limit parameter: The trailing empty list items are trimmed. If the limit parameter is __negative__, the limit is not applied and trailing empty fields are not trimmed. If the function is called without the limit parameter, it works in the same way as with limit set to 0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "split", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "regex == NULL", "description": "regexp is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg is undocumented." ] } }, { "id": "split(string,string,integer)", "canonical_signature": "string[] split(string arg, string regex, integer limit)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If any substring matching the regexp exists, it is used as a delimiter and the arg is split up using the delimiter.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "Compatibility: arg NULL returned a one-element list containing NULL in CloverETL 3.5.x and earlier.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "regex", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented regex argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "regexp is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "limit", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The limit parameter limits the number of items in the list to be returned.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "limit is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "list", "element": { "kind": "named", "name": "string", "display": "string" }, "display": "string[]" }, "description": "Return value of split as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "split", "basis": "documentation" } ] }, "description": "The split() function splits a string from the first argument, based on a _regular expression_ given as the second argument. The function searches in the first argument for substrings matching the regexp. If any substring matching the regexp exists, it is used as a delimiter and the arg is split up using the delimiter. The resulting parts of the string are returned as a list of strings. If the regular pattern does not match any character in the string arg, a list containing one item (the string arg) is returned. The function split() removes terminating empty list items from the result. See the function split(\"cuckoo\",\"o\") in examples. If the input parameter arg is an empty string, the function returns a list with one empty string. If the input arg is null, the function returns an empty list. If the regexp argument is null, the function fails with an error. The limit parameter limits the number of items in the list to be returned. If the limit is __positive__, at most the specified number of items will be returned. The unsplit residue of input string is the last item of the list. If the limit is __zero__, the limit is not applied and the function works as without the limit parameter: The trailing empty list items are trimmed. If the limit parameter is __negative__, the limit is not applied and trailing empty fields are not trimmed. If the function is called without the limit parameter, it works in the same way as with limit set to 0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "split", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "regex == NULL", "description": "regexp is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "limit == NULL", "description": "limit is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter arg is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The split(string,string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "split", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "If the input (arg) of the function is null, the function returns a list with one null string in CloverETL 3.5.x and earlier.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "split", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The split(string,string,integer) is available since CloverETL 4.0.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "split", "basis": "documentation" } ] } ], "see_also": [ "concat", "concatWithSeparator", "join", "matchGroups", "substring" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "split", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "sqrt": { "name": "sqrt", "category": "mathematical", "summary": "The sqrt() function returns the square root of a given argument.", "description": "The sqrt() function returns the square root of a given argument. The argument can be of any numeric data type; if the argument is integer or long, the argument will be converted to the number (double). If a given argument is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "sqrt(decimal)", "canonical_signature": "number sqrt(decimal arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of sqrt as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "sqrt", "basis": "documentation" } ] }, "description": "The sqrt() function returns the square root of a given argument. The argument can be of any numeric data type; if the argument is integer or long, the argument will be converted to the number (double). If a given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "sqrt", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "sqrt(number)", "canonical_signature": "number sqrt(number arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of sqrt as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "sqrt", "basis": "documentation" } ] }, "description": "The sqrt() function returns the square root of a given argument. The argument can be of any numeric data type; if the argument is integer or long, the argument will be converted to the number (double). If a given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "sqrt", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The sqrt(decimal) and sqrt(number) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "sqrt", "basis": "documentation" } ] } ], "see_also": [ "log", "log10", "pow" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "sqrt", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "startsWith": { "name": "startsWith", "category": "string", "summary": "The startsWith() function returns true if the parameter str starts with string sub.", "description": "The startsWith() function returns true if the parameter str starts with string sub. If the parameter str is null, the function returns false. If the parameter sub is null, the function fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "startsWith(string,string)", "canonical_signature": "boolean startsWith(string str, string sub)", "type_parameters": [], "parameters": [ { "position": 0, "name": "str", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The startsWith() function returns true if the parameter str starts with string sub.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "str is NULL -> false.", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "sub", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The startsWith() function returns true if the parameter str starts with string sub.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "sub is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of startsWith as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "startsWith", "basis": "documentation" } ] }, "description": "The startsWith() function returns true if the parameter str starts with string sub. If the parameter str is null, the function returns false. If the parameter sub is null, the function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "startsWith", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "sub == NULL", "description": "sub is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The startsWith(string) function is available since CloverETL 4.0.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "startsWith", "basis": "documentation" } ] } ], "see_also": [ "contains", "endsWith" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "startsWith", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "str2bits": { "name": "str2bits", "category": "conversion", "summary": "The str2bits() function converts a given string argument to an array of bytes.", "description": "The str2bits() function converts a given string argument to an array of bytes. The string can contain only characters: \"1\" and \"0\". Each character \"1\" of a string is converted to the bit 1, each character \"0\" is converted to the bit 0. If the number of characters in the string is not an integral multiple of eight, the string is completed by \"0\" characters from the right. Then, the string is converted to an array of bytes as if the number of its characters were integral multiple of eight. The first character represents the lowest bit. If the input is null, the function returns null. If the input contains any other character, the function str2bits()fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "str2bits(string)", "canonical_signature": "byte str2bits(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of str2bits as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2bits", "basis": "documentation" } ] }, "description": "The str2bits() function converts a given string argument to an array of bytes. The string can contain only characters: \"1\" and \"0\". Each character \"1\" of a string is converted to the bit 1, each character \"0\" is converted to the bit 0. If the number of characters in the string is not an integral multiple of eight, the string is completed by \"0\" characters from the right. Then, the string is converted to an array of bytes as if the number of its characters were integral multiple of eight. The first character represents the lowest bit. If the input is null, the function returns null. If the input contains any other character, the function str2bits()fails.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2bits", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The str2bits(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2bits", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The functionality of str2bits() has been changed in CloverETL 3.5.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2bits", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "In the earlier versions, all characters not being 1 have been considered as 0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2bits", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The function call str2bits(\"A010011001100110\") is correct in CloverETL 3.4, but the same function call _fails with an error_ in CloverETL 3.5.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2bits", "basis": "documentation" } ] } ], "see_also": [ "bits2str" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2bits", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "str2bool": { "name": "str2bool", "category": "conversion", "summary": "The str2bool() function converts a given string argument to the corresponding boolean value.", "description": "The str2bool() function converts a given string argument to the corresponding boolean value. The string can be one of the following: \"TRUE\", \"true\", \"T\", \"t\", \"YES\", \"yes\", \"Y\", \"y\", \"1\", \"FALSE\", \"false\", \"F\", \"f\", \"NO\", \"no\", \"N\", \"n\", \"0\". The strings are converted to boolean true or boolean false. If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "str2bool(string)", "canonical_signature": "boolean str2bool(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "description": "Return value of str2bool as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2bool", "basis": "documentation" } ] }, "description": "The str2bool() function converts a given string argument to the corresponding boolean value. The string can be one of the following: \"TRUE\", \"true\", \"T\", \"t\", \"YES\", \"yes\", \"Y\", \"y\", \"1\", \"FALSE\", \"false\", \"F\", \"f\", \"NO\", \"no\", \"N\", \"n\", \"0\". The strings are converted to boolean true or boolean false. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2bool", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The str2bool(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2bool", "basis": "documentation" } ] } ], "see_also": [ "str2bits", "str2bool", "str2date", "str2decimal", "str2double", "str2integer", "str2long" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2bool", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "str2byte": { "name": "str2byte", "category": "conversion", "summary": "The str2byte() function converts a string payload to an array of bytes using a given charset encoder.", "description": "The str2byte() function converts a string payload to an array of bytes using a given charset encoder. If the charset is null, the function fails with an error. If the payload is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "str2byte(string,string)", "canonical_signature": "byte str2byte(string payload, string charset)", "type_parameters": [], "parameters": [ { "position": 0, "name": "payload", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2byte() function converts a string payload to an array of bytes using a given charset encoder.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "payload is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "charset", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2byte() function converts a string payload to an array of bytes using a given charset encoder.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "charset is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of str2byte as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "payload == NULL", "behavior": { "kind": "returns_null", "description": "payload is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2byte", "basis": "documentation" } ] }, "description": "The str2byte() function converts a string payload to an array of bytes using a given charset encoder. If the charset is null, the function fails with an error. If the payload is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2byte", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "charset == NULL", "description": "charset is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The str2byte(string,string) function is available since CloverETL 3.2.x.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2byte", "basis": "documentation" } ] } ], "see_also": [ "byte2str", "hex2byte" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2byte", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "str2date": { "name": "str2date", "category": "conversion", "summary": "The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "description": "The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone. The input must correspond with the pattern. Otherwise the function fails. If the input is null, the function returns null. If the pattern is null or an empty string, the default date format is used. If the locale is null or an empty string, the respective default value is used instead. If the timeZone is null or an empty string, the respective default value is used instead. If strict is true, date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of an input string and result string. If the input string and result string differ, the function fails. This way you can enforce required number of digits in date. If strict is null or the function does not have the argument strict, it works in the same way as if it was set to false - the format is not checked in the strict way.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "str2date(string,string)", "canonical_signature": "date str2date(string input, string pattern)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "pattern", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "pattern is NULL -> default date format.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of str2date as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2date", "basis": "documentation" } ] }, "description": "The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone. The input must correspond with the pattern. Otherwise the function fails. If the input is null, the function returns null. If the pattern is null or an empty string, the default date format is used. If the locale is null or an empty string, the respective default value is used instead. If the timeZone is null or an empty string, the respective default value is used instead. If strict is true, date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of an input string and result string. If the input string and result string differ, the function fails. This way you can enforce required number of digits in date. If strict is null or the function does not have the argument strict, it works in the same way as if it was set to false - the format is not checked in the strict way.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2date", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "str2date(string,string,boolean)", "canonical_signature": "date str2date(string input, string pattern, boolean strict)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "pattern", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "pattern is NULL -> default date format.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "strict", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If strict is true, date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of an input string and result string.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "strict is NULL -> treated as false (non-strict parsing).", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of str2date as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2date", "basis": "documentation" } ] }, "description": "The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone. The input must correspond with the pattern. Otherwise the function fails. If the input is null, the function returns null. If the pattern is null or an empty string, the default date format is used. If the locale is null or an empty string, the respective default value is used instead. If the timeZone is null or an empty string, the respective default value is used instead. If strict is true, date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of an input string and result string. If the input string and result string differ, the function fails. This way you can enforce required number of digits in date. If strict is null or the function does not have the argument strict, it works in the same way as if it was set to false - the format is not checked in the strict way.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2date", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "str2date(string,string,string)", "canonical_signature": "date str2date(string input, string pattern, string locale)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "pattern", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "pattern is NULL -> default date format.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "locale is NULL -> default locale.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of str2date as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2date", "basis": "documentation" } ] }, "description": "The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone. The input must correspond with the pattern. Otherwise the function fails. If the input is null, the function returns null. If the pattern is null or an empty string, the default date format is used. If the locale is null or an empty string, the respective default value is used instead. If the timeZone is null or an empty string, the respective default value is used instead. If strict is true, date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of an input string and result string. If the input string and result string differ, the function fails. This way you can enforce required number of digits in date. If strict is null or the function does not have the argument strict, it works in the same way as if it was set to false - the format is not checked in the strict way.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2date", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "str2date(string,string,string,boolean)", "canonical_signature": "date str2date(string input, string pattern, string locale, boolean strict)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "pattern", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "pattern is NULL -> default date format.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "locale is NULL -> default locale.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "strict", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If strict is true, date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of an input string and result string.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "strict is NULL -> treated as false (non-strict parsing).", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 4, "maximum": 4 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of str2date as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2date", "basis": "documentation" } ] }, "description": "The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone. The input must correspond with the pattern. Otherwise the function fails. If the input is null, the function returns null. If the pattern is null or an empty string, the default date format is used. If the locale is null or an empty string, the respective default value is used instead. If the timeZone is null or an empty string, the respective default value is used instead. If strict is true, date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of an input string and result string. If the input string and result string differ, the function fails. This way you can enforce required number of digits in date. If strict is null or the function does not have the argument strict, it works in the same way as if it was set to false - the format is not checked in the strict way.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2date", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "str2date(string,string,string,string)", "canonical_signature": "date str2date(string input, string pattern, string locale, string timeZone)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "pattern", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "pattern is NULL -> default date format.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "locale is NULL -> default locale.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "timeZone", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "timeZone is NULL -> default time zone.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 4, "maximum": 4 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of str2date as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2date", "basis": "documentation" } ] }, "description": "The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone. The input must correspond with the pattern. Otherwise the function fails. If the input is null, the function returns null. If the pattern is null or an empty string, the default date format is used. If the locale is null or an empty string, the respective default value is used instead. If the timeZone is null or an empty string, the respective default value is used instead. If strict is true, date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of an input string and result string. If the input string and result string differ, the function fails. This way you can enforce required number of digits in date. If strict is null or the function does not have the argument strict, it works in the same way as if it was set to false - the format is not checked in the strict way.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2date", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "str2date(string,string,string,string,boolean)", "canonical_signature": "date str2date(string input, string pattern, string locale, string timeZone, boolean strict)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "pattern", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "pattern is NULL -> default date format.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "locale is NULL -> default locale.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "timeZone", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone.", "constraints": [], "null_behavior": { "kind": "uses_default", "description": "timeZone is NULL -> default time zone.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 4, "name": "strict", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If strict is true, date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of an input string and result string.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "strict is NULL -> treated as false (non-strict parsing).", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 5, "maximum": 5 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of str2date as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2date", "basis": "documentation" } ] }, "description": "The str2date() function converts the input to the date data type using the specified pattern, locale and timeZone. The input must correspond with the pattern. Otherwise the function fails. If the input is null, the function returns null. If the pattern is null or an empty string, the default date format is used. If the locale is null or an empty string, the respective default value is used instead. If the timeZone is null or an empty string, the respective default value is used instead. If strict is true, date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of an input string and result string. If the input string and result string differ, the function fails. This way you can enforce required number of digits in date. If strict is null or the function does not have the argument strict, it works in the same way as if it was set to false - the format is not checked in the strict way.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2date", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The str2date(string,string) and str2date(string,string,string) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2date", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The str2date(string, string, boolean), str2date(string, string, string, boolean) and str2date(string, string, string, string, boolean) functions are available since CloverETL 4.1.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2date", "basis": "documentation" } ] } ], "see_also": [ "date2str", "isDate" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2date", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "str2decimal": { "name": "str2decimal", "category": "conversion", "summary": "The str2decimal() function converts a given string argument to a decimal value.", "description": "The str2decimal() function converts a given string argument to a decimal value. The conversion can be determined by the format specified as the second argument and the locale specified as the third argument. The arg is a numeric value to be converted to the decimal. If the argument is null, the function returns null. The format determines the data conversion. If a locale is specified, you can use null or an empty string for the format pattern to apply the default number format of that locale. See Numeric format. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "str2decimal(string)", "canonical_signature": "decimal str2decimal(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The arg is a numeric value to be converted to the decimal.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "description": "Return value of str2decimal as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2decimal", "basis": "documentation" } ] }, "description": "The str2decimal() function converts a given string argument to a decimal value. The conversion can be determined by the format specified as the second argument and the locale specified as the third argument. The arg is a numeric value to be converted to the decimal. If the argument is null, the function returns null. The format determines the data conversion. If a locale is specified, you can use null or an empty string for the format pattern to apply the default number format of that locale. See Numeric format. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2decimal", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "str2decimal(string,string)", "canonical_signature": "decimal str2decimal(string arg, string format)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The arg is a numeric value to be converted to the decimal.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The conversion can be determined by the format specified as the second argument and the locale specified as the third argument.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "format is NULL when locale is supplied -> default number format for that locale.", "cases": [ { "condition": "format is NULL when locale is supplied", "behavior": { "kind": "uses_default", "description": "format is NULL when locale is supplied -> default number format for that locale." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "description": "Return value of str2decimal as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2decimal", "basis": "documentation" } ] }, "description": "The str2decimal() function converts a given string argument to a decimal value. The conversion can be determined by the format specified as the second argument and the locale specified as the third argument. The arg is a numeric value to be converted to the decimal. If the argument is null, the function returns null. The format determines the data conversion. If a locale is specified, you can use null or an empty string for the format pattern to apply the default number format of that locale. See Numeric format. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2decimal", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "str2decimal(string,string,string)", "canonical_signature": "decimal str2decimal(string arg, string format, string locale)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The arg is a numeric value to be converted to the decimal.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The conversion can be determined by the format specified as the second argument and the locale specified as the third argument.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "format is NULL when locale is supplied -> default number format for that locale.", "cases": [ { "condition": "format is NULL when locale is supplied", "behavior": { "kind": "uses_default", "description": "format is NULL when locale is supplied -> default number format for that locale." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The conversion can be determined by the format specified as the second argument and the locale specified as the third argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "locale is NULL -> a normal numeric result (probes: 123.45 or 123, depending on the conversion).", "result": { "kind": "literal", "type": "number", "value": 123.45, "display": "123.45" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "description": "Return value of str2decimal as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2decimal", "basis": "documentation" } ] }, "description": "The str2decimal() function converts a given string argument to a decimal value. The conversion can be determined by the format specified as the second argument and the locale specified as the third argument. The arg is a numeric value to be converted to the decimal. If the argument is null, the function returns null. The format determines the data conversion. If a locale is specified, you can use null or an empty string for the format pattern to apply the default number format of that locale. See Numeric format. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2decimal", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The str2decimal(string), str2decimal(string,string) and str2decimal(string,string,string) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2decimal", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "Since CloverDX 6.4.0 the whole string argument must be successfully parsed according to the format. If any part of the argument does not match format, the function fails.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2decimal", "basis": "documentation" } ] } ], "see_also": [ "str2double", "str2integer", "str2long", "toString" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2decimal", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "str2double": { "name": "str2double", "category": "conversion", "summary": "The str2double() function converts a given string argument to the corresponding double value.", "description": "The str2double() function converts a given string argument to the corresponding double value. The conversion can be determined by a format specified as the second argument and a locale specified as the third argument. The arg is string to be converted to double. If the argument is null, the function returns null. The format is described in Data formats. If a locale is specified, you can use null or an empty string for the format pattern to apply the default number format of that locale. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "str2double(string)", "canonical_signature": "number str2double(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The arg is string to be converted to double.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of str2double as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2double", "basis": "documentation" } ] }, "description": "The str2double() function converts a given string argument to the corresponding double value. The conversion can be determined by a format specified as the second argument and a locale specified as the third argument. The arg is string to be converted to double. If the argument is null, the function returns null. The format is described in Data formats. If a locale is specified, you can use null or an empty string for the format pattern to apply the default number format of that locale. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2double", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "str2double(string,string)", "canonical_signature": "number str2double(string arg, string format)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The arg is string to be converted to double.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The conversion can be determined by a format specified as the second argument and a locale specified as the third argument.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "format is NULL when locale is supplied -> default number format for that locale.", "cases": [ { "condition": "format is NULL when locale is supplied", "behavior": { "kind": "uses_default", "description": "format is NULL when locale is supplied -> default number format for that locale." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of str2double as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2double", "basis": "documentation" } ] }, "description": "The str2double() function converts a given string argument to the corresponding double value. The conversion can be determined by a format specified as the second argument and a locale specified as the third argument. The arg is string to be converted to double. If the argument is null, the function returns null. The format is described in Data formats. If a locale is specified, you can use null or an empty string for the format pattern to apply the default number format of that locale. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2double", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "str2double(string,string,string)", "canonical_signature": "number str2double(string arg, string format, string locale)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The arg is string to be converted to double.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The conversion can be determined by a format specified as the second argument and a locale specified as the third argument.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "format is NULL when locale is supplied -> default number format for that locale.", "cases": [ { "condition": "format is NULL when locale is supplied", "behavior": { "kind": "uses_default", "description": "format is NULL when locale is supplied -> default number format for that locale." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The conversion can be determined by a format specified as the second argument and a locale specified as the third argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "locale is NULL -> a normal numeric result (probes: 123.45 or 123, depending on the conversion).", "result": { "kind": "literal", "type": "number", "value": 123.45, "display": "123.45" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of str2double as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2double", "basis": "documentation" } ] }, "description": "The str2double() function converts a given string argument to the corresponding double value. The conversion can be determined by a format specified as the second argument and a locale specified as the third argument. The arg is string to be converted to double. If the argument is null, the function returns null. The format is described in Data formats. If a locale is specified, you can use null or an empty string for the format pattern to apply the default number format of that locale. The locale parameter is described in Locale. If the function is called without the locale parameter, the default locale is used.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2double", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The str2double(string), str2double(string,string) and str2double(string,string,string) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2double", "basis": "documentation" } ] } ], "see_also": [ "num2str", "toString" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2double", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "str2integer": { "name": "str2integer", "category": "conversion", "summary": "The str2integer() function converts a given string argument to the corresponding integer value.", "description": "The str2integer() function converts a given string argument to the corresponding integer value. The conversion can be determined by a numeral system, format or locale. The parameter arg is a numeric value to be converted to integer. If the argument is null, the function returns null. The parameter radix enables to convert a given string argument to integer using specified radix based numeric system representation. The format is described in Numeric format. If a locale is specified, you can use null or an empty string for the format pattern to apply the default number format of that locale. The locale is described in Locale.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "str2integer(string)", "canonical_signature": "integer str2integer(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter arg is a numeric value to be converted to integer.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of str2integer as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2integer", "basis": "documentation" } ] }, "description": "The str2integer() function converts a given string argument to the corresponding integer value. The conversion can be determined by a numeral system, format or locale. The parameter arg is a numeric value to be converted to integer. If the argument is null, the function returns null. The parameter radix enables to convert a given string argument to integer using specified radix based numeric system representation. The format is described in Numeric format. If a locale is specified, you can use null or an empty string for the format pattern to apply the default number format of that locale. The locale is described in Locale.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2integer", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "str2integer(string,integer)", "canonical_signature": "integer str2integer(string arg, integer radix)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter arg is a numeric value to be converted to integer.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "radix", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter radix enables to convert a given string argument to integer using specified radix based numeric system representation.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "radix is NULL for str2integer or str2long -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of str2integer as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2integer", "basis": "documentation" } ] }, "description": "The str2integer() function converts a given string argument to the corresponding integer value. The conversion can be determined by a numeral system, format or locale. The parameter arg is a numeric value to be converted to integer. If the argument is null, the function returns null. The parameter radix enables to convert a given string argument to integer using specified radix based numeric system representation. The format is described in Numeric format. If a locale is specified, you can use null or an empty string for the format pattern to apply the default number format of that locale. The locale is described in Locale.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2integer", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "radix == NULL", "description": "radix is NULL for str2integer or str2long -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "str2integer(string,string)", "canonical_signature": "integer str2integer(string arg, string format)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter arg is a numeric value to be converted to integer.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The conversion can be determined by a numeral system, format or locale.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "format is NULL when locale is supplied -> default number format for that locale.", "cases": [ { "condition": "format is NULL when locale is supplied", "behavior": { "kind": "uses_default", "description": "format is NULL when locale is supplied -> default number format for that locale." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of str2integer as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2integer", "basis": "documentation" } ] }, "description": "The str2integer() function converts a given string argument to the corresponding integer value. The conversion can be determined by a numeral system, format or locale. The parameter arg is a numeric value to be converted to integer. If the argument is null, the function returns null. The parameter radix enables to convert a given string argument to integer using specified radix based numeric system representation. The format is described in Numeric format. If a locale is specified, you can use null or an empty string for the format pattern to apply the default number format of that locale. The locale is described in Locale.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2integer", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "str2integer(string,string,string)", "canonical_signature": "integer str2integer(string arg, string format, string locale)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter arg is a numeric value to be converted to integer.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The conversion can be determined by a numeral system, format or locale.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "format is NULL when locale is supplied -> default number format for that locale.", "cases": [ { "condition": "format is NULL when locale is supplied", "behavior": { "kind": "uses_default", "description": "format is NULL when locale is supplied -> default number format for that locale." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The conversion can be determined by a numeral system, format or locale.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "locale is NULL -> a normal numeric result (probes: 123.45 or 123, depending on the conversion).", "result": { "kind": "literal", "type": "number", "value": 123.45, "display": "123.45" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of str2integer as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2integer", "basis": "documentation" } ] }, "description": "The str2integer() function converts a given string argument to the corresponding integer value. The conversion can be determined by a numeral system, format or locale. The parameter arg is a numeric value to be converted to integer. If the argument is null, the function returns null. The parameter radix enables to convert a given string argument to integer using specified radix based numeric system representation. The format is described in Numeric format. If a locale is specified, you can use null or an empty string for the format pattern to apply the default number format of that locale. The locale is described in Locale.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2integer", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The str2integer(string), str2integer(string,string), str2integer(string,string,string) and str2integer(string,integer) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2integer", "basis": "documentation" } ] } ], "see_also": [ "toString" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2integer", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "str2long": { "name": "str2long", "category": "conversion", "summary": "The str2long() function converts a given string argument to a long value.", "description": "The str2long() function converts a given string argument to a long value. If the value is expressed in the radix based numeric system, the representation is specified by the second argument. The conversion can be affected using a format specified as the second argument and the system locale. The arg is the value to be converted to long. If the argument is null, the function returns null. The radix is radix of numeral system. The format is a format of the number to be converted. If a locale is specified, you can use null or an empty string for the format pattern to apply the default number format of that locale. For details, see Numeric format. The locale is described in Locale.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "str2long(string)", "canonical_signature": "long str2long(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The arg is the value to be converted to long.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of str2long as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2long", "basis": "documentation" } ] }, "description": "The str2long() function converts a given string argument to a long value. If the value is expressed in the radix based numeric system, the representation is specified by the second argument. The conversion can be affected using a format specified as the second argument and the system locale. The arg is the value to be converted to long. If the argument is null, the function returns null. The radix is radix of numeral system. The format is a format of the number to be converted. If a locale is specified, you can use null or an empty string for the format pattern to apply the default number format of that locale. For details, see Numeric format. The locale is described in Locale.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2long", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "str2long(string,integer)", "canonical_signature": "long str2long(string arg, integer radix)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The arg is the value to be converted to long.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "radix", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "If the value is expressed in the radix based numeric system, the representation is specified by the second argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "radix is NULL for str2integer or str2long -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of str2long as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2long", "basis": "documentation" } ] }, "description": "The str2long() function converts a given string argument to a long value. If the value is expressed in the radix based numeric system, the representation is specified by the second argument. The conversion can be affected using a format specified as the second argument and the system locale. The arg is the value to be converted to long. If the argument is null, the function returns null. The radix is radix of numeral system. The format is a format of the number to be converted. If a locale is specified, you can use null or an empty string for the format pattern to apply the default number format of that locale. For details, see Numeric format. The locale is described in Locale.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2long", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "radix == NULL", "description": "radix is NULL for str2integer or str2long -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "str2long(string,string)", "canonical_signature": "long str2long(string arg, string format)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The arg is the value to be converted to long.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The conversion can be affected using a format specified as the second argument and the system locale.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "format is NULL when locale is supplied -> default number format for that locale.", "cases": [ { "condition": "format is NULL when locale is supplied", "behavior": { "kind": "uses_default", "description": "format is NULL when locale is supplied -> default number format for that locale." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of str2long as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2long", "basis": "documentation" } ] }, "description": "The str2long() function converts a given string argument to a long value. If the value is expressed in the radix based numeric system, the representation is specified by the second argument. The conversion can be affected using a format specified as the second argument and the system locale. The arg is the value to be converted to long. If the argument is null, the function returns null. The radix is radix of numeral system. The format is a format of the number to be converted. If a locale is specified, you can use null or an empty string for the format pattern to apply the default number format of that locale. For details, see Numeric format. The locale is described in Locale.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2long", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "str2long(string,string,string)", "canonical_signature": "long str2long(string arg, string format, string locale)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The arg is the value to be converted to long.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "format", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The conversion can be affected using a format specified as the second argument and the system locale.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "format is NULL when locale is supplied -> default number format for that locale.", "cases": [ { "condition": "format is NULL when locale is supplied", "behavior": { "kind": "uses_default", "description": "format is NULL when locale is supplied -> default number format for that locale." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "locale", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The conversion can be affected using a format specified as the second argument and the system locale.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "locale is NULL -> a normal numeric result (probes: 123.45 or 123, depending on the conversion).", "result": { "kind": "literal", "type": "number", "value": 123.45, "display": "123.45" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "long", "display": "long" }, "description": "Return value of str2long as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2long", "basis": "documentation" } ] }, "description": "The str2long() function converts a given string argument to a long value. If the value is expressed in the radix based numeric system, the representation is specified by the second argument. The conversion can be affected using a format specified as the second argument and the system locale. The arg is the value to be converted to long. If the argument is null, the function returns null. The radix is radix of numeral system. The format is a format of the number to be converted. If a locale is specified, you can use null or an empty string for the format pattern to apply the default number format of that locale. For details, see Numeric format. The locale is described in Locale.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2long", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The str2long(string), str2long(string,string), str2long(string,string,string) and str2long(string,integer) functions are available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2long", "basis": "documentation" } ] } ], "see_also": [ "toString" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2long", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "str2timeUnit": { "name": "str2timeUnit", "category": "conversion", "summary": "The str2timeUnit(string) function converts a given input string argument to a time unit value, making it easier to work with different time units in your code.", "description": "The str2timeUnit(string) function converts a given input string argument to a time unit value, making it easier to work with different time units in your code. The function is case-insensitive. This function is useful when you have a time unit represented as a string (e.g. in a graph parameter or field from metadata) and need to obtain its corresponding unit constant.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "str2timeUnit(string)", "canonical_signature": "unit str2timeUnit(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error (\"Unable to convert - input is null.\").", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "unit", "display": "unit" }, "description": "Return value of str2timeUnit as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2timeUnit", "basis": "documentation" } ] }, "description": "The str2timeUnit(string) function converts a given input string argument to a time unit value, making it easier to work with different time units in your code. The function is case-insensitive. This function is useful when you have a time unit represented as a string (e.g. in a graph parameter or field from metadata) and need to obtain its corresponding unit constant.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2timeUnit", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error (\"Unable to convert - input is null.\").", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The str2timeUnit(string) function is available since CloverDX 6.4.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2timeUnit", "basis": "documentation" } ] } ], "see_also": [ "date2num", "dateAdd", "dateDiff" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "str2timeUnit", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "substring": { "name": "substring", "category": "string", "summary": "The substring() function returns a substring of an input string.", "description": "The substring() function returns a substring of an input string. The function substring(arg, fromIndex) returns a substring of arg starting at the position fromIndex. The function substring(arg, fromIndex, length) returns a substring of arg starting at the position fromIndex limited by length. If the original string arg is null, the function returns null. If the arg is __empty string__, the function returns __empty string__. See the compatibility notice. The parameter fromIndex defines the starting position of the substring. If fromIndex is negative or null, the function fails. See compatibility notice. The parameter length is a maximal length of the returned substring. If length is negative or null, the function fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "substring(string,integer)", "canonical_signature": "string substring(string arg, integer fromIndex)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The function substring(arg, fromIndex) returns a substring of arg starting at the position fromIndex.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Compatibility: arg NULL caused a runtime error in CloverETL 3.5.x and earlier.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "fromIndex", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The function substring(arg, fromIndex) returns a substring of arg starting at the position fromIndex.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "fromIndex or length is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of substring as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "substring", "basis": "documentation" } ] }, "description": "The substring() function returns a substring of an input string. The function substring(arg, fromIndex) returns a substring of arg starting at the position fromIndex. The function substring(arg, fromIndex, length) returns a substring of arg starting at the position fromIndex limited by length. If the original string arg is null, the function returns null. If the arg is __empty string__, the function returns __empty string__. See the compatibility notice. The parameter fromIndex defines the starting position of the substring. If fromIndex is negative or null, the function fails. See compatibility notice. The parameter length is a maximal length of the returned substring. If length is negative or null, the function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "substring", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "Compatibility: arg NULL caused a runtime error in CloverETL 3.5.x and earlier.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "fromIndex == NULL", "description": "fromIndex or length is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "substring(string,integer,integer)", "canonical_signature": "string substring(string arg, integer fromIndex, integer length)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The function substring(arg, fromIndex) returns a substring of arg starting at the position fromIndex.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "Compatibility: arg NULL caused a runtime error in CloverETL 3.5.x and earlier.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "fromIndex", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The function substring(arg, fromIndex) returns a substring of arg starting at the position fromIndex.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "fromIndex or length is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "length", "type": { "kind": "named", "name": "integer", "display": "integer" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The function substring(arg, fromIndex, length) returns a substring of arg starting at the position fromIndex limited by length.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "fromIndex or length is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of substring as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "substring", "basis": "documentation" } ] }, "description": "The substring() function returns a substring of an input string. The function substring(arg, fromIndex) returns a substring of arg starting at the position fromIndex. The function substring(arg, fromIndex, length) returns a substring of arg starting at the position fromIndex limited by length. If the original string arg is null, the function returns null. If the arg is __empty string__, the function returns __empty string__. See the compatibility notice. The parameter fromIndex defines the starting position of the substring. If fromIndex is negative or null, the function fails. See compatibility notice. The parameter length is a maximal length of the returned substring. If length is negative or null, the function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "substring", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "Compatibility: arg NULL caused a runtime error in CloverETL 3.5.x and earlier.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "fromIndex == NULL", "description": "fromIndex or length is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "length == NULL", "description": "fromIndex or length is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function substring() works differently in CloverETL 3.5.x and earlier.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "substring", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The function substring() fails, if the input string arg is null in CloverETL 3.5.x and earlier.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "substring", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The function substring() fails, if any of integer parameters is null or out of range of the input string in CloverETL 3.5.x.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "substring", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "Since CloverETL 4.0.0.M1, it fails only with _negative_ or null values.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "substring", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The substring(string,integer,integer) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "substring", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The substring(string, integer) function is available since CloverETL 4.0.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "substring", "basis": "documentation" } ] } ], "see_also": [ "charAt", "cut", "left", "right", "trim" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "substring", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "tan": { "name": "tan", "category": "mathematical", "summary": "The tan() function returns the trigonometric tangent of a given angle.", "description": "The tan() function returns the trigonometric tangent of a given angle. The angle is in radians. If the given argument is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "tan(decimal)", "canonical_signature": "number tan(decimal angle)", "type_parameters": [], "parameters": [ { "position": 0, "name": "angle", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The tan() function returns the trigonometric tangent of a given angle.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of tan as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "tan", "basis": "documentation" } ] }, "description": "The tan() function returns the trigonometric tangent of a given angle. The angle is in radians. If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "tan", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "angle == NULL", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "tan(number)", "canonical_signature": "number tan(number angle)", "type_parameters": [], "parameters": [ { "position": 0, "name": "angle", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The tan() function returns the trigonometric tangent of a given angle.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of tan as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "tan", "basis": "documentation" } ] }, "description": "The tan() function returns the trigonometric tangent of a given angle. The angle is in radians. If the given argument is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "tan", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "angle == NULL", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The tan(decimal) and tan(number) functions are available since CloverETL 3.5.0-M2.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "tan", "basis": "documentation" } ] } ], "see_also": [ "atan", "cos", "sin", "toRadians" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "tan", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "toAbsolutePath": { "name": "toAbsolutePath", "category": "miscellaneous", "summary": "The toAbsolutePath() function converts the specified path to an OS-dependent absolute path to the same file.", "description": "The toAbsolutePath() function converts the specified path to an OS-dependent absolute path to the same file. The input may be a path or a URL. If the input path is relative, it is resolved against the context URL of the running graph. If running on the Server, the function can also handle sandbox URLs. However, a sandbox URL can only be converted to an absolute path, if the file is locally available on the current server node. If the conversion fails, the function returns null. If the given parameter is null, the function fails with an error. The returned path will always use forward slashes as directory separator, even on Microsoft Windows systems. If you need the path to contain backslashes, use the translate()function:", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "toAbsolutePath(string)", "canonical_signature": "string toAbsolutePath(string path)", "type_parameters": [], "parameters": [ { "position": 0, "name": "path", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The toAbsolutePath() function converts the specified path to an OS-dependent absolute path to the same file.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of toAbsolutePath as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "toAbsolutePath", "basis": "documentation" } ] }, "description": "The toAbsolutePath() function converts the specified path to an OS-dependent absolute path to the same file. The input may be a path or a URL. If the input path is relative, it is resolved against the context URL of the running graph. If running on the Server, the function can also handle sandbox URLs. However, a sandbox URL can only be converted to an absolute path, if the file is locally available on the current server node. If the conversion fails, the function returns null. If the given parameter is null, the function fails with an error. The returned path will always use forward slashes as directory separator, even on Microsoft Windows systems. If you need the path to contain backslashes, use the translate()function:", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "toAbsolutePath", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter path is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The toAbsolutePath(string) function is available since CloverETL 3.3.x.", "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "toAbsolutePath", "basis": "documentation" } ] } ], "see_also": [ "translate" ], "evidence": [ { "source_id": "ctl2-miscellaneous-functions", "section": "toAbsolutePath", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "toDegrees": { "name": "toDegrees", "category": "mathematical", "summary": "The toDegrees function converts radians to degrees.", "description": "The toDegrees function converts radians to degrees. The angle is in radians. If the angle is null, the function fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "toDegrees(decimal)", "canonical_signature": "number toDegrees(decimal angle)", "type_parameters": [], "parameters": [ { "position": 0, "name": "angle", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The angle is in radians.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of toDegrees as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "toDegrees", "basis": "documentation" } ] }, "description": "The toDegrees function converts radians to degrees. The angle is in radians. If the angle is null, the function fails.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "toDegrees", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "angle == NULL", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "toDegrees(number)", "canonical_signature": "number toDegrees(number angle)", "type_parameters": [], "parameters": [ { "position": 0, "name": "angle", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The angle is in radians.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of toDegrees as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "toDegrees", "basis": "documentation" } ] }, "description": "The toDegrees function converts radians to degrees. The angle is in radians. If the angle is null, the function fails.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "toDegrees", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "angle == NULL", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The toDegrees(decimal) and toDegrees(number) functions are available since CloverETL 3.5.0-M2.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "toDegrees", "basis": "documentation" } ] } ], "see_also": [ "acos", "asin", "atan", "toRadians" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "toDegrees", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "toMap": { "name": "toMap", "category": "container", "summary": "The function toMap(key_type[], value_type[]) creates a map from two lists.", "description": "The function toMap(key_type[], value_type[]) creates a map from two lists. Elements of the first list will become keys and corresponding elements from the second list will be value (first key will map to first value, etc.). Note that both lists must be the same length. The function toMap(key_type[], value_type) create a map which maps all keys from the first list to the same value set by value. Note that values and keys can contain null values which will become keys or values as needed. Same for value in the second overload of the function - it will result in a map where all values are null. === Error states If the parameter keys is null, the function fails. If the parameter values is null, the function toMap(key_type[], value_type[]) fails. If length of the keys and values lists are not the same, the first overload fails. === Compatibility The toMap function is available since CloverETL 4.0.0.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "toMap(K[],V)", "canonical_signature": "map[K,V] toMap(K[] keys, V value)", "type_parameters": [ { "name": "K", "constraint": { "kind": "any", "display": "any" } }, { "name": "V", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "keys", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "K", "display": "K" }, "display": "K[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Elements of the first list will become keys and corresponding elements from the second list will be value (first key will map to first value, etc.).", "constraints": [], "null_behavior": { "kind": "accepted", "description": "NULL elements in non-NULL keys or values arrays -> accepted as map keys or values.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "value", "type": { "kind": "type_variable", "name": "V", "display": "V" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Elements of the first list will become keys and corresponding elements from the second list will be value (first key will map to first value, etc.).", "constraints": [], "null_behavior": { "kind": "accepted", "description": "NULL elements in non-NULL keys or values arrays -> accepted as map keys or values.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "map", "key": { "kind": "type_variable", "name": "K", "display": "K" }, "value": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "map[K,V]" }, "description": "Return value of toMap as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "toMap", "basis": "documentation" } ] }, "description": "The function toMap(key_type[], value_type[]) creates a map from two lists. Elements of the first list will become keys and corresponding elements from the second list will be value (first key will map to first value, etc.). Note that both lists must be the same length. The function toMap(key_type[], value_type) create a map which maps all keys from the first list to the same value set by value. Note that values and keys can contain null values which will become keys or values as needed. Same for value in the second overload of the function - it will result in a map where all values are null. === Error states If the parameter keys is null, the function fails. If the parameter values is null, the function toMap(key_type[], value_type[]) fails. If length of the keys and values lists are not the same, the first overload fails. === Compatibility The toMap function is available since CloverETL 4.0.0.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "toMap", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "toMap(K[],V[])", "canonical_signature": "map[K,V] toMap(K[] keys, V[] values)", "type_parameters": [ { "name": "K", "constraint": { "kind": "any", "display": "any" } }, { "name": "V", "constraint": { "kind": "any", "display": "any" } } ], "parameters": [ { "position": 0, "name": "keys", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "K", "display": "K" }, "display": "K[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Elements of the first list will become keys and corresponding elements from the second list will be value (first key will map to first value, etc.).", "constraints": [], "null_behavior": { "kind": "accepted", "description": "NULL elements in non-NULL keys or values arrays -> accepted as map keys or values.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "values", "type": { "kind": "list", "element": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "V[]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Note that values and keys can contain null values which will become keys or values as needed.", "constraints": [], "null_behavior": { "kind": "accepted", "description": "NULL elements in non-NULL keys or values arrays -> accepted as map keys or values.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "map", "key": { "kind": "type_variable", "name": "K", "display": "K" }, "value": { "kind": "type_variable", "name": "V", "display": "V" }, "display": "map[K,V]" }, "description": "Return value of toMap as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-container-functions", "section": "toMap", "basis": "documentation" } ] }, "description": "The function toMap(key_type[], value_type[]) creates a map from two lists. Elements of the first list will become keys and corresponding elements from the second list will be value (first key will map to first value, etc.). Note that both lists must be the same length. The function toMap(key_type[], value_type) create a map which maps all keys from the first list to the same value set by value. Note that values and keys can contain null values which will become keys or values as needed. Same for value in the second overload of the function - it will result in a map where all values are null. === Error states If the parameter keys is null, the function fails. If the parameter values is null, the function toMap(key_type[], value_type[]) fails. If length of the keys and values lists are not the same, the first overload fails. === Compatibility The toMap function is available since CloverETL 4.0.0.", "evidence": [ { "source_id": "ctl2-container-functions", "section": "toMap", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [], "evidence": [ { "source_id": "ctl2-container-functions", "section": "toMap", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "toProjectUrl": { "name": "toProjectUrl", "category": "string", "summary": "The toProjectUrl() function converts a relative path, e.g.", "description": "The toProjectUrl() function converts a relative path, e.g. [filename]data-in/file.txt to a full URL containing the name of the sandbox: [filename]sandbox://mysandbox/data-in/file.txt. The parameter path is a relative path to the file. If the parameter path is null, the function toProjectUrl() returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "toProjectUrl(string)", "canonical_signature": "string toProjectUrl(string path)", "type_parameters": [], "parameters": [ { "position": 0, "name": "path", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The toProjectUrl() function converts a relative path, e.g.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "path is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of toProjectUrl as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "path == NULL", "behavior": { "kind": "returns_null", "description": "path is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "toProjectUrl", "basis": "documentation" } ] }, "description": "The toProjectUrl() function converts a relative path, e.g. [filename]data-in/file.txt to a full URL containing the name of the sandbox: [filename]sandbox://mysandbox/data-in/file.txt. The parameter path is a relative path to the file. If the parameter path is null, the function toProjectUrl() returns null.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "toProjectUrl", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The toProjectUrl() function is available since CloverETL 4.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "toProjectUrl", "basis": "documentation" } ] } ], "see_also": [], "evidence": [ { "source_id": "ctl2-string-functions", "section": "toProjectUrl", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "toRadians": { "name": "toRadians", "category": "mathematical", "summary": "The toRadians function converts degrees to radians.", "description": "The toRadians function converts degrees to radians. The angle is in degrees. If the angle is null, the function fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "toRadians(decimal)", "canonical_signature": "number toRadians(decimal angle)", "type_parameters": [], "parameters": [ { "position": 0, "name": "angle", "type": { "kind": "named", "name": "decimal", "display": "decimal" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The angle is in degrees.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of toRadians as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "toRadians", "basis": "documentation" } ] }, "description": "The toRadians function converts degrees to radians. The angle is in degrees. If the angle is null, the function fails.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "toRadians", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "angle == NULL", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "toRadians(number)", "canonical_signature": "number toRadians(number angle)", "type_parameters": [], "parameters": [ { "position": 0, "name": "angle", "type": { "kind": "named", "name": "number", "display": "number" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The angle is in degrees.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "number", "display": "number" }, "description": "Return value of toRadians as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "toRadians", "basis": "documentation" } ] }, "description": "The toRadians function converts degrees to radians. The angle is in degrees. If the angle is null, the function fails.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "toRadians", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "angle == NULL", "description": "angle is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The toRadians(decimal) and toRadians(number) functions are available since CloverETL 3.5.0-M2.", "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "toRadians", "basis": "documentation" } ] } ], "see_also": [ "cos", "sin", "tan", "toDegrees" ], "evidence": [ { "source_id": "ctl2-mathematical-functions", "section": "toRadians", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "toString": { "name": "toString", "category": "conversion", "summary": "Converts the given argument to its string representation.", "description": "Converts the given argument to its string representation. If the input is null, the function returns the string \"null\". The function should be used for logging or similar purposes, not for application logic. The output format is unspecified and may change in future versions.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "toString(any)", "canonical_signature": "string toString(any arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "arg is NULL -> string \"null\".", "result": { "kind": "literal", "type": "string", "value": "null", "display": "\"null\"" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of toString as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "toString", "basis": "documentation" } ] }, "description": "Converts the given argument to its string representation. If the input is null, the function returns the string \"null\". The function should be used for logging or similar purposes, not for application logic. The output format is unspecified and may change in future versions.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "toString", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The toString(int|long|double|decimal|map|list) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "toString", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The toString(boolean) function is available since CloverETL 4.1.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "toString", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "The toString(variant) function is available since CloverDX 5.6.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "toString", "basis": "documentation" } ] } ], "see_also": [ "str2decimal", "str2double", "str2integer", "str2long" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "toString", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "today": { "name": "today", "category": "date", "summary": "The today() function accepts no argument and returns current date and time.", "description": "The today() function accepts no argument and returns current date and time.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "today()", "canonical_signature": "date today()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of today as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "today", "basis": "documentation" } ] }, "description": "The today() function accepts no argument and returns current date and time.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "today", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The today() function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "today", "basis": "documentation" } ] } ], "see_also": [ "zeroDate" ], "evidence": [ { "source_id": "ctl2-date-functions", "section": "today", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "translate": { "name": "translate", "category": "string", "summary": "The translate() function replaces the characters given in the second string of the first argument with characters from the third string.", "description": "The translate() function replaces the characters given in the second string of the first argument with characters from the third string. If one or both of the second or the third argument is null, the function fails with an error. If the input of the function is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "translate(string,string,string)", "canonical_signature": "string translate(string arg, string searchingSet, string replaceSet)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "searchingSet", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented searchingSet argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "searchingSet or replaceSet is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "replaceSet", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented replaceSet argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "searchingSet or replaceSet is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of translate as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "arg is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "translate", "basis": "documentation" } ] }, "description": "The translate() function replaces the characters given in the second string of the first argument with characters from the third string. If one or both of the second or the third argument is null, the function fails with an error. If the input of the function is null, the function returns null.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "translate", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "searchingSet == NULL", "description": "searchingSet or replaceSet is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, { "kind": "runtime_error", "condition": "replaceSet == NULL", "description": "searchingSet or replaceSet is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The translate(string,string,string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "translate", "basis": "documentation" } ] } ], "see_also": [ "replace", "toAbsolutePath" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "translate", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "trim": { "name": "trim", "category": "string", "summary": "The trim() function takes one string argument and returns another string with leading and trailing white spaces removed.", "description": "The trim() function takes one string argument and returns another string with leading and trailing white spaces removed. If the input of the function is an empty string, the function returns an empty string. If the input of the function is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "trim(string)", "canonical_signature": "string trim(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of trim as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "trim", "basis": "documentation" } ] }, "description": "The trim() function takes one string argument and returns another string with leading and trailing white spaces removed. If the input of the function is an empty string, the function returns an empty string. If the input of the function is null, the function returns null.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "trim", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The trim(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "trim", "basis": "documentation" } ] } ], "see_also": [ "isBlank", "removeBlankSpace", "replace", "substring" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "trim", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "trunc": { "name": "trunc", "category": "date", "summary": "The function trunc is deprecated.", "description": "The function trunc is deprecated. It returns a value and modifies the argument at the same time. The trunc() function removes time from date. The function takes one date argument and returns the date with the same year, month and day, but hour, minute, second and millisecond values are set to 0. If the argument is null, the function fails with an error. The function trunc modifies the input parameter.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "trunc(date)", "canonical_signature": "date trunc(date arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of trunc as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "trunc", "basis": "documentation" } ] }, "description": "The function trunc is deprecated. It returns a value and modifies the argument at the same time. The trunc() function removes time from date. The function takes one date argument and returns the date with the same year, month and day, but hour, minute, second and millisecond values are set to 0. If the argument is null, the function fails with an error. The function trunc modifies the input parameter.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "trunc", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [ { "kind": "mutates_parameter", "parameter": "arg", "description": "Documentation states that trunc modifies its target argument.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "trunc", "basis": "documentation" } ] } ], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The trunc(date) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "trunc", "basis": "documentation" } ] } ], "see_also": [ "extractDate", "truncDate" ], "evidence": [ { "source_id": "ctl2-date-functions", "section": "trunc", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "truncDate": { "name": "truncDate", "category": "date", "summary": "The function truncDate is deprecated.", "description": "The function truncDate is deprecated. It returns a value and modifies the argument at the same time. The truncDate() function returns a date with the same hour, minute, second and millisecond as the given date, but year is 1970, month and day values are set to 1. The 0 date is 1970-01-01. If the given argument is null, the function fails with an error. The function truncDate modifies the input parameter.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "truncDate(date)", "canonical_signature": "date truncDate(date arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "date", "display": "date" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of truncDate as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "truncDate", "basis": "documentation" } ] }, "description": "The function truncDate is deprecated. It returns a value and modifies the argument at the same time. The truncDate() function returns a date with the same hour, minute, second and millisecond as the given date, but year is 1970, month and day values are set to 1. The 0 date is 1970-01-01. If the given argument is null, the function fails with an error. The function truncDate modifies the input parameter.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "truncDate", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [ { "kind": "mutates_parameter", "parameter": "arg", "description": "Documentation states that truncDate modifies its target argument.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "truncDate", "basis": "documentation" } ] } ], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The function truncDate(date) is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "truncDate", "basis": "documentation" } ] } ], "see_also": [ "extractTime", "trunc" ], "evidence": [ { "source_id": "ctl2-date-functions", "section": "truncDate", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "unescapeJson": { "name": "unescapeJson", "category": "string", "summary": "The unescapeJson function reverts conversion of escapeJson.", "description": "The unescapeJson function reverts conversion of escapeJson.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "unescapeJson(string)", "canonical_signature": "string unescapeJson(string input)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented input argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of unescapeJson as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "Input NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "unescapeJson", "basis": "documentation" } ] }, "description": "The unescapeJson function reverts conversion of escapeJson.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "unescapeJson", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The unescapeJson(string) function is available since CloverDX 7.5.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "unescapeJson", "basis": "documentation" } ] } ], "see_also": [ "escapeJson" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "unescapeJson", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "unescapeUrl": { "name": "unescapeUrl", "category": "string", "summary": "The unescapeUrl() function decodes escape sequences of illegal characters within components of a specified URL.", "description": "The unescapeUrl() function decodes escape sequences of illegal characters within components of a specified URL. Escape sequences consist of a percent (%) symbol, followed by the two-digit hexadecimal representation (case-insensitive) of the ISO-Latin code point for the character, e.g. %20 is the escaped encoding for the US-ASCII space character. For the URL component description, see isUrl. Function accepts a valid URL only. For an invalid URL, empty string or null input, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "unescapeUrl(string)", "canonical_signature": "string unescapeUrl(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of unescapeUrl as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "unescapeUrl", "basis": "documentation" } ] }, "description": "The unescapeUrl() function decodes escape sequences of illegal characters within components of a specified URL. Escape sequences consist of a percent (%) symbol, followed by the two-digit hexadecimal representation (case-insensitive) of the ISO-Latin code point for the character, e.g. %20 is the escaped encoding for the US-ASCII space character. For the URL component description, see isUrl. Function accepts a valid URL only. For an invalid URL, empty string or null input, the function fails with an error.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "unescapeUrl", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The unescapeUrl(string) function is available since CloverETL 3.1.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "unescapeUrl", "basis": "documentation" } ] } ], "see_also": [ "escapeUrl", "escapeUrlFragment", "isUrl", "unescapeUrlFragment" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "unescapeUrl", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "unescapeUrlFragment": { "name": "unescapeUrlFragment", "category": "string", "summary": "The function unescapes a string escaped by escapeUrlFragment.", "description": "The function unescapes a string escaped by escapeUrlFragment. The parameter input is a string to be unescaped. It the parameter is null, the function returns null. The parameter encoding is an encoding to be used in conversion. If the encoding is null, the conversion fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "unescapeUrlFragment(string)", "canonical_signature": "string unescapeUrlFragment(string input)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter input is a string to be unescaped.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of unescapeUrlFragment as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "unescapeUrlFragment", "basis": "documentation" } ] }, "description": "The function unescapes a string escaped by escapeUrlFragment. The parameter input is a string to be unescaped. It the parameter is null, the function returns null. The parameter encoding is an encoding to be used in conversion. If the encoding is null, the conversion fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "unescapeUrlFragment", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The unescapeUrlFragment(string) function is available since CloverETL 4.0.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "unescapeUrlFragment", "basis": "documentation" } ] } ], "see_also": [ "escapeUrl", "escapeUrlFragment", "isUrl", "unescapeUrl" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "unescapeUrlFragment", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "unescapeXML": { "name": "unescapeXML", "category": "string", "summary": "The unescapeXML(string) function is designed to convert XML-escaped entities back into their original, unescaped characters.", "description": "The unescapeXML(string) function is designed to convert XML-escaped entities back into their original, unescaped characters. This function is useful when you need to extract or display the original content from an XML document that has previously been processed with the escapeXML function. List of reserved characters: ' , \", &, <, >", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "unescapeXML(string)", "canonical_signature": "string unescapeXML(string input)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented input argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of unescapeXML as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "Input NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "unescapeXML", "basis": "documentation" } ] }, "description": "The unescapeXML(string) function is designed to convert XML-escaped entities back into their original, unescaped characters. This function is useful when you need to extract or display the original content from an XML document that has previously been processed with the escapeXML function. List of reserved characters: ' , \", &, <, >", "evidence": [ { "source_id": "ctl2-string-functions", "section": "unescapeXML", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The unescapeXML(string) function is available since CloverDX 6.4.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "unescapeXML", "basis": "documentation" } ] } ], "see_also": [ "escapeXML" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "unescapeXML", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "unicodeNormalize": { "name": "unicodeNormalize", "category": "string", "summary": "The unicodeNormalize() normalizes an input string using a specified __normalization form__.", "description": "The unicodeNormalize() normalizes an input string using a specified __normalization form__. The parameter input contains the string to be normalized. If the parameter input is null, the function returns null. The parameter form defines the _normalization form_ to be used. Following normalization forms are available: NFD: Canonical Decomposition NFC: Canonical Decomposition followed by Canonical Composition NFKD: Compatibility Decomposition NFKC: Compatibility Decomposition followed by Canonical Composition If the parameter form is null, the function fails.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "unicodeNormalize(string,string)", "canonical_signature": "string unicodeNormalize(string input, string form)", "type_parameters": [], "parameters": [ { "position": 0, "name": "input", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The unicodeNormalize() normalizes an input string using a specified __normalization form__.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "form", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The parameter form defines the _normalization form_ to be used.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "form is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of unicodeNormalize as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "input == NULL", "behavior": { "kind": "returns_null", "description": "input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "unicodeNormalize", "basis": "documentation" } ] }, "description": "The unicodeNormalize() normalizes an input string using a specified __normalization form__. The parameter input contains the string to be normalized. If the parameter input is null, the function returns null. The parameter form defines the _normalization form_ to be used. Following normalization forms are available: NFD: Canonical Decomposition NFC: Canonical Decomposition followed by Canonical Composition NFKD: Compatibility Decomposition NFKC: Compatibility Decomposition followed by Canonical Composition If the parameter form is null, the function fails.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "unicodeNormalize", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "form == NULL", "description": "form is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The unicodeNormalize(string) function is available since CloverETL 4.0.0-M1.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "unicodeNormalize", "basis": "documentation" } ] } ], "see_also": [ "isUnicodeNormalized" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "unicodeNormalize", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "upperCase": { "name": "upperCase", "category": "string", "summary": "The upperCase() function takes one string argument and returns another string with cases converted to upper cases only.", "description": "The upperCase() function takes one string argument and returns another string with cases converted to upper cases only. The function returns null for a null input.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "upperCase(string)", "canonical_signature": "string upperCase(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of upperCase as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "arg == NULL", "behavior": { "kind": "returns_null", "description": "Input is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "upperCase", "basis": "documentation" } ] }, "description": "The upperCase() function takes one string argument and returns another string with cases converted to upper cases only. The function returns null for a null input.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "upperCase", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The upperCase(string) function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "upperCase", "basis": "documentation" } ] } ], "see_also": [ "lowerCase", "properCase" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "upperCase", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "validateCreditCard": { "name": "validateCreditCard", "category": "string", "summary": "The validateCreditCard() function takes string argument and uses Luhn algorithm, also known as 'modulus 10', to determine whether the argument is a valid credit card number.", "description": "The validateCreditCard() function takes string argument and uses Luhn algorithm, also known as 'modulus 10', to determine whether the argument is a valid credit card number. The function returns null if the validation passes or an error message if it fails. If the second parameter is true an empty string value is considered to be a valid value.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "validateCreditCard(string,boolean)", "canonical_signature": "string validateCreditCard(string creditCard, boolean acceptEmpty)", "type_parameters": [], "parameters": [ { "position": 0, "name": "creditCard", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented creditCard argument.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "creditCard NULL with acceptEmpty=false -> \"Empty card number is not allowed\".", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "acceptEmpty", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented acceptEmpty argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "acceptEmpty NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of validateCreditCard as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "validateCreditCard", "basis": "documentation" } ] }, "description": "The validateCreditCard() function takes string argument and uses Luhn algorithm, also known as 'modulus 10', to determine whether the argument is a valid credit card number. The function returns null if the validation passes or an error message if it fails. If the second parameter is true an empty string value is considered to be a valid value.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "validateCreditCard", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "acceptEmpty == NULL", "description": "acceptEmpty NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [ "validateEmail", "validatePhoneNumber" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "validateCreditCard", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "validateEmail": { "name": "validateEmail", "category": "string", "summary": "The validateEmail() function takes string argument and performs syntactic check according to RFC822 standard to determine whether the argument is a valid email address.", "description": "The validateEmail() function takes string argument and performs syntactic check according to RFC822 standard to determine whether the argument is a valid email address. It does not try to connect or to send any message to the syntactically valid argument. The function returns null if the validation passes or an error message if it fails. If the second parameter is true an empty string value is considered to be a valid value.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "validateEmail(string,boolean)", "canonical_signature": "string validateEmail(string email, boolean acceptEmpty)", "type_parameters": [], "parameters": [ { "position": 0, "name": "email", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] The validateEmail() function takes string argument and performs syntactic check according to RFC822 standard to determine whether the argument is a valid email address.", "constraints": [], "null_behavior": { "kind": "returns_value", "description": "email is NULL and acceptEmpty is false -> \"Empty email is not allowed\".", "result": { "kind": "literal", "type": "boolean", "value": false, "display": "false" }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "acceptEmpty", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented acceptEmpty argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "acceptEmpty is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of validateEmail as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "validateEmail", "basis": "documentation" } ] }, "description": "The validateEmail() function takes string argument and performs syntactic check according to RFC822 standard to determine whether the argument is a valid email address. It does not try to connect or to send any message to the syntactically valid argument. The function returns null if the validation passes or an error message if it fails. If the second parameter is true an empty string value is considered to be a valid value.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "validateEmail", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "acceptEmpty == NULL", "description": "acceptEmpty is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [ "validateCreditCard", "validatePhoneNumber" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "validateEmail", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "validatePhoneNumber": { "name": "validatePhoneNumber", "category": "string", "summary": "The validatePhoneNumber() function takes string argument and validates if its a phone number.", "description": "The validatePhoneNumber() function takes string argument and validates if its a phone number. The second parameter is phone region in a form of two letters ISO Alpha 2 code. Its ignored and may be left empty if the phone number is written in international format. The function returns null if the validation passes or an error message if it fails. If the third parameter is true an empty string value is considered to be a valid value.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "validatePhoneNumber(string,string,boolean)", "canonical_signature": "string validatePhoneNumber(string email, string phoneRegion, boolean acceptEmpty)", "type_parameters": [], "parameters": [ { "position": 0, "name": "email", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented email argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 1, "name": "phoneRegion", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented phoneRegion argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] }, { "position": 2, "name": "acceptEmpty", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented acceptEmpty argument.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "The available documentation does not establish NULL behavior for this parameter.", "evidence": [] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of validatePhoneNumber as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-string-functions", "section": "validatePhoneNumber", "basis": "documentation" } ] }, "description": "The validatePhoneNumber() function takes string argument and validates if its a phone number. The second parameter is phone region in a form of two letters ISO Alpha 2 code. Its ignored and may be left empty if the phone number is written in international format. The function returns null if the validation passes or an error message if it fails. If the third parameter is true an empty string value is considered to be a valid value.", "evidence": [ { "source_id": "ctl2-string-functions", "section": "validatePhoneNumber", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter email is undocumented.", "NULL behavior for parameter phoneRegion is undocumented.", "NULL behavior for parameter acceptEmpty is undocumented." ] } } ], "compatibility": [], "see_also": [ "validateCreditCard", "validateEmail" ], "evidence": [ { "source_id": "ctl2-string-functions", "section": "validatePhoneNumber", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "variant2record": { "name": "variant2record", "category": "conversion", "summary": "Maps a variant tree - typically the result of parseJson - into a flat record.", "description": "Maps a variant tree - typically the result of parseJson - into a flat record. A variant parsed from JSON is a tree of nested maps and lists, while a record is flat: it has scalar fields and container fields which hold scalars of a single type only. The function bridges the two by searching the whole tree for keys which match a field name of target and converting the values it finds. The target is either a single record, or a list of records - one new record is then appended to the list for every item of the source list. The source parameter is the variant to read. Any map or list is accepted, including a map[string, string] or another map with a specific value type. A scalar has no keys, so it populates nothing. The tree is searched breadth-first: The shallowest match wins. A field populated by this call is never overwritten by a deeper key of the same name. A key which matches no field name is ignored, and is not an error even in the strict mode. A value which fits its matching field is consumed. The keys of a sub-map stored into a string or a variant field are therefore not searched any more. A container which does not fit its matching field is descended into instead. That is a part of the search rather than a failure. When target is a single record, the function returns the number of fields it has populated; when target is a list of records, it returns the number of records it has appended. It returns -1 if source or target is null. .Type conversion in variant2record() |=== h|Target field type h|Accepted value h|Note |string |any value |a sub-map or a sub-list is stored as compact JSON, a date in the ISO-8601 UTC format and a byte value in Base64 |integer |integer, long |a long value out of the integer range is not converted |long |integer, long | |number, decimal |integer, long, number, decimal |a decimal value never goes into an integer or a long field, not even with a zero fractional part |boolean, date, byte, cbyte |a value of the very same type |there is no conversion from a string |variant |any value |the whole sub-tree is stored as it is |list of |a list whose every single element converts to |all or nothing; an empty list gives an empty, non-null field |map[string, ] |a map with string keys whose every single value converts to |all or nothing |=== The strict parameter turns a failed conversion into an error. In strict mode the function fails when a key matches a field name but its value cannot be converted, when target is a list of records but source is not a list, and when source or target is null. If strict is missing, it works in the same way as if it was set to false - such a value is left out silently. The function does not reset target first: fields which are not matched by any key keep their previous value, and a list of records keeps the records it already holds. When target is a list of records, source has to be a list too - typically a parsed JSON array. Every single item of the source list is mapped into a new record appended to target, by the very same search and conversion rules as for a single record. One item always gives one record, so the records keep the positions of the items; an item which is null or a scalar matches nothing and gives an all-null record. A source which is not a list appends nothing and returns 0, and is an error only in the strict mode. The template parameter is a record whose metadata is used for the records being appended. Its metadata has to be the element metadata of target, otherwise the list ends up holding records of mixed metadata. The parameter can be left out when target already holds at least one record, because the metadata of that record is used instead. Note that target may be a list of any type, not only a list of records; a list of a scalar type is rejected where that can be recognized, which is not possible for an empty one. The template parameter can be left out in the interpreted CTL only. A compiled transformation does not know the element type of a list at runtime, so template has to be passed whenever target is empty. Without it the function fails with Passing template always works, so pass one unless target is known to hold a record already. Field names are matched case sensitively, and labels are not taken into account. A JSON key firstName does not match a field named FirstName. The values Integer.MIN_VALUE and Long.MIN_VALUE are the internal null indicators of an integer and a long field. Mapping one of them reports the field as populated, but leaves it null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "variant2record(variant,any)", "canonical_signature": "integer variant2record(variant source, any target)", "type_parameters": [], "parameters": [ { "position": 0, "name": "source", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Maps a variant tree - typically the result of parseJson - into a flat record.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "source or target is NULL when strict is true -> runtime error.", "cases": [ { "condition": "source or target is NULL when strict is true", "behavior": { "kind": "runtime_error", "description": "source or target is NULL when strict is true -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "target", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The function bridges the two by searching the whole tree for keys which match a field name of target and converting the values it finds.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "source or target is NULL when strict is true -> runtime error.", "cases": [ { "condition": "source or target is NULL when strict is true", "behavior": { "kind": "runtime_error", "description": "source or target is NULL when strict is true -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of variant2record as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "variant2record", "basis": "documentation" } ] }, "description": "Maps a variant tree - typically the result of parseJson - into a flat record. A variant parsed from JSON is a tree of nested maps and lists, while a record is flat: it has scalar fields and container fields which hold scalars of a single type only. The function bridges the two by searching the whole tree for keys which match a field name of target and converting the values it finds. The target is either a single record, or a list of records - one new record is then appended to the list for every item of the source list. The source parameter is the variant to read. Any map or list is accepted, including a map[string, string] or another map with a specific value type. A scalar has no keys, so it populates nothing. The tree is searched breadth-first: The shallowest match wins. A field populated by this call is never overwritten by a deeper key of the same name. A key which matches no field name is ignored, and is not an error even in the strict mode. A value which fits its matching field is consumed. The keys of a sub-map stored into a string or a variant field are therefore not searched any more. A container which does not fit its matching field is descended into instead. That is a part of the search rather than a failure. When target is a single record, the function returns the number of fields it has populated; when target is a list of records, it returns the number of records it has appended. It returns -1 if source or target is null. .Type conversion in variant2record() |=== h|Target field type h|Accepted value h|Note |string |any value |a sub-map or a sub-list is stored as compact JSON, a date in the ISO-8601 UTC format and a byte value in Base64 |integer |integer, long |a long value out of the integer range is not converted |long |integer, long | |number, decimal |integer, long, number, decimal |a decimal value never goes into an integer or a long field, not even with a zero fractional part |boolean, date, byte, cbyte |a value of the very same type |there is no conversion from a string |variant |any value |the whole sub-tree is stored as it is |list of |a list whose every single element converts to |all or nothing; an empty list gives an empty, non-null field |map[string, ] |a map with string keys whose every single value converts to |all or nothing |=== The strict parameter turns a failed conversion into an error. In strict mode the function fails when a key matches a field name but its value cannot be converted, when target is a list of records but source is not a list, and when source or target is null. If strict is missing, it works in the same way as if it was set to false - such a value is left out silently. The function does not reset target first: fields which are not matched by any key keep their previous value, and a list of records keeps the records it already holds. When target is a list of records, source has to be a list too - typically a parsed JSON array. Every single item of the source list is mapped into a new record appended to target, by the very same search and conversion rules as for a single record. One item always gives one record, so the records keep the positions of the items; an item which is null or a scalar matches nothing and gives an all-null record. A source which is not a list appends nothing and returns 0, and is an error only in the strict mode. The template parameter is a record whose metadata is used for the records being appended. Its metadata has to be the element metadata of target, otherwise the list ends up holding records of mixed metadata. The parameter can be left out when target already holds at least one record, because the metadata of that record is used instead. Note that target may be a list of any type, not only a list of records; a list of a scalar type is rejected where that can be recognized, which is not possible for an empty one. The template parameter can be left out in the interpreted CTL only. A compiled transformation does not know the element type of a list at runtime, so template has to be passed whenever target is empty. Without it the function fails with Passing template always works, so pass one unless target is known to hold a record already. Field names are matched case sensitively, and labels are not taken into account. A JSON key firstName does not match a field named FirstName. The values Integer.MIN_VALUE and Long.MIN_VALUE are the internal null indicators of an integer and a long field. Mapping one of them reports the field as populated, but leaves it null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "variant2record", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "variant2record(variant,any,any)", "canonical_signature": "integer variant2record(variant source, any target, any template)", "type_parameters": [], "parameters": [ { "position": 0, "name": "source", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Maps a variant tree - typically the result of parseJson - into a flat record.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "source or target is NULL when strict is true -> runtime error.", "cases": [ { "condition": "source or target is NULL when strict is true", "behavior": { "kind": "runtime_error", "description": "source or target is NULL when strict is true -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "target", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The function bridges the two by searching the whole tree for keys which match a field name of target and converting the values it finds.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "source or target is NULL when strict is true -> runtime error.", "cases": [ { "condition": "source or target is NULL when strict is true", "behavior": { "kind": "runtime_error", "description": "source or target is NULL when strict is true -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "template", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The template parameter is a record whose metadata is used for the records being appended.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "template or strict is NULL -> not documented.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of variant2record as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "variant2record", "basis": "documentation" } ] }, "description": "Maps a variant tree - typically the result of parseJson - into a flat record. A variant parsed from JSON is a tree of nested maps and lists, while a record is flat: it has scalar fields and container fields which hold scalars of a single type only. The function bridges the two by searching the whole tree for keys which match a field name of target and converting the values it finds. The target is either a single record, or a list of records - one new record is then appended to the list for every item of the source list. The source parameter is the variant to read. Any map or list is accepted, including a map[string, string] or another map with a specific value type. A scalar has no keys, so it populates nothing. The tree is searched breadth-first: The shallowest match wins. A field populated by this call is never overwritten by a deeper key of the same name. A key which matches no field name is ignored, and is not an error even in the strict mode. A value which fits its matching field is consumed. The keys of a sub-map stored into a string or a variant field are therefore not searched any more. A container which does not fit its matching field is descended into instead. That is a part of the search rather than a failure. When target is a single record, the function returns the number of fields it has populated; when target is a list of records, it returns the number of records it has appended. It returns -1 if source or target is null. .Type conversion in variant2record() |=== h|Target field type h|Accepted value h|Note |string |any value |a sub-map or a sub-list is stored as compact JSON, a date in the ISO-8601 UTC format and a byte value in Base64 |integer |integer, long |a long value out of the integer range is not converted |long |integer, long | |number, decimal |integer, long, number, decimal |a decimal value never goes into an integer or a long field, not even with a zero fractional part |boolean, date, byte, cbyte |a value of the very same type |there is no conversion from a string |variant |any value |the whole sub-tree is stored as it is |list of |a list whose every single element converts to |all or nothing; an empty list gives an empty, non-null field |map[string, ] |a map with string keys whose every single value converts to |all or nothing |=== The strict parameter turns a failed conversion into an error. In strict mode the function fails when a key matches a field name but its value cannot be converted, when target is a list of records but source is not a list, and when source or target is null. If strict is missing, it works in the same way as if it was set to false - such a value is left out silently. The function does not reset target first: fields which are not matched by any key keep their previous value, and a list of records keeps the records it already holds. When target is a list of records, source has to be a list too - typically a parsed JSON array. Every single item of the source list is mapped into a new record appended to target, by the very same search and conversion rules as for a single record. One item always gives one record, so the records keep the positions of the items; an item which is null or a scalar matches nothing and gives an all-null record. A source which is not a list appends nothing and returns 0, and is an error only in the strict mode. The template parameter is a record whose metadata is used for the records being appended. Its metadata has to be the element metadata of target, otherwise the list ends up holding records of mixed metadata. The parameter can be left out when target already holds at least one record, because the metadata of that record is used instead. Note that target may be a list of any type, not only a list of records; a list of a scalar type is rejected where that can be recognized, which is not possible for an empty one. The template parameter can be left out in the interpreted CTL only. A compiled transformation does not know the element type of a list at runtime, so template has to be passed whenever target is empty. Without it the function fails with Passing template always works, so pass one unless target is known to hold a record already. Field names are matched case sensitively, and labels are not taken into account. A JSON key firstName does not match a field named FirstName. The values Integer.MIN_VALUE and Long.MIN_VALUE are the internal null indicators of an integer and a long field. Mapping one of them reports the field as populated, but leaves it null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "variant2record", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter template is undocumented." ] } }, { "id": "variant2record(variant,any,any,boolean)", "canonical_signature": "integer variant2record(variant source, any target, any template, boolean strict)", "type_parameters": [], "parameters": [ { "position": 0, "name": "source", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Maps a variant tree - typically the result of parseJson - into a flat record.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "source or target is NULL when strict is true -> runtime error.", "cases": [ { "condition": "source or target is NULL when strict is true", "behavior": { "kind": "runtime_error", "description": "source or target is NULL when strict is true -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "target", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The function bridges the two by searching the whole tree for keys which match a field name of target and converting the values it finds.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "source or target is NULL when strict is true -> runtime error.", "cases": [ { "condition": "source or target is NULL when strict is true", "behavior": { "kind": "runtime_error", "description": "source or target is NULL when strict is true -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "template", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The template parameter is a record whose metadata is used for the records being appended.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "template or strict is NULL -> not documented.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 3, "name": "strict", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "A key which matches no field name is ignored, and is not an error even in the strict mode.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "template or strict is NULL -> not documented.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 4, "maximum": 4 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of variant2record as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "variant2record", "basis": "documentation" } ] }, "description": "Maps a variant tree - typically the result of parseJson - into a flat record. A variant parsed from JSON is a tree of nested maps and lists, while a record is flat: it has scalar fields and container fields which hold scalars of a single type only. The function bridges the two by searching the whole tree for keys which match a field name of target and converting the values it finds. The target is either a single record, or a list of records - one new record is then appended to the list for every item of the source list. The source parameter is the variant to read. Any map or list is accepted, including a map[string, string] or another map with a specific value type. A scalar has no keys, so it populates nothing. The tree is searched breadth-first: The shallowest match wins. A field populated by this call is never overwritten by a deeper key of the same name. A key which matches no field name is ignored, and is not an error even in the strict mode. A value which fits its matching field is consumed. The keys of a sub-map stored into a string or a variant field are therefore not searched any more. A container which does not fit its matching field is descended into instead. That is a part of the search rather than a failure. When target is a single record, the function returns the number of fields it has populated; when target is a list of records, it returns the number of records it has appended. It returns -1 if source or target is null. .Type conversion in variant2record() |=== h|Target field type h|Accepted value h|Note |string |any value |a sub-map or a sub-list is stored as compact JSON, a date in the ISO-8601 UTC format and a byte value in Base64 |integer |integer, long |a long value out of the integer range is not converted |long |integer, long | |number, decimal |integer, long, number, decimal |a decimal value never goes into an integer or a long field, not even with a zero fractional part |boolean, date, byte, cbyte |a value of the very same type |there is no conversion from a string |variant |any value |the whole sub-tree is stored as it is |list of |a list whose every single element converts to |all or nothing; an empty list gives an empty, non-null field |map[string, ] |a map with string keys whose every single value converts to |all or nothing |=== The strict parameter turns a failed conversion into an error. In strict mode the function fails when a key matches a field name but its value cannot be converted, when target is a list of records but source is not a list, and when source or target is null. If strict is missing, it works in the same way as if it was set to false - such a value is left out silently. The function does not reset target first: fields which are not matched by any key keep their previous value, and a list of records keeps the records it already holds. When target is a list of records, source has to be a list too - typically a parsed JSON array. Every single item of the source list is mapped into a new record appended to target, by the very same search and conversion rules as for a single record. One item always gives one record, so the records keep the positions of the items; an item which is null or a scalar matches nothing and gives an all-null record. A source which is not a list appends nothing and returns 0, and is an error only in the strict mode. The template parameter is a record whose metadata is used for the records being appended. Its metadata has to be the element metadata of target, otherwise the list ends up holding records of mixed metadata. The parameter can be left out when target already holds at least one record, because the metadata of that record is used instead. Note that target may be a list of any type, not only a list of records; a list of a scalar type is rejected where that can be recognized, which is not possible for an empty one. The template parameter can be left out in the interpreted CTL only. A compiled transformation does not know the element type of a list at runtime, so template has to be passed whenever target is empty. Without it the function fails with Passing template always works, so pass one unless target is known to hold a record already. Field names are matched case sensitively, and labels are not taken into account. A JSON key firstName does not match a field named FirstName. The values Integer.MIN_VALUE and Long.MIN_VALUE are the internal null indicators of an integer and a long field. Mapping one of them reports the field as populated, but leaves it null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "variant2record", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter template is undocumented.", "NULL behavior for parameter strict is undocumented." ] } }, { "id": "variant2record(variant,any,boolean)", "canonical_signature": "integer variant2record(variant source, any target, boolean strict)", "type_parameters": [], "parameters": [ { "position": 0, "name": "source", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Maps a variant tree - typically the result of parseJson - into a flat record.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "source or target is NULL when strict is true -> runtime error.", "cases": [ { "condition": "source or target is NULL when strict is true", "behavior": { "kind": "runtime_error", "description": "source or target is NULL when strict is true -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "target", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The function bridges the two by searching the whole tree for keys which match a field name of target and converting the values it finds.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "source or target is NULL when strict is true -> runtime error.", "cases": [ { "condition": "source or target is NULL when strict is true", "behavior": { "kind": "runtime_error", "description": "source or target is NULL when strict is true -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "strict", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "A key which matches no field name is ignored, and is not an error even in the strict mode.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "template or strict is NULL -> not documented.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of variant2record as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "variant2record", "basis": "documentation" } ] }, "description": "Maps a variant tree - typically the result of parseJson - into a flat record. A variant parsed from JSON is a tree of nested maps and lists, while a record is flat: it has scalar fields and container fields which hold scalars of a single type only. The function bridges the two by searching the whole tree for keys which match a field name of target and converting the values it finds. The target is either a single record, or a list of records - one new record is then appended to the list for every item of the source list. The source parameter is the variant to read. Any map or list is accepted, including a map[string, string] or another map with a specific value type. A scalar has no keys, so it populates nothing. The tree is searched breadth-first: The shallowest match wins. A field populated by this call is never overwritten by a deeper key of the same name. A key which matches no field name is ignored, and is not an error even in the strict mode. A value which fits its matching field is consumed. The keys of a sub-map stored into a string or a variant field are therefore not searched any more. A container which does not fit its matching field is descended into instead. That is a part of the search rather than a failure. When target is a single record, the function returns the number of fields it has populated; when target is a list of records, it returns the number of records it has appended. It returns -1 if source or target is null. .Type conversion in variant2record() |=== h|Target field type h|Accepted value h|Note |string |any value |a sub-map or a sub-list is stored as compact JSON, a date in the ISO-8601 UTC format and a byte value in Base64 |integer |integer, long |a long value out of the integer range is not converted |long |integer, long | |number, decimal |integer, long, number, decimal |a decimal value never goes into an integer or a long field, not even with a zero fractional part |boolean, date, byte, cbyte |a value of the very same type |there is no conversion from a string |variant |any value |the whole sub-tree is stored as it is |list of |a list whose every single element converts to |all or nothing; an empty list gives an empty, non-null field |map[string, ] |a map with string keys whose every single value converts to |all or nothing |=== The strict parameter turns a failed conversion into an error. In strict mode the function fails when a key matches a field name but its value cannot be converted, when target is a list of records but source is not a list, and when source or target is null. If strict is missing, it works in the same way as if it was set to false - such a value is left out silently. The function does not reset target first: fields which are not matched by any key keep their previous value, and a list of records keeps the records it already holds. When target is a list of records, source has to be a list too - typically a parsed JSON array. Every single item of the source list is mapped into a new record appended to target, by the very same search and conversion rules as for a single record. One item always gives one record, so the records keep the positions of the items; an item which is null or a scalar matches nothing and gives an all-null record. A source which is not a list appends nothing and returns 0, and is an error only in the strict mode. The template parameter is a record whose metadata is used for the records being appended. Its metadata has to be the element metadata of target, otherwise the list ends up holding records of mixed metadata. The parameter can be left out when target already holds at least one record, because the metadata of that record is used instead. Note that target may be a list of any type, not only a list of records; a list of a scalar type is rejected where that can be recognized, which is not possible for an empty one. The template parameter can be left out in the interpreted CTL only. A compiled transformation does not know the element type of a list at runtime, so template has to be passed whenever target is empty. Without it the function fails with Passing template always works, so pass one unless target is known to hold a record already. Field names are matched case sensitively, and labels are not taken into account. A JSON key firstName does not match a field named FirstName. The values Integer.MIN_VALUE and Long.MIN_VALUE are the internal null indicators of an integer and a long field. Mapping one of them reports the field as populated, but leaves it null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "variant2record", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter strict is undocumented." ] } }, { "id": "variant2record(variant,record)", "canonical_signature": "integer variant2record(variant source, record target)", "type_parameters": [], "parameters": [ { "position": 0, "name": "source", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Maps a variant tree - typically the result of parseJson - into a flat record.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "source or target is NULL when strict is true -> runtime error.", "cases": [ { "condition": "source or target is NULL when strict is true", "behavior": { "kind": "runtime_error", "description": "source or target is NULL when strict is true -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "target", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The function bridges the two by searching the whole tree for keys which match a field name of target and converting the values it finds.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "source or target is NULL when strict is true -> runtime error.", "cases": [ { "condition": "source or target is NULL when strict is true", "behavior": { "kind": "runtime_error", "description": "source or target is NULL when strict is true -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of variant2record as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "variant2record", "basis": "documentation" } ] }, "description": "Maps a variant tree - typically the result of parseJson - into a flat record. A variant parsed from JSON is a tree of nested maps and lists, while a record is flat: it has scalar fields and container fields which hold scalars of a single type only. The function bridges the two by searching the whole tree for keys which match a field name of target and converting the values it finds. The target is either a single record, or a list of records - one new record is then appended to the list for every item of the source list. The source parameter is the variant to read. Any map or list is accepted, including a map[string, string] or another map with a specific value type. A scalar has no keys, so it populates nothing. The tree is searched breadth-first: The shallowest match wins. A field populated by this call is never overwritten by a deeper key of the same name. A key which matches no field name is ignored, and is not an error even in the strict mode. A value which fits its matching field is consumed. The keys of a sub-map stored into a string or a variant field are therefore not searched any more. A container which does not fit its matching field is descended into instead. That is a part of the search rather than a failure. When target is a single record, the function returns the number of fields it has populated; when target is a list of records, it returns the number of records it has appended. It returns -1 if source or target is null. .Type conversion in variant2record() |=== h|Target field type h|Accepted value h|Note |string |any value |a sub-map or a sub-list is stored as compact JSON, a date in the ISO-8601 UTC format and a byte value in Base64 |integer |integer, long |a long value out of the integer range is not converted |long |integer, long | |number, decimal |integer, long, number, decimal |a decimal value never goes into an integer or a long field, not even with a zero fractional part |boolean, date, byte, cbyte |a value of the very same type |there is no conversion from a string |variant |any value |the whole sub-tree is stored as it is |list of |a list whose every single element converts to |all or nothing; an empty list gives an empty, non-null field |map[string, ] |a map with string keys whose every single value converts to |all or nothing |=== The strict parameter turns a failed conversion into an error. In strict mode the function fails when a key matches a field name but its value cannot be converted, when target is a list of records but source is not a list, and when source or target is null. If strict is missing, it works in the same way as if it was set to false - such a value is left out silently. The function does not reset target first: fields which are not matched by any key keep their previous value, and a list of records keeps the records it already holds. When target is a list of records, source has to be a list too - typically a parsed JSON array. Every single item of the source list is mapped into a new record appended to target, by the very same search and conversion rules as for a single record. One item always gives one record, so the records keep the positions of the items; an item which is null or a scalar matches nothing and gives an all-null record. A source which is not a list appends nothing and returns 0, and is an error only in the strict mode. The template parameter is a record whose metadata is used for the records being appended. Its metadata has to be the element metadata of target, otherwise the list ends up holding records of mixed metadata. The parameter can be left out when target already holds at least one record, because the metadata of that record is used instead. Note that target may be a list of any type, not only a list of records; a list of a scalar type is rejected where that can be recognized, which is not possible for an empty one. The template parameter can be left out in the interpreted CTL only. A compiled transformation does not know the element type of a list at runtime, so template has to be passed whenever target is empty. Without it the function fails with Passing template always works, so pass one unless target is known to hold a record already. Field names are matched case sensitively, and labels are not taken into account. A JSON key firstName does not match a field named FirstName. The values Integer.MIN_VALUE and Long.MIN_VALUE are the internal null indicators of an integer and a long field. Mapping one of them reports the field as populated, but leaves it null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "variant2record", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "variant2record(variant,record,boolean)", "canonical_signature": "integer variant2record(variant source, record target, boolean strict)", "type_parameters": [], "parameters": [ { "position": 0, "name": "source", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Maps a variant tree - typically the result of parseJson - into a flat record.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "source or target is NULL when strict is true -> runtime error.", "cases": [ { "condition": "source or target is NULL when strict is true", "behavior": { "kind": "runtime_error", "description": "source or target is NULL when strict is true -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "target", "type": { "kind": "named", "name": "record", "display": "record" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The function bridges the two by searching the whole tree for keys which match a field name of target and converting the values it finds.", "constraints": [], "null_behavior": { "kind": "conditional", "description": "source or target is NULL when strict is true -> runtime error.", "cases": [ { "condition": "source or target is NULL when strict is true", "behavior": { "kind": "runtime_error", "description": "source or target is NULL when strict is true -> runtime error." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 2, "name": "strict", "type": { "kind": "named", "name": "boolean", "display": "boolean" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "A key which matches no field name is ignored, and is not an error even in the strict mode.", "constraints": [], "null_behavior": { "kind": "undocumented", "description": "template or strict is NULL -> not documented.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 3, "maximum": 3 }, "returns": { "type": { "kind": "named", "name": "integer", "display": "integer" }, "description": "Return value of variant2record as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "variant2record", "basis": "documentation" } ] }, "description": "Maps a variant tree - typically the result of parseJson - into a flat record. A variant parsed from JSON is a tree of nested maps and lists, while a record is flat: it has scalar fields and container fields which hold scalars of a single type only. The function bridges the two by searching the whole tree for keys which match a field name of target and converting the values it finds. The target is either a single record, or a list of records - one new record is then appended to the list for every item of the source list. The source parameter is the variant to read. Any map or list is accepted, including a map[string, string] or another map with a specific value type. A scalar has no keys, so it populates nothing. The tree is searched breadth-first: The shallowest match wins. A field populated by this call is never overwritten by a deeper key of the same name. A key which matches no field name is ignored, and is not an error even in the strict mode. A value which fits its matching field is consumed. The keys of a sub-map stored into a string or a variant field are therefore not searched any more. A container which does not fit its matching field is descended into instead. That is a part of the search rather than a failure. When target is a single record, the function returns the number of fields it has populated; when target is a list of records, it returns the number of records it has appended. It returns -1 if source or target is null. .Type conversion in variant2record() |=== h|Target field type h|Accepted value h|Note |string |any value |a sub-map or a sub-list is stored as compact JSON, a date in the ISO-8601 UTC format and a byte value in Base64 |integer |integer, long |a long value out of the integer range is not converted |long |integer, long | |number, decimal |integer, long, number, decimal |a decimal value never goes into an integer or a long field, not even with a zero fractional part |boolean, date, byte, cbyte |a value of the very same type |there is no conversion from a string |variant |any value |the whole sub-tree is stored as it is |list of |a list whose every single element converts to |all or nothing; an empty list gives an empty, non-null field |map[string, ] |a map with string keys whose every single value converts to |all or nothing |=== The strict parameter turns a failed conversion into an error. In strict mode the function fails when a key matches a field name but its value cannot be converted, when target is a list of records but source is not a list, and when source or target is null. If strict is missing, it works in the same way as if it was set to false - such a value is left out silently. The function does not reset target first: fields which are not matched by any key keep their previous value, and a list of records keeps the records it already holds. When target is a list of records, source has to be a list too - typically a parsed JSON array. Every single item of the source list is mapped into a new record appended to target, by the very same search and conversion rules as for a single record. One item always gives one record, so the records keep the positions of the items; an item which is null or a scalar matches nothing and gives an all-null record. A source which is not a list appends nothing and returns 0, and is an error only in the strict mode. The template parameter is a record whose metadata is used for the records being appended. Its metadata has to be the element metadata of target, otherwise the list ends up holding records of mixed metadata. The parameter can be left out when target already holds at least one record, because the metadata of that record is used instead. Note that target may be a list of any type, not only a list of records; a list of a scalar type is rejected where that can be recognized, which is not possible for an empty one. The template parameter can be left out in the interpreted CTL only. A compiled transformation does not know the element type of a list at runtime, so template has to be passed whenever target is empty. Without it the function fails with Passing template always works, so pass one unless target is known to hold a record already. Field names are matched case sensitively, and labels are not taken into account. A JSON key firstName does not match a field named FirstName. The values Integer.MIN_VALUE and Long.MIN_VALUE are the internal null indicators of an integer and a long field. Mapping one of them reports the field as populated, but leaves it null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "variant2record", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "partial", "issues": [ "NULL behavior for parameter strict is undocumented." ] } } ], "compatibility": [ { "applies_to": "documented version", "description": "Available since CloverDX 7.6.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "variant2record", "basis": "documentation" } ] } ], "see_also": [ "map2record", "parseJson", "record2map", "resetRecord" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "variant2record", "basis": "documentation" } ], "data_quality": { "status": "partial", "issues": [] } }, "writeAvro": { "name": "writeAvro", "category": "conversion", "summary": "Converts variant data type to bytes contaning Avro data serialized with the https://avro.apache.org/docs/current/spec.html#binary_encoding[Binary encoding] using the specified Avro schema in JSON.", "description": "Converts variant data type to bytes contaning Avro data serialized with the https://avro.apache.org/docs/current/spec.html#binary_encoding[Binary encoding] using the specified Avro schema in JSON. Converted data have to match Avro schema supplemented as the second parameter. The resulted Avro data bytes are not regular Avro file, but the data only without Avro schema. The resulted Avro data can be used for example for a messaging system (JMS) or events streaming system (Kafka). If the data input is null, the function returns null. If the Avro schema is null, the function fails with an error. Its counterpart is the function parseAvro. .Type conversion in writeAvro() |=== h|Avro type h|Avro logical type h|Accepted CTL types h|Note |null type | |null value | |boolean | |boolean | |int | |integer | |int |date |integer, date |system timezone is used for conversion Clover date to Avro date; integer value is written with no conversion |int |time-millis |integer, date |system timezone is used for conversion Clover date to Avro time; integer value is written with no conversion |long | |long, integer | |long |time-micros |long, integer, date |system timezone is used for conversion Clover date to Avro time; integer and long values are written with no conversion |long |timestamp-millis |long, integer, date | |long |timestamp-micros |long, integer, date | |long |local-timestamp-millis |long, integer, date |system timezone is used for conversion Clover date to Avro timestamp; integer and long values are written with no conversion |long |local-timestamp-micros |long, integer, date |system timezone is used for conversion Clover date to Avro timestamp; integer and long values are written with no conversion |float | |number, decimal, long, integer | |double | |number, decimal, long, integer | |bytes | |byte, cbyte | |bytes |decimal |byte, cbyte, decimal | |string | |string | |string |uuid |string |value must be UUID |record | |map {string -> any} |keys match field names; apply this table to the value types |enum | |string |value must match enum symbol |array | |list |apply this table to the items type |map | |map |apply this table to the values type |union | |types from union |apply this table to the union types |fixed | |byte, cbyte | |fixed |decimal |byte, cbyte, decimal | |fixed |duration | |not supported |===", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "writeAvro(variant,string)", "canonical_signature": "byte writeAvro(variant object, string schema)", "type_parameters": [], "parameters": [ { "position": 0, "name": "object", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented object argument.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "object is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] }, { "position": 1, "name": "schema", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "[source] Converts variant data type to bytes contaning Avro data serialized with the https://avro.apache.org/docs/current/spec.html#binary_encoding[Binary encoding] using the specified Avro schema in JSON.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "schema is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 2, "maximum": 2 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of writeAvro as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "object == NULL", "behavior": { "kind": "returns_null", "description": "object is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeAvro", "basis": "documentation" } ] }, "description": "Converts variant data type to bytes contaning Avro data serialized with the https://avro.apache.org/docs/current/spec.html#binary_encoding[Binary encoding] using the specified Avro schema in JSON. Converted data have to match Avro schema supplemented as the second parameter. The resulted Avro data bytes are not regular Avro file, but the data only without Avro schema. The resulted Avro data can be used for example for a messaging system (JMS) or events streaming system (Kafka). If the data input is null, the function returns null. If the Avro schema is null, the function fails with an error. Its counterpart is the function parseAvro. .Type conversion in writeAvro() |=== h|Avro type h|Avro logical type h|Accepted CTL types h|Note |null type | |null value | |boolean | |boolean | |int | |integer | |int |date |integer, date |system timezone is used for conversion Clover date to Avro date; integer value is written with no conversion |int |time-millis |integer, date |system timezone is used for conversion Clover date to Avro time; integer value is written with no conversion |long | |long, integer | |long |time-micros |long, integer, date |system timezone is used for conversion Clover date to Avro time; integer and long values are written with no conversion |long |timestamp-millis |long, integer, date | |long |timestamp-micros |long, integer, date | |long |local-timestamp-millis |long, integer, date |system timezone is used for conversion Clover date to Avro timestamp; integer and long values are written with no conversion |long |local-timestamp-micros |long, integer, date |system timezone is used for conversion Clover date to Avro timestamp; integer and long values are written with no conversion |float | |number, decimal, long, integer | |double | |number, decimal, long, integer | |bytes | |byte, cbyte | |bytes |decimal |byte, cbyte, decimal | |string | |string | |string |uuid |string |value must be UUID |record | |map {string -> any} |keys match field names; apply this table to the value types |enum | |string |value must match enum symbol |array | |list |apply this table to the items type |map | |map |apply this table to the values type |union | |types from union |apply this table to the union types |fixed | |byte, cbyte | |fixed |decimal |byte, cbyte, decimal | |fixed |duration | |not supported |===", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeAvro", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "schema == NULL", "description": "schema is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [], "see_also": [ "getAvroSchema", "parseAvro" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeAvro", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "writeBson": { "name": "writeBson", "category": "conversion", "summary": "Converts a map to http://bsonspec.org[BSON] binary data format.", "description": "Converts a map to http://bsonspec.org[BSON] binary data format. Note that map keys at any level of the argument must be strings, otherwise the function fails. The top-level object must be a map. Unlike writeExtendedBson, this function cannot write top-level lists and single values, such as numbers or strings. Lists and primitive values are only allowed inside the top-level map. The advantage over writeJson is that BSON preserves data types. For example, dates are written as strings in JSON and you need to convert them manually back to dates. On the other hand, JSON is a text-based format, so it is human readable. It is also more commonly used than BSON, especially in REST APIs. To sum it up: Use + writeJson to call REST APIs. Use + writeBson to communicate with third-party applications that support BSON. If the input is null, the function returns null. Its counterpart is the function parseBson.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "writeBson(map[any,any])", "canonical_signature": "byte writeBson(map[any,any] object)", "type_parameters": [], "parameters": [ { "position": 0, "name": "object", "type": { "kind": "map", "key": { "kind": "any", "display": "any" }, "value": { "kind": "any", "display": "any" }, "display": "map[any,any]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The top-level object must be a map.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "object is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of writeBson as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "object == NULL", "behavior": { "kind": "returns_null", "description": "object is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeBson", "basis": "documentation" } ] }, "description": "Converts a map to http://bsonspec.org[BSON] binary data format. Note that map keys at any level of the argument must be strings, otherwise the function fails. The top-level object must be a map. Unlike writeExtendedBson, this function cannot write top-level lists and single values, such as numbers or strings. Lists and primitive values are only allowed inside the top-level map. The advantage over writeJson is that BSON preserves data types. For example, dates are written as strings in JSON and you need to convert them manually back to dates. On the other hand, JSON is a text-based format, so it is human readable. It is also more commonly used than BSON, especially in REST APIs. To sum it up: Use + writeJson to call REST APIs. Use + writeBson to communicate with third-party applications that support BSON. If the input is null, the function returns null. Its counterpart is the function parseBson.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeBson", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "writeBson(variant)", "canonical_signature": "byte writeBson(variant object)", "type_parameters": [], "parameters": [ { "position": 0, "name": "object", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "The top-level object must be a map.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "object is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of writeBson as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "object == NULL", "behavior": { "kind": "returns_null", "description": "object is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeBson", "basis": "documentation" } ] }, "description": "Converts a map to http://bsonspec.org[BSON] binary data format. Note that map keys at any level of the argument must be strings, otherwise the function fails. The top-level object must be a map. Unlike writeExtendedBson, this function cannot write top-level lists and single values, such as numbers or strings. Lists and primitive values are only allowed inside the top-level map. The advantage over writeJson is that BSON preserves data types. For example, dates are written as strings in JSON and you need to convert them manually back to dates. On the other hand, JSON is a text-based format, so it is human readable. It is also more commonly used than BSON, especially in REST APIs. To sum it up: Use + writeJson to call REST APIs. Use + writeBson to communicate with third-party applications that support BSON. If the input is null, the function returns null. Its counterpart is the function parseBson.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeBson", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "Available since CloverDX 5.6.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeBson", "basis": "documentation" } ] } ], "see_also": [ "parseBson", "writeExtendedBson", "writeJson" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeBson", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "writeExtendedBson": { "name": "writeExtendedBson", "category": "conversion", "summary": "The function writeExtendedBson is deprecated.", "description": "The function writeExtendedBson is deprecated. It was used for passing variant values between components. Variant values can be passed on edges directly since CloverDX 5.11.0. Using writeExtendedBson function is no longer necessary. Converts lists, maps or primitive values to an extension of http://bsonspec.org[BSON] binary data format. Use this function to transport structured data internally within CloverDX. Reconstruct the original object using parseBson. A similar function, writeBson, cannot handle single values, e.g. strings, integers, and top-level lists, because such values are not supported in standard BSON. Function writeExtendedBson removes these limitations, but the output is not compatible with third-party applications supporting standard BSON. To sum it up: Use + writeJson if you need text-based output. Use + writeBson for compatibility with third-party applications supporting BSON. If the input is null, the function returns null.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "writeExtendedBson(any)", "canonical_signature": "byte writeExtendedBson(any object)", "type_parameters": [], "parameters": [ { "position": 0, "name": "object", "type": { "kind": "any", "display": "any" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Reconstruct the original object using parseBson.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "object is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of writeExtendedBson as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "object == NULL", "behavior": { "kind": "returns_null", "description": "object is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeExtendedBson", "basis": "documentation" } ] }, "description": "The function writeExtendedBson is deprecated. It was used for passing variant values between components. Variant values can be passed on edges directly since CloverDX 5.11.0. Using writeExtendedBson function is no longer necessary. Converts lists, maps or primitive values to an extension of http://bsonspec.org[BSON] binary data format. Use this function to transport structured data internally within CloverDX. Reconstruct the original object using parseBson. A similar function, writeBson, cannot handle single values, e.g. strings, integers, and top-level lists, because such values are not supported in standard BSON. Function writeExtendedBson removes these limitations, but the output is not compatible with third-party applications supporting standard BSON. To sum it up: Use + writeJson if you need text-based output. Use + writeBson for compatibility with third-party applications supporting BSON. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeExtendedBson", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "writeExtendedBson(map[any,any])", "canonical_signature": "byte writeExtendedBson(map[any,any] object)", "type_parameters": [], "parameters": [ { "position": 0, "name": "object", "type": { "kind": "map", "key": { "kind": "any", "display": "any" }, "value": { "kind": "any", "display": "any" }, "display": "map[any,any]" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Reconstruct the original object using parseBson.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "object is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of writeExtendedBson as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "object == NULL", "behavior": { "kind": "returns_null", "description": "object is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeExtendedBson", "basis": "documentation" } ] }, "description": "The function writeExtendedBson is deprecated. It was used for passing variant values between components. Variant values can be passed on edges directly since CloverDX 5.11.0. Using writeExtendedBson function is no longer necessary. Converts lists, maps or primitive values to an extension of http://bsonspec.org[BSON] binary data format. Use this function to transport structured data internally within CloverDX. Reconstruct the original object using parseBson. A similar function, writeBson, cannot handle single values, e.g. strings, integers, and top-level lists, because such values are not supported in standard BSON. Function writeExtendedBson removes these limitations, but the output is not compatible with third-party applications supporting standard BSON. To sum it up: Use + writeJson if you need text-based output. Use + writeBson for compatibility with third-party applications supporting BSON. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeExtendedBson", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } }, { "id": "writeExtendedBson(variant)", "canonical_signature": "byte writeExtendedBson(variant object)", "type_parameters": [], "parameters": [ { "position": 0, "name": "object", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Reconstruct the original object using parseBson.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "object is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "byte", "display": "byte" }, "description": "Return value of writeExtendedBson as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "object == NULL", "behavior": { "kind": "returns_null", "description": "object is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeExtendedBson", "basis": "documentation" } ] }, "description": "The function writeExtendedBson is deprecated. It was used for passing variant values between components. Variant values can be passed on edges directly since CloverDX 5.11.0. Using writeExtendedBson function is no longer necessary. Converts lists, maps or primitive values to an extension of http://bsonspec.org[BSON] binary data format. Use this function to transport structured data internally within CloverDX. Reconstruct the original object using parseBson. A similar function, writeBson, cannot handle single values, e.g. strings, integers, and top-level lists, because such values are not supported in standard BSON. Function writeExtendedBson removes these limitations, but the output is not compatible with third-party applications supporting standard BSON. To sum it up: Use + writeJson if you need text-based output. Use + writeBson for compatibility with third-party applications supporting BSON. If the input is null, the function returns null.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeExtendedBson", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "Available since CloverDX 5.6.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeExtendedBson", "basis": "documentation" } ] }, { "applies_to": "documented version", "description": "Deprecated since CloverDX 5.11.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeExtendedBson", "basis": "documentation" } ] } ], "see_also": [ "parseBson", "writeBson", "writeJson" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeExtendedBson", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "writeJson": { "name": "writeJson", "category": "conversion", "summary": "Converts CTL lists, maps or primitive values to a https://www.json.org[JSON] string.", "description": "Converts CTL lists, maps or primitive values to a https://www.json.org[JSON] string. Dates are written as strings in https://en.wikipedia.org/wiki/ISO_8601[ISO 8601] format in UTC time zone, e.g. \"2020-03-24T18:45:34.853Z\". Keys in all maps at any level of the object are converted to strings. If the input is null, the function returns null. There are two similar functions: {empty} + writeBson produces BSON, a binary format that preserves data types better than JSON. {empty} + writeExtendedBson is a way of encoding variant into proprietary extension of the BSON format and it is incompatible with third-party applications. The counterpart of writeJson is the function parseJson.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "writeJson(variant)", "canonical_signature": "string writeJson(variant object)", "type_parameters": [], "parameters": [ { "position": 0, "name": "object", "type": { "kind": "named", "name": "variant", "display": "variant" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Keys in all maps at any level of the object are converted to strings.", "constraints": [], "null_behavior": { "kind": "returns_null", "description": "object is NULL -> NULL.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of writeJson as documented.", "nullable": { "kind": "conditional", "description": "The normalized NULL-behavior source documents NULL results for specific arguments.", "cases": [ { "condition": "object == NULL", "behavior": { "kind": "returns_null", "description": "object is NULL -> NULL." }, "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ] }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeJson", "basis": "documentation" } ] }, "description": "Converts CTL lists, maps or primitive values to a https://www.json.org[JSON] string. Dates are written as strings in https://en.wikipedia.org/wiki/ISO_8601[ISO 8601] format in UTC time zone, e.g. \"2020-03-24T18:45:34.853Z\". Keys in all maps at any level of the object are converted to strings. If the input is null, the function returns null. There are two similar functions: {empty} + writeBson produces BSON, a binary format that preserves data types better than JSON. {empty} + writeExtendedBson is a way of encoding variant into proprietary extension of the BSON format and it is incompatible with third-party applications. The counterpart of writeJson is the function parseJson.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeJson", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "Available since CloverDX 5.6.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeJson", "basis": "documentation" } ] } ], "see_also": [ "parseJson", "record2map", "writeBson", "writeExtendedBson" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "writeJson", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "xml2json": { "name": "xml2json", "category": "conversion", "summary": "The xml2json() function converts a string XML formatted argument to a JSON formatted string.", "description": "The xml2json() function converts a string XML formatted argument to a JSON formatted string. Its counterpart is the function json2xml. If the input is null, the function fails with an error.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "xml2json(string)", "canonical_signature": "string xml2json(string arg)", "type_parameters": [], "parameters": [ { "position": 0, "name": "arg", "type": { "kind": "named", "name": "string", "display": "string" }, "optional": false, "variadic": false, "default": { "kind": "none", "description": "No default; the parameter is required." }, "description": "Documented arg argument.", "constraints": [], "null_behavior": { "kind": "runtime_error", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] }, "evidence": [] } ], "arity": { "minimum": 1, "maximum": 1 }, "returns": { "type": { "kind": "named", "name": "string", "display": "string" }, "description": "Return value of xml2json as documented.", "nullable": { "kind": "never", "description": "The normalized NULL-behavior source does not document a NULL result for any input parameter." }, "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "xml2json", "basis": "documentation" } ] }, "description": "The xml2json() function converts a string XML formatted argument to a JSON formatted string. Its counterpart is the function json2xml. If the input is null, the function fails with an error.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "xml2json", "basis": "documentation" } ], "null_interactions": [], "errors": [ { "kind": "runtime_error", "condition": "arg == NULL", "description": "arg is NULL -> runtime error.", "evidence": [ { "source_id": "ctl2-null-behavior", "section": "NULL behavior", "basis": "normalized_summary" } ] } ], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The xml2json(string) function is available since CloverETL 3.1.0.", "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "xml2json", "basis": "documentation" } ] } ], "see_also": [ "json2xml" ], "evidence": [ { "source_id": "ctl2-conversion-functions", "section": "xml2json", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } }, "zeroDate": { "name": "zeroDate", "category": "date", "summary": "The zeroDate() function accepts no argument and returns 1.1.1970 0:00:00 GMT.", "description": "The zeroDate() function accepts no argument and returns 1.1.1970 0:00:00 GMT.", "availability": { "status": "supported", "since": null, "deprecated_since": null, "replacement": null }, "overloads": [ { "id": "zeroDate()", "canonical_signature": "date zeroDate()", "type_parameters": [], "parameters": [], "arity": { "minimum": 0, "maximum": 0 }, "returns": { "type": { "kind": "named", "name": "date", "display": "date" }, "description": "Return value of zeroDate as documented.", "nullable": { "kind": "undocumented", "description": "Return nullability is not documented separately." }, "evidence": [ { "source_id": "ctl2-date-functions", "section": "zeroDate", "basis": "documentation" } ] }, "description": "The zeroDate() function accepts no argument and returns 1.1.1970 0:00:00 GMT.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "zeroDate", "basis": "documentation" } ], "null_interactions": [], "errors": [], "side_effects": [], "examples": [], "compatibility": [], "data_quality": { "status": "complete", "issues": [] } } ], "compatibility": [ { "applies_to": "documented version", "description": "The zeroDate() function is available since CloverETL 3.0.0.", "evidence": [ { "source_id": "ctl2-date-functions", "section": "zeroDate", "basis": "documentation" } ] } ], "see_also": [ "today" ], "evidence": [ { "source_id": "ctl2-date-functions", "section": "zeroDate", "basis": "documentation" } ], "data_quality": { "status": "complete", "issues": [] } } } }