This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
dev:sql:functions:home [2010/06/11 23:00] tdo |
dev:sql:functions:home [2011/03/31 14:49] doc |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| {{page>:top_add&nofooter&noeditbtn}} | {{page>:top_add&nofooter&noeditbtn}} | ||
| - | <html><div align="center"><span style="color:red">DRAFT</span></div></html> | + | ====== Omnidex SQL Functions Quick Reference ====== |
| - | ====== Omnidex SQL: Functions ====== | + | |
| - | {{page>:sql_bar&nofooter&noeditbtn}} | + | |
| - | ===== Standard ANSI SQL Functions ===== | + | |
| - | + | ||
| - | The Omnidex SQL Language supports several standard SQL Functions based on the ANSI SQL standard as well as functions typically found in the major relational databases. | + | |
| - | + | ||
| - | ^ SQL Functions ^ Syntax ^ Description ^ | + | |
| - | | [[ ABS ]] | ABS(numeric_expression) | Returns the absolute value of a numeric expression. | | + | |
| - | | [[ CASE ]] | xxx| Allows simple IF..THEN..ELSE logic in a select-item. | | + | |
| - | | [[ CAST ]] | xxx| Convert an expression to a specific data type. | | + | |
| - | | [[ dev:sql:functions:character_length:home | CHAR[ACTER]_LENGTH ]] |xxx | Return the number of characters in a string. | | + | |
| - | | [[ COALESCE ]] | COALESCE(value[, value…]) | Returns the first non-NULL expression in the list. | | + | |
| - | | [[ dev:sql:functions:concatenation | || (Concatenation) ]] |xxx |Concatenate multiple columns or strings into a single character string. | | + | |
| - | | [[ CURRENT_DATE]] | xxx | Return the current data from the system clock. | | + | |
| - | | [[ CURRENT_TIME]] | xxx | Return the current time from the system clock. | | + | |
| - | | [[ CURRENT_TIMESTAMP]] | xxx| Return the current timestamp from the system clock. | | + | |
| - | | [[ CURRENT_USER]] | xxx| Return the current Omnidex user. | | + | |
| - | | [[ EXTRACT]] | xxx| Extract an individual field value from a date_class data type field. | | + | |
| - | | [[ LOWER]] | xxx|Convert all characters in a text string to lower case. | | + | |
| - | | [[ POSITION]] |xxx| Return the position of a string within another string. | | + | |
| - | | [[ SUBSTRING]] | xxx|Return a specific part of a string. | | + | |
| - | | [[ SESSION_USER]] |xxx| Return the current Omnidex user. | | + | |
| - | | [[ SYSTEM_USER]] | xxx|Return the current system user. | | + | |
| - | | [[ TRIM ]] | xxx| Remove leading and/or trailing "pad" characters from a string. | | + | |
| - | | [[ UPPER ]] | xxx| Convert all characters in a text string to upper case. | | + | |
| - | | [[ USER ]] | xxx|Return the current Omnidex user. | | + | |
| - | + | ||
| - | ===== Omnidex Extended Functions ===== | + | |
| - | + | ||
| - | The Omnidex SQL Language supports several functions that are extensions to the standard SQL Functions. Extended functions are prefixed with a ( %%$%% ) so that they are easy to locate in existing SQL code. | + | |
| - | + | ||
| - | ^ Omnidex Functions ^ Description ^ | + | |
| - | | [[ $CALC_DATE ]] | Calculates a new date value based on an offset of days or other time vlaues| | + | |
| - | | [[ dev:sql:functions:col_length | $COL[UMN]_LENGTH ]] | Return the length of a column as defined in the environment catalog. Same as $COL_LEN. | | + | |
| - | | [[ dev:sql:functions:contains:home | $CONTAINS ]] | Provides additional keyword searching options over the standard Omnidex keyword search.| | + | |
| - | | [[ dev:sql:functions:context:home | $CONTEXT ]] | Return snippets of text from data qualified in a $CONTAINS function. | | + | |
| - | | [[ $CONVERT ]] | Convert a scalar expression from one data type to another. | | + | |
| - | | [[ $COMPARE_DATES]] | Calculates the difference between two dates in days unless a date unit is specified.| | + | |
| - | | [[ $CURRENT_ROW ]] | Return the current row number. | | + | |
| - | | [[ $DISTANCE ]] | Calculates the distance between two geographical points.| | + | |
| - | | [[ $EXTERNAL ]] | Execute an external user-defined function. | | + | |
| - | | [[ [[ dev:sql:functions:highlight_criteria:home | $HIGHLIGHT_CRITERIA ]] | Retrieve a select item that was used in the WHERE clause of a SELECT statement and highlights all keywords involved in the criteria| | + | |
| - | | [[ [[ dev:sql:functions:highlight_keywords:home | $HIGHLIGHT_KEYWORDS ]] | Retrieve a select item and highlight specific keywords.| | + | |
| - | | [[ $IFNULL ]] | Specify a return value for columns containing null values. | | + | |
| - | | [[ $LJ ]] | Left justify a string by eliminating leading white space. | | + | |
| - | | [[ [[ dev:sql:functions:lookup:home | $LOOKUP ]] | Retrieve textual metadata. | | + | |
| - | | [[ $LPAD ]] | Add leading "PAD" characters to a string. | | + | |
| - | | [[ $MOD ]] | Return "n modulus y" (remainder). | | + | |
| - | | [[ $PROPER ]] | Shift the first letter of each word in a string to upper case and all other letters to lower case. | | + | |
| - | | [[ $RANDOM ]] | Return a pseudo-random number. | | + | |
| - | | [[ $RJ ]] | Right justify a string by eliminating trailing white space and inserting leading spaces as needed. | | + | |
| - | | [[ $ROUND ]] | Round a numerical value to the specified number of decimal places. | | + | |
| - | | [[ $RPAD ]] | Add trailing "PAD" characters to a string. | | + | |
| - | | [[ $SCORE ]] | Returns the rank/relevancy score of qualified text from a $CONTAINS function. | | + | |
| - | | [[ $SOUNDEX ]] | Return the Soundex equivalent to a character string. | | + | |
| - | | [[ $TRUNC ]] | Return a numeric expression truncated to a specified number of digits to the right of the decimal point. | | + | |
| - | + | ||
| - | MIN_SCORE and FREQ_ADJUSTMENT FIXME | + | |
| - | ===== Oracle Functions ===== | + | |
| - | The following functions can be used within an Omnidex SQL statement after the SET SQL_SYNTAX ORACLE statement has been issued or declared in the CREATE ENVIRONMENT statement. | + | |
| - | ^ Oracle Functions ^ Syntax ^ Description ^ | + | |
| - | | [[ CHR ]] | CHR(integer-expression)| Returns the Ascii character for the specified integer value | | + | |
| - | | [[ INSTR ]] | INSTR(string, substring[, position[, occurrence]]) |Returns an integer value representing the starting position of a string within the search string. | | + | |
| + | (This will be converted to a three-column once the underlying pages are written) | ||
| + | |< 95% 100% >| | ||
| + | ^ Omnidex SQL Functions ^^^ | ||
| + | |**String Functions** ||| | ||
| + | |[[dev:sql:functions:character_length|CHARACTER_LENGTH]] ||| | ||
| + | |[[dev:sql:functions:lower|LOWER]] ||| | ||
| + | |[[dev:sql:functions:position|POSITION]] ||| | ||
| + | |[[dev:sql:functions:substring|SUBSTRING]] ||| | ||
| + | |[[dev:sql:functions:trim|TRIM]] ||| | ||
| + | |[[dev:sql:functions:upper|UPPER]] ||| | ||
| + | |[[dev:sql:functions:concatenation| || (Concatenation)]] ||| | ||
| + | |[[dev:sql:functions:lj|$LJ]] ||| | ||
| + | |[[dev:sql:functions:lpad|$LPAD]] ||| | ||
| + | |[[dev:sql:functions:proper|$PROPER]] ||| | ||
| + | |[[dev:sql:functions:rj|$RJ]] ||| | ||
| + | |[[dev:sql:functions:rpad|$RPAD]] ||| | ||
| + | | ||| | ||
| + | |**Math Functions** ||| | ||
| + | |[[dev:sql:functions:abs|ABS]] ||| | ||
| + | |[[dev:sql:functions:ceiling|CEIL[ING] ]] ||| | ||
| + | |[[dev:sql:functions:floor|FLOOR]] ||| | ||
| + | |[[dev:sql:functions:mod|MOD]] ||| | ||
| + | |[[dev:sql:functions:round|ROUND]] ||| | ||
| + | |[[dev:sql:functions:trunc|TRUNC]] ||| | ||
| + | |[[dev:sql:functions:random|$RANDOM]] ||| | ||
| + | | ||| | ||
| + | |**Date Functions** ||| | ||
| + | |[[dev:sql:functions:extract|EXTRACT]] ||| | ||
| + | |[[dev:sql:functions:calc_date|$CALC_DATE]] ||| | ||
| + | |[[dev:sql:functions:compare_dates|$COMPARE_DATES]] ||| | ||
| + | | ||| | ||
| + | |**Logic Functions** ||| | ||
| + | |[[dev:sql:functions:case|CASE]] ||| | ||
| + | |[[dev:sql:functions:coalesce|COALESCE]] ||| | ||
| + | |[[dev:sql:functions:nullif|NULLIF]] ||| | ||
| + | |[[dev:sql:functions:ifnull|$IFNULL]] ||| | ||
| + | | ||| | ||
| + | |**Utility and Conversion Functions** ||| | ||
| + | |[[dev:sql:functions:cast|CAST]] ||| | ||
| + | |[[dev:sql:functions:column_length|$COLUMN_LENGTH]] ||| | ||
| + | |[[dev:sql:functions:convert|$CONVERT]] ||| | ||
| + | |[[dev:sql:functions:data_length|$DATA_LENGTH]] ||| | ||
| + | |[[dev:sql:functions:distance|$DISTANCE]] ||| | ||
| + | | ||| | ||
| + | |**Variables** ||| | ||
| + | |[[dev:sql:functions:current_date|CURRENT_DATE]] ||| | ||
| + | |[[dev:sql:functions:current_time|CURRENT_TIME]] ||| | ||
| + | |[[dev:sql:functions:current_timestamp|CURRENT_TIMESTAMP]] ||| | ||
| + | |[[dev:sql:functions:current_user|CURRENT_USER]] ||| | ||
| + | |[[dev:sql:functions:session_user|SESSION_USER]] ||| | ||
| + | |[[dev:sql:functions:system_user|SYSTEM_USER]] ||| | ||
| + | |[[dev:sql:functions:user|USER]] ||| | ||
| + | |[[dev:sql:functions:current_row| $CURRENT_ROW]] ||| | ||
| + | | ||| | ||
| + | |**Omnidex Text Functions** ||| | ||
| + | |[[dev:sql:functions:contains|$CONTAINS]] ||| | ||
| + | |[[dev:sql:functions:context|$CONTEXT]] ||| | ||
| + | |[[dev:sql:functions:highlight_criteria|$HIGHLIGHT_CRITERIA]] ||| | ||
| + | |[[dev:sql:functions:highlight_keywords|$HIGHLIGHT_KEYWORDS]] ||| | ||
| + | |[[dev:sql:functions:lookup|$LOOKUP]] ||| | ||
| + | |[[dev:sql:functions:retrieve_file|$RETRIEVE_FILE]] ||| | ||
| + | |[[dev:sql:functions:score|$SCORE]] ||| | ||
| + | |[[dev:sql:functions:soundex|$SOUNDEX]] ||| | ||
| + | | ||| | ||
| + | |**Oracle-specific Functions** ||| | ||
| + | |[[dev:sql:functions:chr|CHR]] ||| | ||
| + | |[[dev:sql:functions:instr|INSTR]] ||| | ||
| + | |[[dev:sql:functions:new_time|NEW_TIME]] ||| | ||
| + | |[[dev:sql:functions:nvl|NVL]] ||| | ||
| + | |[[dev:sql:functions:power|POWER]] ||| | ||
| + | |[[dev:sql:functions:substr|SUBSTR]] ||| | ||
| + | |[[dev:sql:functions:sysdate|SYSDATE]] ||| | ||
| + | |[[dev:sql:functions:systimestamp|SYSTIMESTAMP]] ||| | ||
| + | |[[dev:sql:functions:sys_extract_utc|SYS_EXTRACT_UTC]] ||| | ||
| + | |[[dev:sql:functions:to_date|TO_DATE]] ||| | ||
| + | |[[dev:sql:functions:to_number|TO_NUMBER]] ||| | ||
| + | | ||| | ||
| + | ====== Omnidex SQL Function Descriptions ====== | ||
| + | |< 95% 20% 24% 56% >| | ||
| + | ^Function ^Parameters ^Description ^ | ||
| + | | ||| | ||
| + | ^**String Functions** ^^^ | ||
| + | | [[dev:sql:functions:character_length | CHAR[ACTER]_LENGTH]] |(char_expr) | Return the number of characters in a character expression. | | ||
| + | | [[dev:sql:functions:lower | LOWER]] | (char_expr)|Convert all characters in a character expression to lower case. | | ||
| + | | [[dev:sql:functions:position | POSITION]] | (search_expr IN target_expr)| Return the position of a character expression within another character expression. | | ||
| + | | [[dev:sql:functions:substring | SUBSTRING]] | (char_expr FROM pos FOR len)|Return a specific part of a character expression starting at FROM position FOR length. | | ||
| + | | [[dev:sql:functions:trim | TRIM ]] | (['char' FROM] column)| Remove leading and/or trailing spaces or characters from a character expression. | | ||
| + | | [[dev:sql:functions:upper | UPPER ]] | (column)| Convert all characters in a character expression to upper case. | | ||
| + | | [[dev:sql:functions:concatenation | || (Concatenation) ]] | char_expr %%||%% char_expr | Concatenate multiple character expressions into a single character expression. | | ||
| + | | [[dev:sql:functions:lj | $LJ ]] | (char_expr) | Left justify a character expression eliminating leading white space. | | ||
| + | | [[dev:sql:functions:lpad | $LPAD ]] | (char_expr, len [, pad_char ])| Add leading 'pad' characters to a character expression. | | ||
| + | | [[dev:sql:functions:proper | $PROPER ]] | (char_expr) | Shift the first letter of each word in a character expression to upper case and all other letters to lower case. | | ||
| + | | [[dev:sql:functions:rj | $RJ ]] | (char_expr) | Right justify a character expression eliminating trailing white space. | | ||
| + | | [[dev:sql:functions:rpad | $RPAD ]] | (char_expr, len [, pad_char ])| Add trailing 'pad' characters to a character expression. | | ||
| + | | ||| | ||
| + | ^**Math Functions** ^^^ | ||
| + | | [[dev:sql:functions:abs | ABS ]] | (num_expr) | Returns the absolute value of a numeric expression. | | ||
| + | | [[dev:sql:functions:mod | MOD ]] | (int_expr, divisor) | Returns the integral remainder of one integer expression divided by another. | | ||
| + | | [[dev:sql:functions:round | ROUND ]] | (num_expr [, digits]) | Round a numerical value to the specified number of decimal places. | | ||
| + | | [[dev:sql:functions:trunc | TRUNC ]] | (num_expr [, digits]) | Return a numeric expression truncated to a specified number of digits to the right of the decimal point. | | ||
| + | | [[dev:sql:functions:random | $RANDOM ]] | (num_expr [, seed]) | Return a pseudo-random number. | | ||
| {{page>:bottom_add&nofooter&noeditbtn}} | {{page>:bottom_add&nofooter&noeditbtn}} | ||