SQL functions STR

SQL function STR

A function to convert a number to a string.

Outline

STR(number[,length[,decimals]])

Copy

parameter

• number - An expression that resolves to a number.It can be a field name, a number, or the result of other functions.If a field name is specified, a logical value is used.
• length - optional - an integer specifying the total length of the desired output string, including all characters (numbers, decimal points, symbols, spaces).The default value is 10.
• decimals - optional — an integer specifying the number of digits to the right of the decimal point to include.The default value is 0.

Description

STR Converts a number to STRING format, truncating the number based on the length and decimal value.The length parameter must be large enough to contain the entire integer portion of the number and, if a decimal is specified, the number of decimal places plus 1 (for the decimal point).If the length is not large enough, STR will return an asterisk (*) string equal to the length.

STR Converts numbers to their canonical form before string conversion.Therefore, it performs arithmetic operations, removing leading and trailing zeros and leading plus signs from the number.

If the number parameter is NULL, STR returns NULL.If the number parameter is an empty string (''), STR returns an empty string.STRING spaces are reserved.

Example

In the following embedded SQL example, STR converts a number to a string:

/// d ##class(PHA.TEST.SQLFunction).Str()ClassMethodStr(){&sql(SELECT STR(123),STR(123,4),STR(+00123.45,3),STR(+00123.45,3,1),STR(+00123.45,5,1)INTO :v,:w,:x,:y,:z)if SQLCODE '= 0 {w !,"Error code ",SQLCODE} else {w !,"Resulting STR:",v,"string"w !,"Resulting STR:",w,"string"w !,"Resulting STR:",x,"string"w !,"Resulting STR:",y,"string"w !,"Resulting STR:",z,"string"}}

Copy

DHC-APP>d ##class(PHA.TEST.SQLFunction).Str()Resulting STR: 123 stringResulting STR: 123 stringResulting STR: 123 stringResulting STR:*** stringResulting STR:123.4 string

Copy

The first STR function returns a string consisting of 7 leading spaces and the number 123; the seven leading spaces are becauseThe default string length is 10.The second STR function returns the string "123"; note the leading whitespace required to return a string of length 4.The third STR function returns the string “123”; the number is put into canonical form, and the decimal defaults to 0.The fourth STR function returns "***" because the string is not long enough to contain the entire number specified; the number of asterisks indicates the string length.The fifth STR function returns "123.4"; note that the length must be 5 to contain decimal digits.